[clinton/guile-figl.git] / upstream-doc / man3 / glGetSamplerParameter.xml

<?xml version="1.0" encoding="UTF-8"?>\r
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"\r
              "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">\r
<refentry id="glGetSamplerParameter">\r
    <refmeta>\r
        <refmetainfo>\r
            <copyright>\r
                <year>2010</year>\r
                <holder>Khronos Group</holder>\r
            </copyright>\r
        </refmetainfo>\r
        <refentrytitle>glGetSamplerParameter</refentrytitle>\r
        <manvolnum>3G</manvolnum>\r
    </refmeta>\r
    <refnamediv>\r
        <refname>glGetSamplerParameter</refname>\r
        <refpurpose>return sampler parameter values</refpurpose>\r
    </refnamediv>\r
    <refsynopsisdiv><title>C Specification</title>\r
        <funcsynopsis>\r
            <funcprototype>\r
                <funcdef>void <function>glGetSamplerParameterfv</function></funcdef>\r
                <paramdef>GLuint <parameter>sampler</parameter></paramdef>\r
                <paramdef>GLenum <parameter>pname</parameter></paramdef>\r
                <paramdef>GLfloat * <parameter>params</parameter></paramdef>\r
            </funcprototype>\r
        </funcsynopsis>\r
        <funcsynopsis>\r
            <funcprototype>\r
                <funcdef>void <function>glGetSamplerParameteriv</function></funcdef>\r
                <paramdef>GLuint <parameter>sampler</parameter></paramdef>\r
                <paramdef>GLenum <parameter>pname</parameter></paramdef>\r
                <paramdef>GLint * <parameter>params</parameter></paramdef>\r
            </funcprototype>\r
        </funcsynopsis>\r
        <funcsynopsis>\r
            <funcprototype>\r
                <funcdef>void <function>glGetSamplerParameterIiv</function></funcdef>\r
                <paramdef>GLuint <parameter>sampler</parameter></paramdef>\r
                <paramdef>GLenum <parameter>pname</parameter></paramdef>\r
                <paramdef>GLint * <parameter>params</parameter></paramdef>\r
            </funcprototype>\r
        </funcsynopsis>\r
        <funcsynopsis>\r
            <funcprototype>\r
                <funcdef>void <function>glGetSamplerParameterIuiv</function></funcdef>\r
                <paramdef>GLuint <parameter>sampler</parameter></paramdef>\r
                <paramdef>GLenum <parameter>pname</parameter></paramdef>\r
                <paramdef>GLuint * <parameter>params</parameter></paramdef>\r
            </funcprototype>\r
        </funcsynopsis>\r
    </refsynopsisdiv>\r
    <!-- eqn: ignoring delim $$ -->\r
    <refsect1 id="parameters"><title>Parameters</title>\r
        <variablelist>\r
        <varlistentry>\r
            <term><parameter>sampler</parameter></term>\r
            <listitem>\r
                <para>\r
                    Specifies name of the sampler object from which to retrieve parameters.\r
                </para>\r
            </listitem>\r
        </varlistentry>\r
        <varlistentry>\r
            <term><parameter>pname</parameter></term>\r
            <listitem>\r
                <para>\r
                    Specifies the symbolic name of a sampler parameter.\r
                    <constant>GL_TEXTURE_MAG_FILTER</constant>,\r
                    <constant>GL_TEXTURE_MIN_FILTER</constant>,\r
                    <constant>GL_TEXTURE_MIN_LOD</constant>,\r
                    <constant>GL_TEXTURE_MAX_LOD</constant>,\r
                    <constant>GL_TEXTURE_LOD_BIAS</constant>,\r
                    <constant>GL_TEXTURE_WRAP_S</constant>,\r
                    <constant>GL_TEXTURE_WRAP_T</constant>,\r
                    <constant>GL_TEXTURE_WRAP_R</constant>,\r
                    <constant>GL_TEXTURE_BORDER_COLOR</constant>,\r
                    <constant>GL_TEXTURE_COMPARE_MODE</constant>, and\r
                    <constant>GL_TEXTURE_COMPARE_FUNC</constant>\r
                    are accepted.\r
                </para>\r
            </listitem>\r
        </varlistentry>\r
        <varlistentry>\r
            <term><parameter>params</parameter></term>\r
            <listitem>\r
                <para>\r
                    Returns the sampler parameters.\r
                </para>\r
            </listitem>\r
        </varlistentry>\r
        </variablelist>\r
    </refsect1>\r
    <refsect1 id="description"><title>Description</title>\r
        <para>\r
            <function>glGetSamplerParameter</function> returns in <parameter>params</parameter> the value or values of the sampler parameter\r
            specified as <parameter>pname</parameter>.\r
            <parameter>sampler</parameter> defines the target sampler, and must be the name of an existing sampler object, returned from a previous call\r
            to <citerefentry><refentrytitle>glGenSamplers</refentrytitle></citerefentry>.\r
            <parameter>pname</parameter> accepts the same symbols as <citerefentry><refentrytitle>glSamplerParameter</refentrytitle></citerefentry>,\r
            with the same interpretations:\r
        </para>\r
        <variablelist>\r
            <varlistentry>\r
                <term><constant>GL_TEXTURE_MAG_FILTER</constant></term>\r
                <listitem>\r
                    <para>\r
                        Returns the single-valued texture magnification filter,\r
                        a symbolic constant. The initial value is <constant>GL_LINEAR</constant>.\r
                    </para>\r
                </listitem>\r
            </varlistentry>\r
            <varlistentry>\r
                <term><constant>GL_TEXTURE_MIN_FILTER</constant></term>\r
                <listitem>\r
                    <para>\r
                        Returns the single-valued texture minification filter,\r
                        a symbolic constant. The initial value is <constant>GL_NEAREST_MIPMAP_LINEAR</constant>.\r
                    </para>\r
                </listitem>\r
            </varlistentry>\r
            <varlistentry>\r
                <term><constant>GL_TEXTURE_MIN_LOD</constant></term>\r
                <listitem>\r
                    <para>\r
                        Returns the single-valued texture minimum level-of-detail value.  The\r
                        initial value is \r
                        <inlineequation><mml:math>\r
                            <!-- eqn: -1000: -->\r
                            <mml:mn>-1000</mml:mn>\r
                        </mml:math></inlineequation>.\r
                    </para>\r
                </listitem>\r
            </varlistentry>\r
            <varlistentry>\r
                <term><constant>GL_TEXTURE_MAX_LOD</constant></term>\r
                <listitem>\r
                    <para>\r
                        Returns the single-valued texture maximum level-of-detail value. The\r
                        initial value is 1000.\r
                    </para>\r
                </listitem>\r
            </varlistentry>\r
            <varlistentry>\r
                <term><constant>GL_TEXTURE_WRAP_S</constant></term>\r
                <listitem>\r
                    <para>\r
                        Returns the single-valued wrapping function for texture coordinate \r
                        <inlineequation><mml:math><mml:mi mathvariant="italic">s</mml:mi></mml:math></inlineequation>,\r
                        a symbolic constant. The initial value is <constant>GL_REPEAT</constant>.\r
                    </para>\r
                </listitem>\r
            </varlistentry>\r
            <varlistentry>\r
                <term><constant>GL_TEXTURE_WRAP_T</constant></term>\r
                <listitem>\r
                    <para>\r
                        Returns the single-valued wrapping function for texture coordinate \r
                        <inlineequation><mml:math><mml:mi mathvariant="italic">t</mml:mi></mml:math></inlineequation>,\r
                        a symbolic constant. The initial value is <constant>GL_REPEAT</constant>.\r
                    </para>\r
                </listitem>\r
            </varlistentry>\r
            <varlistentry>\r
                <term><constant>GL_TEXTURE_WRAP_R</constant></term>\r
                <listitem>\r
                    <para>\r
                        Returns the single-valued wrapping function for texture coordinate \r
                        <inlineequation><mml:math><mml:mi mathvariant="italic">r</mml:mi></mml:math></inlineequation>,\r
                        a symbolic constant. The initial value is <constant>GL_REPEAT</constant>.\r
                    </para>\r
                </listitem>\r
            </varlistentry>\r
            <varlistentry>\r
                <term><constant>GL_TEXTURE_BORDER_COLOR</constant></term>\r
                <listitem>\r
                    <para>\r
                        Returns four integer or floating-point numbers that comprise the RGBA color\r
                        of the texture border.\r
                        Floating-point values are returned in the range \r
                        <inlineequation><mml:math>\r
                            <!-- eqn: [0,1]: -->\r
                            <mml:mfenced open="[" close="]">\r
                                <mml:mn>0</mml:mn>\r
                                <mml:mn>1</mml:mn>\r
                            </mml:mfenced>\r
                        </mml:math></inlineequation>.\r
                        Integer values are returned as a linear mapping of the internal floating-point\r
                        representation such that 1.0 maps to the most positive representable\r
                        integer and \r
                        <inlineequation><mml:math>\r
                            <!-- eqn: -1.0: -->\r
                            <mml:mn>-1.0</mml:mn>\r
                        </mml:math></inlineequation>\r
                        maps to the most negative representable\r
                        integer. The initial value is (0, 0, 0, 0).\r
                    </para>\r
                </listitem>\r
            </varlistentry>\r
            <varlistentry>\r
                <term><constant>GL_TEXTURE_COMPARE_MODE</constant></term>\r
                <listitem>\r
                    <para>\r
                        Returns a single-valued texture comparison mode, a symbolic constant.  The\r
                        initial value is <constant>GL_NONE</constant>. See <citerefentry><refentrytitle>glSamplerParameter</refentrytitle></citerefentry>.\r
                    </para>\r
                </listitem>\r
            </varlistentry>\r
            <varlistentry>\r
                <term><constant>GL_TEXTURE_COMPARE_FUNC</constant></term>\r
                <listitem>\r
                    <para>\r
                        Returns a single-valued texture comparison function, a symbolic constant.  The\r
                        initial value is <constant>GL_LEQUAL</constant>. See <citerefentry><refentrytitle>glSamplerParameter</refentrytitle></citerefentry>.\r
                    </para>\r
                </listitem>\r
            </varlistentry>\r
        </variablelist>\r
    </refsect1>\r
    <refsect1 id="notes"><title>Notes</title>\r
        <para>\r
            If an error is generated,\r
            no change is made to the contents of <parameter>params</parameter>.\r
        </para>\r
        <para>\r
            <function>glGetSamplerParameter</function> is available only if the GL version is 3.3 or higher.\r
        </para>\r
    </refsect1>\r
    <refsect1 id="errors"><title>Errors</title>\r
        <para>\r
            <constant>GL_INVALID_VALUE</constant> is generated if <parameter>sampler</parameter> is not the name of a sampler object returned from\r
            a previous call to <citerefentry><refentrytitle>glGenSamplers</refentrytitle></citerefentry>.\r
        </para>\r
        <para>\r
            <constant>GL_INVALID_ENUM</constant> is generated if <parameter>pname</parameter> is not an accepted value.\r
        </para>\r
    </refsect1>\r
    <refsect1 id="seealso"><title>See Also</title>\r
        <para>\r
            <citerefentry><refentrytitle>glSamplerParameter</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>glGenSamplers</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>glDeleteSamplers</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>glSamplerParameter</refentrytitle></citerefentry>\r
        </para>\r
    </refsect1>\r
    <refsect1 id="Copyright"><title>Copyright</title>\r
        <para>\r
            Copyright <trademark class="copyright"></trademark> 2010 Khronos Group. \r
            This material may be distributed subject to the terms and conditions set forth in \r
            the Open Publication License, v 1.0, 8 June 1999.\r
            <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.\r
        </para>\r
    </refsect1>\r
</refentry>\r
Commit	Line	Data
7faf1d71 AW	1	<?xml version="1.0" encoding="UTF-8"?>\r
	2	<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"\r
	3	"http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">\r
	4	<refentry id="glGetSamplerParameter">\r
	5	<refmeta>\r
	6	<refmetainfo>\r
	7	<copyright>\r
	8	<year>2010</year>\r
	9	<holder>Khronos Group</holder>\r
	10	</copyright>\r
	11	</refmetainfo>\r
	12	<refentrytitle>glGetSamplerParameter</refentrytitle>\r
	13	<manvolnum>3G</manvolnum>\r
	14	</refmeta>\r
	15	<refnamediv>\r
	16	<refname>glGetSamplerParameter</refname>\r
	17	<refpurpose>return sampler parameter values</refpurpose>\r
	18	</refnamediv>\r
	19	<refsynopsisdiv><title>C Specification</title>\r
	20	<funcsynopsis>\r
	21	<funcprototype>\r
	22	<funcdef>void <function>glGetSamplerParameterfv</function></funcdef>\r
	23	<paramdef>GLuint <parameter>sampler</parameter></paramdef>\r
	24	<paramdef>GLenum <parameter>pname</parameter></paramdef>\r
	25	<paramdef>GLfloat * <parameter>params</parameter></paramdef>\r
	26	</funcprototype>\r
	27	</funcsynopsis>\r
	28	<funcsynopsis>\r
	29	<funcprototype>\r
	30	<funcdef>void <function>glGetSamplerParameteriv</function></funcdef>\r
	31	<paramdef>GLuint <parameter>sampler</parameter></paramdef>\r
	32	<paramdef>GLenum <parameter>pname</parameter></paramdef>\r
	33	<paramdef>GLint * <parameter>params</parameter></paramdef>\r
	34	</funcprototype>\r
	35	</funcsynopsis>\r
	36	<funcsynopsis>\r
	37	<funcprototype>\r
	38	<funcdef>void <function>glGetSamplerParameterIiv</function></funcdef>\r
	39	<paramdef>GLuint <parameter>sampler</parameter></paramdef>\r
	40	<paramdef>GLenum <parameter>pname</parameter></paramdef>\r
	41	<paramdef>GLint * <parameter>params</parameter></paramdef>\r
	42	</funcprototype>\r
	43	</funcsynopsis>\r
	44	<funcsynopsis>\r
	45	<funcprototype>\r
	46	<funcdef>void <function>glGetSamplerParameterIuiv</function></funcdef>\r
	47	<paramdef>GLuint <parameter>sampler</parameter></paramdef>\r
	48	<paramdef>GLenum <parameter>pname</parameter></paramdef>\r
	49	<paramdef>GLuint * <parameter>params</parameter></paramdef>\r
	50	</funcprototype>\r
	51	</funcsynopsis>\r
	52	</refsynopsisdiv>\r
	53	<!-- eqn: ignoring delim $$ -->\r
	54	<refsect1 id="parameters"><title>Parameters</title>\r
	55	<variablelist>\r
	56	<varlistentry>\r
	57	<term><parameter>sampler</parameter></term>\r
	58	<listitem>\r
	59	<para>\r
	60	Specifies name of the sampler object from which to retrieve parameters.\r
	61	</para>\r
	62	</listitem>\r
	63	</varlistentry>\r
	64	<varlistentry>\r
65	<term><parameter>pname</parameter></term>\r
66	<listitem>\r
67	<para>\r
68	Specifies the symbolic name of a sampler parameter.\r
69	<constant>GL_TEXTURE_MAG_FILTER</constant>,\r
70	<constant>GL_TEXTURE_MIN_FILTER</constant>,\r
71	<constant>GL_TEXTURE_MIN_LOD</constant>,\r
72	<constant>GL_TEXTURE_MAX_LOD</constant>,\r
73	<constant>GL_TEXTURE_LOD_BIAS</constant>,\r
74	<constant>GL_TEXTURE_WRAP_S</constant>,\r
75	<constant>GL_TEXTURE_WRAP_T</constant>,\r
76	<constant>GL_TEXTURE_WRAP_R</constant>,\r
77	<constant>GL_TEXTURE_BORDER_COLOR</constant>,\r
78	<constant>GL_TEXTURE_COMPARE_MODE</constant>, and\r
79	<constant>GL_TEXTURE_COMPARE_FUNC</constant>\r
80	are accepted.\r
81	</para>\r
82	</listitem>\r
83	</varlistentry>\r
84	<varlistentry>\r
85	<term><parameter>params</parameter></term>\r
86	<listitem>\r
87	<para>\r
88	Returns the sampler parameters.\r
89	</para>\r
90	</listitem>\r
91	</varlistentry>\r
92	</variablelist>\r
93	</refsect1>\r
94	<refsect1 id="description"><title>Description</title>\r
95	<para>\r
96	<function>glGetSamplerParameter</function> returns in <parameter>params</parameter> the value or values of the sampler parameter\r
97	specified as <parameter>pname</parameter>.\r
98	<parameter>sampler</parameter> defines the target sampler, and must be the name of an existing sampler object, returned from a previous call\r
99	to <citerefentry><refentrytitle>glGenSamplers</refentrytitle></citerefentry>.\r
100	<parameter>pname</parameter> accepts the same symbols as <citerefentry><refentrytitle>glSamplerParameter</refentrytitle></citerefentry>,\r
101	with the same interpretations:\r
102	</para>\r
103	<variablelist>\r
104	<varlistentry>\r
105	<term><constant>GL_TEXTURE_MAG_FILTER</constant></term>\r
106	<listitem>\r
107	<para>\r
108	Returns the single-valued texture magnification filter,\r
109	a symbolic constant. The initial value is <constant>GL_LINEAR</constant>.\r
110	</para>\r
111	</listitem>\r
112	</varlistentry>\r
113	<varlistentry>\r
114	<term><constant>GL_TEXTURE_MIN_FILTER</constant></term>\r
115	<listitem>\r
116	<para>\r
117	Returns the single-valued texture minification filter,\r
118	a symbolic constant. The initial value is <constant>GL_NEAREST_MIPMAP_LINEAR</constant>.\r
119	</para>\r
120	</listitem>\r
121	</varlistentry>\r
122	<varlistentry>\r
123	<term><constant>GL_TEXTURE_MIN_LOD</constant></term>\r
124	<listitem>\r
125	<para>\r
126	Returns the single-valued texture minimum level-of-detail value. The\r
127	initial value is \r
128	<inlineequation><mml:math>\r
129	<!-- eqn: -1000: -->\r
130	<mml:mn>-1000</mml:mn>\r
131	</mml:math></inlineequation>.\r
132	</para>\r
133	</listitem>\r
134	</varlistentry>\r
135	<varlistentry>\r
136	<term><constant>GL_TEXTURE_MAX_LOD</constant></term>\r
137	<listitem>\r
138	<para>\r
139	Returns the single-valued texture maximum level-of-detail value. The\r
140	initial value is 1000.\r
141	</para>\r
142	</listitem>\r
143	</varlistentry>\r
144	<varlistentry>\r
145	<term><constant>GL_TEXTURE_WRAP_S</constant></term>\r
146	<listitem>\r
147	<para>\r
148	Returns the single-valued wrapping function for texture coordinate \r
149	<inlineequation><mml:math><mml:mi mathvariant="italic">s</mml:mi></mml:math></inlineequation>,\r
150	a symbolic constant. The initial value is <constant>GL_REPEAT</constant>.\r
151	</para>\r
152	</listitem>\r
153	</varlistentry>\r
154	<varlistentry>\r
155	<term><constant>GL_TEXTURE_WRAP_T</constant></term>\r
156	<listitem>\r
157	<para>\r
158	Returns the single-valued wrapping function for texture coordinate \r
159	<inlineequation><mml:math><mml:mi mathvariant="italic">t</mml:mi></mml:math></inlineequation>,\r
160	a symbolic constant. The initial value is <constant>GL_REPEAT</constant>.\r
161	</para>\r
162	</listitem>\r
163	</varlistentry>\r
164	<varlistentry>\r
165	<term><constant>GL_TEXTURE_WRAP_R</constant></term>\r
166	<listitem>\r
167	<para>\r
168	Returns the single-valued wrapping function for texture coordinate \r
169	<inlineequation><mml:math><mml:mi mathvariant="italic">r</mml:mi></mml:math></inlineequation>,\r
170	a symbolic constant. The initial value is <constant>GL_REPEAT</constant>.\r
171	</para>\r
172	</listitem>\r
173	</varlistentry>\r
174	<varlistentry>\r
175	<term><constant>GL_TEXTURE_BORDER_COLOR</constant></term>\r
176	<listitem>\r
177	<para>\r
178	Returns four integer or floating-point numbers that comprise the RGBA color\r
179	of the texture border.\r
180	Floating-point values are returned in the range \r
181	<inlineequation><mml:math>\r
182	<!-- eqn: [0,1]: -->\r
183	<mml:mfenced open="[" close="]">\r
184	<mml:mn>0</mml:mn>\r
185	<mml:mn>1</mml:mn>\r
186	</mml:mfenced>\r
187	</mml:math></inlineequation>.\r
188	Integer values are returned as a linear mapping of the internal floating-point\r
189	representation such that 1.0 maps to the most positive representable\r
190	integer and \r
191	<inlineequation><mml:math>\r
192	<!-- eqn: -1.0: -->\r
193	<mml:mn>-1.0</mml:mn>\r
194	</mml:math></inlineequation>\r
195	maps to the most negative representable\r
196	integer. The initial value is (0, 0, 0, 0).\r
197	</para>\r
198	</listitem>\r
199	</varlistentry>\r
200	<varlistentry>\r
201	<term><constant>GL_TEXTURE_COMPARE_MODE</constant></term>\r
202	<listitem>\r
203	<para>\r
204	Returns a single-valued texture comparison mode, a symbolic constant. The\r
205	initial value is <constant>GL_NONE</constant>. See <citerefentry><refentrytitle>glSamplerParameter</refentrytitle></citerefentry>.\r
206	</para>\r
207	</listitem>\r
208	</varlistentry>\r
209	<varlistentry>\r
210	<term><constant>GL_TEXTURE_COMPARE_FUNC</constant></term>\r
211	<listitem>\r
212	<para>\r
213	Returns a single-valued texture comparison function, a symbolic constant. The\r
214	initial value is <constant>GL_LEQUAL</constant>. See <citerefentry><refentrytitle>glSamplerParameter</refentrytitle></citerefentry>.\r
215	</para>\r
216	</listitem>\r
217	</varlistentry>\r
218	</variablelist>\r
219	</refsect1>\r
220	<refsect1 id="notes"><title>Notes</title>\r
221	<para>\r
222	If an error is generated,\r
223	no change is made to the contents of <parameter>params</parameter>.\r
224	</para>\r
225	<para>\r
226	<function>glGetSamplerParameter</function> is available only if the GL version is 3.3 or higher.\r
227	</para>\r
228	</refsect1>\r
229	<refsect1 id="errors"><title>Errors</title>\r
230	<para>\r
231	<constant>GL_INVALID_VALUE</constant> is generated if <parameter>sampler</parameter> is not the name of a sampler object returned from\r
232	a previous call to <citerefentry><refentrytitle>glGenSamplers</refentrytitle></citerefentry>.\r
233	</para>\r
234	<para>\r
235	<constant>GL_INVALID_ENUM</constant> is generated if <parameter>pname</parameter> is not an accepted value.\r
236	</para>\r
237	</refsect1>\r
238	<refsect1 id="seealso"><title>See Also</title>\r
239	<para>\r
240	<citerefentry><refentrytitle>glSamplerParameter</refentrytitle></citerefentry>,\r
241	<citerefentry><refentrytitle>glGenSamplers</refentrytitle></citerefentry>,\r
242	<citerefentry><refentrytitle>glDeleteSamplers</refentrytitle></citerefentry>,\r
243	<citerefentry><refentrytitle>glSamplerParameter</refentrytitle></citerefentry>\r
244	</para>\r
245	</refsect1>\r
246	<refsect1 id="Copyright"><title>Copyright</title>\r
247	<para>\r
248	Copyright <trademark class="copyright"></trademark> 2010 Khronos Group. \r
249	This material may be distributed subject to the terms and conditions set forth in \r
250	the Open Publication License, v 1.0, 8 June 1999.\r
251	<ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.\r
252	</para>\r
253	</refsect1>\r
254	</refentry>\r