/usr/share/doc/opengl-4-html-doc/glGetSamplerParameter.xml is in opengl-4-html-doc 1.0~svn22917-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd"><!-- saved from url=(0013)about:internet -->
<?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 4 Reference Pages</title><meta name="generator" content="DocBook XSL Stylesheets V1.78.1" /></head><body><div class="refentry"><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" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr><td><code class="funcdef">void <strong class="fsfunc">glGetSamplerParameterfv</strong>(</code></td><td>GLuint <var class="pdparam">sampler</var>, </td></tr><tr><td> </td><td>GLenum <var class="pdparam">pname</var>, </td></tr><tr><td> </td><td>GLfloat * <var class="pdparam">params</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div><div class="funcsynopsis"><table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr><td><code class="funcdef">void <strong class="fsfunc">glGetSamplerParameteriv</strong>(</code></td><td>GLuint <var class="pdparam">sampler</var>, </td></tr><tr><td> </td><td>GLenum <var class="pdparam">pname</var>, </td></tr><tr><td> </td><td>GLint * <var class="pdparam">params</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div><div class="funcsynopsis"><table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr><td><code class="funcdef">void <strong class="fsfunc">glGetSamplerParameterIiv</strong>(</code></td><td>GLuint <var class="pdparam">sampler</var>, </td></tr><tr><td> </td><td>GLenum <var class="pdparam">pname</var>, </td></tr><tr><td> </td><td>GLint * <var class="pdparam">params</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div><div class="funcsynopsis"><table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr><td><code class="funcdef">void <strong class="fsfunc">glGetSamplerParameterIuiv</strong>(</code></td><td>GLuint <var class="pdparam">sampler</var>, </td></tr><tr><td> </td><td>GLenum <var class="pdparam">pname</var>, </td></tr><tr><td> </td><td>GLuint * <var class="pdparam">params</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div></div><div class="refsect1"><a id="parameters"></a><h2>Parameters</h2><div class="variablelist"><dl class="variablelist"><dt><span class="term"><em class="parameter"><code>sampler</code></em></span></dt><dd><p>
Specifies name of the sampler object from which to retrieve parameters.
</p></dd><dt><span class="term"><em class="parameter"><code>pname</code></em></span></dt><dd><p>
Specifies the symbolic name of a sampler parameter.
<code class="constant">GL_TEXTURE_MAG_FILTER</code>,
<code class="constant">GL_TEXTURE_MIN_FILTER</code>,
<code class="constant">GL_TEXTURE_MIN_LOD</code>,
<code class="constant">GL_TEXTURE_MAX_LOD</code>,
<code class="constant">GL_TEXTURE_LOD_BIAS</code>,
<code class="constant">GL_TEXTURE_WRAP_S</code>,
<code class="constant">GL_TEXTURE_WRAP_T</code>,
<code class="constant">GL_TEXTURE_WRAP_R</code>,
<code class="constant">GL_TEXTURE_BORDER_COLOR</code>,
<code class="constant">GL_TEXTURE_COMPARE_MODE</code>, and
<code class="constant">GL_TEXTURE_COMPARE_FUNC</code>
are accepted.
</p></dd><dt><span class="term"><em class="parameter"><code>params</code></em></span></dt><dd><p>
Returns the sampler parameters.
</p></dd></dl></div></div><div class="refsect1"><a id="description"></a><h2>Description</h2><p>
<code class="function">glGetSamplerParameter</code> returns in <em class="parameter"><code>params</code></em> the value or values of the sampler parameter
specified as <em class="parameter"><code>pname</code></em>.
<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
to <a class="citerefentry" href="glGenSamplers.xml"><span class="citerefentry"><span class="refentrytitle">glGenSamplers</span></span></a>.
<em class="parameter"><code>pname</code></em> accepts the same symbols as <a class="citerefentry" href="glSamplerParameter.xml"><span class="citerefentry"><span class="refentrytitle">glSamplerParameter</span></span></a>,
with the same interpretations:
</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="constant">GL_TEXTURE_MAG_FILTER</code></span></dt><dd><p>
Returns the single-valued texture magnification filter,
a symbolic constant. The initial value is <code class="constant">GL_LINEAR</code>.
</p></dd><dt><span class="term"><code class="constant">GL_TEXTURE_MIN_FILTER</code></span></dt><dd><p>
Returns the single-valued texture minification filter,
a symbolic constant. The initial value is <code class="constant">GL_NEAREST_MIPMAP_LINEAR</code>.
</p></dd><dt><span class="term"><code class="constant">GL_TEXTURE_MIN_LOD</code></span></dt><dd><p>
Returns the single-valued texture minimum level-of-detail value. The
initial value is
<mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
<mml:mn>-1000</mml:mn>
</mml:math>.
</p></dd><dt><span class="term"><code class="constant">GL_TEXTURE_MAX_LOD</code></span></dt><dd><p>
Returns the single-valued texture maximum level-of-detail value. The
initial value is 1000.
</p></dd><dt><span class="term"><code class="constant">GL_TEXTURE_WRAP_S</code></span></dt><dd><p>
Returns the single-valued wrapping function for texture coordinate
<mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll"><mml:mi mathvariant="italic">s</mml:mi></mml:math>,
a symbolic constant. The initial value is <code class="constant">GL_REPEAT</code>.
</p></dd><dt><span class="term"><code class="constant">GL_TEXTURE_WRAP_T</code></span></dt><dd><p>
Returns the single-valued wrapping function for texture coordinate
<mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll"><mml:mi mathvariant="italic">t</mml:mi></mml:math>,
a symbolic constant. The initial value is <code class="constant">GL_REPEAT</code>.
</p></dd><dt><span class="term"><code class="constant">GL_TEXTURE_WRAP_R</code></span></dt><dd><p>
Returns the single-valued wrapping function for texture coordinate
<mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll"><mml:mi mathvariant="italic">r</mml:mi></mml:math>,
a symbolic constant. The initial value is <code class="constant">GL_REPEAT</code>.
</p></dd><dt><span class="term"><code class="constant">GL_TEXTURE_BORDER_COLOR</code></span></dt><dd><p>
Returns four integer or floating-point numbers that comprise the RGBA color
of the texture border.
Floating-point values are returned in the range
<mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
<mml:mfenced open="[" close="]">
<mml:mn>0</mml:mn>
<mml:mn>1</mml:mn>
</mml:mfenced>
</mml:math>.
Integer values are returned as a linear mapping of the internal floating-point
representation such that 1.0 maps to the most positive representable
integer and
<mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
<mml:mn>-1.0</mml:mn>
</mml:math>
maps to the most negative representable
integer. The initial value is (0, 0, 0, 0).
</p></dd><dt><span class="term"><code class="constant">GL_TEXTURE_COMPARE_MODE</code></span></dt><dd><p>
Returns a single-valued texture comparison mode, a symbolic constant. The
initial value is <code class="constant">GL_NONE</code>. See <a class="citerefentry" href="glSamplerParameter.xml"><span class="citerefentry"><span class="refentrytitle">glSamplerParameter</span></span></a>.
</p></dd><dt><span class="term"><code class="constant">GL_TEXTURE_COMPARE_FUNC</code></span></dt><dd><p>
Returns a single-valued texture comparison function, a symbolic constant. The
initial value is <code class="constant">GL_LEQUAL</code>. See <a class="citerefentry" href="glSamplerParameter.xml"><span class="citerefentry"><span class="refentrytitle">glSamplerParameter</span></span></a>.
</p></dd></dl></div></div><div class="refsect1"><a id="notes"></a><h2>Notes</h2><p>
If an error is generated,
no change is made to the contents of <em class="parameter"><code>params</code></em>.
</p><p>
<code class="function">glGetSamplerParameter</code> is available only if the GL version is 3.3 or higher.
</p></div><div class="refsect1"><a id="errors"></a><h2>Errors</h2><p>
<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
a previous call to <a class="citerefentry" href="glGenSamplers.xml"><span class="citerefentry"><span class="refentrytitle">glGenSamplers</span></span></a>.
</p><p>
<code class="constant">GL_INVALID_ENUM</code> is generated if <em class="parameter"><code>pname</code></em> is not an accepted value.
</p></div><div class="refsect1"><a id="seealso"></a><h2>See Also</h2><p>
<a class="citerefentry" href="glSamplerParameter.xml"><span class="citerefentry"><span class="refentrytitle">glSamplerParameter</span></span></a>,
<a class="citerefentry" href="glGenSamplers.xml"><span class="citerefentry"><span class="refentrytitle">glGenSamplers</span></span></a>,
<a class="citerefentry" href="glDeleteSamplers.xml"><span class="citerefentry"><span class="refentrytitle">glDeleteSamplers</span></span></a>,
<a class="citerefentry" href="glSamplerParameter.xml"><span class="citerefentry"><span class="refentrytitle">glSamplerParameter</span></span></a>
</p></div><div class="refsect1"><a id="Copyright"></a><h2>Copyright</h2><p>
Copyright <span class="trademark"></span>© 2010 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.
<a class="ulink" href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>.
</p></div></div></body></html>
|