upstream-doc/man4/xhtml/glGetProgramInterface.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>glGetProgramInterface - 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="glGetProgramInterface"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glGetProgramInterface — query a property of an interface in a program</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">glGetProgramInterfaceiv</b>(</code></td><td>GLuint  </td><td><var class="pdparam">program</var>, </td></tr><tr><td> </td><td>GLenum  </td><td><var class="pdparam">programInterface</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>program</code></em></span></dt><dd><p>
   5                     The name of a program object whose interface to query.
   6                 </p></dd><dt><span class="term"><em class="parameter"><code>programInterface</code></em></span></dt><dd><p>
   7                     A token identifying the interface within <em class="parameter"><code>program</code></em> to query.
   8                 </p></dd><dt><span class="term"><em class="parameter"><code>pname</code></em></span></dt><dd><p>
   9                     The name of the parameter within <em class="parameter"><code>programInterface</code></em> to query.
  10                 </p></dd><dt><span class="term"><em class="parameter"><code>params</code></em></span></dt><dd><p>
  11                     The address of a variable to retrieve the value of <em class="parameter"><code>pname</code></em> for the program interface.
  12                 </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p>
  13             <code class="function">glGetProgramInterfaceiv</code> queries the property of the interface identifed
  14             by <em class="parameter"><code>programInterface</code></em> in <em class="parameter"><code>program</code></em>, the property name of
  15             which is given by <em class="parameter"><code>pname</code></em>.
  16         </p><p>
  17             <em class="parameter"><code>program</code></em> must be the name of an existing program object. <em class="parameter"><code>programInterface</code></em>
  18             is the name of the interface within <em class="parameter"><code>program</code></em> to query and must be one of the following
  19             values:
  20         </p><div class="variablelist"><dl><dt><span class="term"><code class="constant">GL_UNIFORM</code></span></dt><dd><p>
  21                         The query is targeted at the set of active uniforms within <em class="parameter"><code>program</code></em>.
  22                     </p></dd><dt><span class="term"><code class="constant">GL_UNIFORM_BLOCK</code></span></dt><dd><p>
  23                         The query is targeted at the set of active uniform blocks within <em class="parameter"><code>program</code></em>.
  24                     </p></dd><dt><span class="term"><code class="constant">GL_ATOMIC_COUNTER_BUFFER</code></span></dt><dd><p>
  25                         The query is targeted at the set of active atomic counter buffer binding points within <em class="parameter"><code>program</code></em>.
  26                     </p></dd><dt><span class="term"><code class="constant">GL_PROGRAM_INPUT</code></span></dt><dd><p>
  27                         The query is targeted at the set of active input variables used by the first shader stage of <em class="parameter"><code>program</code></em>.
  28                         If <em class="parameter"><code>program</code></em> contains multiple shader stages then input variables from any stage other than the first
  29                         will not be enumerated.
  30                     </p></dd><dt><span class="term"><code class="constant">GL_PROGRAM_OUTPUT</code></span></dt><dd><p>
  31                         The query is targeted at the set of active output variables produced by the last shader stage of <em class="parameter"><code>program</code></em>.
  32                         If <em class="parameter"><code>program</code></em> contains multiple shader stages then output variables from any stage other than the last
  33                         will not be enumerated.
  34                     </p></dd><dt><span class="term"><code class="constant">GL_VERTEX_SUBROUTINE</code>, </span><span class="term"><code class="constant">GL_TESS_CONTROL_SUBROUTINE</code>, </span><span class="term"><code class="constant">GL_TESS_EVALUATION_SUBROUTINE</code>, </span><span class="term"><code class="constant">GL_GEOMETRY_SUBROUTINE</code>, </span><span class="term"><code class="constant">GL_FRAGMENT_SUBROUTINE</code>, </span><span class="term"><code class="constant">GL_COMPUTE_SUBROUTINE</code></span></dt><dd><p>
  35                         The query is targeted at the set of active subroutines for the vertex, tessellation control, tessellation evaluation,
  36                         geometry, fragment and compute shader stages of <em class="parameter"><code>program</code></em>, respectively.
  37                     </p></dd><dt><span class="term"><code class="constant">GL_VERTEX_SUBROUTINE_UNIFORM</code>, </span><span class="term"><code class="constant">GL_TESS_CONTROL_SUBROUTINE_UNIFORM</code>, </span><span class="term"><code class="constant">GL_TESS_EVALUATION_SUBROUTINE_UNIFORM</code>, </span><span class="term"><code class="constant">GL_GEOMETRY_SUBROUTINE_UNIFORM</code>, </span><span class="term"><code class="constant">GL_FRAGMENT_SUBROUTINE_UNIFORM</code>, </span><span class="term"><code class="constant">GL_COMPUTE_SUBROUTINE_UNIFORM</code></span></dt><dd><p>
  38                         The query is targeted at the set of active subroutine uniform variables used by the vertex, tessellation control, tessellation evaluation,
  39                         geometry, fragment and compute shader stages of <em class="parameter"><code>program</code></em>, respectively.
  40                     </p></dd><dt><span class="term"><code class="constant">GL_TRANSFORM_FEEDBACK_VARYING</code></span></dt><dd><p>
  41                         The query is targeted at the set of output variables from the last non-fragment stage of <em class="parameter"><code>program</code></em> that would be
  42                         captured if transform feedback were active.
  43                     </p></dd><dt><span class="term"><code class="constant">GL_BUFFER_VARIABLE</code></span></dt><dd><p>
  44                         The query is targeted at the set of active buffer variables used by <em class="parameter"><code>program</code></em>.
  45                     </p></dd><dt><span class="term"><code class="constant">GL_SHADER_STORAGE_BLOCK</code></span></dt><dd><p>
  46                         The query is targeted at the set of active shader storage blocks used by <em class="parameter"><code>program</code></em>.
  47                     </p></dd></dl></div><p>
  48             <em class="parameter"><code>pname</code></em> identifies the property of <em class="parameter"><code>programInterface</code></em>
  49             to return in <em class="parameter"><code>params</code></em>.
  50         </p><p>
  51             If <em class="parameter"><code>pname</code></em> is <code class="constant">GL_ACTIVE_RESOURCES</code>, the value returned is the number of
  52             resources in the active resource list for <em class="parameter"><code>programInterface</code></em>.  If the list
  53             of active resources for <em class="parameter"><code>programInterface</code></em> is empty, zero is returned.
  54         </p><p>
  55             If <em class="parameter"><code>pname</code></em> is <code class="constant">GL_MAX_NAME_LENGTH</code>, the value returned is the length of the
  56             longest active name string for an active resource in <em class="parameter"><code>programInterface</code></em>.
  57             This length includes an extra character for the null terminator.  If the
  58             list of active resources for <em class="parameter"><code>programInterface</code></em> is empty, zero is
  59             returned.  It is an error to specify <code class="constant">GL_MAX_NAME_LENGTH</code> when <em class="parameter"><code>programInterface</code></em>
  60             is <code class="constant">GL_ATOMIC_COUNTER_BUFFER</code>, as active atomic counter buffer resources are
  61             not assigned name strings.
  62         </p><p>
  63             If <em class="parameter"><code>pname</code></em> is <code class="constant">GL_MAX_NUM_ACTIVE_VARIABLES</code>, the value returned is the number
  64             of active variables belonging to the interface block or atomic counter
  65             buffer resource in <em class="parameter"><code>programInterface</code></em> with the most active variables.  If
  66             the list of active resources for <em class="parameter"><code>programInterface</code></em> is empty, zero is
  67             returned.  When <em class="parameter"><code>pname</code></em> is <code class="constant">GL_MAX_NUM_ACTIVE_VARIABLES</code>, <em class="parameter"><code>programInterface</code></em>
  68             must be <code class="constant">GL_UNIFORM_BLOCK</code>, <code class="constant">GL_ATOMIC_COUNTER_BUFFER</code>, or <code class="constant">GL_SHADER_STORAGE_BLOCK</code>.
  69         </p><p>
  70             If <em class="parameter"><code>pname</code></em> is <code class="constant">GL_MAX_NUM_COMPATIBLE_SUBROUTINES</code>, the value returned is the
  71             number of compatible subroutines belonging to the active subroutine
  72             uniform in <em class="parameter"><code>programInterface</code></em> with the most compatible subroutines.  If
  73             the list of active resources for <em class="parameter"><code>programInterface</code></em> is empty, zero is
  74             returned. When <em class="parameter"><code>pname</code></em> is <code class="constant">GL_MAX_NUM_COMPATIBLE_SUBROUTINES</code>,
  75             <em class="parameter"><code>programInterface</code></em> must be one of <code class="constant">GL_VERTEX_SUBROUTINE_UNIFORM</code>,
  76             <code class="constant">GL_TESS_CONTROL_SUBROUTINE_UNIFORM</code>, <code class="constant">GL_TESS_EVALUATION_SUBROUTINE_UNIFORM</code>,
  77             <code class="constant">GL_GEOMETRY_SUBROUTINE_UNIFORM</code>, <code class="constant">GL_FRAGMENT_SUBROUTINE_UNIFORM</code>, or
  78             <code class="constant">GL_COMPUTE_SUBROUTINE_UNIFORM</code>.
  79         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p>
  80             <code class="constant">GL_INVALID_ENUM</code> is generated if <em class="parameter"><code>identifier</code></em>
  81             is not one of the accepted object types.
  82         </p><p>
  83             <code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>program</code></em>
  84             is not the name of an existing sync object.
  85         </p><p>
  86             <code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>bufSize</code></em> is
  87             zero.
  88         </p><p>
  89             If not NULL, <em class="parameter"><code>length</code></em> and <em class="parameter"><code>label</code></em> should be addresses
  90             to which the client has write access, otherwise undefined behavior, including process termination
  91             may occur.
  92         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="associatedgets"></a><h2>Associated Gets</h2><p>
  93             <a href="glGet.xml"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with argument <code class="constant">GL_MAX_LABEL_LENGTH</code>.
  94         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p>
  95             <a href="glPushDebugGroup.xml"><span class="citerefentry"><span class="refentrytitle">glPushDebugGroup</span></span></a>,
  96             <a href="glPopDebugGroup.xml"><span class="citerefentry"><span class="refentrytitle">glPopDebugGroup</span></span></a>,
  97             <a href="glObjectLabel.xml"><span class="citerefentry"><span class="refentrytitle">glObjectLabel</span></span></a>,
  98             <a href="glGetObjectLabel.xml"><span class="citerefentry"><span class="refentrytitle">glGetObjectLabel</span></span></a>.
  99         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p>
 100             Copyright <span class="trademark"></span>© 2012 Khronos Group.
 101             This material may be distributed subject to the terms and conditions set forth in
 102             the Open Publication License, v 1.0, 8 June 1999.
 103             <a href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>.
 104         </p></div></div></body></html>