1 <?xml version=
"1.0" encoding=
"UTF-8"?>
2 <!DOCTYPE book PUBLIC
"-//OASIS//DTD DocBook MathML Module V1.1b1//EN"
3 "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">
4 <refentry id=
"glGetTexParameter">
9 <holder>Silicon Graphics, Inc.
</holder>
12 <refentrytitle>glGetTexParameter
</refentrytitle>
13 <manvolnum>3G
</manvolnum>
16 <refname>glGetTexParameter
</refname>
17 <refpurpose>return texture parameter values
</refpurpose>
19 <refsynopsisdiv><title>C Specification
</title>
22 <funcdef>void
<function>glGetTexParameterfv
</function></funcdef>
23 <paramdef>GLenum
<parameter>target
</parameter></paramdef>
24 <paramdef>GLenum
<parameter>pname
</parameter></paramdef>
25 <paramdef>GLfloat *
<parameter>params
</parameter></paramdef>
30 <funcdef>void
<function>glGetTexParameteriv
</function></funcdef>
31 <paramdef>GLenum
<parameter>target
</parameter></paramdef>
32 <paramdef>GLenum
<parameter>pname
</parameter></paramdef>
33 <paramdef>GLint *
<parameter>params
</parameter></paramdef>
38 <funcdef>void
<function>glGetTexParameterIiv
</function></funcdef>
39 <paramdef>GLenum
<parameter>target
</parameter></paramdef>
40 <paramdef>GLenum
<parameter>pname
</parameter></paramdef>
41 <paramdef>GLint *
<parameter>params
</parameter></paramdef>
46 <funcdef>void
<function>glGetTexParameterIuiv
</function></funcdef>
47 <paramdef>GLenum
<parameter>target
</parameter></paramdef>
48 <paramdef>GLenum
<parameter>pname
</parameter></paramdef>
49 <paramdef>GLuint *
<parameter>params
</parameter></paramdef>
53 <!-- eqn: ignoring delim $$ -->
54 <refsect1 id=
"parameters"><title>Parameters
</title>
57 <term><parameter>target
</parameter></term>
60 Specifies the symbolic name of the target texture.
61 <constant>GL_TEXTURE_1D
</constant>,
62 <constant>GL_TEXTURE_2D
</constant>,
63 <constant>GL_TEXTURE_1D_ARRAY
</constant>,
64 <constant>GL_TEXTURE_2D_ARRAY
</constant>,
65 <constant>GL_TEXTURE_3D
</constant>,
66 <constant>GL_TEXTURE_RECTANGLE
</constant>,
67 <constant>GL_TEXTURE_CUBE_MAP
</constant>, and
68 <constant>GL_TEXTURE_CUBE_MAP_ARRAY
</constant>
74 <term><parameter>pname
</parameter></term>
77 Specifies the symbolic name of a texture parameter.
78 <constant>GL_DEPTH_STENCIL_TEXTURE_MODE
</constant>,
79 <constant>GL_TEXTURE_BASE_LEVEL
</constant>,
80 <constant>GL_TEXTURE_BORDER_COLOR
</constant>,
81 <constant>GL_TEXTURE_COMPARE_MODE
</constant>,
82 <constant>GL_TEXTURE_COMPARE_FUNC
</constant>,
83 <constant>GL_TEXTURE_IMMUTABLE_FORMAT
</constant>,
84 <constant>GL_TEXTURE_IMMUTABLE_LEVELS
</constant>,
85 <constant>GL_TEXTURE_LOD_BIAS
</constant>,
86 <constant>GL_TEXTURE_MAG_FILTER
</constant>,
87 <constant>GL_TEXTURE_MAX_LEVEL
</constant>,
88 <constant>GL_TEXTURE_MAX_LOD
</constant>,
89 <constant>GL_TEXTURE_MIN_FILTER
</constant>,
90 <constant>GL_TEXTURE_MIN_LOD
</constant>,
91 <constant>GL_TEXTURE_SWIZZLE_R
</constant>,
92 <constant>GL_TEXTURE_SWIZZLE_G
</constant>,
93 <constant>GL_TEXTURE_SWIZZLE_B
</constant>,
94 <constant>GL_TEXTURE_SWIZZLE_A
</constant>,
95 <constant>GL_TEXTURE_SWIZZLE_RGBA
</constant>,
96 <constant>GL_TEXTURE_VIEW_MIN_LAYER
</constant>,
97 <constant>GL_TEXTURE_VIEW_MIN_LEVEL
</constant>,
98 <constant>GL_TEXTURE_VIEW_NUM_LAYERS
</constant>,
99 <constant>GL_TEXTURE_VIEW_NUM_LEVELS
</constant>,
100 <constant>GL_TEXTURE_WRAP_S
</constant>,
101 <constant>GL_TEXTURE_WRAP_T
</constant>, and
102 <constant>GL_TEXTURE_WRAP_R
</constant>
108 <term><parameter>params
</parameter></term>
111 Returns the texture parameters.
117 <refsect1 id=
"description"><title>Description
</title>
119 <function>glGetTexParameter
</function> returns in
<parameter>params
</parameter> the value or values of the texture parameter
120 specified as
<parameter>pname
</parameter>.
121 <parameter>target
</parameter> defines the target texture.
122 <constant>GL_TEXTURE_1D
</constant>,
123 <constant>GL_TEXTURE_2D
</constant>,
124 <constant>GL_TEXTURE_3D
</constant>,
125 <constant>GL_TEXTURE_1D_ARRAY
</constant>,
126 <constant>GL_TEXTURE_2D_ARRAY
</constant>,
127 <constant>GL_TEXTURE_RECTANGLE
</constant>,
128 <constant>GL_TEXTURE_CUBE_MAP
</constant>,
129 <constant>GL_TEXTURE_CUBE_MAP_ARRAY
</constant>
130 specify one-, two-, or three-dimensional, one-dimensional array, two-dimensional array, rectangle, cube-mapped or cube-mapped array texturing, respectively.
131 <parameter>pname
</parameter> accepts the same symbols as
<citerefentry><refentrytitle>glTexParameter
</refentrytitle></citerefentry>,
132 with the same interpretations:
136 <term><constant>GL_DEPTH_STENCIL_TEXTURE_MODE
</constant></term>
139 Returns the single-value depth stencil texture mode, a symbolic constant.
140 The initial value is
<constant>GL_DEPTH_COMPONENT
</constant>.
145 <term><constant>GL_TEXTURE_MAG_FILTER
</constant></term>
148 Returns the single-valued texture magnification filter,
149 a symbolic constant. The initial value is
<constant>GL_LINEAR
</constant>.
154 <term><constant>GL_TEXTURE_MIN_FILTER
</constant></term>
157 Returns the single-valued texture minification filter,
158 a symbolic constant. The initial value is
<constant>GL_NEAREST_MIPMAP_LINEAR
</constant>.
163 <term><constant>GL_TEXTURE_MIN_LOD
</constant></term>
166 Returns the single-valued texture minimum level-of-detail value. The
168 <inlineequation><mml:math>
170 <mml:mn>-
1000</mml:mn>
171 </mml:math></inlineequation>.
176 <term><constant>GL_TEXTURE_MAX_LOD
</constant></term>
179 Returns the single-valued texture maximum level-of-detail value. The
180 initial value is
1000.
185 <term><constant>GL_TEXTURE_BASE_LEVEL
</constant></term>
188 Returns the single-valued base texture mipmap level. The initial value is
0.
193 <term><constant>GL_TEXTURE_MAX_LEVEL
</constant></term>
196 Returns the single-valued maximum texture mipmap array level. The initial
202 <term><constant>GL_TEXTURE_SWIZZLE_R
</constant></term>
205 Returns the red component swizzle. The initial value is
<constant>GL_RED
</constant>.
210 <term><constant>GL_TEXTURE_SWIZZLE_G
</constant></term>
213 Returns the green component swizzle. The initial value is
<constant>GL_GREEN
</constant>.
218 <term><constant>GL_TEXTURE_SWIZZLE_B
</constant></term>
221 Returns the blue component swizzle. The initial value is
<constant>GL_BLUE
</constant>.
226 <term><constant>GL_TEXTURE_SWIZZLE_A
</constant></term>
229 Returns the alpha component swizzle. The initial value is
<constant>GL_ALPHA
</constant>.
234 <term><constant>GL_TEXTURE_SWIZZLE_RGBA
</constant></term>
237 Returns the component swizzle for all channels in a single query.
242 <term><constant>GL_TEXTURE_WRAP_S
</constant></term>
245 Returns the single-valued wrapping function for texture coordinate
246 <inlineequation><mml:math><mml:mi mathvariant=
"italic">s
</mml:mi></mml:math></inlineequation>,
247 a symbolic constant. The initial value is
<constant>GL_REPEAT
</constant>.
252 <term><constant>GL_TEXTURE_WRAP_T
</constant></term>
255 Returns the single-valued wrapping function for texture coordinate
256 <inlineequation><mml:math><mml:mi mathvariant=
"italic">t
</mml:mi></mml:math></inlineequation>,
257 a symbolic constant. The initial value is
<constant>GL_REPEAT
</constant>.
262 <term><constant>GL_TEXTURE_WRAP_R
</constant></term>
265 Returns the single-valued wrapping function for texture coordinate
266 <inlineequation><mml:math><mml:mi mathvariant=
"italic">r
</mml:mi></mml:math></inlineequation>,
267 a symbolic constant. The initial value is
<constant>GL_REPEAT
</constant>.
272 <term><constant>GL_TEXTURE_BORDER_COLOR
</constant></term>
275 Returns four integer or floating-point numbers that comprise the RGBA color
276 of the texture border.
277 Floating-point values are returned in the range
278 <inlineequation><mml:math>
280 <mml:mfenced open=
"[" close=
"]">
284 </mml:math></inlineequation>.
285 Integer values are returned as a linear mapping of the internal floating-point
286 representation such that
1.0 maps to the most positive representable
288 <inlineequation><mml:math>
290 <mml:mn>-
1.0</mml:mn>
291 </mml:math></inlineequation>
292 maps to the most negative representable
293 integer. The initial value is (
0,
0,
0,
0).
298 <term><constant>GL_TEXTURE_COMPARE_MODE
</constant></term>
301 Returns a single-valued texture comparison mode, a symbolic constant. The
302 initial value is
<constant>GL_NONE
</constant>. See
<citerefentry><refentrytitle>glTexParameter
</refentrytitle></citerefentry>.
307 <term><constant>GL_TEXTURE_COMPARE_FUNC
</constant></term>
310 Returns a single-valued texture comparison function, a symbolic constant. The
311 initial value is
<constant>GL_LEQUAL
</constant>. See
<citerefentry><refentrytitle>glTexParameter
</refentrytitle></citerefentry>.
316 <term><constant>GL_TEXTURE_VIEW_MIN_LEVEL
</constant></term>
319 Returns a single-valued base level of a texture view relative to its parent. The
320 initial value is
0. See
<citerefentry><refentrytitle>glTextureView
</refentrytitle></citerefentry>.
325 <term><constant>GL_TEXTURE_VIEW_NUM_LEVELS
</constant></term>
328 Returns a single-valued number of levels of detail of a texture view.
329 See
<citerefentry><refentrytitle>glTextureView
</refentrytitle></citerefentry>.
334 <term><constant>GL_TEXTURE_VIEW_MIN_LAYER
</constant></term>
337 Returns a single-valued first level of a texture array view relative to its parent.
338 See
<citerefentry><refentrytitle>glTextureView
</refentrytitle></citerefentry>.
343 <term><constant>GL_TEXTURE_VIEW_NUM_LAYERS
</constant></term>
346 Returns a single-valued number of layers in a texture array view.
347 See
<citerefentry><refentrytitle>glTextureView
</refentrytitle></citerefentry>.
352 <term><constant>GL_TEXTURE_IMMUTABLE_LEVELS
</constant></term>
355 Returns a single-valued number of immutable texture levels in a texture view.
356 See
<citerefentry><refentrytitle>glTextureView
</refentrytitle></citerefentry>.
362 In addition to the parameters that may be set with
<citerefentry><refentrytitle>glTexParameter
</refentrytitle></citerefentry>,
363 <function>glGetTexParameter
</function> accepts the following read-only parameters:
367 <term><constant>GL_TEXTURE_IMMUTABLE_FORMAT
</constant></term>
370 Returns non-zero if the texture has an immutable format. Textures become
371 immutable if their storage is specified with
<citerefentry><refentrytitle>glTexStorage1D
</refentrytitle></citerefentry>,
372 <citerefentry><refentrytitle>glTexStorage2D
</refentrytitle></citerefentry> or
<citerefentry><refentrytitle>glTexStorage3D
</refentrytitle></citerefentry>.
373 The initial value is
<constant>GL_FALSE
</constant>.
379 <refsect1 id=
"notes"><title>Notes
</title>
381 If an error is generated,
382 no change is made to the contents of
<parameter>params
</parameter>.
385 <constant>GL_DEPTH_STENCIL_TEXTURE_MODE
</constant>,
<constant>GL_TEXTURE_VIEW_MIN_LEVEL
</constant>,
386 <constant>GL_TEXTURE_VIEW_NUM_LEVELS
</constant>,
<constant>GL_TEXTURE_VIEW_MIN_LAYER
</constant>,
387 <constant>GL_TEXTURE_VIEW_NUM_LAYERS
</constant> and
<constant>GL_TEXTURE_IMMUTABLE_LEVELS
</constant> are available only if the GL version is
4.3 or greater.
390 <refsect1 id=
"errors"><title>Errors
</title>
392 <constant>GL_INVALID_ENUM
</constant> is generated if
<parameter>target
</parameter> or
<parameter>pname
</parameter> is not an
396 <refsect1 id=
"seealso"><title>See Also
</title>
398 <citerefentry><refentrytitle>glTexParameter
</refentrytitle></citerefentry>,
399 <citerefentry><refentrytitle>glTexStorage1D
</refentrytitle></citerefentry>,
400 <citerefentry><refentrytitle>glTexStorage2D
</refentrytitle></citerefentry>,
401 <citerefentry><refentrytitle>glTexStorage3D
</refentrytitle></citerefentry>,
402 <citerefentry><refentrytitle>glTextureView
</refentrytitle></citerefentry>
405 <refsect1 id=
"Copyright"><title>Copyright
</title>
407 Copyright
<trademark class=
"copyright"></trademark> 1991-
2006
408 Silicon Graphics, Inc. Copyright
<trademark class=
"copyright"></trademark> 2010-
2012
409 Khronos Group. This document is licensed under the SGI
410 Free Software B License. For details, see
411 <ulink url=
"http://oss.sgi.com/projects/FreeB/">http://oss.sgi.com/projects/FreeB/
</ulink>.