rename upstream-man-pages to upstream-doc
[clinton/guile-figl.git] / upstream-doc / man3 / xhtml / glBindBufferRange.xml
CommitLineData
7faf1d71
AW
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>glBindBufferRange - OpenGL 3.3 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="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 border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"><tr><td><code class="funcdef">void <b class="fsfunc">glBindBufferRange</b>(</code></td><td>GLenum </td><td><var class="pdparam">target</var>, </td></tr><tr><td> </td><td>GLuint </td><td><var class="pdparam">index</var>, </td></tr><tr><td> </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">size</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 bind operation. <em class="parameter"><code>target</code></em> must be
6 either <code class="constant">GL_TRANSFORM_FEEDBACK_BUFFER</code> or <code class="constant">GL_UNIFORM_BUFFER</code>.
7 </p></dd><dt><span class="term"><em class="parameter"><code>index</code></em></span></dt><dd><p>
8 Specify the index of the binding point within the array specified by <em class="parameter"><code>target</code></em>.
9 </p></dd><dt><span class="term"><em class="parameter"><code>buffer</code></em></span></dt><dd><p>
10 The name of a buffer object to bind to the specified binding point.
11 </p></dd><dt><span class="term"><em class="parameter"><code>offset</code></em></span></dt><dd><p>
12 The starting offset in basic machine units into the buffer object <em class="parameter"><code>buffer</code></em>.
13 </p></dd><dt><span class="term"><em class="parameter"><code>size</code></em></span></dt><dd><p>
14 The amount of data in machine units that can be read from the buffet object while used as an indexed target.
15 </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p>
16 <code class="function">glBindBufferRange</code> binds a range the buffer object <em class="parameter"><code>buffer</code></em>
17 represented by <em class="parameter"><code>offset</code></em> and <em class="parameter"><code>size</code></em> to the
18 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>.
19 Each <em class="parameter"><code>target</code></em> represents an indexed array of buffer binding points, as well
20 as a single general binding point that can be used by other buffer manipulation functions such as
21 <a href="glBindBuffer.xml"><span class="citerefentry"><span class="refentrytitle">glBindBuffer</span></span></a> or
22 <a href="glMapBuffer.xml"><span class="citerefentry"><span class="refentrytitle">glMapBuffer</span></span></a>. In addition to binding
23 a range of <em class="parameter"><code>buffer</code></em> to the indexed buffer binding target, <code class="function">glBindBufferRange</code>
24 also binds the range to the generic buffer binding point specified by <em class="parameter"><code>target</code></em>.
25 </p><p>
26 <em class="parameter"><code>offset</code></em> specifies the offset in basic machine units into the buffer object
27 <em class="parameter"><code>buffer</code></em> and <em class="parameter"><code>size</code></em> specifies the amount of data that
28 can be read from the buffer object while used as an indexed target.
29 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p>
30 <code class="constant">GL_INVALID_ENUM</code> is generated if <em class="parameter"><code>target</code></em> is not
31 <code class="constant">GL_TRANSFORM_FEEDBACK_BUFFER</code> or <code class="constant">GL_UNIFORM_BUFFER</code>.
32 </p><p>
33 <code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>index</code></em> is greater
34 than or equal to the number of <em class="parameter"><code>target</code></em>-specific indexed binding points.
35 </p><p>
36 <code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>size</code></em> is less than
37 or equal to zero, or if <em class="parameter"><code>offset</code></em> + <em class="parameter"><code>size</code></em> is greater
38 than the value of <code class="constant">GL_BUFFER_SIZE</code>.
39 </p><p>
40 Additional errors may be generated if <em class="parameter"><code>offset</code></em> violates any
41 <em class="parameter"><code>target</code></em>-specific alignmemt restrictions.
42 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p>
43 <a href="glGenBuffers.xml"><span class="citerefentry"><span class="refentrytitle">glGenBuffers</span></span></a>,
44 <a href="glDeleteBuffers.xml"><span class="citerefentry"><span class="refentrytitle">glDeleteBuffers</span></span></a>,
45 <a href="glBindBuffer.xml"><span class="citerefentry"><span class="refentrytitle">glBindBuffer</span></span></a>,
46 <a href="glBindBufferBase.xml"><span class="citerefentry"><span class="refentrytitle">glBindBufferBase</span></span></a>,
47 <a href="glMapBuffer.xml"><span class="citerefentry"><span class="refentrytitle">glMapBuffer</span></span></a>,
48 <a href="glUnmapBuffer.xml"><span class="citerefentry"><span class="refentrytitle">glUnmapBuffer</span></span></a>,
49 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p>
50 Copyright <span class="trademark"></span>© 2010 Khronos Group.
51 This material may be distributed subject to the terms and conditions set forth in
52 the Open Publication License, v 1.0, 8 June 1999.
53 <a href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>.
54 </p></div></div></body></html>