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>glGetProgramBinary - 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=
"glGetProgramBinary"></a><div class=
"titlepage"></div><div class=
"refnamediv"><h2>Name
</h2><p>glGetProgramBinary — return a binary representation of a program object's compiled and linked executable source
</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">glGetProgramBinary
</b>(
</code></td><td>GLuint
</td><td><var class=
"pdparam">program
</var>,
</td></tr><tr><td> </td><td>GLsizei
</td><td><var class=
"pdparam">bufsize
</var>,
</td></tr><tr><td> </td><td>GLsizei *
</td><td><var class=
"pdparam">length
</var>,
</td></tr><tr><td> </td><td>GLenum *
</td><td><var class=
"pdparam">binaryFormat
</var>,
</td></tr><tr><td> </td><td>void *
</td><td><var class=
"pdparam">binary
</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>program
</code></em></span></dt><dd><p>
5 Specifies the name of a program object whose binary representation to retrieve.
6 </p></dd><dt><span class=
"term"><em class=
"parameter"><code>bufSize
</code></em></span></dt><dd><p>
7 Specifies the size of the buffer whose address is given by
<em class=
"parameter"><code>binary
</code></em>.
8 </p></dd><dt><span class=
"term"><em class=
"parameter"><code>length
</code></em></span></dt><dd><p>
9 Specifies the address of a variable to receive the number of bytes written into
<em class=
"parameter"><code>binary
</code></em>.
10 </p></dd><dt><span class=
"term"><em class=
"parameter"><code>binaryFormat
</code></em></span></dt><dd><p>
11 Specifies the address of a variable to receive a token indicating the format of the binary data returned by the GL.
12 </p></dd><dt><span class=
"term"><em class=
"parameter"><code>binary
</code></em></span></dt><dd><p>
13 Specifies the address an array into which the GL will return
<em class=
"parameter"><code>program
</code></em>'s binary representation.
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">glGetProgramBinary
</code> returns a binary representation of the compiled
16 and linked executable for
<em class=
"parameter"><code>program
</code></em> into the array of bytes whose
17 address is specified in
<em class=
"parameter"><code>binary
</code></em>. The maximum number of bytes that
18 may be written into
<em class=
"parameter"><code>binary
</code></em> is specified by
<em class=
"parameter"><code>bufSize
</code></em>.
19 If the program binary is greater in size than
<em class=
"parameter"><code>bufSize
</code></em> bytes,
20 then an error is generated, otherwise the actual number of bytes written into
<em class=
"parameter"><code>binary
</code></em>
21 is returned in the variable whose address is given by
<em class=
"parameter"><code>length
</code></em>. If
22 <em class=
"parameter"><code>length
</code></em> is
<code class=
"constant">NULL
</code>, then no length is returned.
24 The format of the program binary written into
<em class=
"parameter"><code>binary
</code></em> is returned in
25 the variable whose address is given by
<em class=
"parameter"><code>binaryFormat
</code></em>, and may be implementation dependent. The binary produced
26 by the GL may subsequently be returned to the GL by calling
<a href=
"glProgramBinary.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glProgramBinary
</span></span></a>,
27 with
<em class=
"parameter"><code>binaryFormat
</code></em> and
<em class=
"parameter"><code>length
</code></em> set to the values
28 returned by
<code class=
"function">glGetProgramBinary
</code>, and passing the returned binary data
29 in the
<em class=
"parameter"><code>binary
</code></em> parameter.
30 </p></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"errors"></a><h2>Errors
</h2><p>
31 <code class=
"constant">GL_INVALID_OPERATION
</code> is generated if
<em class=
"parameter"><code>bufSize
</code></em> is less than
32 the size of
<code class=
"constant">GL_PROGRAM_BINARY_LENGTH
</code> for
<em class=
"parameter"><code>program
</code></em>.
34 <code class=
"constant">GL_INVALID_OPERATION
</code> is generated if
<code class=
"constant">GL_LINK_STATUS
</code> for the
35 program object is false.
36 </p></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"associatedgets"></a><h2>Associated Gets
</h2><p>
37 <a href=
"glGetProgram.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glGetProgram
</span></span></a> with argument
<code class=
"constant">GL_PROGRAM_BINARY_LENGTH
</code>
38 </p></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"seealso"></a><h2>See Also
</h2><p>
39 <a href=
"glGetProgram.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glGetProgram
</span></span></a>,
40 <a href=
"glProgramBinary.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glProgramBinary
</span></span></a>
41 </p></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"Copyright"></a><h2>Copyright
</h2><p>
42 Copyright
<span class=
"trademark"></span>©
2010 Khronos Group.
43 This material may be distributed subject to the terms and conditions set forth in
44 the Open Publication License, v
1.0,
8 June
1999.
45 <a href=
"http://opencontent.org/openpub/" target=
"_top">http://opencontent.org/openpub/
</a>.
46 </p></div></div></body></html>