File: glShaderSource.xml

package info (click to toggle)
khronos-opengl-man4 1.0~svn27841-1
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 24,888 kB
  • ctags: 377
  • sloc: xml: 188,408; makefile: 1,153; python: 736; sh: 49; php: 7; sed: 2
file content (43 lines) | stat: -rw-r--r-- 6,354 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd">
<?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 - OpenGL 4 Reference Pages</title><meta name="generator" content="DocBook XSL Stylesheets V1.78.1" /></head><body><div class="refentry"><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"><h2>C Specification</h2><div class="funcsynopsis"><table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr><td><code class="funcdef">void <strong class="fsfunc">glShaderSource</strong>(</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"><a id="parameters"></a><h2>Parameters</h2><div class="variablelist"><dl class="variablelist"><dt><span class="term"><em class="parameter"><code>shader</code></em></span></dt><dd><p>Specifies the handle of the shader object
                    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
                    <em class="parameter"><code>string</code></em> and
                    <em class="parameter"><code>length</code></em>
                    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
                    containing the source code to be loaded into the
                    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"><a id="description"></a><h2>Description</h2><p><code class="function">glShaderSource</code> sets the source code
        in <em class="parameter"><code>shader</code></em> to the source code in the array
        of strings specified by <em class="parameter"><code>string</code></em>. Any
        source code previously stored in the shader object is completely
        replaced. The number of strings in the array is specified by
        <em class="parameter"><code>count</code></em>. If <em class="parameter"><code>length</code></em>
        is <code class="constant">NULL</code>, each string is assumed to be null
        terminated. If <em class="parameter"><code>length</code></em> is a value other
        than <code class="constant">NULL</code>, it points to an array containing
        a string length for each of the corresponding elements of
        <em class="parameter"><code>string</code></em>. Each element in the
        <em class="parameter"><code>length</code></em> array may contain the length of
        the corresponding string (the null character is not counted as
        part of the string length) or a value less than 0 to indicate
        that the string is null terminated. The source code strings are
        not scanned or parsed at this time; they are simply copied into
        the specified shader object.</p></div><div class="refsect1"><a id="notes"></a><h2>Notes</h2><p>OpenGL copies the shader source code strings when
        <code class="function">glShaderSource</code> is called, so an application
        may free its copy of the source code strings immediately after
        the function returns.</p></div><div class="refsect1"><a id="errors"></a><h2>Errors</h2><p><code class="constant">GL_INVALID_VALUE</code> is generated if
        <em class="parameter"><code>shader</code></em> is not a value generated by
        OpenGL.</p><p><code class="constant">GL_INVALID_OPERATION</code> is generated if
        <em class="parameter"><code>shader</code></em> is not a shader object.</p><p><code class="constant">GL_INVALID_VALUE</code> is generated if
        <em class="parameter"><code>count</code></em> is less than 0.</p></div><div class="refsect1"><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>
        with arguments <em class="parameter"><code>shader</code></em> and
        <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>
        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"><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>,
        <a class="citerefentry" href="glCreateShader.xml"><span class="citerefentry"><span class="refentrytitle">glCreateShader</span></span></a>,
        <a class="citerefentry" href="glDeleteShader.xml"><span class="citerefentry"><span class="refentrytitle">glDeleteShader</span></span></a></p></div><div class="refsect1"><a id="Copyright"></a><h2>Copyright</h2><p>
            Copyright <span class="trademark"></span>© 2003-2005 3Dlabs Inc. Ltd.
            Copyright <span class="trademark"></span>© 2010-2013 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>