forked from BSVino/docs.gl
-
Notifications
You must be signed in to change notification settings - Fork 0
/
glBindBufferRange.xhtml
53 lines (53 loc) · 6.48 KB
/
glBindBufferRange.xhtml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
<div class="refentry"><a id="glBindBufferRange"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glBindBufferRange — bind a range within a buffer object to an indexed buffer target</p></div><div class="refsynopsisdiv"><h2>C Specification</h2><div class="funcsynopsis"><table class="funcprototype-table" style="cellspacing: 0; cellpadding: 0;"><tr><td><code class="funcdef">void <strong class="fsfunc">glBindBufferRange</strong>(</code></td><td>GLenum<var class="pdparam">target</var>, </td></tr><tr><td> </td><td>GLuint<var class="pdparam">index</var>, </td></tr><tr><td> </td><td>GLuint<var class="pdparam">buffer</var>, </td></tr><tr><td> </td><td>GLintptr<var class="pdparam">offset</var>, </td></tr><tr><td> </td><td>GLsizeiptr<var class="pdparam">size</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div></div><div class="refsect1"><a id="parameters"></a><h2>Parameters</h2><div class="variablelist"><dl class="variablelist"><dt><span class="term"><em class="parameter"><code>target</code></em></span></dt><dd><p>
Specify the target of the bind operation. <em class="parameter"><code>target</code></em> must be
either <code class="constant">GL_TRANSFORM_FEEDBACK_BUFFER</code> or <code class="constant">GL_UNIFORM_BUFFER</code>.
</p></dd><dt><span class="term"><em class="parameter"><code>index</code></em></span></dt><dd><p>
Specify the index of the binding point within the array specified by <em class="parameter"><code>target</code></em>.
</p></dd><dt><span class="term"><em class="parameter"><code>buffer</code></em></span></dt><dd><p>
The name of a buffer object to bind to the specified binding point.
</p></dd><dt><span class="term"><em class="parameter"><code>offset</code></em></span></dt><dd><p>
The starting offset in basic machine units into the buffer object <em class="parameter"><code>buffer</code></em>.
</p></dd><dt><span class="term"><em class="parameter"><code>size</code></em></span></dt><dd><p>
The amount of data in machine units that can be read from the buffet object while used as an indexed target.
</p></dd></dl></div></div><div class="refsect1"><a id="description"></a><h2>Description</h2><p>
<code class="function">glBindBufferRange</code> binds a range the buffer object <em class="parameter"><code>buffer</code></em>
represented by <em class="parameter"><code>offset</code></em> and <em class="parameter"><code>size</code></em> to the
binding point at index <em class="parameter"><code>index</code></em> of the array of targets specified by <em class="parameter"><code>target</code></em>.
Each <em class="parameter"><code>target</code></em> represents an indexed array of buffer binding points, as well
as a single general binding point that can be used by other buffer manipulation functions such as
<a class="citerefentry" href="glBindBuffer"><span class="citerefentry"><span class="refentrytitle">glBindBuffer</span></span></a> or
<a class="citerefentry" href="glMapBuffer"><span class="citerefentry"><span class="refentrytitle">glMapBuffer</span></span></a>. In addition to binding
a range of <em class="parameter"><code>buffer</code></em> to the indexed buffer binding target, <code class="function">glBindBufferRange</code>
also binds the range to the generic buffer binding point specified by <em class="parameter"><code>target</code></em>.
</p><p>
<em class="parameter"><code>offset</code></em> specifies the offset in basic machine units into the buffer object
<em class="parameter"><code>buffer</code></em> and <em class="parameter"><code>size</code></em> specifies the amount of data that
can be read from the buffer object while used as an indexed target.
</p></div><div class="refsect1"><a id="errors"></a><h2>Errors</h2><p>
<code class="constant">GL_INVALID_ENUM</code> is generated if <em class="parameter"><code>target</code></em> is not
<code class="constant">GL_TRANSFORM_FEEDBACK_BUFFER</code> or <code class="constant">GL_UNIFORM_BUFFER</code>.
</p><p>
<code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>index</code></em> is greater
than or equal to the number of <em class="parameter"><code>target</code></em>-specific indexed binding points.
</p><p>
<code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>size</code></em> is less than
or equal to zero, or if <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>.
</p><p>
Additional errors may be generated if <em class="parameter"><code>offset</code></em> violates any
<em class="parameter"><code>target</code></em>-specific alignmemt restrictions.
</p></div>
{$pipelinestall}{$examples}
<div class="refsect1"><a id="seealso"></a><h2>See Also</h2><p>
<a class="citerefentry" href="glGenBuffers"><span class="citerefentry"><span class="refentrytitle">glGenBuffers</span></span></a>,
<a class="citerefentry" href="glDeleteBuffers"><span class="citerefentry"><span class="refentrytitle">glDeleteBuffers</span></span></a>,
<a class="citerefentry" href="glBindBuffer"><span class="citerefentry"><span class="refentrytitle">glBindBuffer</span></span></a>,
<a class="citerefentry" href="glBindBufferBase"><span class="citerefentry"><span class="refentrytitle">glBindBufferBase</span></span></a>,
<a class="citerefentry" href="glMapBuffer"><span class="citerefentry"><span class="refentrytitle">glMapBuffer</span></span></a>,
<a class="citerefentry" href="glUnmapBuffer"><span class="citerefentry"><span class="refentrytitle">glUnmapBuffer</span></span></a>,
</p></div><div class="refsect1"><div id="Copyright"><h2>Copyright</h2><p>
Copyright © 2010 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.
<a class="ulink" href="https://opencontent.org/openpub/" target="_top">https://opencontent.org/openpub/</a>.
</p></div></div></div>