HCoop / clinton / guile-figl.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
rename upstream-man-pages to upstream-doc
[clinton/guile-figl.git] / upstream-man-pages / man3 / xhtml / glGetActiveUniformBlockName.xml
diff --git a/upstream-man-pages/man3/xhtml/glGetActiveUniformBlockName.xml b/upstream-man-pages/man3/xhtml/glGetActiveUniformBlockName.xml
deleted file mode 100644 (file)
index cf3b606..0000000
--- a/upstream-man-pages/man3/xhtml/glGetActiveUniformBlockName.xml
+++ /dev/null
@@ -1,50 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd">
-<!-- saved from url=(0013)about:internet -->
-<?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>glGetActiveUniformBlockName</title><meta name="generator" content="DocBook XSL Stylesheets V1.75.2" /></head><body><div class="refentry" title="glGetActiveUniformBlockName"><a id="glGetActiveUniformBlockName"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glGetActiveUniformBlockName — retrieve the name of an active uniform block</p></div><div class="refsynopsisdiv" title="C Specification"><h2>C Specification</h2><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr><td><code class="funcdef">void <b class="fsfunc">glGetActiveUniformBlockName</b>(</code></td><td>GLuint <var class="pdparam">program</var>, </td></tr><tr><td> </td><td>GLuint <var class="pdparam">uniformBlockIndex</var>, </td></tr><tr><td> </td><td>GLsizei <var class="pdparam">bufSize</var>, </td></tr><tr><td> </td><td>GLsizei *<var class="pdparam">length</var>, </td></tr><tr><td> </td><td>GLchar *<var class="pdparam">uniformBlockName</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div></div><div class="refsect1" title="Parameters"><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>
-                    Specifies the name of a program containing the uniform block.
-                </p></dd><dt><span class="term"><em class="parameter"><code>uniformBlockIndex</code></em></span></dt><dd><p>
-                    Specifies the index of the uniform block within <em class="parameter"><code>program</code></em>.
-                </p></dd><dt><span class="term"><em class="parameter"><code>bufSize</code></em></span></dt><dd><p>
-                    Specifies the size of the buffer addressed by <em class="parameter"><code>uniformBlockName</code></em>.
-                </p></dd><dt><span class="term"><em class="parameter"><code>length</code></em></span></dt><dd><p>
-                    Specifies the address of a variable to receive the number of characters that were written to <em class="parameter"><code>uniformBlockName</code></em>.
-                </p></dd><dt><span class="term"><em class="parameter"><code>uniformBlockName</code></em></span></dt><dd><p>
-                    Specifies the address an array of characters to receive the name of the uniform block at <em class="parameter"><code>uniformBlockIndex</code></em>.
-                </p></dd></dl></div></div><div class="refsect1" title="Description"><a id="description"></a><h2>Description</h2><p>
-            <code class="function">glGetActiveUniformBlockName</code> retrieves the name of the active uniform block at <em class="parameter"><code>uniformBlockIndex</code></em>
-            within <em class="parameter"><code>program</code></em>.
-        </p><p>
-            <em class="parameter"><code>program</code></em> must be the name of a program object for which the command
-            <a class="citerefentry" href="glLinkProgram.xml"><span class="citerefentry"><span class="refentrytitle">glLinkProgram</span></span></a> must have been called in the past, although it is not required that
-            <a class="citerefentry" href="glLinkProgram.xml"><span class="citerefentry"><span class="refentrytitle">glLinkProgram</span></span></a> must have succeeded. The link could have failed because the number
-            of active uniforms exceeded the limit.
-        </p><p>
-            <em class="parameter"><code>uniformBlockIndex</code></em> is an active uniform block index of <em class="parameter"><code>program</code></em>, and must be less than the value
-            of <code class="constant">GL_ACTIVE_UNIFORM_BLOCKS</code>.
-        </p><p>
-            Upon success, the name of the uniform block identified by <em class="parameter"><code>unifomBlockIndex</code></em> is returned into
-            <em class="parameter"><code>uniformBlockName</code></em>. The name is nul-terminated. The actual number of characters written into <em class="parameter"><code>uniformBlockName</code></em>,
-            excluding the nul terminator, is returned in <em class="parameter"><code>length</code></em>. If <em class="parameter"><code>length</code></em> is <code class="code">NULL</code>, no length is returned.
-        </p><p>
-            <em class="parameter"><code>bufSize</code></em> contains the maximum number of characters (including the nul terminator) that will be written into
-            <em class="parameter"><code>uniformBlockName</code></em>.
-        </p><p>
-            If an error occurs, nothing will be written to <em class="parameter"><code>uniformBlockName</code></em> or <em class="parameter"><code>length</code></em>.
-        </p></div><div class="refsect1" title="Errors"><a id="errors"></a><h2>Errors</h2><p>
-            <code class="constant">GL_INVALID_OPERATION</code> is generated if <em class="parameter"><code>program</code></em> is not the name of a program object for which
-            <a class="citerefentry" href="glLinkProgram.xml"><span class="citerefentry"><span class="refentrytitle">glLinkProgram</span></span></a> has been called in the past.
-        </p><p>
-            <code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>uniformBlockIndex</code></em> is greater than or equal to the value
-            of <code class="constant">GL_ACTIVE_UNIFORM_BLOCKS</code> or is not the index of an active uniform block in <em class="parameter"><code>program</code></em>.
-        </p></div><div class="refsect1" title="Notes"><a id="notes"></a><h2>Notes</h2><p>
-            <code class="function">glGetActiveUniformBlockName</code> is available only if the GL version is 3.1 or greater.
-        </p></div><div class="refsect1" title="See Also"><a id="seealso"></a><h2>See Also</h2><p>
-            <a class="citerefentry" href="glGetActiveUniformBlock.xml"><span class="citerefentry"><span class="refentrytitle">glGetActiveUniformBlock</span></span></a>,
-            <a class="citerefentry" href="glGetUniformBlockIndex.xml"><span class="citerefentry"><span class="refentrytitle">glGetUniformBlockIndex</span></span></a>
-        </p></div><div class="refsect1" title="Copyright"><a id="Copyright"></a><h2>Copyright</h2><p>
-            Copyright <span class="trademark"></span>© 2010 Khronos Group. 
-            This material may be distributed subject to the terms and conditions set forth in 
-            the Open Publication License, v 1.0, 8 June 1999.
-            <a class="ulink" href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>.
-        </p></div></div></body></html>
Unnamed repository; edit this file 'description' to name the repository.