rename upstream-man-pages to upstream-doc
[clinton/guile-figl.git] / upstream-doc / man3 / glBindVertexArray.xml
CommitLineData
7faf1d71
AW
1<?xml version="1.0" encoding="UTF-8"?>\r
2<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"\r
3 "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">\r
4<refentry id="glBindVertexArray">\r
5 <refmeta>\r
6 <refmetainfo>\r
7 <copyright>\r
8 <year>2010</year>\r
9 <holder>Khronos Group</holder>\r
10 </copyright>\r
11 </refmetainfo>\r
12 <refentrytitle>glBindVertexArray</refentrytitle>\r
13 <manvolnum>3G</manvolnum>\r
14 </refmeta>\r
15 <refnamediv>\r
16 <refname>glBindVertexArray</refname>\r
17 <refpurpose>bind a vertex array object</refpurpose>\r
18 </refnamediv>\r
19 <refsynopsisdiv><title>C Specification</title>\r
20 <funcsynopsis>\r
21 <funcprototype>\r
22 <funcdef>void <function>glBindVertexArray</function></funcdef>\r
23 <paramdef>GLuint <parameter>array</parameter></paramdef>\r
24 </funcprototype>\r
25 </funcsynopsis>\r
26 </refsynopsisdiv>\r
27 <refsect1 id="parameters"><title>Parameters</title>\r
28 <variablelist>\r
29 <varlistentry>\r
30 <term><parameter>array</parameter></term>\r
31 <listitem>\r
32 <para>\r
33 Specifies the name of the vertex array to bind.\r
34 </para>\r
35 </listitem>\r
36 </varlistentry>\r
37 </variablelist>\r
38 </refsect1>\r
39 <refsect1 id="description"><title>Description</title>\r
40 <para>\r
41 <function>glBindVertexArray</function> binds the vertex array object with name <parameter>array</parameter>. <parameter>array</parameter>\r
42 is the name of a vertex array object previously returned from a call to <citerefentry><refentrytitle>glGenVertexArrays</refentrytitle></citerefentry>,\r
43 or zero to break the existing vertex array object binding.\r
44 </para>\r
45 <para>\r
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\r
47 is successful no change is made to the state of the vertex array object, and any previous vertex array object binding is broken.\r
48 </para>\r
49 </refsect1>\r
50 <refsect1 id="errors"><title>Errors</title>\r
51 <para>\r
52 <constant>GL_INVALID_OPERATION</constant> is generated if <parameter>array</parameter> is not zero or the name of a vertex array object\r
53 previously returned from a call to <citerefentry><refentrytitle>glGenVertexArrays</refentrytitle></citerefentry>.\r
54 </para>\r
55 </refsect1>\r
56 <refsect1 id="seealso"><title>See Also</title>\r
57 <para>\r
58 <citerefentry><refentrytitle>glGenVertexArrays</refentrytitle></citerefentry>,\r
59 <citerefentry><refentrytitle>glDeleteVertexArrays</refentrytitle></citerefentry>\r
60 <citerefentry><refentrytitle>glVertexAttribPointer</refentrytitle></citerefentry>\r
61 <citerefentry><refentrytitle>glEnableVertexAttribArray</refentrytitle></citerefentry>\r
62 </para>\r
63 </refsect1>\r
64 <refsect1 id="Copyright"><title>Copyright</title>\r
65 <para>\r
66 Copyright <trademark class="copyright"></trademark> 2010 Khronos Group.\r
67 This material may be distributed subject to the terms and conditions set forth in\r
68 the Open Publication License, v 1.0, 8 June 1999.\r
69 <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.\r
70 </para>\r
71 </refsect1>\r
72</refentry>\r