upstream-man-pages/man3/glGetBufferPointerv.xml

   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_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>.
  45                 </para>
  46             </listitem>
  47         </varlistentry>
  48         <varlistentry>
  49             <term><parameter>pname</parameter></term>
  50             <listitem>
  51                 <para>
  52                     Specifies the pointer to be returned.  The symbolic constant must be <constant>GL_BUFFER_MAP_POINTER</constant>.
  53                 </para>
  54             </listitem>
  55         </varlistentry>
  56         <varlistentry>
  57             <term><parameter>params</parameter></term>
  58             <listitem>
  59                 <para>
  60                     Returns the pointer value specified by <parameter>pname</parameter>.
  61                 </para>
  62             </listitem>
  63         </varlistentry>
  64         </variablelist>
  65     </refsect1>
  66     <refsect1 id="description"><title>Description</title>
  67         <para>
  68             <function>glGetBufferPointerv</function> returns pointer information. <parameter>pname</parameter> is a symbolic constant
  69             indicating the pointer to be returned, which must be <constant>GL_BUFFER_MAP_POINTER</constant>, the pointer
  70             to which the buffer object's data store is mapped.  If the data store is not currently mapped, <constant>NULL</constant> is returned.
  71             <parameter>params</parameter> is a pointer to a location in which to place the returned pointer value.
  72         </para>
  73     </refsect1>
  74     <refsect1 id="notes"><title>Notes</title>
  75         <para>
  76             If an error is generated,
  77             no change is made to the contents of <parameter>params</parameter>.
  78         </para>
  79         <para>
  80             The initial value for the pointer is <constant>NULL</constant>.
  81         </para>
  82     </refsect1>
  83     <refsect1 id="errors"><title>Errors</title>
  84         <para>
  85             <constant>GL_INVALID_ENUM</constant> is generated if <parameter>target</parameter> or <parameter>pname</parameter> is not an
  86             accepted value.
  87         </para>
  88         <para>
  89             <constant>GL_INVALID_OPERATION</constant> is generated if the reserved buffer object name 0 is bound to <parameter>target</parameter>.
  90         </para>
  91     </refsect1>
  92     <refsect1 id="seealso"><title>See Also</title>
  93         <para>
  94             <citerefentry><refentrytitle>glBindBuffer</refentrytitle></citerefentry>,
  95             <citerefentry><refentrytitle>glMapBuffer</refentrytitle></citerefentry>
  96         </para>
  97     </refsect1>
  98     <refsect1 id="Copyright"><title>Copyright</title>
  99         <para>
 100             Copyright <trademark class="copyright"></trademark> 2005 Addison-Wesley.
 101             This material may be distributed subject to the terms and conditions set forth in
 102             the Open Publication License, v 1.0, 8 June 1999.
 103             <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.
 104         </para>
 105     </refsect1>
 106 </refentry>