HCoop / clinton / guile-figl.git / blame
| Commit | Line | Data |
|---|---|---|
| 7faf1d71 AW |
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>glGetShaderSource - 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="glGetShaderSource"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glGetShaderSource — Returns the source code string 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">glGetShaderSource</b>(</code></td><td>GLuint </td><td><var class="pdparam">shader</var>, </td></tr><tr><td> </td><td>GLsizei </td><td><var class="pdparam">bufSize</var>, </td></tr><tr><td> </td><td>GLsizei * </td><td><var class="pdparam">length</var>, </td></tr><tr><td> </td><td>GLchar * </td><td><var class="pdparam">source</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 | |
| 5 | queried.</p></dd><dt><span class="term"><em class="parameter"><code>bufSize</code></em></span></dt><dd><p>Specifies the size of the character buffer for | |
| 6 | storing the returned source code string.</p></dd><dt><span class="term"><em class="parameter"><code>length</code></em></span></dt><dd><p>Returns the length of the string returned in | |
| 7 | <em class="parameter"><code>source</code></em> (excluding the null | |
| 8 | terminator).</p></dd><dt><span class="term"><em class="parameter"><code>source</code></em></span></dt><dd><p>Specifies an array of characters that is used | |
| 9 | to return the source code string.</p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p><code class="function">glGetShaderSource</code> returns the | |
| 10 | concatenation of the source code strings from the shader object | |
| 11 | specified by <em class="parameter"><code>shader</code></em>. The source code | |
| 12 | strings for a shader object are the result of a previous call to | |
| 13 | <a href="glShaderSource.xml"><span class="citerefentry"><span class="refentrytitle">glShaderSource</span></span></a>. | |
| 14 | The string returned by the function will be null | |
| 15 | terminated.</p><p><code class="function">glGetShaderSource</code> returns in | |
| 16 | <em class="parameter"><code>source</code></em> as much of the source code string | |
| 17 | as it can, up to a maximum of <em class="parameter"><code>bufSize</code></em> | |
| 18 | characters. The number of characters actually returned, | |
| 19 | excluding the null termination character, is specified by | |
| 20 | <em class="parameter"><code>length</code></em>. If the length of the returned | |
| 21 | string is not required, a value of <code class="constant">NULL</code> can | |
| 22 | be passed in the <em class="parameter"><code>length</code></em> argument. The | |
| 23 | size of the buffer required to store the returned source code | |
| 24 | string can be obtained by calling | |
| 25 | <a href="glGetShader.xml"><span class="citerefentry"><span class="refentrytitle">glGetShader</span></span></a> | |
| 26 | with the value | |
| 27 | <code class="constant">GL_SHADER_SOURCE_LENGTH</code>.</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 | |
| 28 | <em class="parameter"><code>shader</code></em> is not a value generated by | |
| 29 | OpenGL.</p><p><code class="constant">GL_INVALID_OPERATION</code> is generated if | |
| 30 | <em class="parameter"><code>shader</code></em> is not a shader object.</p><p><code class="constant">GL_INVALID_VALUE</code> is generated if | |
| 31 | <em class="parameter"><code>bufSize</code></em> is less than 0.</p></div><div class="refsect1" lang="en" xml:lang="en"><a id="associatedgets"></a><h2>Associated Gets</h2><p><a href="glGetShader.xml"><span class="citerefentry"><span class="refentrytitle">glGetShader</span></span></a> | |
| 32 | with argument | |
| 33 | <code class="constant">GL_SHADER_SOURCE_LENGTH</code></p><p><a 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 href="glCreateShader.xml"><span class="citerefentry"><span class="refentrytitle">glCreateShader</span></span></a>, | |
| 34 | <a 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> | |
| 35 | Copyright <span class="trademark"></span>© 2003-2005 3Dlabs Inc. Ltd. | |
| 36 | This material may be distributed subject to the terms and conditions set forth in | |
| 37 | the Open Publication License, v 1.0, 8 June 1999. | |
| 38 | <a href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>. | |
| 39 | </p></div></div></body></html> |