rename upstream-man-pages to upstream-doc
[clinton/guile-figl.git] / upstream-doc / man3 / glDeleteVertexArrays.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="glDeleteVertexArrays">\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>glDeleteVertexArrays</refentrytitle>\r
13 <manvolnum>3G</manvolnum>\r
14 </refmeta>\r
15 <refnamediv>\r
16 <refname>glDeleteVertexArrays</refname>\r
17 <refpurpose>delete vertex array objects</refpurpose>\r
18 </refnamediv>\r
19 <refsynopsisdiv><title>C Specification</title>\r
20 <funcsynopsis>\r
21 <funcprototype>\r
22 <funcdef>void <function>glDeleteVertexArrays</function></funcdef>\r
23 <paramdef>GLsizei <parameter>n</parameter></paramdef>\r
24 <paramdef>const GLuint *<parameter>arrays</parameter></paramdef>\r
25 </funcprototype>\r
26 </funcsynopsis>\r
27 </refsynopsisdiv>\r
28 <!-- eqn: ignoring delim $$ -->\r
29 <refsect1 id="parameters"><title>Parameters</title>\r
30 <variablelist>\r
31 <varlistentry>\r
32 <term><parameter>n</parameter></term>\r
33 <listitem>\r
34 <para>\r
35 Specifies the number of vertex array objects to be deleted.\r
36 </para>\r
37 </listitem>\r
38 </varlistentry>\r
39 <varlistentry>\r
40 <term><parameter>arrays</parameter></term>\r
41 <listitem>\r
42 <para>\r
43 Specifies the address of an array containing the <parameter>n</parameter> names of the objects to be deleted.\r
44 </para>\r
45 </listitem>\r
46 </varlistentry>\r
47 </variablelist>\r
48 </refsect1>\r
49 <refsect1 id="description"><title>Description</title>\r
50 <para>\r
51 <function>glDeleteVertexArrays</function> deletes <parameter>n</parameter> vertex array objects whose names are stored in the\r
52 array addressed by <parameter>arrays</parameter>. Once a vertex array object is deleted it has no contents and its name is\r
53 again unused. If a vertex array object that is currently bound is deleted, the binding for that object reverts to zero\r
54 and the default vertex array becomes current. Unused names in <parameter>arrays</parameter> are silently ignored, as is the value zero.\r
55 </para>\r
56 </refsect1>\r
57 <refsect1 id="errors"><title>Errors</title>\r
58 <para>\r
59 <constant>GL_INVALID_VALUE</constant> is generated if <parameter>n</parameter> is negative.\r
60 </para>\r
61 </refsect1>\r
62 <refsect1 id="seealso"><title>See Also</title>\r
63 <para>\r
64 <citerefentry><refentrytitle>glGenVertexArrays</refentrytitle></citerefentry>,\r
65 <citerefentry><refentrytitle>glIsVertexArray</refentrytitle></citerefentry>,\r
66 <citerefentry><refentrytitle>glBindVertexArray</refentrytitle></citerefentry>\r
67 </para>\r
68 </refsect1>\r
69 <refsect1 id="Copyright"><title>Copyright</title>\r
70 <para>\r
71 Copyright <trademark class="copyright"></trademark> 2010 Khronos Group. \r
72 This material may be distributed subject to the terms and conditions set forth in \r
73 the Open Publication License, v 1.0, 8 June 1999.\r
74 <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.\r
75 </para>\r
76 </refsect1>\r
77</refentry>\r