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
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
|
<!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="glGetShader">
<info>
<copyright>
<year>2003-2005</year>
<holder>3Dlabs Inc. Ltd.</holder>
</copyright>
<copyright>
<year>2010-2014</year>
<holder>Khronos Group</holder>
</copyright>
</info>
<refmeta>
<refentrytitle>glGetShader</refentrytitle>
<manvolnum>3G</manvolnum>
</refmeta>
<refnamediv>
<refname>glGetShaderiv</refname>
<refpurpose>Returns a parameter from a shader object</refpurpose>
</refnamediv>
<refsynopsisdiv><title>C Specification</title>
<funcsynopsis>
<funcprototype>
<funcdef>void <function>glGetShaderiv</function></funcdef>
<paramdef>GLuint <parameter>shader</parameter></paramdef>
<paramdef>GLenum <parameter>pname</parameter></paramdef>
<paramdef>GLint *<parameter>params</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 xml:id="parameters"><title>Parameters</title>
<variablelist>
<varlistentry>
<term><parameter>shader</parameter></term>
<listitem>
<para>Specifies the shader object to be
queried.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>pname</parameter></term>
<listitem>
<para>Specifies the object parameter. Accepted
symbolic names are
<constant>GL_SHADER_TYPE</constant>,
<constant>GL_DELETE_STATUS</constant>,
<constant>GL_COMPILE_STATUS</constant>,
<constant>GL_INFO_LOG_LENGTH</constant>,
<constant>GL_SHADER_SOURCE_LENGTH</constant>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>params</parameter></term>
<listitem>
<para>Returns the requested object parameter.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 xml:id="description"><title>Description</title>
<para><function>glGetShader</function>
returns in <parameter>params</parameter>
the value of a parameter for a specific shader object. The
following parameters are defined:</para>
<variablelist>
<varlistentry>
<term><constant>GL_SHADER_TYPE</constant></term>
<listitem>
<para> <parameter>params</parameter> returns
<constant>GL_VERTEX_SHADER</constant> if
<parameter>shader</parameter> is a vertex shader
object, <constant>GL_GEOMETRY_SHADER</constant> if <parameter>shader</parameter>
is a geometry shader object, and <constant>GL_FRAGMENT_SHADER</constant>
if <parameter>shader</parameter> is a fragment
shader object.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>GL_DELETE_STATUS</constant></term>
<listitem>
<para> <parameter>params</parameter> returns
<constant>GL_TRUE</constant> if
<parameter>shader</parameter> is currently flagged
for deletion, and <constant>GL_FALSE</constant>
otherwise.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>GL_COMPILE_STATUS</constant></term>
<listitem>
<para> <parameter>params</parameter> returns
<constant>GL_TRUE</constant> if the last compile
operation on <parameter>shader</parameter> was
successful, and <constant>GL_FALSE</constant>
otherwise.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>GL_INFO_LOG_LENGTH</constant></term>
<listitem>
<para> <parameter>params</parameter> returns the
number of characters in the information log for
<parameter>shader</parameter> including the null
termination character (i.e., the size of the
character buffer required to store the information
log). If <parameter>shader</parameter> has no
information log, a value of 0 is returned.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>GL_SHADER_SOURCE_LENGTH</constant></term>
<listitem>
<para> <parameter>params</parameter> returns the
length of the concatenation of the source strings
that make up the shader source for the
<parameter>shader</parameter>, including the null
termination character. (i.e., the size of the
character buffer required to store the shader
source). If no source code exists, 0 is
returned.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 xml:id="notes"><title>Notes</title>
<para>If an error is generated, no change is made to the
contents of <parameter>params</parameter>.</para>
</refsect1>
<refsect1 xml:id="errors"><title>Errors</title>
<para><constant>GL_INVALID_VALUE</constant> is generated if
<parameter>shader</parameter> is not a value generated by
OpenGL.</para>
<para><constant>GL_INVALID_OPERATION</constant> is generated if
<parameter>shader</parameter> does not refer to a shader
object.</para>
<para><constant>GL_INVALID_ENUM</constant> is generated if
<parameter>pname</parameter> is not an accepted value.</para>
</refsect1>
<refsect1 xml:id="associatedgets"><title>Associated Gets</title>
<para><citerefentry><refentrytitle>glGetShaderInfoLog</refentrytitle></citerefentry>
with argument <parameter>shader</parameter></para>
<para><citerefentry><refentrytitle>glGetShaderSource</refentrytitle></citerefentry>
with argument <parameter>shader</parameter></para>
<para><citerefentry><refentrytitle>glIsShader</refentrytitle></citerefentry></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>glGetShaderiv</function></entry>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="apiversion.xml" xpointer="xpointer(/*/*[@role='20']/*)"/>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 xml:id="seealso"><title>See Also</title>
<para><citerefentry><refentrytitle>glCompileShader</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glCreateShader</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glDeleteShader</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glGetProgram</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glShaderSource</refentrytitle></citerefentry></para>
</refsect1>
<refsect1 xml:id="Copyright"><title>Copyright</title>
<para>
Copyright <trademark class="copyright"/> 2003-2005 3Dlabs Inc. Ltd.
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>
|
