[clinton/guile-figl.git] / upstream-doc / man2 / glGetConvolutionParameter.xml

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"
              "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">
<refentry id="glGetConvolutionParameter">
    <refmeta>
        <refmetainfo>
            <copyright>
                <year>1991-2006</year>
                <holder>Silicon Graphics, Inc.</holder>
            </copyright>
        </refmetainfo>
        <refentrytitle>glGetConvolutionParameter</refentrytitle>
        <manvolnum>3G</manvolnum>
    </refmeta>
    <refnamediv>
        <refname>glGetConvolutionParameter</refname>
        <refpurpose>get convolution parameters</refpurpose>
    </refnamediv>
    <refsynopsisdiv><title>C Specification</title>
        <funcsynopsis>
            <funcprototype>
                <funcdef>void <function>glGetConvolutionParameterfv</function></funcdef>
                <paramdef>GLenum <parameter>target</parameter></paramdef>
                <paramdef>GLenum <parameter>pname</parameter></paramdef>
                <paramdef>GLfloat * <parameter>params</parameter></paramdef>
            </funcprototype>
        </funcsynopsis>
        <funcsynopsis>
            <funcprototype>
                <funcdef>void <function>glGetConvolutionParameteriv</function></funcdef>
                <paramdef>GLenum <parameter>target</parameter></paramdef>
                <paramdef>GLenum <parameter>pname</parameter></paramdef>
                <paramdef>GLint * <parameter>params</parameter></paramdef>
            </funcprototype>
        </funcsynopsis>
    </refsynopsisdiv>
    <refsect1 id="parameters"><title>Parameters</title>
        <variablelist>
        <varlistentry>
            <term><parameter>target</parameter></term>
            <listitem>
                <para>
                    The filter whose parameters are to be retrieved.
                    Must be one of
                    <constant>GL_CONVOLUTION_1D</constant>,
                    <constant>GL_CONVOLUTION_2D</constant>, or
                    <constant>GL_SEPARABLE_2D</constant>.
                </para>
            </listitem>
        </varlistentry>
        <varlistentry>
            <term><parameter>pname</parameter></term>
            <listitem>
                <para>
                    The parameter to be retrieved.
                    Must be one of
                    <constant>GL_CONVOLUTION_BORDER_MODE</constant>,
                    <constant>GL_CONVOLUTION_BORDER_COLOR</constant>,
                    <constant>GL_CONVOLUTION_FILTER_SCALE</constant>,
                    <constant>GL_CONVOLUTION_FILTER_BIAS</constant>,
                    <constant>GL_CONVOLUTION_FORMAT</constant>,
                    <constant>GL_CONVOLUTION_WIDTH</constant>,
                    <constant>GL_CONVOLUTION_HEIGHT</constant>,
                    <constant>GL_MAX_CONVOLUTION_WIDTH</constant>, or
                    <constant>GL_MAX_CONVOLUTION_HEIGHT</constant>.
                </para>
            </listitem>
        </varlistentry>
        <varlistentry>
            <term><parameter>params</parameter></term>
            <listitem>
                <para>
                    Pointer to storage for the parameters to be retrieved.
                </para>
            </listitem>
        </varlistentry>
        </variablelist>
    </refsect1>
    <refsect1 id="description"><title>Description</title>
        <para>
            <function>glGetConvolutionParameter</function> retrieves convolution parameters.
            <parameter>target</parameter> determines which convolution filter is queried.
            <parameter>pname</parameter> determines which parameter is returned:
        </para>
        <variablelist>
            <varlistentry>
                <term><constant>GL_CONVOLUTION_BORDER_MODE</constant></term>
                <listitem>
			  <para>
			  </para>
                    <para>
                        The convolution border mode.
                        See <citerefentry><refentrytitle>glConvolutionParameter</refentrytitle></citerefentry> for a list of border modes.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term><constant>GL_CONVOLUTION_BORDER_COLOR</constant></term>
                <listitem>
			  <para>
			  </para>
                    <para>
                        The current convolution border color.
                        <parameter>params</parameter> must be a pointer to an array of four elements,
                        which will receive the red, green, blue, and alpha border colors.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term><constant>GL_CONVOLUTION_FILTER_SCALE</constant></term>
                <listitem>
			  <para>
			  </para>
                    <para>
                        The current filter scale factors.
                        <parameter>params</parameter> must be a pointer to an array of four elements,
                        which will receive the red, green, blue, and alpha filter scale
                        factors in that order.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term><constant>GL_CONVOLUTION_FILTER_BIAS</constant></term>
                <listitem>
			  <para>
			  </para>
                    <para>
                        The current filter bias factors.
                        <parameter>params</parameter> must be a pointer to an array of four elements,
                        which will receive the red, green, blue, and alpha filter bias
                        terms in that order.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term><constant>GL_CONVOLUTION_FORMAT</constant></term>
                <listitem>
			  <para>
			  </para>
                    <para>
                        The current internal format.
                        See <citerefentry><refentrytitle>glConvolutionFilter1D</refentrytitle></citerefentry>, <citerefentry><refentrytitle>glConvolutionFilter2D</refentrytitle></citerefentry>,
                        and <citerefentry><refentrytitle>glSeparableFilter2D</refentrytitle></citerefentry> for lists of allowable
                        formats.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term><constant>GL_CONVOLUTION_WIDTH</constant></term>
                <listitem>
			  <para>
			  </para>
                    <para>
                        The current filter image width.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term><constant>GL_CONVOLUTION_HEIGHT</constant></term>
                <listitem>
			  <para>
			  </para>
                    <para>
                        The current filter image height.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term><constant>GL_MAX_CONVOLUTION_WIDTH</constant></term>
                <listitem>
			  <para>
			  </para>
                    <para>
                        The maximum acceptable filter image width.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term><constant>GL_MAX_CONVOLUTION_HEIGHT</constant></term>
                <listitem>
			  <para>
			  </para>
                    <para>
                        The maximum acceptable filter image height.
                    </para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsect1>
    <refsect1 id="errors"><title>Errors</title>
        <para>
            <constant>GL_INVALID_ENUM</constant> is generated if <parameter>target</parameter> is not one of the allowable
            values.
        </para>
        <para>
            <constant>GL_INVALID_ENUM</constant> is generated if <parameter>pname</parameter> is not one of the allowable
            values.
        </para>
        <para>
            <constant>GL_INVALID_ENUM</constant> is generated if <parameter>target</parameter> is <constant>GL_CONVOLUTION_1D</constant>
            and <parameter>pname</parameter> is <constant>GL_CONVOLUTION_HEIGHT</constant> or
            <constant>GL_MAX_CONVOLUTION_HEIGHT</constant>.
        </para>
        <para>
            <constant>GL_INVALID_OPERATION</constant> is generated if <function>glGetConvolutionParameter</function> is executed
            between the execution of <citerefentry><refentrytitle>glBegin</refentrytitle></citerefentry> and the corresponding
            execution of <citerefentry><refentrytitle>glEnd</refentrytitle></citerefentry>.
        </para>
    </refsect1>
    <refsect1 id="seealso"><title>See Also</title>
        <para>
            <citerefentry><refentrytitle>glGetConvolutionFilter</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>glGetSeparableFilter</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>glConvolutionParameter</refentrytitle></citerefentry>
        </para>
    </refsect1>
    <refsect1 id="Copyright"><title>Copyright</title>
        <para>
            Copyright <trademark class="copyright"></trademark> 1991-2006
            Silicon Graphics, Inc. This document is licensed under the SGI
            Free Software B License. For details, see
            <ulink url="http://oss.sgi.com/projects/FreeB/">http://oss.sgi.com/projects/FreeB/</ulink>.
        </para>
    </refsect1>
</refentry>
Commit	Line	Data
7faf1d71 AW	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="glGetConvolutionParameter">
	5	<refmeta>
	6	<refmetainfo>
	7	<copyright>
	8	<year>1991-2006</year>
	9	<holder>Silicon Graphics, Inc.</holder>
	10	</copyright>
	11	</refmetainfo>
	12	<refentrytitle>glGetConvolutionParameter</refentrytitle>
	13	<manvolnum>3G</manvolnum>
	14	</refmeta>
	15	<refnamediv>
	16	<refname>glGetConvolutionParameter</refname>
	17	<refpurpose>get convolution parameters</refpurpose>
	18	</refnamediv>
	19	<refsynopsisdiv><title>C Specification</title>
	20	<funcsynopsis>
	21	<funcprototype>
	22	<funcdef>void <function>glGetConvolutionParameterfv</function></funcdef>
	23	<paramdef>GLenum <parameter>target</parameter></paramdef>
	24	<paramdef>GLenum <parameter>pname</parameter></paramdef>
	25	<paramdef>GLfloat * <parameter>params</parameter></paramdef>
	26	</funcprototype>
	27	</funcsynopsis>
	28	<funcsynopsis>
	29	<funcprototype>
	30	<funcdef>void <function>glGetConvolutionParameteriv</function></funcdef>
	31	<paramdef>GLenum <parameter>target</parameter></paramdef>
	32	<paramdef>GLenum <parameter>pname</parameter></paramdef>
	33	<paramdef>GLint * <parameter>params</parameter></paramdef>
	34	</funcprototype>
	35	</funcsynopsis>
	36	</refsynopsisdiv>
	37	<refsect1 id="parameters"><title>Parameters</title>
	38	<variablelist>
	39	<varlistentry>
	40	<term><parameter>target</parameter></term>
	41	<listitem>
	42	<para>
	43	The filter whose parameters are to be retrieved.
	44	Must be one of
	45	<constant>GL_CONVOLUTION_1D</constant>,
	46	<constant>GL_CONVOLUTION_2D</constant>, or
	47	<constant>GL_SEPARABLE_2D</constant>.
	48	</para>
	49	</listitem>
	50	</varlistentry>
	51	<varlistentry>
	52	<term><parameter>pname</parameter></term>
	53	<listitem>
	54	<para>
	55	The parameter to be retrieved.
	56	Must be one of
	57	<constant>GL_CONVOLUTION_BORDER_MODE</constant>,
	58	<constant>GL_CONVOLUTION_BORDER_COLOR</constant>,
	59	<constant>GL_CONVOLUTION_FILTER_SCALE</constant>,
	60	<constant>GL_CONVOLUTION_FILTER_BIAS</constant>,
	61	<constant>GL_CONVOLUTION_FORMAT</constant>,
	62	<constant>GL_CONVOLUTION_WIDTH</constant>,
	63	<constant>GL_CONVOLUTION_HEIGHT</constant>,
	64	<constant>GL_MAX_CONVOLUTION_WIDTH</constant>, or
65	<constant>GL_MAX_CONVOLUTION_HEIGHT</constant>.
66	</para>
67	</listitem>
68	</varlistentry>
69	<varlistentry>
70	<term><parameter>params</parameter></term>
71	<listitem>
72	<para>
73	Pointer to storage for the parameters to be retrieved.
74	</para>
75	</listitem>
76	</varlistentry>
77	</variablelist>
78	</refsect1>
79	<refsect1 id="description"><title>Description</title>
80	<para>
81	<function>glGetConvolutionParameter</function> retrieves convolution parameters.
82	<parameter>target</parameter> determines which convolution filter is queried.
83	<parameter>pname</parameter> determines which parameter is returned:
84	</para>
85	<variablelist>
86	<varlistentry>
87	<term><constant>GL_CONVOLUTION_BORDER_MODE</constant></term>
88	<listitem>
89	<para>
90	</para>
91	<para>
92	The convolution border mode.
93	See <citerefentry><refentrytitle>glConvolutionParameter</refentrytitle></citerefentry> for a list of border modes.
94	</para>
95	</listitem>
96	</varlistentry>
97	<varlistentry>
98	<term><constant>GL_CONVOLUTION_BORDER_COLOR</constant></term>
99	<listitem>
100	<para>
101	</para>
102	<para>
103	The current convolution border color.
104	<parameter>params</parameter> must be a pointer to an array of four elements,
105	which will receive the red, green, blue, and alpha border colors.
106	</para>
107	</listitem>
108	</varlistentry>
109	<varlistentry>
110	<term><constant>GL_CONVOLUTION_FILTER_SCALE</constant></term>
111	<listitem>
112	<para>
113	</para>
114	<para>
115	The current filter scale factors.
116	<parameter>params</parameter> must be a pointer to an array of four elements,
117	which will receive the red, green, blue, and alpha filter scale
118	factors in that order.
119	</para>
120	</listitem>
121	</varlistentry>
122	<varlistentry>
123	<term><constant>GL_CONVOLUTION_FILTER_BIAS</constant></term>
124	<listitem>
125	<para>
126	</para>
127	<para>
128	The current filter bias factors.
129	<parameter>params</parameter> must be a pointer to an array of four elements,
130	which will receive the red, green, blue, and alpha filter bias
131	terms in that order.
132	</para>
133	</listitem>
134	</varlistentry>
135	<varlistentry>
136	<term><constant>GL_CONVOLUTION_FORMAT</constant></term>
137	<listitem>
138	<para>
139	</para>
140	<para>
141	The current internal format.
142	See <citerefentry><refentrytitle>glConvolutionFilter1D</refentrytitle></citerefentry>, <citerefentry><refentrytitle>glConvolutionFilter2D</refentrytitle></citerefentry>,
143	and <citerefentry><refentrytitle>glSeparableFilter2D</refentrytitle></citerefentry> for lists of allowable
144	formats.
145	</para>
146	</listitem>
147	</varlistentry>
148	<varlistentry>
149	<term><constant>GL_CONVOLUTION_WIDTH</constant></term>
150	<listitem>
151	<para>
152	</para>
153	<para>
154	The current filter image width.
155	</para>
156	</listitem>
157	</varlistentry>
158	<varlistentry>
159	<term><constant>GL_CONVOLUTION_HEIGHT</constant></term>
160	<listitem>
161	<para>
162	</para>
163	<para>
164	The current filter image height.
165	</para>
166	</listitem>
167	</varlistentry>
168	<varlistentry>
169	<term><constant>GL_MAX_CONVOLUTION_WIDTH</constant></term>
170	<listitem>
171	<para>
172	</para>
173	<para>
174	The maximum acceptable filter image width.
175	</para>
176	</listitem>
177	</varlistentry>
178	<varlistentry>
179	<term><constant>GL_MAX_CONVOLUTION_HEIGHT</constant></term>
180	<listitem>
181	<para>
182	</para>
183	<para>
184	The maximum acceptable filter image height.
185	</para>
186	</listitem>
187	</varlistentry>
188	</variablelist>
189	</refsect1>
190	<refsect1 id="errors"><title>Errors</title>
191	<para>
192	<constant>GL_INVALID_ENUM</constant> is generated if <parameter>target</parameter> is not one of the allowable
193	values.
194	</para>
195	<para>
196	<constant>GL_INVALID_ENUM</constant> is generated if <parameter>pname</parameter> is not one of the allowable
197	values.
198	</para>
199	<para>
200	<constant>GL_INVALID_ENUM</constant> is generated if <parameter>target</parameter> is <constant>GL_CONVOLUTION_1D</constant>
201	and <parameter>pname</parameter> is <constant>GL_CONVOLUTION_HEIGHT</constant> or
202	<constant>GL_MAX_CONVOLUTION_HEIGHT</constant>.
203	</para>
204	<para>
205	<constant>GL_INVALID_OPERATION</constant> is generated if <function>glGetConvolutionParameter</function> is executed
206	between the execution of <citerefentry><refentrytitle>glBegin</refentrytitle></citerefentry> and the corresponding
207	execution of <citerefentry><refentrytitle>glEnd</refentrytitle></citerefentry>.
208	</para>
209	</refsect1>
210	<refsect1 id="seealso"><title>See Also</title>
211	<para>
212	<citerefentry><refentrytitle>glGetConvolutionFilter</refentrytitle></citerefentry>,
213	<citerefentry><refentrytitle>glGetSeparableFilter</refentrytitle></citerefentry>,
214	<citerefentry><refentrytitle>glConvolutionParameter</refentrytitle></citerefentry>
215	</para>
216	</refsect1>
217	<refsect1 id="Copyright"><title>Copyright</title>
218	<para>
219	Copyright <trademark class="copyright"></trademark> 1991-2006
220	Silicon Graphics, Inc. This document is licensed under the SGI
221	Free Software B License. For details, see
222	<ulink url="http://oss.sgi.com/projects/FreeB/">http://oss.sgi.com/projects/FreeB/</ulink>.
223	</para>
224	</refsect1>
225	</refentry>