upstream-man-pages/man4/xhtml/glClearBufferSubData.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>glClearBufferSubData - 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="glClearBufferSubData"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glClearBufferSubData — fill all or part of buffer object's data store with a fixed value</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">glClearBufferSubData</b>(</code></td><td>GLenum  </td><td><var class="pdparam">target</var>, </td></tr><tr><td> </td><td>GLenum  </td><td><var class="pdparam">internalformat</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">size</var>, </td></tr><tr><td> </td><td>GLenum  </td><td><var class="pdparam">format</var>, </td></tr><tr><td> </td><td>GLenum  </td><td><var class="pdparam">type</var>, </td></tr><tr><td> </td><td>const void *  </td><td><var class="pdparam">data</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>target</code></em></span></dt><dd><p>
   5                     Specify the target of the operation. <em class="parameter"><code>target</code></em> must be
   6                     one of the global buffer binding targets.
   7                 </p></dd><dt><span class="term"><em class="parameter"><code>internalformat</code></em></span></dt><dd><p>
   8                     The internal format with which the data will be stored in the buffer object.
   9                 </p></dd><dt><span class="term"><em class="parameter"><code>offset</code></em></span></dt><dd><p>
  10                     The offset, in basic machine units into the buffer object's data store at which to start filling.
  11                 </p></dd><dt><span class="term"><em class="parameter"><code>size</code></em></span></dt><dd><p>
  12                     The size, in basic machine units of the range of the data store to fill.
  13                 </p></dd><dt><span class="term"><em class="parameter"><code>format</code></em></span></dt><dd><p>
  14                     The format of the data in memory addressed by <em class="parameter"><code>data</code></em>.
  15                 </p></dd><dt><span class="term"><em class="parameter"><code>type</code></em></span></dt><dd><p>
  16                     The type of the data in memory addressed by <em class="parameter"><code>data</code></em>.
  17                 </p></dd><dt><span class="term"><em class="parameter"><code>data</code></em></span></dt><dd><p>
  18                     The address of a memory location storing the data to be replicated into the
  19                     buffer's data store.
  20                 </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p>
  21             <code class="function">glClearBufferSubData</code> fills a specified region of a buffer object's
  22             data store with data from client memory. <em class="parameter"><code>offset</code></em> and <em class="parameter"><code>size</code></em>
  23             demark the extent of the region within the data store of the buffer object bound to
  24             <em class="parameter"><code>target</code></em> to fill with data. Data, initially supplied in a format
  25             specified by <em class="parameter"><code>format</code></em> in data type <em class="parameter"><code>type</code></em> is
  26             read from the memory address given by <em class="parameter"><code>data</code></em> and converted into
  27             the internal representation given by <em class="parameter"><code>internalforamt</code></em>.
  28             This converted data is then replicated throughout the specified region of the buffer object's
  29             data store.
  30         </p><p>
  31             If <em class="parameter"><code>data</code></em> is NULL, then the subrange of the buffer's data store
  32             is filled with zeros.
  33         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p>
  34             <code class="constant">GL_INVALID_ENUM</code> is generated if <em class="parameter"><code>target</code></em> not one of the generic buffer binding targets.
  35         </p><p>
  36             <code class="constant">GL_INVALID_VALUE</code> is generated if no buffer is bound to <em class="parameter"><code>target</code></em>.
  37         </p><p>
  38             <code class="constant">GL_INVALID_ENUM</code> is generated if <em class="parameter"><code>internalformat</code></em> is not a sized internal format.
  39         </p><p>
  40             <code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>offset</code></em> or <em class="parameter"><code>range</code></em> are not multiples of
  41             the number of basic machine units per-element for the internal format specified by
  42             <em class="parameter"><code>internalformat</code></em>.
  43         </p><p>
  44             <code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>offset</code></em> or <em class="parameter"><code>size</code></em> is less than zero, or if
  45             <em class="parameter"><code>offset</code></em> + <em class="parameter"><code>size</code></em> is greater than the value of <code class="constant">GL_BUFFER_SIZE</code> for the buffer bound to <em class="parameter"><code>target</code></em>.
  46         </p><p>
  47             <code class="constant">GL_INVALID_OPERATION</code> is generated if any part of the specified buffer range is
  48             mapped with <a href="glMapBufferRange.xml"><span class="citerefentry"><span class="refentrytitle">glMapBufferRange</span></span></a> or <a href="glMapBuffer.xml"><span class="citerefentry"><span class="refentrytitle">glMapBuffer</span></span></a>.
  49         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p>
  50             <a href="glClearBufferData.xml"><span class="citerefentry"><span class="refentrytitle">glClearBufferData</span></span></a>.
  51         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p>
  52             Copyright <span class="trademark"></span>© 2012 Khronos Group.
  53             This material may be distributed subject to the terms and conditions set forth in
  54             the Open Publication License, v 1.0, 8 June 1999.
  55             <a href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>.
  56         </p></div></div></body></html>