include more low-level bindings
[clinton/guile-figl.git] / upstream-man-pages / man3 / xhtml / glShaderSource.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>glShaderSource</title><meta name="generator" content="DocBook XSL Stylesheets V1.75.2" /></head><body><div class="refentry" title="glShaderSource"><a id="glShaderSource"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glShaderSource — Replaces the source code in a shader object</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">glShaderSource</b>(</code></td><td>GLuint <var class="pdparam">shader</var>, </td></tr><tr><td> </td><td>GLsizei <var class="pdparam">count</var>, </td></tr><tr><td> </td><td>const GLchar **<var class="pdparam">string</var>, </td></tr><tr><td> </td><td>const GLint *<var class="pdparam">length</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>shader</code></em></span></dt><dd><p>Specifies the handle of the shader object
5 whose source code is to be replaced.</p></dd><dt><span class="term"><em class="parameter"><code>count</code></em></span></dt><dd><p>Specifies the number of elements in the
6 <em class="parameter"><code>string</code></em> and
7 <em class="parameter"><code>length</code></em>
8 arrays.</p></dd><dt><span class="term"><em class="parameter"><code>string</code></em></span></dt><dd><p>Specifies an array of pointers to strings
9 containing the source code to be loaded into the
10 shader.</p></dd><dt><span class="term"><em class="parameter"><code>length</code></em></span></dt><dd><p>Specifies an array of string lengths.</p></dd></dl></div></div><div class="refsect1" title="Description"><a id="description"></a><h2>Description</h2><p><code class="function">glShaderSource</code> sets the source code
11 in <em class="parameter"><code>shader</code></em> to the source code in the array
12 of strings specified by <em class="parameter"><code>string</code></em>. Any
13 source code previously stored in the shader object is completely
14 replaced. The number of strings in the array is specified by
15 <em class="parameter"><code>count</code></em>. If <em class="parameter"><code>length</code></em>
16 is <code class="constant">NULL</code>, each string is assumed to be null
17 terminated. If <em class="parameter"><code>length</code></em> is a value other
18 than <code class="constant">NULL</code>, it points to an array containing
19 a string length for each of the corresponding elements of
20 <em class="parameter"><code>string</code></em>. Each element in the
21 <em class="parameter"><code>length</code></em> array may contain the length of
22 the corresponding string (the null character is not counted as
23 part of the string length) or a value less than 0 to indicate
24 that the string is null terminated. The source code strings are
25 not scanned or parsed at this time; they are simply copied into
26 the specified shader object.</p></div><div class="refsect1" title="Notes"><a id="notes"></a><h2>Notes</h2><p>OpenGL copies the shader source code strings when
27 <code class="function">glShaderSource</code> is called, so an application
28 may free its copy of the source code strings immediately after
29 the function returns.</p></div><div class="refsect1" title="Errors"><a id="errors"></a><h2>Errors</h2><p><code class="constant">GL_INVALID_VALUE</code> is generated if
30 <em class="parameter"><code>shader</code></em> is not a value generated by
31 OpenGL.</p><p><code class="constant">GL_INVALID_OPERATION</code> is generated if
32 <em class="parameter"><code>shader</code></em> is not a shader object.</p><p><code class="constant">GL_INVALID_VALUE</code> is generated if
33 <em class="parameter"><code>count</code></em> is less than 0.</p></div><div class="refsect1" title="Associated Gets"><a id="associatedgets"></a><h2>Associated Gets</h2><p><a class="citerefentry" href="glGetShader.xml"><span class="citerefentry"><span class="refentrytitle">glGetShader</span></span></a>
34 with arguments <em class="parameter"><code>shader</code></em> and
35 <code class="constant">GL_SHADER_SOURCE_LENGTH</code></p><p><a class="citerefentry" href="glGetShaderSource.xml"><span class="citerefentry"><span class="refentrytitle">glGetShaderSource</span></span></a>
36 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" title="See Also"><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>,
37 <a class="citerefentry" href="glCreateShader.xml"><span class="citerefentry"><span class="refentrytitle">glCreateShader</span></span></a>,
38 <a class="citerefentry" href="glDeleteShader.xml"><span class="citerefentry"><span class="refentrytitle">glDeleteShader</span></span></a></p></div><div class="refsect1" title="Copyright"><a id="Copyright"></a><h2>Copyright</h2><p>
39 Copyright <span class="trademark"></span>© 2003-2005 3Dlabs Inc. Ltd.
40 This material may be distributed subject to the terms and conditions set forth in
41 the Open Publication License, v 1.0, 8 June 1999.
42 <a class="ulink" href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>.
43 </p></div></div></body></html>