| 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"> |
| 5 | <refmeta> |
| 6 | <refmetainfo> |
| 7 | <copyright> |
| 8 | <year>2005</year> |
| 9 | <holder>Sams Publishing</holder> |
| 10 | </copyright> |
| 11 | </refmetainfo> |
| 12 | <refentrytitle>glGetBufferPointerv</refentrytitle> |
| 13 | <manvolnum>3G</manvolnum> |
| 14 | </refmeta> |
| 15 | <refnamediv> |
| 16 | <refname>glGetBufferPointerv</refname> |
| 17 | <refpurpose>return the pointer to a mapped buffer object's data store</refpurpose> |
| 18 | </refnamediv> |
| 19 | <refsynopsisdiv><title>C Specification</title> |
| 20 | <funcsynopsis> |
| 21 | <funcprototype> |
| 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> |
| 26 | </funcprototype> |
| 27 | </funcsynopsis> |
| 28 | </refsynopsisdiv> |
| 29 | <refsect1 id="parameters"><title>Parameters</title> |
| 30 | <variablelist> |
| 31 | <varlistentry> |
| 32 | <term><parameter>target</parameter></term> |
| 33 | <listitem> |
| 34 | <para> |
| 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>. |
| 40 | </para> |
| 41 | </listitem> |
| 42 | </varlistentry> |
| 43 | <varlistentry> |
| 44 | <term><parameter>pname</parameter></term> |
| 45 | <listitem> |
| 46 | <para> |
| 47 | Specifies the pointer to be returned. The symbolic constant must be <constant>GL_BUFFER_MAP_POINTER</constant>. |
| 48 | </para> |
| 49 | </listitem> |
| 50 | </varlistentry> |
| 51 | <varlistentry> |
| 52 | <term><parameter>params</parameter></term> |
| 53 | <listitem> |
| 54 | <para> |
| 55 | Returns the pointer value specified by <parameter>pname</parameter>. |
| 56 | </para> |
| 57 | </listitem> |
| 58 | </varlistentry> |
| 59 | </variablelist> |
| 60 | </refsect1> |
| 61 | <refsect1 id="description"><title>Description</title> |
| 62 | <para> |
| 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. |
| 67 | </para> |
| 68 | </refsect1> |
| 69 | <refsect1 id="notes"><title>Notes</title> |
| 70 | <para> |
| 71 | If an error is generated, |
| 72 | no change is made to the contents of <parameter>params</parameter>. |
| 73 | </para> |
| 74 | <para> |
| 75 | <function>glGetBufferPointerv</function> is available only if the GL version is 1.5 or greater. |
| 76 | </para> |
| 77 | <para> |
| 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. |
| 80 | </para> |
| 81 | <para> |
| 82 | The initial value for the pointer is <constant>NULL</constant>. |
| 83 | </para> |
| 84 | </refsect1> |
| 85 | <refsect1 id="errors"><title>Errors</title> |
| 86 | <para> |
| 87 | <constant>GL_INVALID_ENUM</constant> is generated if <parameter>target</parameter> or <parameter>pname</parameter> is not an |
| 88 | accepted value. |
| 89 | </para> |
| 90 | <para> |
| 91 | <constant>GL_INVALID_OPERATION</constant> is generated if the reserved buffer object name 0 is bound to <parameter>target</parameter>. |
| 92 | </para> |
| 93 | <para> |
| 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>. |
| 97 | </para> |
| 98 | </refsect1> |
| 99 | <refsect1 id="seealso"><title>See Also</title> |
| 100 | <para> |
| 101 | <citerefentry><refentrytitle>glBindBuffer</refentrytitle></citerefentry>, |
| 102 | <citerefentry><refentrytitle>glMapBuffer</refentrytitle></citerefentry> |
| 103 | </para> |
| 104 | </refsect1> |
| 105 | <refsect1 id="Copyright"><title>Copyright</title> |
| 106 | <para> |
| 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>. |
| 111 | </para> |
| 112 | </refsect1> |
| 113 | </refentry> |