Opentk/Source/Bind/Specifications/Docs/glInvalidateBufferSubData.xml
2013-12-15 22:32:32 +01:00

105 lines
4.7 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"
"http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">
<refentry id="glInvalidateBufferSubData">
<refentryinfo>
<copyright>
<year>2013</year>
<holder>Khronos Group</holder>
</copyright>
</refentryinfo>
<refmeta>
<refentrytitle>glInvalidateBufferSubData</refentrytitle>
<manvolnum>3G</manvolnum>
</refmeta>
<refnamediv>
<refname>glInvalidateBufferSubData</refname>
<refpurpose>invalidate a region of a buffer object's data store</refpurpose>
</refnamediv>
<refsynopsisdiv><title>C Specification</title>
<funcsynopsis>
<funcprototype>
<funcdef>void <function>glInvalidateBufferSubData</function></funcdef>
<paramdef>GLuint <parameter>buffer</parameter></paramdef>
<paramdef>GLintptr <parameter>offset</parameter></paramdef>
<paramdef>GLsizeiptr <parameter>length</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="parameters"><title>Parameters</title>
<variablelist>
<varlistentry>
<term><parameter>buffer</parameter></term>
<listitem>
<para>
The name of a buffer object, a subrange of whose data store to invalidate.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>offset</parameter></term>
<listitem>
<para>
The offset within the buffer's data store of the start of the range to be invalidated.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>length</parameter></term>
<listitem>
<para>
The length of the range within the buffer's data store to be invalidated.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 id="description"><title>Description</title>
<para>
<function>glInvalidateBufferSubData</function> invalidates all or part of the
content of the data store of a buffer object. After invalidation, the content
of the specified range of the buffer's data store becomes undefined. The
start of the range is given by <parameter>offset</parameter> and its size
is given by <parameter>length</parameter>, both measured in basic machine units.
</para>
</refsect1>
<refsect1 id="errors"><title>Errors</title>
<para>
<constant>GL_INVALID_VALUE</constant> is generated if <parameter>offset</parameter> or
<parameter>length</parameter> is negative, or if <parameter>offset</parameter> +
<parameter>length</parameter> is greater than the value of <constant>GL_BUFFER_SIZE</constant>
for <parameter>buffer</parameter>.
</para>
<para>
<constant>GL_INVALID_VALUE</constant> is generated if <parameter>buffer</parameter> is not the
name of an existing buffer object.
</para>
<para>
<constant>GL_INVALID_OPERATION</constant> is generated if any part of <parameter>buffer</parameter>
is currently mapped.
</para>
</refsect1>
<refsect1 id="associatedgets"><title>Associated Gets</title>
<para>
<citerefentry><refentrytitle>glGetBufferParameter</refentrytitle></citerefentry> with argument <constant>GL_BUFFER_SIZE</constant>
</para>
</refsect1>
<refsect1 id="seealso"><title>See Also</title>
<para>
<citerefentry><refentrytitle>glInvalidateTexSubImage</refentrytitle></citerefentry>,,
<citerefentry><refentrytitle>glInvalidateTexImage</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glInvalidateBufferData</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glInvalidateFramebuffer</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glInvalidateSubFramebuffer</refentrytitle></citerefentry>.
</para>
</refsect1>
<refsect1 id="Copyright"><title>Copyright</title>
<para>
Copyright <trademark class="copyright"></trademark> 2013 Khronos Group.
This material may be distributed subject to the terms and conditions set forth in
the Open Publication License, v 1.0, 8 June 1999.
<ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.
</para>
</refsect1>
</refentry>