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
37 <constant>GL_ARRAY_BUFFER
</constant>,
38 <constant>GL_ATOMIC_COUNTER_BUFFER
</constant>,
39 <constant>GL_COPY_READ_BUFFER
</constant>,
40 <constant>GL_COPY_WRITE_BUFFER
</constant>,
41 <constant>GL_DRAW_INDIRECT_BUFFER
</constant>,
42 <constant>GL_DISPATCH_INDIRECT_BUFFER
</constant>,
43 <constant>GL_ELEMENT_ARRAY_BUFFER
</constant>,
44 <constant>GL_PIXEL_PACK_BUFFER
</constant>,
45 <constant>GL_PIXEL_UNPACK_BUFFER
</constant>,
46 <constant>GL_SHADER_STORAGE_BUFFER
</constant>,
47 <constant>GL_TEXTURE_BUFFER
</constant>,
48 <constant>GL_TRANSFORM_FEEDBACK_BUFFER
</constant>, or
49 <constant>GL_UNIFORM_BUFFER
</constant>.
54 <term><parameter>pname
</parameter></term>
57 Specifies the pointer to be returned. The symbolic constant must be
<constant>GL_BUFFER_MAP_POINTER
</constant>.
62 <term><parameter>params
</parameter></term>
65 Returns the pointer value specified by
<parameter>pname
</parameter>.
71 <refsect1 id=
"description"><title>Description
</title>
73 <function>glGetBufferPointerv
</function> returns pointer information.
<parameter>pname
</parameter> is a symbolic constant
74 indicating the pointer to be returned, which must be
<constant>GL_BUFFER_MAP_POINTER
</constant>, the pointer
75 to which the buffer object's data store is mapped. If the data store is not currently mapped,
<constant>NULL
</constant> is returned.
76 <parameter>params
</parameter> is a pointer to a location in which to place the returned pointer value.
79 <refsect1 id=
"notes"><title>Notes
</title>
81 If an error is generated,
82 no change is made to the contents of
<parameter>params
</parameter>.
85 The initial value for the pointer is
<constant>NULL
</constant>.
88 The
<constant>GL_ATOMIC_COUNTER_BUFER
</constant> target is available only if the GL version is
4.2 or greater.
91 The
<constant>GL_DISPATCH_INDIRECT_BUFFER
</constant> and
<constant>GL_SHADER_STORAGE_BUFFER
</constant> targets are available only if the GL version is
4.3 or greater.
94 <refsect1 id=
"errors"><title>Errors
</title>
96 <constant>GL_INVALID_ENUM
</constant> is generated if
<parameter>target
</parameter> or
<parameter>pname
</parameter> is not an
100 <constant>GL_INVALID_OPERATION
</constant> is generated if the reserved buffer object name
0 is bound to
<parameter>target
</parameter>.
103 <refsect1 id=
"seealso"><title>See Also
</title>
105 <citerefentry><refentrytitle>glBindBuffer
</refentrytitle></citerefentry>,
106 <citerefentry><refentrytitle>glMapBuffer
</refentrytitle></citerefentry>
109 <refsect1 id=
"Copyright"><title>Copyright
</title>
111 Copyright
<trademark class=
"copyright"></trademark> 2005 Addison-Wesley.
112 This material may be distributed subject to the terms and conditions set forth in
113 the Open Publication License, v
1.0,
8 June
1999.
114 <ulink url=
"http://opencontent.org/openpub/">http://opencontent.org/openpub/
</ulink>.