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=
"glGetBufferPointerv">
9 <holder>Sams Publishing
</holder>
12 <refentrytitle>glGetBufferPointerv
</refentrytitle>
13 <manvolnum>3G
</manvolnum>
16 <refname>glGetBufferPointerv
</refname>
17 <refpurpose>return the pointer to a mapped buffer object's data store
</refpurpose>
19 <refsynopsisdiv><title>C Specification
</title>
22 <funcdef>void
<function>glGetBufferPointerv
</function></funcdef>
23 <paramdef>GLenum
<parameter>target
</parameter></paramdef>
24 <paramdef>GLenum
<parameter>pname
</parameter></paramdef>
25 <paramdef>GLvoid **
<parameter>params
</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_ELEMENT_ARRAY_BUFFER
</constant>,
38 <constant>GL_PIXEL_PACK_BUFFER
</constant>, or
39 <constant>GL_PIXEL_UNPACK_BUFFER
</constant>.
44 <term><parameter>pname
</parameter></term>
47 Specifies the pointer to be returned. The symbolic constant must be
<constant>GL_BUFFER_MAP_POINTER
</constant>.
52 <term><parameter>params
</parameter></term>
55 Returns the pointer value specified by
<parameter>pname
</parameter>.
61 <refsect1 id=
"description"><title>Description
</title>
63 <function>glGetBufferPointerv
</function> returns pointer information.
<parameter>pname
</parameter> is a symbolic constant
64 indicating the pointer to be returned, which must be
<constant>GL_BUFFER_MAP_POINTER
</constant>, the pointer
65 to which the buffer object's data store is mapped. If the data store is not currently mapped,
<constant>NULL
</constant> is returned.
66 <parameter>params
</parameter> is a pointer to a location in which to place the returned pointer value.
69 <refsect1 id=
"notes"><title>Notes
</title>
71 If an error is generated,
72 no change is made to the contents of
<parameter>params
</parameter>.
75 <function>glGetBufferPointerv
</function> is available only if the GL version is
1.5 or greater.
78 Targets
<constant>GL_PIXEL_PACK_BUFFER
</constant> and
<constant>GL_PIXEL_UNPACK_BUFFER
</constant> are available
79 only if the GL version is
2.1 or greater.
82 The initial value for the pointer is
<constant>NULL
</constant>.
85 <refsect1 id=
"errors"><title>Errors
</title>
87 <constant>GL_INVALID_ENUM
</constant> is generated if
<parameter>target
</parameter> or
<parameter>pname
</parameter> is not an
91 <constant>GL_INVALID_OPERATION
</constant> is generated if the reserved buffer object name
0 is bound to
<parameter>target
</parameter>.
94 <constant>GL_INVALID_OPERATION
</constant> is generated if
<function>glGetBufferPointerv
</function>
95 is executed between the execution of
<citerefentry><refentrytitle>glBegin
</refentrytitle></citerefentry>
96 and the corresponding execution of
<citerefentry><refentrytitle>glEnd
</refentrytitle></citerefentry>.
99 <refsect1 id=
"seealso"><title>See Also
</title>
101 <citerefentry><refentrytitle>glBindBuffer
</refentrytitle></citerefentry>,
102 <citerefentry><refentrytitle>glMapBuffer
</refentrytitle></citerefentry>
105 <refsect1 id=
"Copyright"><title>Copyright
</title>
107 Copyright
<trademark class=
"copyright"></trademark> 2005 Addison-Wesley.
108 This material may be distributed subject to the terms and conditions set forth in
109 the Open Publication License, v
1.0,
8 June
1999.
110 <ulink url=
"http://opencontent.org/openpub/">http://opencontent.org/openpub/
</ulink>.