upstream-doc/man4/xhtml/glShaderBinary.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>glShaderBinary - 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="glShaderBinary"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glShaderBinary — load pre-compiled shader binaries</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">glShaderBinary</b>(</code></td><td>GLsizei  </td><td><var class="pdparam">count</var>, </td></tr><tr><td> </td><td>const GLuint * </td><td><var class="pdparam">shaders</var>, </td></tr><tr><td> </td><td>GLenum  </td><td><var class="pdparam">binaryFormat</var>, </td></tr><tr><td> </td><td>const void * </td><td><var class="pdparam">binary</var>, </td></tr><tr><td> </td><td>GLsizei  </td><td><var class="pdparam">length</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>count</code></em></span></dt><dd><p>
   5                 Specifies the number of shader object handles contained in <em class="parameter"><code>shaders</code></em>.
   6             </p></dd><dt><span class="term"><em class="parameter"><code>shaders</code></em></span></dt><dd><p>
   7                 Specifies the address of an array of shader handles into which to load pre-compiled shader binaries.
   8             </p></dd><dt><span class="term"><em class="parameter"><code>binaryFormat</code></em></span></dt><dd><p>
   9                 Specifies the format of the shader binaries contained in <em class="parameter"><code>binary</code></em>.
  10             </p></dd><dt><span class="term"><em class="parameter"><code>binary</code></em></span></dt><dd><p>
  11                 Specifies the address of an array of bytes containing pre-compiled binary shader code.
  12             </p></dd><dt><span class="term"><em class="parameter"><code>length</code></em></span></dt><dd><p>
  13                 Specifies the length of the array whose address is given in <em class="parameter"><code>binary</code></em>.
  14             </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p>
  15             <code class="function">glShaderBinary</code> loads pre-compiled shader binary code into the <em class="parameter"><code>count</code></em>
  16             shader objects whose handles are given in <em class="parameter"><code>shaders</code></em>. <em class="parameter"><code>binary</code></em>
  17             points to <em class="parameter"><code>length</code></em> bytes of binary shader code stored in client memory.
  18             <em class="parameter"><code>binaryFormat</code></em> specifies the format of the pre-compiled code.
  19         </p><p>
  20             The binary image contained in <em class="parameter"><code>binary</code></em> will be decoded according to the extension
  21             specification defining the specified <em class="parameter"><code>binaryFormat</code></em> token. OpenGL
  22             does not define any specific binary formats, but it does provide a mechanism to obtain token
  23             vaues for such formats provided by such extensions.
  24         </p><p>
  25             Depending on the types of the shader objects in <em class="parameter"><code>shaders</code></em>, <code class="function">glShaderBinary</code>
  26             will individually load binary vertex or fragment shaders, or load an executable binary that contains an optimized
  27             pair of vertex and fragment shaders stored in the same binary.
  28         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p>
  29             <code class="constant">GL_INVALID_OPERATION</code> is generated if more than one of the handles in
  30             <em class="parameter"><code>shaders</code></em> refers to the same shader object.
  31         </p><p>
  32             <code class="constant">GL_INVALID_ENUM</code> is generated if <em class="parameter"><code>binaryFormat</code></em> is not an
  33             accepted value.
  34         </p><p>
  35             <code class="constant">GL_INVALID_VALUE</code> is generated if the data pointed to by <em class="parameter"><code>binary</code></em>
  36             does not match the format specified by <em class="parameter"><code>binaryFormat</code></em>.
  37         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="associatedgets"></a><h2>Associated Gets</h2><p>
  38             <a href="glGet.xml"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with parameter <code class="constant">GL_NUM_SHADER_BINARY_FORMATS</code>.
  39         </p><p>
  40             <a href="glGet.xml"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with parameter <code class="constant">GL_SHADER_BINARY_FORMATS</code>.
  41         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p>
  42             <a href="glGetProgram.xml"><span class="citerefentry"><span class="refentrytitle">glGetProgram</span></span></a>,
  43             <a href="glGetProgramBinary.xml"><span class="citerefentry"><span class="refentrytitle">glGetProgramBinary</span></span></a>,
  44             <a href="glProgramBinary.xml"><span class="citerefentry"><span class="refentrytitle">glProgramBinary</span></span></a>
  45         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p>
  46             Copyright <span class="trademark"></span>© 2010 Khronos Group.
  47             This material may be distributed subject to the terms and conditions set forth in
  48             the Open Publication License, v 1.0, 8 June 1999.
  49             <a href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>.
  50         </p></div></div></body></html>