forked from BSVino/docs.gl
-
Notifications
You must be signed in to change notification settings - Fork 0
/
glGetBufferParameteriv.xhtml
42 lines (42 loc) · 4.26 KB
/
glGetBufferParameteriv.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
<div class="refentry" title="glGetBufferParameteriv"><a id="glGetBufferParameteriv"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glGetBufferParameteriv — return parameters of a buffer object</p></div><div class="refsynopsisdiv" title="C Specification"><h2>C Specification</h2><div class="funcsynopsis"><table class="funcprototype-table"><tr><td><code class="funcdef">void <b class="fsfunc">glGetBufferParameteriv</b>(</code></td><td>GLenum <var class="pdparam">target</var>, </td></tr><tr><td> </td><td>GLenum <var class="pdparam">pname</var>, </td></tr><tr><td> </td><td>GLint * <var class="pdparam">params</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div></div><div class="refsect1" title="Parameters"><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>
Specifies the target buffer object.
The symbolic constant must be <code class="constant">GL_ARRAY_BUFFER</code> or
<code class="constant">GL_ELEMENT_ARRAY_BUFFER</code>.
</p></dd><dt><span class="term">
<em class="parameter"><code>pname</code></em>
</span></dt><dd><p>
Specifies the symbolic name of a buffer object parameter.
Accepted values are
<code class="constant">GL_BUFFER_SIZE</code> or <code class="constant">GL_BUFFER_USAGE</code>.
</p></dd><dt><span class="term">
<em class="parameter"><code>params</code></em>
</span></dt><dd><p>Returns the requested parameter.</p></dd></dl></div></div><div class="refsect1" title="Description"><a id="description"></a><h2>Description</h2><p>
<code class="function">glGetBufferParameteriv</code> returns in <em class="parameter"><code>params</code></em> a selected parameter of the buffer object
specified by <em class="parameter"><code>target</code></em>.
</p><p>
<em class="parameter"><code>pname</code></em> names a specific buffer object parameter, as follows:
</p><div class="variablelist"><dl><dt><span class="term"><code class="constant">GL_BUFFER_SIZE</code></span></dt><dd><p>
<em class="parameter"><code>params</code></em> returns the size of the buffer object, measured in bytes.
The initial value is 0.
</p></dd><dt><span class="term"><code class="constant">GL_BUFFER_USAGE</code></span></dt><dd><p>
<em class="parameter"><code>params</code></em> returns the buffer object's usage pattern. The initial value is
<code class="constant">GL_STATIC_DRAW</code>.
</p></dd></dl></div></div><div class="refsect1" title="Notes"><a id="notes"></a><h2>Notes</h2><p>
If an error is generated,
no change is made to the contents of <em class="parameter"><code>params</code></em>.
</p></div><div class="refsect1" title="Errors"><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> or <em class="parameter"><code>pname</code></em> is not an
accepted value.
</p><p>
<code class="constant">GL_INVALID_OPERATION</code> is generated if the reserved buffer object name 0 is bound to <em class="parameter"><code>target</code></em>.
</p></div><div class="refsect1" title="See Also"><a id="seealso"></a><h2>See Also</h2><p>
<a class="citerefentry" href="glBufferData"><span class="citerefentry"><span class="refentrytitle">glBufferData</span></span></a>,
<a class="citerefentry" href="glBindBuffer"><span class="citerefentry"><span class="refentrytitle">glBindBuffer</span></span></a>
</p></div><div class="refsect1" title="Copyright"><a id="copyright"></a><h2>Copyright</h2><p>
Copyright © 2003-2004
Silicon Graphics, Inc. This document is licensed under the SGI
Free Software B License. For details, see
<a class="ulink" href="https://web.archive.org/web/20171022161616/http://oss.sgi.com/projects/FreeB/" target="_top">https://web.archive.org/web/20171022161616/http://oss.sgi.com/projects/FreeB/</a>.
</p></div></div>