Opentk/Source/Bind/Specifications/Docs/GL/glIsVertexArray.xml

66 lines
3.1 KiB
XML

<!DOCTYPE refentry [ <!ENTITY % mathent SYSTEM "math.ent"> %mathent; ]>
<!-- Converted by db4-upgrade version 1.1 -->
<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="glIsVertexArray">
<info>
<copyright>
<year>2010-2013</year>
<holder>Khronos Group</holder>
</copyright>
</info>
<refmeta>
<refentrytitle>glIsVertexArray</refentrytitle>
<manvolnum>3G</manvolnum>
</refmeta>
<refnamediv>
<refname>glIsVertexArray</refname>
<refpurpose>determine if a name corresponds to a vertex array object</refpurpose>
</refnamediv>
<refsynopsisdiv><title>C Specification</title>
<funcsynopsis>
<funcprototype>
<funcdef>GLboolean <function>glIsVertexArray</function></funcdef>
<paramdef>GLuint <parameter>array</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 xml:id="parameters"><title>Parameters</title>
<variablelist>
<varlistentry>
<term><parameter>array</parameter></term>
<listitem>
<para>
Specifies a value that may be the name of a vertex array object.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 xml:id="description"><title>Description</title>
<para>
<function>glIsVertexArray</function> returns <constant>GL_TRUE</constant> if <parameter>array</parameter> is currently the name of a vertex array
object. If <parameter>array</parameter> is zero, or if <parameter>array</parameter> is not the name of a vertex array object, or if an error
occurs, <function>glIsVertexArray</function> returns <constant>GL_FALSE</constant>. If <parameter>array</parameter> is a name returned by
<citerefentry><refentrytitle>glGenVertexArrays</refentrytitle></citerefentry>, by that has not yet been bound through a call to
<citerefentry><refentrytitle>glBindVertexArray</refentrytitle></citerefentry>, then the name is not a vertex array object and
<function>glIsVertexArray</function> returns <constant>GL_FALSE</constant>.
</para>
</refsect1>
<refsect1 xml:id="seealso"><title>See Also</title>
<para>
<citerefentry><refentrytitle>glGenVertexArrays</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glBindVertexArray</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glDeleteVertexArrays</refentrytitle></citerefentry>
</para>
</refsect1>
<refsect1 xml:id="Copyright"><title>Copyright</title>
<para>
Copyright <trademark class="copyright"/> 2010-2013 Khronos Group.
This material may be distributed subject to the terms and conditions set forth in
the Open Publication License, v 1.0, 8 June 1999.
<link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://opencontent.org/openpub/">http://opencontent.org/openpub/</link>.
</para>
</refsect1>
</refentry>