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>, and
67 <constant>GL_TEXTURE_CUBE_MAP
</constant>
73 <term><parameter>pname
</parameter></term>
76 Specifies the symbolic name of a texture parameter.
77 <constant>GL_TEXTURE_BASE_LEVEL
</constant>,
78 <constant>GL_TEXTURE_BORDER_COLOR
</constant>,
79 <constant>GL_TEXTURE_COMPARE_MODE
</constant>,
80 <constant>GL_TEXTURE_COMPARE_FUNC
</constant>,
81 <constant>GL_TEXTURE_LOD_BIAS
</constant>,
82 <constant>GL_TEXTURE_MAG_FILTER
</constant>,
83 <constant>GL_TEXTURE_MAX_LEVEL
</constant>,
84 <constant>GL_TEXTURE_MAX_LOD
</constant>,
85 <constant>GL_TEXTURE_MIN_FILTER
</constant>,
86 <constant>GL_TEXTURE_MIN_LOD
</constant>,
87 <constant>GL_TEXTURE_SWIZZLE_R
</constant>,
88 <constant>GL_TEXTURE_SWIZZLE_G
</constant>,
89 <constant>GL_TEXTURE_SWIZZLE_B
</constant>,
90 <constant>GL_TEXTURE_SWIZZLE_A
</constant>,
91 <constant>GL_TEXTURE_SWIZZLE_RGBA
</constant>,
92 <constant>GL_TEXTURE_WRAP_S
</constant>,
93 <constant>GL_TEXTURE_WRAP_T
</constant>, and
94 <constant>GL_TEXTURE_WRAP_R
</constant>
100 <term><parameter>params
</parameter></term>
103 Returns the texture parameters.
109 <refsect1 id=
"description"><title>Description
</title>
111 <function>glGetTexParameter
</function> returns in
<parameter>params
</parameter> the value or values of the texture parameter
112 specified as
<parameter>pname
</parameter>.
113 <parameter>target
</parameter> defines the target texture.
114 <constant>GL_TEXTURE_1D
</constant>,
115 <constant>GL_TEXTURE_2D
</constant>,
116 <constant>GL_TEXTURE_3D
</constant>,
117 <constant>GL_TEXTURE_1D_ARRAY
</constant>,
118 <constant>GL_TEXTURE_2D_ARRAY
</constant>,
119 <constant>GL_TEXTURE_RECTANGLE
</constant>, and
120 <constant>GL_TEXTURE_CUBE_MAP
</constant>
121 specify one-, two-, or three-dimensional, one-dimensional array, two-dimensional array, rectangle or cube-mapped texturing, respectively.
122 <parameter>pname
</parameter> accepts the same symbols as
<citerefentry><refentrytitle>glTexParameter
</refentrytitle></citerefentry>,
123 with the same interpretations:
127 <term><constant>GL_TEXTURE_MAG_FILTER
</constant></term>
130 Returns the single-valued texture magnification filter,
131 a symbolic constant. The initial value is
<constant>GL_LINEAR
</constant>.
136 <term><constant>GL_TEXTURE_MIN_FILTER
</constant></term>
139 Returns the single-valued texture minification filter,
140 a symbolic constant. The initial value is
<constant>GL_NEAREST_MIPMAP_LINEAR
</constant>.
145 <term><constant>GL_TEXTURE_MIN_LOD
</constant></term>
148 Returns the single-valued texture minimum level-of-detail value. The
150 <inlineequation><mml:math>
152 <mml:mn>-
1000</mml:mn>
153 </mml:math></inlineequation>.
158 <term><constant>GL_TEXTURE_MAX_LOD
</constant></term>
161 Returns the single-valued texture maximum level-of-detail value. The
162 initial value is
1000.
167 <term><constant>GL_TEXTURE_BASE_LEVEL
</constant></term>
170 Returns the single-valued base texture mipmap level. The initial value is
0.
175 <term><constant>GL_TEXTURE_MAX_LEVEL
</constant></term>
178 Returns the single-valued maximum texture mipmap array level. The initial
184 <term><constant>GL_TEXTURE_SWIZZLE_R
</constant></term>
187 Returns the red component swizzle. The initial value is
<constant>GL_RED
</constant>.
192 <term><constant>GL_TEXTURE_SWIZZLE_G
</constant></term>
195 Returns the green component swizzle. The initial value is
<constant>GL_GREEN
</constant>.
200 <term><constant>GL_TEXTURE_SWIZZLE_B
</constant></term>
203 Returns the blue component swizzle. The initial value is
<constant>GL_BLUE
</constant>.
208 <term><constant>GL_TEXTURE_SWIZZLE_A
</constant></term>
211 Returns the alpha component swizzle. The initial value is
<constant>GL_ALPHA
</constant>.
216 <term><constant>GL_TEXTURE_SWIZZLE_RGBA
</constant></term>
219 Returns the component swizzle for all channels in a single query.
224 <term><constant>GL_TEXTURE_WRAP_S
</constant></term>
227 Returns the single-valued wrapping function for texture coordinate
228 <inlineequation><mml:math><mml:mi mathvariant=
"italic">s
</mml:mi></mml:math></inlineequation>,
229 a symbolic constant. The initial value is
<constant>GL_REPEAT
</constant>.
234 <term><constant>GL_TEXTURE_WRAP_T
</constant></term>
237 Returns the single-valued wrapping function for texture coordinate
238 <inlineequation><mml:math><mml:mi mathvariant=
"italic">t
</mml:mi></mml:math></inlineequation>,
239 a symbolic constant. The initial value is
<constant>GL_REPEAT
</constant>.
244 <term><constant>GL_TEXTURE_WRAP_R
</constant></term>
247 Returns the single-valued wrapping function for texture coordinate
248 <inlineequation><mml:math><mml:mi mathvariant=
"italic">r
</mml:mi></mml:math></inlineequation>,
249 a symbolic constant. The initial value is
<constant>GL_REPEAT
</constant>.
254 <term><constant>GL_TEXTURE_BORDER_COLOR
</constant></term>
257 Returns four integer or floating-point numbers that comprise the RGBA color
258 of the texture border.
259 Floating-point values are returned in the range
260 <inlineequation><mml:math>
262 <mml:mfenced open=
"[" close=
"]">
266 </mml:math></inlineequation>.
267 Integer values are returned as a linear mapping of the internal floating-point
268 representation such that
1.0 maps to the most positive representable
270 <inlineequation><mml:math>
272 <mml:mn>-
1.0</mml:mn>
273 </mml:math></inlineequation>
274 maps to the most negative representable
275 integer. The initial value is (
0,
0,
0,
0).
280 <term><constant>GL_TEXTURE_COMPARE_MODE
</constant></term>
283 Returns a single-valued texture comparison mode, a symbolic constant. The
284 initial value is
<constant>GL_NONE
</constant>. See
<citerefentry><refentrytitle>glTexParameter
</refentrytitle></citerefentry>.
289 <term><constant>GL_TEXTURE_COMPARE_FUNC
</constant></term>
292 Returns a single-valued texture comparison function, a symbolic constant. The
293 initial value is
<constant>GL_LEQUAL
</constant>. See
<citerefentry><refentrytitle>glTexParameter
</refentrytitle></citerefentry>.
299 <refsect1 id=
"notes"><title>Notes
</title>
301 If an error is generated,
302 no change is made to the contents of
<parameter>params
</parameter>.
305 <refsect1 id=
"errors"><title>Errors
</title>
307 <constant>GL_INVALID_ENUM
</constant> is generated if
<parameter>target
</parameter> or
<parameter>pname
</parameter> is not an
311 <refsect1 id=
"seealso"><title>See Also
</title>
313 <citerefentry><refentrytitle>glTexParameter
</refentrytitle></citerefentry>
316 <refsect1 id=
"Copyright"><title>Copyright
</title>
318 Copyright
<trademark class=
"copyright"></trademark> 1991-
2006
319 Silicon Graphics, Inc. Copyright
<trademark class=
"copyright"></trademark> 2010
320 Khronos Group. This document is licensed under the SGI
321 Free Software B License. For details, see
322 <ulink url=
"http://oss.sgi.com/projects/FreeB/">http://oss.sgi.com/projects/FreeB/
</ulink>.