rename upstream-man-pages to upstream-doc
[clinton/guile-figl.git] / upstream-doc / man3 / glIsVertexArray.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="glIsVertexArray">\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>glIsVertexArray</refentrytitle>\r
13 <manvolnum>3G</manvolnum>\r
14 </refmeta>\r
15 <refnamediv>\r
16 <refname>glIsVertexArray</refname>\r
17 <refpurpose>determine if a name corresponds to a vertex array object</refpurpose>\r
18 </refnamediv>\r
19 <refsynopsisdiv><title>C Specification</title>\r
20 <funcsynopsis>\r
21 <funcprototype>\r
22 <funcdef>GLboolean <function>glIsVertexArray</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 a value that may be the name of a vertex array object.\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>glIsVertexArray</function> returns <constant>GL_TRUE</constant> if <parameter>array</parameter> is currently the name of a renderbuffer\r
42 object. If <parameter>renderbuffer</parameter> is zero, or if <parameter>array</parameter> is not the name of a renderbuffer object, or if an error\r
43 occurs, <function>glIsVertexArray</function> returns <constant>GL_FALSE</constant>. If <parameter>array</parameter> is a name returned by\r
44 <citerefentry><refentrytitle>glGenVertexArrays</refentrytitle></citerefentry>, by that has not yet been bound through a call to\r
45 <citerefentry><refentrytitle>glBindVertexArray</refentrytitle></citerefentry>, then the name is not a vertex array object and\r
46 <function>glIsVertexArray</function> returns <constant>GL_FALSE</constant>.\r
47 </para>\r
48 </refsect1>\r
49 <refsect1 id="seealso"><title>See Also</title>\r
50 <para>\r
51 <citerefentry><refentrytitle>glGenVertexArrays</refentrytitle></citerefentry>,\r
52 <citerefentry><refentrytitle>glBindVertexArray</refentrytitle></citerefentry>,\r
53 <citerefentry><refentrytitle>glDeleteVertexArrays</refentrytitle></citerefentry>\r
54 </para>\r
55 </refsect1>\r
56 <refsect1 id="Copyright"><title>Copyright</title>\r
57 <para>\r
58 Copyright <trademark class="copyright"></trademark> 2010 Khronos Group. \r
59 This material may be distributed subject to the terms and conditions set forth in \r
60 the Open Publication License, v 1.0, 8 June 1999.\r
61 <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.\r
62 </para>\r
63 </refsect1>\r
64</refentry>\r