upstream-man-pages/man4/glBindVertexArray.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="glBindVertexArray">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>2010</year>
   9                 <holder>Khronos Group</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>glBindVertexArray</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>glBindVertexArray</refname>
  17         <refpurpose>bind a vertex array object</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>C Specification</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>void <function>glBindVertexArray</function></funcdef>
  23                 <paramdef>GLuint <parameter>array</parameter></paramdef>
  24             </funcprototype>
  25         </funcsynopsis>
  26     </refsynopsisdiv>
  27     <refsect1 id="parameters"><title>Parameters</title>
  28         <variablelist>
  29         <varlistentry>
  30             <term><parameter>array</parameter></term>
  31             <listitem>
  32                 <para>
  33                     Specifies the name of the vertex array to bind.
  34                 </para>
  35             </listitem>
  36         </varlistentry>
  37         </variablelist>
  38     </refsect1>
  39     <refsect1 id="description"><title>Description</title>
  40         <para>
  41             <function>glBindVertexArray</function> binds the vertex array object with name <parameter>array</parameter>. <parameter>array</parameter>
  42             is the name of a vertex array object previously returned from a call to <citerefentry><refentrytitle>glGenVertexArrays</refentrytitle></citerefentry>,
  43             or zero to break the existing vertex array object binding.
  44         </para>
  45         <para>
  46             If no vertex array object with name <parameter>array</parameter> exists, one is created when <parameter>array</parameter> is first bound. If the bind
  47             is successful no change is made to the state of the vertex array object, and any previous vertex array object binding is broken.
  48         </para>
  49     </refsect1>
  50     <refsect1 id="errors"><title>Errors</title>
  51         <para>
  52             <constant>GL_INVALID_OPERATION</constant> is generated if <parameter>array</parameter> is not zero or the name of a vertex array object
  53             previously returned from a call to <citerefentry><refentrytitle>glGenVertexArrays</refentrytitle></citerefentry>.
  54         </para>
  55     </refsect1>
  56     <refsect1 id="seealso"><title>See Also</title>
  57         <para>
  58             <citerefentry><refentrytitle>glGenVertexArrays</refentrytitle></citerefentry>,
  59             <citerefentry><refentrytitle>glDeleteVertexArrays</refentrytitle></citerefentry>
  60             <citerefentry><refentrytitle>glVertexAttribPointer</refentrytitle></citerefentry>
  61             <citerefentry><refentrytitle>glEnableVertexAttribArray</refentrytitle></citerefentry>
  62             </para>
  63     </refsect1>
  64     <refsect1 id="Copyright"><title>Copyright</title>
  65         <para>
  66             Copyright <trademark class="copyright"></trademark> 2010 Khronos Group.
  67             This material may be distributed subject to the terms and conditions set forth in
  68             the Open Publication License, v 1.0, 8 June 1999.
  69             <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.
  70         </para>
  71     </refsect1>
  72 </refentry>