Opentk/Source/Bind/Specifications/Docs/GL/glIsShader.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="glIsShader">
    <info>
        <copyright>
            <year>2003-2005</year>
            <holder>3Dlabs Inc. Ltd.</holder>
        </copyright>
        <copyright>
            <year>2010-2013</year>
            <holder>Khronos Group</holder>
        </copyright>
    </info>
    <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 xml: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 xml: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 xml:id="notes"><title>Notes</title>
    <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 xml: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 xml: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 xml:id="Copyright"><title>Copyright</title>
        <para>
            Copyright <trademark class="copyright"/> 2003-2005 3Dlabs Inc. Ltd.
            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>