upstream-man-pages/man3/glGetBufferParameter.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="glGetBufferParameteriv">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>2005</year>
   9                 <holder>Sams Publishing</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>glGetBufferParameteriv</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>glGetBufferParameteriv</refname>
  17         <refpurpose>return parameters of a buffer object</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>C Specification</title>
  20         <funcsynopsis>
  21             <funcprototype>
  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>
  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>value</parameter></term>
  50             <listitem>
  51                 <para>
  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>.
  55                 </para>
  56             </listitem>
  57         </varlistentry>
  58         <varlistentry>
  59             <term><parameter>data</parameter></term>
  60             <listitem>
  61                 <para>
  62                     Returns the requested parameter.
  63                 </para>
  64             </listitem>
  65         </varlistentry>
  66         </variablelist>
  67     </refsect1>
  68     <refsect1 id="description"><title>Description</title>
  69         <para>
  70             <function>glGetBufferParameteriv</function> returns in <parameter>data</parameter> a selected parameter of the buffer object
  71             specified by <parameter>target</parameter>.
  72         </para>
  73         <para>
  74             <parameter>value</parameter> names a specific buffer object parameter, as follows:
  75         </para>
  76         <variablelist>
  77             <varlistentry>
  78                 <term><constant>GL_BUFFER_ACCESS</constant></term>
  79                 <listitem>
  80                     <para>
  81                         <parameter>params</parameter> returns the access policy set while mapping the buffer object.
  82                         The initial value is <constant>GL_READ_WRITE</constant>.
  83                     </para>
  84                 </listitem>
  85             </varlistentry>
  86             <varlistentry>
  87                 <term><constant>GL_BUFFER_MAPPED</constant></term>
  88                 <listitem>
  89                     <para>
  90                         <parameter>params</parameter> returns a flag indicating whether the buffer object is currently
  91                         mapped. The initial value is <constant>GL_FALSE</constant>.
  92                     </para>
  93                 </listitem>
  94             </varlistentry>
  95             <varlistentry>
  96                 <term><constant>GL_BUFFER_SIZE</constant></term>
  97                 <listitem>
  98                     <para>
  99                         <parameter>params</parameter> returns the size of the buffer object, measured in bytes.
 100                         The initial value is 0.
 101                     </para>
 102                 </listitem>
 103             </varlistentry>
 104             <varlistentry>
 105                 <term><constant>GL_BUFFER_USAGE</constant></term>
 106                 <listitem>
 107                     <para>
 108                         <parameter>params</parameter> returns the buffer object's usage pattern.  The initial value is
 109                         <constant>GL_STATIC_DRAW</constant>.
 110                     </para>
 111                 </listitem>
 112             </varlistentry>
 113         </variablelist>
 114     </refsect1>
 115     <refsect1 id="notes"><title>Notes</title>
 116         <para>
 117             If an error is generated,
 118             no change is made to the contents of <parameter>data</parameter>.
 119         </para>
 120     </refsect1>
 121     <refsect1 id="errors"><title>Errors</title>
 122         <para>
 123             <constant>GL_INVALID_ENUM</constant> is generated if <parameter>target</parameter> or <parameter>value</parameter> is not an
 124             accepted value.
 125         </para>
 126         <para>
 127             <constant>GL_INVALID_OPERATION</constant> is generated if the reserved buffer object name 0 is bound to <parameter>target</parameter>.
 128         </para>
 129     </refsect1>
 130     <refsect1 id="seealso"><title>See Also</title>
 131         <para>
 132             <citerefentry><refentrytitle>glBindBuffer</refentrytitle></citerefentry>,
 133             <citerefentry><refentrytitle>glBufferData</refentrytitle></citerefentry>,
 134             <citerefentry><refentrytitle>glMapBuffer</refentrytitle></citerefentry>,
 135             <citerefentry><refentrytitle>glUnmapBuffer</refentrytitle></citerefentry>
 136         </para>
 137     </refsect1>
 138     <refsect1 id="Copyright"><title>Copyright</title>
 139         <para>
 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>.
 144         </para>
 145     </refsect1>
 146 </refentry>