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">
9 <holder>Silicon Graphics, Inc.
</holder>
12 <refentrytitle>glGetConvolutionParameter
</refentrytitle>
13 <manvolnum>3G
</manvolnum>
16 <refname>glGetConvolutionParameter
</refname>
17 <refpurpose>get convolution parameters
</refpurpose>
19 <refsynopsisdiv><title>C Specification
</title>
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>
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>
37 <refsect1 id=
"parameters"><title>Parameters
</title>
40 <term><parameter>target
</parameter></term>
43 The filter whose parameters are to be retrieved.
45 <constant>GL_CONVOLUTION_1D
</constant>,
46 <constant>GL_CONVOLUTION_2D
</constant>, or
47 <constant>GL_SEPARABLE_2D
</constant>.
52 <term><parameter>pname
</parameter></term>
55 The parameter to be retrieved.
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>.
70 <term><parameter>params
</parameter></term>
73 Pointer to storage for the parameters to be retrieved.
79 <refsect1 id=
"description"><title>Description
</title>
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:
87 <term><constant>GL_CONVOLUTION_BORDER_MODE
</constant></term>
92 The convolution border mode.
93 See
<citerefentry><refentrytitle>glConvolutionParameter
</refentrytitle></citerefentry> for a list of border modes.
98 <term><constant>GL_CONVOLUTION_BORDER_COLOR
</constant></term>
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.
110 <term><constant>GL_CONVOLUTION_FILTER_SCALE
</constant></term>
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.
123 <term><constant>GL_CONVOLUTION_FILTER_BIAS
</constant></term>
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
136 <term><constant>GL_CONVOLUTION_FORMAT
</constant></term>
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
149 <term><constant>GL_CONVOLUTION_WIDTH
</constant></term>
154 The current filter image width.
159 <term><constant>GL_CONVOLUTION_HEIGHT
</constant></term>
164 The current filter image height.
169 <term><constant>GL_MAX_CONVOLUTION_WIDTH
</constant></term>
174 The maximum acceptable filter image width.
179 <term><constant>GL_MAX_CONVOLUTION_HEIGHT
</constant></term>
184 The maximum acceptable filter image height.
190 <refsect1 id=
"errors"><title>Errors
</title>
192 <constant>GL_INVALID_ENUM
</constant> is generated if
<parameter>target
</parameter> is not one of the allowable
196 <constant>GL_INVALID_ENUM
</constant> is generated if
<parameter>pname
</parameter> is not one of the allowable
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>.
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>.
210 <refsect1 id=
"seealso"><title>See Also
</title>
212 <citerefentry><refentrytitle>glGetConvolutionFilter
</refentrytitle></citerefentry>,
213 <citerefentry><refentrytitle>glGetSeparableFilter
</refentrytitle></citerefentry>,
214 <citerefentry><refentrytitle>glConvolutionParameter
</refentrytitle></citerefentry>
217 <refsect1 id=
"Copyright"><title>Copyright
</title>
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>.