a2cfe598bf6491dc5e8d01a0a5e02a18c8963bb5
[clinton/guile-figl.git] / upstream-man-pages / man4 / xhtml / glBindBufferBase.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>glBindBufferBase - 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="glBindBufferBase"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glBindBufferBase — bind 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">glBindBufferBase</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><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 one of <code class="constant">GL_ATOMIC_COUNTER_BUFFER</code>,
7 <code class="constant">GL_TRANSFORM_FEEDBACK_BUFFER</code>, <code class="constant">GL_UNIFORM_BUFFER</code> or
8 <code class="constant">GL_SHADER_STORAGE_BUFFER</code>.
9 </p></dd><dt><span class="term"><em class="parameter"><code>index</code></em></span></dt><dd><p>
10 Specify the index of the binding point within the array specified by <em class="parameter"><code>target</code></em>.
11 </p></dd><dt><span class="term"><em class="parameter"><code>buffer</code></em></span></dt><dd><p>
12 The name of a buffer object to bind to the specified binding point.
13 </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p>
14 <code class="function">glBindBufferBase</code> binds the buffer object <em class="parameter"><code>buffer</code></em>
15 to the binding point at index <em class="parameter"><code>index</code></em> of the array of targets specified
16 by <em class="parameter"><code>target</code></em>. Each <em class="parameter"><code>target</code></em> represents an indexed
17 array of buffer binding points, as well as a single general binding point that can be used by
18 other buffer manipulation functions such as <a href="glBindBuffer.xml"><span class="citerefentry"><span class="refentrytitle">glBindBuffer</span></span></a>
19 or <a href="glMapBuffer.xml"><span class="citerefentry"><span class="refentrytitle">glMapBuffer</span></span></a>. In addition to binding
20 <em class="parameter"><code>buffer</code></em> to the indexed buffer binding target, <code class="function">glBindBufferBase</code>
21 also binds <em class="parameter"><code>buffer</code></em> to the generic buffer binding point specified by <em class="parameter"><code>target</code></em>.
22 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="notes"></a><h2>Notes</h2><p>
23 Calling <code class="function">glBindBufferBase</code> is equivalent to calling
24 <a href="glBindBufferRange.xml"><span class="citerefentry"><span class="refentrytitle">glBindBufferRange</span></span></a> with <em class="parameter"><code>offset</code></em>
25 zero and <em class="parameter"><code>size</code></em> equal to the size of the buffer.
26 </p><p>
27 The <code class="constant">GL_ATOMIC_COUNTER_BUFER</code> target is available only if the GL version is 4.2 or greater.
28 </p><p>
29 The <code class="constant">GL_SHADER_STORAGE_BUFFER</code> target is available only if the GL version is 4.3 or greater.
30 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p>
31 <code class="constant">GL_INVALID_ENUM</code> is generated if <em class="parameter"><code>target</code></em> is not
32 <code class="constant">GL_ATOMIC_COUNTER_BUFFER</code>,
33 <code class="constant">GL_TRANSFORM_FEEDBACK_BUFFER</code>, <code class="constant">GL_UNIFORM_BUFFER</code> or
34 <code class="constant">GL_SHADER_STORAGE_BUFFER</code>.
35 </p><p>
36 <code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>index</code></em> is greater
37 than or equal to the number of <em class="parameter"><code>target</code></em>-specific indexed binding points.
38 </p><p>
39 <code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>buffer</code></em> does
40 not have an associated data store, or if the size of that store is zero.
41 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p>
42 <a href="glGenBuffers.xml"><span class="citerefentry"><span class="refentrytitle">glGenBuffers</span></span></a>,
43 <a href="glDeleteBuffers.xml"><span class="citerefentry"><span class="refentrytitle">glDeleteBuffers</span></span></a>,
44 <a href="glBindBuffer.xml"><span class="citerefentry"><span class="refentrytitle">glBindBuffer</span></span></a>,
45 <a href="glBindBufferRange.xml"><span class="citerefentry"><span class="refentrytitle">glBindBufferRange</span></span></a>,
46 <a href="glMapBuffer.xml"><span class="citerefentry"><span class="refentrytitle">glMapBuffer</span></span></a>,
47 <a href="glUnmapBuffer.xml"><span class="citerefentry"><span class="refentrytitle">glUnmapBuffer</span></span></a>,
48 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p>
49 Copyright <span class="trademark"></span>© 2010-2011 Khronos Group.
50 This material may be distributed subject to the terms and conditions set forth in
51 the Open Publication License, v 1.0, 8 June 1999.
52 <a href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>.
53 </p></div></div></body></html>