upstream-man-pages/man4/xhtml/glCreateShaderProgram.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>glCreateShaderProgram - 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="glCreateShaderProgram"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glCreateShaderProgramv — create a stand-alone program from an array of null-terminated source code strings</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">GLuint <b class="fsfunc">glCreateShaderProgramv</b>(</code></td><td>GLenum  </td><td><var class="pdparam">type</var>, </td></tr><tr><td> </td><td>GLsizei  </td><td><var class="pdparam">count</var>, </td></tr><tr><td> </td><td>const char ** </td><td><var class="pdparam">strings</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>type</code></em></span></dt><dd><p>
   5                 Specifies the type of shader to create.
   6             </p></dd><dt><span class="term"><em class="parameter"><code>count</code></em></span></dt><dd><p>
   7                 Specifies the number of source code strings in the array <em class="parameter"><code>strings</code></em>.
   8             </p></dd><dt><span class="term"><em class="parameter"><code>strings</code></em></span></dt><dd><p>
   9                 Specifies the address of an array of pointers to source code strings from which to create the program object.
  10             </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p>
  11             <code class="function">glCreateShaderProgram</code> creates a program object containing compiled and linked
  12             shaders for a single stage specified by <em class="parameter"><code>type</code></em>. <em class="parameter"><code>strings</code></em>
  13             refers to an array of <em class="parameter"><code>count</code></em> strings from which to create the shader executables.
  14        </p><p>
  15             <code class="function">glCreateShaderProgram</code> is equivalent (assuming no errors are generated) to:
  16        </p><pre class="programlisting">    const GLuint shader = glCreateShader(type);
  17     if (shader) {
  18         glShaderSource(shader, count, strings, NULL);
  19         glCompileShader(shader);
  20         const GLuint program = glCreateProgram();
  21         if (program) {
  22             GLint compiled = GL_FALSE;
  23             glGetShaderiv(shader, GL_COMPILE_STATUS, &amp;compiled);
  24             glProgramParameteri(program, GL_PROGRAM_SEPARABLE, GL_TRUE);
  25             if (compiled) {
  26                 glAttachShader(program, shader);
  27                 glLinkProgram(program);
  28                 glDetachShader(program, shader);
  29             }
  30             /* append-shader-info-log-to-program-info-log */
  31         }
  32         glDeleteShader(shader);
  33         return program;
  34     } else {
  35         return 0;
  36     }</pre><p>
  37         The program object created by <code class="function">glCreateShaderProgram</code> has its <code class="constant">GL_PROGRAM_SEPARABLE</code>
  38         status set to <code class="constant">GL_TRUE</code>.
  39     </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p>
  40             <code class="constant">GL_INVALID_ENUM</code> is generated if if <em class="parameter"><code>type</code></em> is not
  41             an accepted shader type.
  42         </p><p>
  43             <code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>count</code></em> is
  44             negative.
  45         </p><p>
  46             Other errors are generated if the supplied shader code fails to compile
  47             and link, as described for the commands in the pseudocode sequence above,
  48             but all such errors are generated without any side effects of executing those
  49             commands.
  50         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p>
  51             <a href="glCreateShader.xml"><span class="citerefentry"><span class="refentrytitle">glCreateShader</span></span></a>,
  52             <a href="glCreateProgram.xml"><span class="citerefentry"><span class="refentrytitle">glCreateProgram</span></span></a>,
  53             <a href="glCompileShader.xml"><span class="citerefentry"><span class="refentrytitle">glCompileShader</span></span></a>,
  54             <a href="glLinkProgram.xml"><span class="citerefentry"><span class="refentrytitle">glLinkProgram</span></span></a>
  55         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p>
  56             Copyright <span class="trademark"></span>© 2010-2012 Khronos Group.
  57             This material may be distributed subject to the terms and conditions set forth in
  58             the Open Publication License, v 1.0, 8 June 1999.
  59             <a href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>.
  60         </p></div></div></body></html>