upstream-doc/man2/xhtml/glGetShader.xml

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd">
   2 <!-- saved from url=(0013)about:internet -->
   3 <?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" pref:renderer="mathplayer-dl"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>glGetShader</title><meta name="generator" content="DocBook XSL Stylesheets V1.73.2" /></head><body><div class="refentry" lang="en" xml:lang="en"><a id="glGetShader"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glGetShaderiv — Returns a parameter from a shader object</p></div><div class="refsynopsisdiv"><h2>C Specification</h2><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"><tr><td><code class="funcdef">void <b class="fsfunc">glGetShaderiv</b>(</code></td><td>GLuint  </td><td><var class="pdparam">shader</var>, </td></tr><tr><td> </td><td>GLenum  </td><td><var class="pdparam">pname</var>, </td></tr><tr><td> </td><td>GLint * </td><td><var class="pdparam">params</var><code>)</code>;</td></tr></table></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="parameters"></a><h2>Parameters</h2><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>shader</code></em></span></dt><dd><p>Specifies the shader object to be
   4                     queried.</p></dd><dt><span class="term"><em class="parameter"><code>pname</code></em></span></dt><dd><p>Specifies the object parameter. Accepted
   5                     symbolic names are
   6                     <code class="constant">GL_SHADER_TYPE</code>,
   7                     <code class="constant">GL_DELETE_STATUS</code>,
   8                     <code class="constant">GL_COMPILE_STATUS</code>,
   9                     <code class="constant">GL_INFO_LOG_LENGTH</code>,
  10                     <code class="constant">GL_SHADER_SOURCE_LENGTH</code>.</p></dd><dt><span class="term"><em class="parameter"><code>params</code></em></span></dt><dd><p>Returns the requested object parameter.</p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p><code class="function">glGetShader</code>
  11         returns in <em class="parameter"><code>params</code></em>
  12         the value of a parameter for a specific shader object. The
  13         following parameters are defined:</p><div class="variablelist"><dl><dt><span class="term"><code class="constant">GL_SHADER_TYPE</code></span></dt><dd><p> <em class="parameter"><code>params</code></em> returns
  14                     <code class="constant">GL_VERTEX_SHADER</code> if
  15                     <em class="parameter"><code>shader</code></em> is a vertex shader
  16                     object, and <code class="constant">GL_FRAGMENT_SHADER</code>
  17                     if <em class="parameter"><code>shader</code></em> is a fragment
  18                     shader object.</p></dd><dt><span class="term"><code class="constant">GL_DELETE_STATUS</code></span></dt><dd><p> <em class="parameter"><code>params</code></em> returns
  19                     <code class="constant">GL_TRUE</code> if
  20                     <em class="parameter"><code>shader</code></em> is currently flagged
  21                     for deletion, and <code class="constant">GL_FALSE</code>
  22                     otherwise.</p></dd><dt><span class="term"><code class="constant">GL_COMPILE_STATUS</code></span></dt><dd><p> <em class="parameter"><code>params</code></em> returns
  23                     <code class="constant">GL_TRUE</code> if the last compile
  24                     operation on <em class="parameter"><code>shader</code></em> was
  25                     successful, and <code class="constant">GL_FALSE</code>
  26                     otherwise.</p></dd><dt><span class="term"><code class="constant">GL_INFO_LOG_LENGTH</code></span></dt><dd><p> <em class="parameter"><code>params</code></em> returns the
  27                     number of characters in the information log for
  28                     <em class="parameter"><code>shader</code></em> including the null
  29                     termination character (i.e., the size of the
  30                     character buffer required to store the information
  31                     log). If <em class="parameter"><code>shader</code></em> has no
  32                     information log, a value of 0 is returned.</p></dd><dt><span class="term"><code class="constant">GL_SHADER_SOURCE_LENGTH</code></span></dt><dd><p> <em class="parameter"><code>params</code></em> returns the
  33                     length of the concatenation of the source strings
  34                     that make up the shader source for the
  35                     <em class="parameter"><code>shader</code></em>, including the null
  36                     termination character. (i.e., the size of the
  37                     character buffer required to store the shader
  38                     source). If no source code exists, 0 is
  39                     returned.</p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="notes"></a><h2>Notes</h2><p><code class="function">glGetShader</code> is available only if the
  40         GL version is 2.0 or greater.</p><p>If an error is generated, no change is made to the
  41         contents of <em class="parameter"><code>params</code></em>.</p></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p><code class="constant">GL_INVALID_VALUE</code> is generated if
  42         <em class="parameter"><code>shader</code></em> is not a value generated by
  43         OpenGL.</p><p><code class="constant">GL_INVALID_OPERATION</code> is generated if
  44         <em class="parameter"><code>shader</code></em> does not refer to a shader
  45         object.</p><p><code class="constant">GL_INVALID_ENUM</code> is generated if
  46         <em class="parameter"><code>pname</code></em> is not an accepted value.</p><p><code class="constant">GL_INVALID_OPERATION</code> is generated if
  47         <code class="function">glGetShader</code> is executed between the
  48         execution of
  49         <a class="citerefentry" href="glBegin.xml"><span class="citerefentry"><span class="refentrytitle">glBegin</span></span></a>
  50         and the corresponding execution of
  51         <a class="citerefentry" href="glEnd.xml"><span class="citerefentry"><span class="refentrytitle">glEnd</span></span></a>.</p></div><div class="refsect1" lang="en" xml:lang="en"><a id="associatedgets"></a><h2>Associated Gets</h2><p><a class="citerefentry" href="glGetShaderInfoLog.xml"><span class="citerefentry"><span class="refentrytitle">glGetShaderInfoLog</span></span></a>
  52         with argument <em class="parameter"><code>shader</code></em></p><p><a class="citerefentry" href="glGetShaderSource.xml"><span class="citerefentry"><span class="refentrytitle">glGetShaderSource</span></span></a>
  53         with argument <em class="parameter"><code>shader</code></em></p><p><a class="citerefentry" href="glIsShader.xml"><span class="citerefentry"><span class="refentrytitle">glIsShader</span></span></a></p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p><a class="citerefentry" href="glCompileShader.xml"><span class="citerefentry"><span class="refentrytitle">glCompileShader</span></span></a>,
  54         <a class="citerefentry" href="glCreateShader.xml"><span class="citerefentry"><span class="refentrytitle">glCreateShader</span></span></a>,
  55         <a class="citerefentry" href="glDeleteShader.xml"><span class="citerefentry"><span class="refentrytitle">glDeleteShader</span></span></a>,
  56         <a class="citerefentry" href="glGetProgram.xml"><span class="citerefentry"><span class="refentrytitle">glGetProgram</span></span></a>,
  57         <a class="citerefentry" href="glShaderSource.xml"><span class="citerefentry"><span class="refentrytitle">glShaderSource</span></span></a></p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p>
  58             Copyright <span class="trademark"></span>© 2003-2005 3Dlabs Inc. Ltd.
  59             This material may be distributed subject to the terms and conditions set forth in
  60             the Open Publication License, v 1.0, 8 June 1999.
  61             <a class="ulink" href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>.
  62         </p></div></div></body></html>