1 <?xml version=
"1.0" encoding=
"UTF-8"?>
2 <!DOCTYPE book PUBLIC
"-//OASIS//DTD DocBook MathML Module V1.1b1//EN"
3 "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">
4 <refentry id=
"glGetBufferParameteriv">
9 <holder>Sams Publishing
</holder>
12 <refentrytitle>glGetBufferParameteriv
</refentrytitle>
13 <manvolnum>3G
</manvolnum>
16 <refname>glGetBufferParameteriv
</refname>
17 <refpurpose>return parameters of a buffer object
</refpurpose>
19 <refsynopsisdiv><title>C Specification
</title>
22 <funcdef>void
<function>glGetBufferParameteriv
</function></funcdef>
23 <paramdef>GLenum
<parameter>target
</parameter></paramdef>
24 <paramdef>GLenum
<parameter>value
</parameter></paramdef>
25 <paramdef>GLint *
<parameter>data
</parameter></paramdef>
29 <refsect1 id=
"parameters"><title>Parameters
</title>
32 <term><parameter>target
</parameter></term>
35 Specifies the target buffer object.
36 The symbolic constant must be
<constant>GL_ARRAY_BUFFER
</constant>,
37 <constant>GL_COPY_READ_BUFFER
</constant>,
38 <constant>GL_COPY_WRITE_BUFFER
</constant>,
39 <constant>GL_ELEMENT_ARRAY_BUFFER
</constant>,
40 <constant>GL_PIXEL_PACK_BUFFER
</constant>,
41 <constant>GL_PIXEL_UNPACK_BUFFER
</constant>,
42 <constant>GL_TEXTURE_BUFFER
</constant>,
43 <constant>GL_TRANSFORM_FEEDBACK_BUFFER
</constant>, or
44 <constant>GL_UNIFORM_BUFFER
</constant>.
49 <term><parameter>value
</parameter></term>
52 Specifies the symbolic name of a buffer object parameter.
53 Accepted values are
<constant>GL_BUFFER_ACCESS
</constant>,
<constant>GL_BUFFER_MAPPED
</constant>,
54 <constant>GL_BUFFER_SIZE
</constant>, or
<constant>GL_BUFFER_USAGE
</constant>.
59 <term><parameter>data
</parameter></term>
62 Returns the requested parameter.
68 <refsect1 id=
"description"><title>Description
</title>
70 <function>glGetBufferParameteriv
</function> returns in
<parameter>data
</parameter> a selected parameter of the buffer object
71 specified by
<parameter>target
</parameter>.
74 <parameter>value
</parameter> names a specific buffer object parameter, as follows:
78 <term><constant>GL_BUFFER_ACCESS
</constant></term>
81 <parameter>params
</parameter> returns the access policy set while mapping the buffer object.
82 The initial value is
<constant>GL_READ_WRITE
</constant>.
87 <term><constant>GL_BUFFER_MAPPED
</constant></term>
90 <parameter>params
</parameter> returns a flag indicating whether the buffer object is currently
91 mapped. The initial value is
<constant>GL_FALSE
</constant>.
96 <term><constant>GL_BUFFER_SIZE
</constant></term>
99 <parameter>params
</parameter> returns the size of the buffer object, measured in bytes.
100 The initial value is
0.
105 <term><constant>GL_BUFFER_USAGE
</constant></term>
108 <parameter>params
</parameter> returns the buffer object's usage pattern. The initial value is
109 <constant>GL_STATIC_DRAW
</constant>.
115 <refsect1 id=
"notes"><title>Notes
</title>
117 If an error is generated,
118 no change is made to the contents of
<parameter>data
</parameter>.
121 <refsect1 id=
"errors"><title>Errors
</title>
123 <constant>GL_INVALID_ENUM
</constant> is generated if
<parameter>target
</parameter> or
<parameter>value
</parameter> is not an
127 <constant>GL_INVALID_OPERATION
</constant> is generated if the reserved buffer object name
0 is bound to
<parameter>target
</parameter>.
130 <refsect1 id=
"seealso"><title>See Also
</title>
132 <citerefentry><refentrytitle>glBindBuffer
</refentrytitle></citerefentry>,
133 <citerefentry><refentrytitle>glBufferData
</refentrytitle></citerefentry>,
134 <citerefentry><refentrytitle>glMapBuffer
</refentrytitle></citerefentry>,
135 <citerefentry><refentrytitle>glUnmapBuffer
</refentrytitle></citerefentry>
138 <refsect1 id=
"Copyright"><title>Copyright
</title>
140 Copyright
<trademark class=
"copyright"></trademark> 2005 Addison-Wesley.
141 This material may be distributed subject to the terms and conditions set forth in
142 the Open Publication License, v
1.0,
8 June
1999.
143 <ulink url=
"http://opencontent.org/openpub/">http://opencontent.org/openpub/
</ulink>.