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
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
|
<!DOCTYPE refentry [ <!ENTITY % mathent SYSTEM "math.ent"> %mathent; ]>
<!-- Converted by db4-upgrade version 1.1 -->
<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="glGetProgramBinary">
<info>
<copyright>
<year>2010-2014</year>
<holder>Khronos Group</holder>
</copyright>
</info>
<refmeta>
<refentrytitle>glGetProgramBinary</refentrytitle>
<manvolnum>3G</manvolnum>
</refmeta>
<refnamediv>
<refname>glGetProgramBinary</refname>
<refpurpose>return a binary representation of a program object's compiled and linked executable source</refpurpose>
</refnamediv>
<refsynopsisdiv><title>C Specification</title>
<funcsynopsis>
<funcprototype>
<funcdef>void <function>glGetProgramBinary</function></funcdef>
<paramdef>GLuint <parameter>program</parameter></paramdef>
<paramdef>GLsizei <parameter>bufsize</parameter></paramdef>
<paramdef>GLsizei *<parameter>length</parameter></paramdef>
<paramdef>GLenum *<parameter>binaryFormat</parameter></paramdef>
<paramdef>void *<parameter>binary</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 xml:id="parameters"><title>Parameters</title>
<variablelist>
<varlistentry>
<term><parameter>program</parameter></term>
<listitem>
<para>
Specifies the name of a program object whose binary representation to retrieve.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>bufSize</parameter></term>
<listitem>
<para>
Specifies the size of the buffer whose address is given by <parameter>binary</parameter>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>length</parameter></term>
<listitem>
<para>
Specifies the address of a variable to receive the number of bytes written into <parameter>binary</parameter>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>binaryFormat</parameter></term>
<listitem>
<para>
Specifies the address of a variable to receive a token indicating the format of the binary data returned by the GL.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>binary</parameter></term>
<listitem>
<para>
Specifies the address an array into which the GL will return <parameter>program</parameter>'s binary representation.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 xml:id="description"><title>Description</title>
<para>
<function>glGetProgramBinary</function> returns a binary representation of the compiled
and linked executable for <parameter>program</parameter> into the array of bytes whose
address is specified in <parameter>binary</parameter>. The maximum number of bytes that
may be written into <parameter>binary</parameter> is specified by <parameter>bufSize</parameter>.
If the program binary is greater in size than <parameter>bufSize</parameter> bytes,
then an error is generated, otherwise the actual number of bytes written into <parameter>binary</parameter>
is returned in the variable whose address is given by <parameter>length</parameter>. If
<parameter>length</parameter> is <constant>NULL</constant>, then no length is returned.
</para>
<para>
The format of the program binary written into <parameter>binary</parameter> is returned in
the variable whose address is given by <parameter>binaryFormat</parameter>, and may be implementation dependent. The binary produced
by the GL may subsequently be returned to the GL by calling <citerefentry><refentrytitle>glProgramBinary</refentrytitle></citerefentry>,
with <parameter>binaryFormat</parameter> and <parameter>length</parameter> set to the values
returned by <function>glGetProgramBinary</function>, and passing the returned binary data
in the <parameter>binary</parameter> parameter.
</para>
</refsect1>
<refsect1 xml:id="errors"><title>Errors</title>
<para>
<constant>GL_INVALID_OPERATION</constant> is generated if <parameter>bufSize</parameter> is less than
the size of <constant>GL_PROGRAM_BINARY_LENGTH</constant> for <parameter>program</parameter>.
</para>
<para>
<constant>GL_INVALID_OPERATION</constant> is generated if <constant>GL_LINK_STATUS</constant> for the
program object is false.
</para>
</refsect1>
<refsect1 xml:id="associatedgets"><title>Associated Gets</title>
<para>
<citerefentry><refentrytitle>glGetProgram</refentrytitle></citerefentry> with argument <constant>GL_PROGRAM_BINARY_LENGTH</constant>
</para>
</refsect1>
<refsect1 xml:id="versions"><title>Version Support</title>
<informaltable>
<tgroup cols="13" align="left">
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="apifunchead.xml" xpointer="xpointer(/*/*)"/>
<tbody>
<row>
<entry><function>glGetProgramBinary</function></entry>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="apiversion.xml" xpointer="xpointer(/*/*[@role='41']/*)"/>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 xml:id="seealso"><title>See Also</title>
<para>
<citerefentry><refentrytitle>glGetProgram</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glProgramBinary</refentrytitle></citerefentry>
</para>
</refsect1>
<refsect1 xml:id="Copyright"><title>Copyright</title>
<para>
Copyright <trademark class="copyright"/> 2010-2014 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.
<link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://opencontent.org/openpub/">http://opencontent.org/openpub/</link>.
</para>
</refsect1>
</refentry>
|
