upstream-doc/man4/glInvalidateBufferSubData.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"
   3               "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">
   4 <refentry id="glInvalidateBufferSubData">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>2012</year>
   9                 <holder>Khronos Group</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>glInvalidateBufferSubData</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>glInvalidateBufferSubData</refname>
  17         <refpurpose>invalidate a region of a buffer object's data store</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>C Specification</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>void <function>glInvalidateBufferSubData</function></funcdef>
  23                 <paramdef>GLuint <parameter>buffer</parameter></paramdef>
  24                 <paramdef>GLintptr <parameter>offset</parameter></paramdef>
  25                 <paramdef>GLsizeiptr <parameter>length</parameter></paramdef>
  26             </funcprototype>
  27         </funcsynopsis>
  28     </refsynopsisdiv>
  29     <refsect1 id="parameters"><title>Parameters</title>
  30         <variablelist>
  31         <varlistentry>
  32             <term><parameter>buffer</parameter></term>
  33             <listitem>
  34                 <para>
  35                     The name of a buffer object, a subrange of whose data store to invalidate.
  36                 </para>
  37             </listitem>
  38         </varlistentry>
  39         <varlistentry>
  40             <term><parameter>offset</parameter></term>
  41             <listitem>
  42                 <para>
  43                     The offset within the buffer's data store of the start of the range to be invalidated.
  44                 </para>
  45             </listitem>
  46         </varlistentry>
  47         <varlistentry>
  48             <term><parameter>length</parameter></term>
  49             <listitem>
  50                 <para>
  51                     The length of the range within the buffer's data store to be invalidated.
  52                 </para>
  53             </listitem>
  54         </varlistentry>
  55         </variablelist>
  56     </refsect1>
  57     <refsect1 id="description"><title>Description</title>
  58         <para>
  59             <function>glInvalidateBufferSubData</function> invalidates all or part of the
  60             content of the data store of a buffer object. After invalidation, the content
  61             of the specified range of the buffer's data store becomes undefined. The
  62             start of the range is given by <parameter>offset</parameter> and its size
  63             is given by <parameter>length</parameter>, both measured in basic machine units.
  64         </para>
  65     </refsect1>
  66     <refsect1 id="errors"><title>Errors</title>
  67         <para>
  68             <constant>GL_INVALID_VALUE</constant> is generated if <parameter>offset</parameter> or
  69             <parameter>length</parameter> is negative, or if <parameter>offset</parameter> +
  70             <parameter>length</parameter> is greater than the value of <constant>GL_BUFFER_SIZE</constant>
  71             for <parameter>buffer</parameter>.
  72         </para>
  73         <para>
  74             <constant>GL_INVALID_VALUE</constant> is generated if <parameter>buffer</parameter> is not the
  75             name of an existing buffer object.
  76         </para>
  77         <para>
  78             <constant>GL_INVALID_OPERATION</constant> is generated if any part of <parameter>buffer</parameter>
  79             is currently mapped.
  80         </para>
  81     </refsect1>
  82     <refsect1 id="associatedgets"><title>Associated Gets</title>
  83         <para>
  84             <citerefentry><refentrytitle>glGetBufferParameter</refentrytitle></citerefentry> with argument <constant>GL_BUFFER_SIZE</constant>
  85         </para>
  86     </refsect1>
  87     <refsect1 id="seealso"><title>See Also</title>
  88         <para>
  89             <citerefentry><refentrytitle>glInvalidateTexSubImage</refentrytitle></citerefentry>,,
  90             <citerefentry><refentrytitle>glInvalidateTexImage</refentrytitle></citerefentry>,
  91             <citerefentry><refentrytitle>glInvalidateBufferData</refentrytitle></citerefentry>,
  92             <citerefentry><refentrytitle>glInvalidateFramebuffer</refentrytitle></citerefentry>,
  93             <citerefentry><refentrytitle>glInvalidateSubFramebuffer</refentrytitle></citerefentry>.
  94         </para>
  95     </refsect1>
  96     <refsect1 id="Copyright"><title>Copyright</title>
  97         <para>
  98             Copyright <trademark class="copyright"></trademark> 2012 Khronos Group.
  99             This material may be distributed subject to the terms and conditions set forth in
 100             the Open Publication License, v 1.0, 8 June 1999.
 101             <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.
 102         </para>
 103     </refsect1>
 104 </refentry>