93 lines
4.2 KiB
XML
93 lines
4.2 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="glIsShader">
|
||
|
|
<refmeta>
|
||
|
|
<refentrytitle>glIsShader</refentrytitle>
|
||
|
|
<manvolnum>3G</manvolnum>
|
||
|
|
</refmeta>
|
||
|
|
<refnamediv>
|
||
|
|
<refname>glIsShader</refname>
|
||
|
|
<refpurpose>Determines if a name corresponds to a shader object</refpurpose>
|
||
|
|
</refnamediv>
|
||
|
|
<refsynopsisdiv><title>C Specification</title>
|
||
|
|
<funcsynopsis>
|
||
|
|
<funcprototype>
|
||
|
|
<funcdef>GLboolean <function>glIsShader</function></funcdef>
|
||
|
|
<paramdef>GLuint <parameter>shader</parameter></paramdef>
|
||
|
|
</funcprototype>
|
||
|
|
</funcsynopsis>
|
||
|
|
</refsynopsisdiv>
|
||
|
|
<refsect1 id="parameters"><title>Parameters</title>
|
||
|
|
<variablelist>
|
||
|
|
<varlistentry>
|
||
|
|
<term><parameter>shader</parameter></term>
|
||
|
|
<listitem>
|
||
|
|
<para>Specifies a potential shader object.</para>
|
||
|
|
</listitem>
|
||
|
|
</varlistentry>
|
||
|
|
</variablelist>
|
||
|
|
</refsect1>
|
||
|
|
<refsect1 id="description"><title>Description</title>
|
||
|
|
<para><function>glIsShader</function> returns
|
||
|
|
<constant>GL_TRUE</constant> if <parameter>shader</parameter> is
|
||
|
|
the name of a shader object previously created with
|
||
|
|
<citerefentry><refentrytitle>glCreateShader</refentrytitle></citerefentry>
|
||
|
|
and not yet deleted with <citerefentry><refentrytitle>glDeleteShader</refentrytitle></citerefentry>.
|
||
|
|
If <parameter>shader</parameter> is
|
||
|
|
zero or a non-zero value that is not the name of a shader
|
||
|
|
object, or if an error occurs, <function>glIsShader </function> returns
|
||
|
|
<constant>GL_FALSE</constant>.</para>
|
||
|
|
</refsect1>
|
||
|
|
<refsect1 id="notes"><title>Notes</title>
|
||
|
|
<para><function>glIsShader</function> is available only if the
|
||
|
|
GL version is 2.0 or greater.</para>
|
||
|
|
|
||
|
|
<para>No error is generated if <parameter>shader</parameter> is
|
||
|
|
not a valid shader object name.</para>
|
||
|
|
|
||
|
|
<para>A shader object marked for deletion with <citerefentry><refentrytitle>glDeleteShader</refentrytitle></citerefentry>
|
||
|
|
but still attached to a program object is still considered
|
||
|
|
a shader object and <function>glIsShader</function> will return <constant>GL_TRUE</constant>.</para>
|
||
|
|
</refsect1>
|
||
|
|
<refsect1 id="errors"><title>Errors</title>
|
||
|
|
<para><constant>GL_INVALID_OPERATION</constant> is generated if
|
||
|
|
<function>glIsShader</function> is executed between the
|
||
|
|
execution of
|
||
|
|
<citerefentry><refentrytitle>glBegin</refentrytitle></citerefentry>
|
||
|
|
and the corresponding execution of
|
||
|
|
<citerefentry><refentrytitle>glEnd</refentrytitle></citerefentry>.</para>
|
||
|
|
</refsect1>
|
||
|
|
<refsect1 id="associatedgets"><title>Associated Gets</title>
|
||
|
|
<para><citerefentry><refentrytitle>glGetAttachedShaders</refentrytitle></citerefentry>
|
||
|
|
with a valid program object</para>
|
||
|
|
|
||
|
|
<para><citerefentry><refentrytitle>glGetShader</refentrytitle></citerefentry>
|
||
|
|
with arguments <parameter>shader</parameter> and a parameter to
|
||
|
|
be queried</para>
|
||
|
|
|
||
|
|
<para><citerefentry><refentrytitle>glGetShaderInfoLog</refentrytitle></citerefentry>
|
||
|
|
with argument <parameter>object</parameter></para>
|
||
|
|
|
||
|
|
<para><citerefentry><refentrytitle>glGetShaderSource</refentrytitle></citerefentry>
|
||
|
|
with argument <parameter>object</parameter></para>
|
||
|
|
</refsect1>
|
||
|
|
<refsect1 id="seealso"><title>See Also</title>
|
||
|
|
<para><citerefentry><refentrytitle>glAttachShader</refentrytitle></citerefentry>,
|
||
|
|
<citerefentry><refentrytitle>glCompileShader</refentrytitle></citerefentry>,
|
||
|
|
<citerefentry><refentrytitle>glCreateShader</refentrytitle></citerefentry>,
|
||
|
|
<citerefentry><refentrytitle>glDeleteShader</refentrytitle></citerefentry>,
|
||
|
|
<citerefentry><refentrytitle>glDetachShader</refentrytitle></citerefentry>,
|
||
|
|
<citerefentry><refentrytitle>glLinkProgram</refentrytitle></citerefentry>,
|
||
|
|
<citerefentry><refentrytitle>glShaderSource</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>
|