upstream-doc/man4/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>No error is generated if <parameter>shader</parameter> is
  44     not a valid shader object name.</para>
  45
  46     <para>A shader object marked for deletion with <citerefentry><refentrytitle>glDeleteShader</refentrytitle></citerefentry>
  47         but still attached to a program object is still considered
  48         a shader object and <function>glIsShader</function> will return <constant>GL_TRUE</constant>.</para>
  49     </refsect1>
  50     <refsect1 id="associatedgets"><title>Associated Gets</title>
  51     <para><citerefentry><refentrytitle>glGetAttachedShaders</refentrytitle></citerefentry>
  52     with a valid program object</para>
  53
  54     <para><citerefentry><refentrytitle>glGetShader</refentrytitle></citerefentry>
  55     with arguments <parameter>shader</parameter> and a parameter to
  56     be queried</para>
  57
  58     <para><citerefentry><refentrytitle>glGetShaderInfoLog</refentrytitle></citerefentry>
  59     with argument <parameter>object</parameter></para>
  60
  61     <para><citerefentry><refentrytitle>glGetShaderSource</refentrytitle></citerefentry>
  62     with argument <parameter>object</parameter></para>
  63     </refsect1>
  64     <refsect1 id="seealso"><title>See Also</title>
  65     <para><citerefentry><refentrytitle>glAttachShader</refentrytitle></citerefentry>,
  66     <citerefentry><refentrytitle>glCompileShader</refentrytitle></citerefentry>,
  67     <citerefentry><refentrytitle>glCreateShader</refentrytitle></citerefentry>,
  68     <citerefentry><refentrytitle>glDeleteShader</refentrytitle></citerefentry>,
  69     <citerefentry><refentrytitle>glDetachShader</refentrytitle></citerefentry>,
  70     <citerefentry><refentrytitle>glLinkProgram</refentrytitle></citerefentry>,
  71     <citerefentry><refentrytitle>glShaderSource</refentrytitle></citerefentry></para>
  72     </refsect1>
  73     <refsect1 id="Copyright"><title>Copyright</title>
  74         <para>
  75             Copyright <trademark class="copyright"></trademark> 2003-2005 3Dlabs Inc. Ltd.
  76             This material may be distributed subject to the terms and conditions set forth in
  77             the Open Publication License, v 1.0, 8 June 1999.
  78             <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.
  79         </para>
  80     </refsect1>
  81 </refentry>