upstream-doc/man4/xhtml/glGetProgramStage.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd">
   3 <!-- saved from url=(0013)about:internet -->
   4 <?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" /><link rel="stylesheet" type="text/css" href="opengl-man.css" /><title>glGetProgramStage - OpenGL 4 Reference Pages</title><meta name="generator" content="DocBook XSL Stylesheets V1.69.1" /></head><body><div class="refentry" lang="en" xml:lang="en"><a id="glGetProgramStage"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glGetProgramStage — retrieve properties of a program object corresponding to a specified shader stage</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">glGetProgramStageiv</b>(</code></td><td>GLuint  </td><td><var class="pdparam">program</var>, </td></tr><tr><td> </td><td>GLenum  </td><td><var class="pdparam">shadertype</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">values</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>program</code></em></span></dt><dd><p>
   5                     Specifies the name of the program containing shader stage.
   6                 </p></dd><dt><span class="term"><em class="parameter"><code>shadertype</code></em></span></dt><dd><p>
   7                     Specifies the shader stage from which to query for the subroutine parameter. <em class="parameter"><code>shadertype</code></em>
   8                     must be one of <code class="constant">GL_VERTEX_SHADER</code>, <code class="constant">GL_TESS_CONTROL_SHADER</code>,
   9                     <code class="constant">GL_TESS_EVALUATION_SHADER</code>, <code class="constant">GL_GEOMETRY_SHADER</code> or
  10                     <code class="constant">GL_FRAGMENT_SHADER</code>.
  11                 </p></dd><dt><span class="term"><em class="parameter"><code>pname</code></em></span></dt><dd><p>
  12                     Specifies the parameter of the shader to query. <em class="parameter"><code>pname</code></em>
  13                     must be <code class="constant">GL_ACTIVE_SUBROUTINE_UNIFORMS</code>,
  14                     <code class="constant">GL_ACTIVE_SUBROUTINE_UNIFORM_LOCATIONS</code>,
  15                     <code class="constant">GL_ACTIVE_SUBROUTINES</code>,
  16                     <code class="constant">GL_ACTIVE_SUBROUTINE_UNIFORM_MAX_LENGTH</code>,
  17                     or <code class="constant">GL_ACTIVE_SUBROUTINE_MAX_LENGTH</code>.
  18                 </p></dd><dt><span class="term"><em class="parameter"><code>values</code></em></span></dt><dd><p>
  19                     Specifies the address of a variable into which the queried value or values will be placed.
  20                 </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p>
  21             <code class="function">glGetProgramStage</code> queries a parameter of a shader stage attached to a program object.
  22             <em class="parameter"><code>program</code></em> contains the name of the program to which the shader is attached. <em class="parameter"><code>shadertype</code></em>
  23             specifies the stage from which to query the parameter. <em class="parameter"><code>pname</code></em> specifies which parameter
  24             should be queried. The value or values of the parameter to be queried is returned in the variable whose address
  25             is given in <em class="parameter"><code>values</code></em>.
  26         </p><p>
  27             If <em class="parameter"><code>pname</code></em> is <code class="constant">GL_ACTIVE_SUBROUTINE_UNIFORMS</code>, the number
  28             of active subroutine variables in the stage is returned in <em class="parameter"><code>values</code></em>.
  29         </p><p>
  30             If <em class="parameter"><code>pname</code></em> is <code class="constant">GL_ACTIVE_SUBROUTINE_UNIFORM_LOCATIONS</code>,
  31             the number of active subroutine variable locations in the stage is returned in <em class="parameter"><code>values</code></em>.
  32         </p><p>
  33             If <em class="parameter"><code>pname</code></em> is <code class="constant">GL_ACTIVE_SUBROUTINES</code>,
  34             the number of active subroutines in the stage is returned in <em class="parameter"><code>values</code></em>.
  35         </p><p>
  36             If <em class="parameter"><code>pname</code></em> is <code class="constant">GL_ACTIVE_SUBROUTINE_UNIFORM_MAX_LENGTH</code>,
  37             the length of the longest subroutine uniform for the stage is returned in <em class="parameter"><code>values</code></em>.
  38         </p><p>
  39             If <em class="parameter"><code>pname</code></em> is <code class="constant">GL_ACTIVE_SUBROUTINE_MAX_LENGTH</code>,
  40             the length of the longest subroutine name for the stage is returned in <em class="parameter"><code>values</code></em>. The
  41             returned name length includes space for the null-terminator.
  42         </p><p>
  43             If there is no shader present of type <em class="parameter"><code>shadertype</code></em>, the returned value will be consistent
  44             with a shader containing no subroutines or subroutine uniforms.
  45         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p>
  46             <code class="constant">GL_INVALID_ENUM</code> is generated if <em class="parameter"><code>shadertype</code></em> or <em class="parameter"><code>pname</code></em>
  47             is not one of the accepted values.
  48         </p><p>
  49             <code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>program</code></em> is not the name of an
  50             existing program object.
  51         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p>
  52             <a href="glGetProgram.xml"><span class="citerefentry"><span class="refentrytitle">glGetProgram</span></span></a>
  53         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p>
  54             Copyright <span class="trademark"></span>© 2010 Khronos Group.
  55             This material may be distributed subject to the terms and conditions set forth in
  56             the Open Publication License, v 1.0, 8 June 1999.
  57             <a href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>.
  58         </p></div></div></body></html>