1 <?xml version=
"1.0" encoding=
"UTF-8"?>
2 <!DOCTYPE html PUBLIC
"-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd">
3 <!-- saved from url=(0013)about:internet -->
4 <?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>glGetSamplerParameter - OpenGL
3.3 Reference Pages
</title><meta name=
"generator" content=
"DocBook XSL Stylesheets V1.69.1" /></head><body><div class=
"refentry" lang=
"en" xml:
lang=
"en"><a id=
"glGetSamplerParameter"></a><div class=
"titlepage"></div><div class=
"refnamediv"><h2>Name
</h2><p>glGetSamplerParameter — return sampler parameter values
</p></div><div class=
"refsynopsisdiv"><h2>C Specification
</h2><div class=
"funcsynopsis"><table border=
"0" summary=
"Function synopsis" cellspacing=
"0" cellpadding=
"0"><tr><td><code class=
"funcdef">void
<b class=
"fsfunc">glGetSamplerParameterfv
</b>(
</code></td><td>GLuint
</td><td><var class=
"pdparam">sampler
</var>,
</td></tr><tr><td> </td><td>GLenum
</td><td><var class=
"pdparam">pname
</var>,
</td></tr><tr><td> </td><td>GLfloat *
</td><td><var class=
"pdparam">params
</var><code>)
</code>;
</td></tr></table></div><div class=
"funcsynopsis"><table border=
"0" summary=
"Function synopsis" cellspacing=
"0" cellpadding=
"0"><tr><td><code class=
"funcdef">void
<b class=
"fsfunc">glGetSamplerParameteriv
</b>(
</code></td><td>GLuint
</td><td><var class=
"pdparam">sampler
</var>,
</td></tr><tr><td> </td><td>GLenum
</td><td><var class=
"pdparam">pname
</var>,
</td></tr><tr><td> </td><td>GLint *
</td><td><var class=
"pdparam">params
</var><code>)
</code>;
</td></tr></table></div><div class=
"funcsynopsis"><table border=
"0" summary=
"Function synopsis" cellspacing=
"0" cellpadding=
"0"><tr><td><code class=
"funcdef">void
<b class=
"fsfunc">glGetSamplerParameterIiv
</b>(
</code></td><td>GLuint
</td><td><var class=
"pdparam">sampler
</var>,
</td></tr><tr><td> </td><td>GLenum
</td><td><var class=
"pdparam">pname
</var>,
</td></tr><tr><td> </td><td>GLint *
</td><td><var class=
"pdparam">params
</var><code>)
</code>;
</td></tr></table></div><div class=
"funcsynopsis"><table border=
"0" summary=
"Function synopsis" cellspacing=
"0" cellpadding=
"0"><tr><td><code class=
"funcdef">void
<b class=
"fsfunc">glGetSamplerParameterIuiv
</b>(
</code></td><td>GLuint
</td><td><var class=
"pdparam">sampler
</var>,
</td></tr><tr><td> </td><td>GLenum
</td><td><var class=
"pdparam">pname
</var>,
</td></tr><tr><td> </td><td>GLuint *
</td><td><var class=
"pdparam">params
</var><code>)
</code>;
</td></tr></table></div></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"parameters"></a><h2>Parameters
</h2><div class=
"variablelist"><dl><dt><span class=
"term"><em class=
"parameter"><code>sampler
</code></em></span></dt><dd><p>
5 Specifies name of the sampler object from which to retrieve parameters.
6 </p></dd><dt><span class=
"term"><em class=
"parameter"><code>pname
</code></em></span></dt><dd><p>
7 Specifies the symbolic name of a sampler parameter.
8 <code class=
"constant">GL_TEXTURE_MAG_FILTER
</code>,
9 <code class=
"constant">GL_TEXTURE_MIN_FILTER
</code>,
10 <code class=
"constant">GL_TEXTURE_MIN_LOD
</code>,
11 <code class=
"constant">GL_TEXTURE_MAX_LOD
</code>,
12 <code class=
"constant">GL_TEXTURE_LOD_BIAS
</code>,
13 <code class=
"constant">GL_TEXTURE_WRAP_S
</code>,
14 <code class=
"constant">GL_TEXTURE_WRAP_T
</code>,
15 <code class=
"constant">GL_TEXTURE_WRAP_R
</code>,
16 <code class=
"constant">GL_TEXTURE_BORDER_COLOR
</code>,
17 <code class=
"constant">GL_TEXTURE_COMPARE_MODE
</code>, and
18 <code class=
"constant">GL_TEXTURE_COMPARE_FUNC
</code>
20 </p></dd><dt><span class=
"term"><em class=
"parameter"><code>params
</code></em></span></dt><dd><p>
21 Returns the sampler parameters.
22 </p></dd></dl></div></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"description"></a><h2>Description
</h2><p>
23 <code class=
"function">glGetSamplerParameter
</code> returns in
<em class=
"parameter"><code>params
</code></em> the value or values of the sampler parameter
24 specified as
<em class=
"parameter"><code>pname
</code></em>.
25 <em class=
"parameter"><code>sampler
</code></em> defines the target sampler, and must be the name of an existing sampler object, returned from a previous call
26 to
<a href=
"glGenSamplers.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glGenSamplers
</span></span></a>.
27 <em class=
"parameter"><code>pname
</code></em> accepts the same symbols as
<a href=
"glSamplerParameter.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glSamplerParameter
</span></span></a>,
28 with the same interpretations:
29 </p><div class=
"variablelist"><dl><dt><span class=
"term"><code class=
"constant">GL_TEXTURE_MAG_FILTER
</code></span></dt><dd><p>
30 Returns the single-valued texture magnification filter,
31 a symbolic constant. The initial value is
<code class=
"constant">GL_LINEAR
</code>.
32 </p></dd><dt><span class=
"term"><code class=
"constant">GL_TEXTURE_MIN_FILTER
</code></span></dt><dd><p>
33 Returns the single-valued texture minification filter,
34 a symbolic constant. The initial value is
<code class=
"constant">GL_NEAREST_MIPMAP_LINEAR
</code>.
35 </p></dd><dt><span class=
"term"><code class=
"constant">GL_TEXTURE_MIN_LOD
</code></span></dt><dd><p>
36 Returns the single-valued texture minimum level-of-detail value. The
38 <mml:math xmlns:
mml=
"http://www.w3.org/1998/Math/MathML" overflow=
"scroll">
40 <mml:mn>-
1000</mml:mn>
42 </p></dd><dt><span class=
"term"><code class=
"constant">GL_TEXTURE_MAX_LOD
</code></span></dt><dd><p>
43 Returns the single-valued texture maximum level-of-detail value. The
44 initial value is
1000.
45 </p></dd><dt><span class=
"term"><code class=
"constant">GL_TEXTURE_WRAP_S
</code></span></dt><dd><p>
46 Returns the single-valued wrapping function for texture coordinate
47 <mml:math xmlns:
mml=
"http://www.w3.org/1998/Math/MathML" overflow=
"scroll"><mml:mi mathvariant=
"italic">s
</mml:mi></mml:math>,
48 a symbolic constant. The initial value is
<code class=
"constant">GL_REPEAT
</code>.
49 </p></dd><dt><span class=
"term"><code class=
"constant">GL_TEXTURE_WRAP_T
</code></span></dt><dd><p>
50 Returns the single-valued wrapping function for texture coordinate
51 <mml:math xmlns:
mml=
"http://www.w3.org/1998/Math/MathML" overflow=
"scroll"><mml:mi mathvariant=
"italic">t
</mml:mi></mml:math>,
52 a symbolic constant. The initial value is
<code class=
"constant">GL_REPEAT
</code>.
53 </p></dd><dt><span class=
"term"><code class=
"constant">GL_TEXTURE_WRAP_R
</code></span></dt><dd><p>
54 Returns the single-valued wrapping function for texture coordinate
55 <mml:math xmlns:
mml=
"http://www.w3.org/1998/Math/MathML" overflow=
"scroll"><mml:mi mathvariant=
"italic">r
</mml:mi></mml:math>,
56 a symbolic constant. The initial value is
<code class=
"constant">GL_REPEAT
</code>.
57 </p></dd><dt><span class=
"term"><code class=
"constant">GL_TEXTURE_BORDER_COLOR
</code></span></dt><dd><p>
58 Returns four integer or floating-point numbers that comprise the RGBA color
59 of the texture border.
60 Floating-point values are returned in the range
61 <mml:math xmlns:
mml=
"http://www.w3.org/1998/Math/MathML" overflow=
"scroll">
63 <mml:mfenced open=
"[" close=
"]">
68 Integer values are returned as a linear mapping of the internal floating-point
69 representation such that
1.0 maps to the most positive representable
71 <mml:math xmlns:
mml=
"http://www.w3.org/1998/Math/MathML" overflow=
"scroll">
75 maps to the most negative representable
76 integer. The initial value is (
0,
0,
0,
0).
77 </p></dd><dt><span class=
"term"><code class=
"constant">GL_TEXTURE_COMPARE_MODE
</code></span></dt><dd><p>
78 Returns a single-valued texture comparison mode, a symbolic constant. The
79 initial value is
<code class=
"constant">GL_NONE
</code>. See
<a href=
"glSamplerParameter.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glSamplerParameter
</span></span></a>.
80 </p></dd><dt><span class=
"term"><code class=
"constant">GL_TEXTURE_COMPARE_FUNC
</code></span></dt><dd><p>
81 Returns a single-valued texture comparison function, a symbolic constant. The
82 initial value is
<code class=
"constant">GL_LEQUAL
</code>. See
<a href=
"glSamplerParameter.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glSamplerParameter
</span></span></a>.
83 </p></dd></dl></div></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"notes"></a><h2>Notes
</h2><p>
84 If an error is generated,
85 no change is made to the contents of
<em class=
"parameter"><code>params
</code></em>.
87 <code class=
"function">glGetSamplerParameter
</code> is available only if the GL version is
3.3 or higher.
88 </p></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"errors"></a><h2>Errors
</h2><p>
89 <code class=
"constant">GL_INVALID_VALUE
</code> is generated if
<em class=
"parameter"><code>sampler
</code></em> is not the name of a sampler object returned from
90 a previous call to
<a href=
"glGenSamplers.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glGenSamplers
</span></span></a>.
92 <code class=
"constant">GL_INVALID_ENUM
</code> is generated if
<em class=
"parameter"><code>pname
</code></em> is not an accepted value.
93 </p></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"seealso"></a><h2>See Also
</h2><p>
94 <a href=
"glSamplerParameter.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glSamplerParameter
</span></span></a>,
95 <a href=
"glGenSamplers.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glGenSamplers
</span></span></a>,
96 <a href=
"glDeleteSamplers.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glDeleteSamplers
</span></span></a>,
97 <a href=
"glSamplerParameter.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glSamplerParameter
</span></span></a>
98 </p></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"Copyright"></a><h2>Copyright
</h2><p>
99 Copyright
<span class=
"trademark"></span>©
2010 Khronos Group.
100 This material may be distributed subject to the terms and conditions set forth in
101 the Open Publication License, v
1.0,
8 June
1999.
102 <a href=
"http://opencontent.org/openpub/" target=
"_top">http://opencontent.org/openpub/
</a>.
103 </p></div></div></body></html>