Opentk/Source/Bind/Specifications/Docs/ES20/glIsProgram.xml
2014-03-28 20:06:55 +01:00

63 lines
2.9 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"
"http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">
<refentry id="glIsProgram">
<refmeta>
<refentrytitle>glIsProgram</refentrytitle>
<manvolnum>3G</manvolnum>
</refmeta>
<refnamediv>
<refname>glIsProgram</refname>
<refpurpose>determine if a name corresponds to a program object</refpurpose>
</refnamediv>
<refsynopsisdiv><title>C Specification</title>
<funcsynopsis>
<funcprototype>
<funcdef>GLboolean <function>glIsProgram</function></funcdef>
<paramdef>GLuint <parameter>program</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="parameters"><title>Parameters</title>
<variablelist>
<varlistentry>
<term><parameter>program</parameter></term>
<listitem>
<para>Specifies a potential program object.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 id="description"><title>Description</title>
<para><function>glIsProgram</function> returns
<constant>GL_TRUE</constant> if <parameter>program</parameter>
is the name of a program object previously created with
<citerefentry><refentrytitle>glCreateProgram</refentrytitle></citerefentry>
and not yet deleted with <citerefentry><refentrytitle>glDeleteProgram</refentrytitle></citerefentry>.
If <parameter>program</parameter> is zero or a non-zero value that
is not the name of a program object, or if an error occurs,
<function>glIsProgram</function> returns <constant>GL_FALSE</constant>.</para>
</refsect1>
<refsect1 id="notes"><title>Notes</title>
<para>No error is generated if <parameter>program</parameter> is
not a valid program object name.</para>
<para>A program object marked for deletion with <citerefentry><refentrytitle>glDeleteProgram</refentrytitle></citerefentry>
but still in use as part of current rendering state is still considered
a program object and <function>glIsProgram</function> will return <constant>GL_TRUE</constant>.</para>
</refsect1>
<refsect1 id="seealso"><title>See Also</title>
<para><citerefentry><refentrytitle>glCreateProgram</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glDeleteProgram</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glUseProgram</refentrytitle></citerefentry></para>
</refsect1>
<refsect1 id="copyright"><title>Copyright</title>
<para>
Copyright <trademark class="copyright"></trademark> 2003-2005 3Dlabs Inc. Ltd.
This material may be distributed subject to the terms and conditions set forth in
the Open Publication License, v 1.0, 8 June 1999.
<ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.
</para>
</refsect1>
</refentry>