upstream-doc/man4/xhtml/glInvalidateBufferSubData.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd">
   3 <!-- saved from url=(0013)about:internet -->
   4 <?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" pref:renderer="mathplayer-dl"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><link rel="stylesheet" type="text/css" href="opengl-man.css" /><title>glInvalidateBufferSubData - OpenGL 4 Reference Pages</title><meta name="generator" content="DocBook XSL Stylesheets V1.69.1" /></head><body><div class="refentry" lang="en" xml:lang="en"><a id="glInvalidateBufferSubData"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glInvalidateBufferSubData — invalidate a region of a buffer object's data store</p></div><div class="refsynopsisdiv"><h2>C Specification</h2><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"><tr><td><code class="funcdef">void <b class="fsfunc">glInvalidateBufferSubData</b>(</code></td><td>GLuint  </td><td><var class="pdparam">buffer</var>, </td></tr><tr><td> </td><td>GLintptr  </td><td><var class="pdparam">offset</var>, </td></tr><tr><td> </td><td>GLsizeiptr  </td><td><var class="pdparam">length</var><code>)</code>;</td></tr></table></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="parameters"></a><h2>Parameters</h2><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>buffer</code></em></span></dt><dd><p>
   5                     The name of a buffer object, a subrange of whose data store to invalidate.
   6                 </p></dd><dt><span class="term"><em class="parameter"><code>offset</code></em></span></dt><dd><p>
   7                     The offset within the buffer's data store of the start of the range to be invalidated.
   8                 </p></dd><dt><span class="term"><em class="parameter"><code>length</code></em></span></dt><dd><p>
   9                     The length of the range within the buffer's data store to be invalidated.
  10                 </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p>
  11             <code class="function">glInvalidateBufferSubData</code> invalidates all or part of the
  12             content of the data store of a buffer object. After invalidation, the content
  13             of the specified range of the buffer's data store becomes undefined. The
  14             start of the range is given by <em class="parameter"><code>offset</code></em> and its size
  15             is given by <em class="parameter"><code>length</code></em>, both measured in basic machine units.
  16         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p>
  17             <code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>offset</code></em> or
  18             <em class="parameter"><code>length</code></em> is negative, or if <em class="parameter"><code>offset</code></em> +
  19             <em class="parameter"><code>length</code></em> is greater than the value of <code class="constant">GL_BUFFER_SIZE</code>
  20             for <em class="parameter"><code>buffer</code></em>.
  21         </p><p>
  22             <code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>buffer</code></em> is not the
  23             name of an existing buffer object.
  24         </p><p>
  25             <code class="constant">GL_INVALID_OPERATION</code> is generated if any part of <em class="parameter"><code>buffer</code></em>
  26             is currently mapped.
  27         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="associatedgets"></a><h2>Associated Gets</h2><p>
  28             <a href="glGetBufferParameter.xml"><span class="citerefentry"><span class="refentrytitle">glGetBufferParameter</span></span></a> with argument <code class="constant">GL_BUFFER_SIZE</code>
  29         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p>
  30             <a href="glInvalidateTexSubImage.xml"><span class="citerefentry"><span class="refentrytitle">glInvalidateTexSubImage</span></span></a>,,
  31             <a href="glInvalidateTexImage.xml"><span class="citerefentry"><span class="refentrytitle">glInvalidateTexImage</span></span></a>,
  32             <a href="glInvalidateBufferData.xml"><span class="citerefentry"><span class="refentrytitle">glInvalidateBufferData</span></span></a>,
  33             <a href="glInvalidateFramebuffer.xml"><span class="citerefentry"><span class="refentrytitle">glInvalidateFramebuffer</span></span></a>,
  34             <a href="glInvalidateSubFramebuffer.xml"><span class="citerefentry"><span class="refentrytitle">glInvalidateSubFramebuffer</span></span></a>.
  35         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p>
  36             Copyright <span class="trademark"></span>© 2012 Khronos Group.
  37             This material may be distributed subject to the terms and conditions set forth in
  38             the Open Publication License, v 1.0, 8 June 1999.
  39             <a href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>.
  40         </p></div></div></body></html>