upstream-doc/man2/glIsShader.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"
   3               "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">
   4 <refentry id="glIsShader">
   5     <refmeta>
   6         <refentrytitle>glIsShader</refentrytitle>
   7         <manvolnum>3G</manvolnum>
   8     </refmeta>
   9     <refnamediv>
  10         <refname>glIsShader</refname>
  11         <refpurpose>Determines if a name corresponds to a shader object</refpurpose>
  12     </refnamediv>
  13     <refsynopsisdiv><title>C Specification</title>
  14         <funcsynopsis>
  15             <funcprototype>
  16                 <funcdef>GLboolean <function>glIsShader</function></funcdef>
  17                 <paramdef>GLuint <parameter>shader</parameter></paramdef>
  18             </funcprototype>
  19         </funcsynopsis>
  20     </refsynopsisdiv>
  21     <refsect1 id="parameters"><title>Parameters</title>
  22         <variablelist>
  23             <varlistentry>
  24                 <term><parameter>shader</parameter></term>
  25                 <listitem>
  26                     <para>Specifies a potential shader object.</para>
  27                 </listitem>
  28             </varlistentry>
  29         </variablelist>
  30     </refsect1>
  31     <refsect1 id="description"><title>Description</title>
  32         <para><function>glIsShader</function> returns
  33         <constant>GL_TRUE</constant> if <parameter>shader</parameter> is
  34         the name of a shader object previously created with
  35         <citerefentry><refentrytitle>glCreateShader</refentrytitle></citerefentry>
  36         and not yet deleted with <citerefentry><refentrytitle>glDeleteShader</refentrytitle></citerefentry>.
  37         If <parameter>shader</parameter> is
  38         zero or a non-zero value that is not the name of a shader
  39         object, or if an error occurs, <function>glIsShader </function> returns
  40         <constant>GL_FALSE</constant>.</para>
  41     </refsect1>
  42     <refsect1 id="notes"><title>Notes</title>
  43         <para><function>glIsShader</function> is available only if the
  44         GL version is 2.0 or greater.</para>
  45
  46         <para>No error is generated if <parameter>shader</parameter> is
  47         not a valid shader object name.</para>
  48
  49         <para>A shader object marked for deletion with <citerefentry><refentrytitle>glDeleteShader</refentrytitle></citerefentry>
  50         but still attached to a program object is still considered
  51         a shader object and <function>glIsShader</function> will return <constant>GL_TRUE</constant>.</para>
  52     </refsect1>
  53     <refsect1 id="errors"><title>Errors</title>
  54         <para><constant>GL_INVALID_OPERATION</constant> is generated if
  55         <function>glIsShader</function> is executed between the
  56         execution of
  57         <citerefentry><refentrytitle>glBegin</refentrytitle></citerefentry>
  58         and the corresponding execution of
  59         <citerefentry><refentrytitle>glEnd</refentrytitle></citerefentry>.</para>
  60     </refsect1>
  61     <refsect1 id="associatedgets"><title>Associated Gets</title>
  62         <para><citerefentry><refentrytitle>glGetAttachedShaders</refentrytitle></citerefentry>
  63         with a valid program object</para>
  64
  65         <para><citerefentry><refentrytitle>glGetShader</refentrytitle></citerefentry>
  66         with arguments <parameter>shader</parameter> and a parameter to
  67         be queried</para>
  68
  69         <para><citerefentry><refentrytitle>glGetShaderInfoLog</refentrytitle></citerefentry>
  70         with argument <parameter>object</parameter></para>
  71
  72         <para><citerefentry><refentrytitle>glGetShaderSource</refentrytitle></citerefentry>
  73         with argument <parameter>object</parameter></para>
  74     </refsect1>
  75     <refsect1 id="seealso"><title>See Also</title>
  76         <para><citerefentry><refentrytitle>glAttachShader</refentrytitle></citerefentry>,
  77         <citerefentry><refentrytitle>glCompileShader</refentrytitle></citerefentry>,
  78         <citerefentry><refentrytitle>glCreateShader</refentrytitle></citerefentry>,
  79         <citerefentry><refentrytitle>glDeleteShader</refentrytitle></citerefentry>,
  80         <citerefentry><refentrytitle>glDetachShader</refentrytitle></citerefentry>,
  81         <citerefentry><refentrytitle>glLinkProgram</refentrytitle></citerefentry>,
  82         <citerefentry><refentrytitle>glShaderSource</refentrytitle></citerefentry></para>
  83     </refsect1>
  84     <refsect1 id="Copyright"><title>Copyright</title>
  85         <para>
  86             Copyright <trademark class="copyright"></trademark> 2003-2005 3Dlabs Inc. Ltd.
  87             This material may be distributed subject to the terms and conditions set forth in
  88             the Open Publication License, v 1.0, 8 June 1999.
  89             <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.
  90         </para>
  91     </refsect1>
  92 </refentry>