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
44
45
|
<?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>glGetProgramBinary - OpenGL 4 Reference Pages</title><meta name="generator" content="DocBook XSL Stylesheets V1.78.1" /></head><body><div class="refentry"><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" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr><td><code class="funcdef">void <strong class="fsfunc">glGetProgramBinary</strong>(</code></td><td>GLuint <var class="pdparam">program</var>, </td></tr><tr><td> </td><td>GLsizei <var class="pdparam">bufsize</var>, </td></tr><tr><td> </td><td>GLsizei *<var class="pdparam">length</var>, </td></tr><tr><td> </td><td>GLenum *<var class="pdparam">binaryFormat</var>, </td></tr><tr><td> </td><td>void *<var class="pdparam">binary</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>program</code></em></span></dt><dd><p>
Specifies the name of a program object whose binary representation to retrieve.
</p></dd><dt><span class="term"><em class="parameter"><code>bufSize</code></em></span></dt><dd><p>
Specifies the size of the buffer whose address is given by <em class="parameter"><code>binary</code></em>.
</p></dd><dt><span class="term"><em class="parameter"><code>length</code></em></span></dt><dd><p>
Specifies the address of a variable to receive the number of bytes written into <em class="parameter"><code>binary</code></em>.
</p></dd><dt><span class="term"><em class="parameter"><code>binaryFormat</code></em></span></dt><dd><p>
Specifies the address of a variable to receive a token indicating the format of the binary data returned by the GL.
</p></dd><dt><span class="term"><em class="parameter"><code>binary</code></em></span></dt><dd><p>
Specifies the address an array into which the GL will return <em class="parameter"><code>program</code></em>'s binary representation.
</p></dd></dl></div></div><div class="refsect1"><a id="description"></a><h2>Description</h2><p>
<code class="function">glGetProgramBinary</code> returns a binary representation of the compiled
and linked executable for <em class="parameter"><code>program</code></em> into the array of bytes whose
address is specified in <em class="parameter"><code>binary</code></em>. The maximum number of bytes that
may be written into <em class="parameter"><code>binary</code></em> is specified by <em class="parameter"><code>bufSize</code></em>.
If the program binary is greater in size than <em class="parameter"><code>bufSize</code></em> bytes,
then an error is generated, otherwise the actual number of bytes written into <em class="parameter"><code>binary</code></em>
is returned in the variable whose address is given by <em class="parameter"><code>length</code></em>. If
<em class="parameter"><code>length</code></em> is <code class="constant">NULL</code>, then no length is returned.
</p><p>
The format of the program binary written into <em class="parameter"><code>binary</code></em> is returned in
the variable whose address is given by <em class="parameter"><code>binaryFormat</code></em>, and may be implementation dependent. The binary produced
by the GL may subsequently be returned to the GL by calling <a class="citerefentry" href="glProgramBinary.xml"><span class="citerefentry"><span class="refentrytitle">glProgramBinary</span></span></a>,
with <em class="parameter"><code>binaryFormat</code></em> and <em class="parameter"><code>length</code></em> set to the values
returned by <code class="function">glGetProgramBinary</code>, and passing the returned binary data
in the <em class="parameter"><code>binary</code></em> parameter.
</p></div><div class="refsect1"><a id="errors"></a><h2>Errors</h2><p>
<code class="constant">GL_INVALID_OPERATION</code> is generated if <em class="parameter"><code>bufSize</code></em> is less than
the size of <code class="constant">GL_PROGRAM_BINARY_LENGTH</code> for <em class="parameter"><code>program</code></em>.
</p><p>
<code class="constant">GL_INVALID_OPERATION</code> is generated if <code class="constant">GL_LINK_STATUS</code> for the
program object is false.
</p></div><div class="refsect1"><a id="associatedgets"></a><h2>Associated Gets</h2><p>
<a class="citerefentry" href="glGetProgram.xml"><span class="citerefentry"><span class="refentrytitle">glGetProgram</span></span></a> with argument <code class="constant">GL_PROGRAM_BINARY_LENGTH</code>
</p></div><div class="refsect1"><a id="seealso"></a><h2>See Also</h2><p>
<a class="citerefentry" href="glGetProgram.xml"><span class="citerefentry"><span class="refentrytitle">glGetProgram</span></span></a>,
<a class="citerefentry" href="glProgramBinary.xml"><span class="citerefentry"><span class="refentrytitle">glProgramBinary</span></span></a>
</p></div><div class="refsect1"><a id="Copyright"></a><h2>Copyright</h2><p>
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>
|
