upstream-doc/man2/xhtml/glCreateShader.xml

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd">
   2 <!-- saved from url=(0013)about:internet -->
   3 <?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" /><title>glCreateShader</title><meta name="generator" content="DocBook XSL Stylesheets V1.73.2" /></head><body><div class="refentry" lang="en" xml:lang="en"><a id="glCreateShader"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glCreateShader — Creates 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">GLuint <b class="fsfunc">glCreateShader</b>(</code></td><td>GLenum  </td><td><var class="pdparam">shaderType</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>shaderType</code></em></span></dt><dd><p>Specifies the type of shader to be created.
   4                     Must be either <code class="constant">GL_VERTEX_SHADER</code>
   5                     or <code class="constant">GL_FRAGMENT_SHADER</code>.</p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p><code class="function">glCreateShader</code> creates an empty
   6         shader object and returns a non-zero value by which it can be
   7         referenced. A shader object is used to maintain the source code
   8         strings that define a shader. <em class="parameter"><code>shaderType</code></em>
   9         indicates the type of shader to be created. Two types of shaders
  10         are supported. A shader of type
  11         <code class="constant">GL_VERTEX_SHADER</code> is a shader that is
  12         intended to run on the programmable vertex processor and replace
  13         the fixed functionality vertex processing in OpenGL. A shader of
  14         type <code class="constant">GL_FRAGMENT_SHADER</code> is a shader that is
  15         intended to run on the programmable fragment processor and
  16         replace the fixed functionality fragment processing in
  17         OpenGL.</p><p>When created, a shader object's
  18         <code class="constant">GL_SHADER_TYPE</code> parameter is set to either
  19         <code class="constant">GL_VERTEX_SHADER</code> or
  20         <code class="constant">GL_FRAGMENT_SHADER</code>, depending on the value
  21         of <em class="parameter"><code>shaderType</code></em>.</p></div><div class="refsect1" lang="en" xml:lang="en"><a id="notes"></a><h2>Notes</h2><p><code class="function">glCreateShader</code> is available only if
  22         the GL version is 2.0 or greater.</p><p>Like display lists and texture objects, the name space for
  23         shader objects may be shared across a set of contexts, as long
  24         as the server sides of the contexts share the same address
  25         space. If the name space is shared across contexts, any attached
  26         objects and the data associated with those attached objects are
  27         shared as well.</p><p>Applications are responsible for providing the
  28         synchronization across API calls when objects are accessed from
  29         different execution threads.</p></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p>This function returns 0 if an error occurs creating the
  30         shader object.</p><p><code class="constant">GL_INVALID_ENUM</code> is generated if
  31         <em class="parameter"><code>shaderType</code></em> is not an accepted value.</p><p><code class="constant">GL_INVALID_OPERATION</code> is generated if
  32         <code class="function">glCreateShader</code> is executed between the
  33         execution of
  34         <a class="citerefentry" href="glBegin.xml"><span class="citerefentry"><span class="refentrytitle">glBegin</span></span></a>
  35         and the corresponding execution of
  36         <a class="citerefentry" href="glEnd.xml"><span class="citerefentry"><span class="refentrytitle">glEnd</span></span></a>.</p></div><div class="refsect1" lang="en" xml:lang="en"><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>
  37         with a valid shader object and the parameter to be queried</p><p><a class="citerefentry" href="glGetShaderInfoLog.xml"><span class="citerefentry"><span class="refentrytitle">glGetShaderInfoLog</span></span></a>
  38         with a valid shader object</p><p><a class="citerefentry" href="glGetShaderSource.xml"><span class="citerefentry"><span class="refentrytitle">glGetShaderSource</span></span></a>
  39         with a valid shader object</p><p><a class="citerefentry" 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 class="citerefentry" href="glAttachShader.xml"><span class="citerefentry"><span class="refentrytitle">glAttachShader</span></span></a>,
  40         <a class="citerefentry" href="glCompileShader.xml"><span class="citerefentry"><span class="refentrytitle">glCompileShader</span></span></a>,
  41         <a class="citerefentry" href="glDeleteShader.xml"><span class="citerefentry"><span class="refentrytitle">glDeleteShader</span></span></a>,
  42         <a class="citerefentry" href="glDetachShader.xml"><span class="citerefentry"><span class="refentrytitle">glDetachShader</span></span></a>,
  43         <a class="citerefentry" href="glShaderSource.xml"><span class="citerefentry"><span class="refentrytitle">glShaderSource</span></span></a>
  44         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p>
  45             Copyright <span class="trademark"></span>© 2003-2005 3Dlabs Inc. Ltd.
  46             This material may be distributed subject to the terms and conditions set forth in
  47             the Open Publication License, v 1.0, 8 June 1999.
  48             <a class="ulink" href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>.
  49         </p></div></div></body></html>