1GLGETCONVOLUTIONPARA(3G)         OpenGL Manual        GLGETCONVOLUTIONPARA(3G)
2
3
4

NAME

6       glGetConvolutionParameter - get convolution parameters
7

C SPECIFICATION

9       void glGetConvolutionParameterfv(GLenum target, GLenum pname,
10                                        GLfloat * params);
11
12       void glGetConvolutionParameteriv(GLenum target, GLenum pname,
13                                        GLint * params);
14

PARAMETERS

16       target
17           The filter whose parameters are to be retrieved. Must be one of
18           GL_CONVOLUTION_1D, GL_CONVOLUTION_2D, or GL_SEPARABLE_2D.
19
20       pname
21           The parameter to be retrieved. Must be one of
22           GL_CONVOLUTION_BORDER_MODE, GL_CONVOLUTION_BORDER_COLOR,
23           GL_CONVOLUTION_FILTER_SCALE, GL_CONVOLUTION_FILTER_BIAS,
24           GL_CONVOLUTION_FORMAT, GL_CONVOLUTION_WIDTH, GL_CONVOLUTION_HEIGHT,
25           GL_MAX_CONVOLUTION_WIDTH, or GL_MAX_CONVOLUTION_HEIGHT.
26
27       params
28           Pointer to storage for the parameters to be retrieved.
29

DESCRIPTION

31       glGetConvolutionParameter retrieves convolution parameters.  target
32       determines which convolution filter is queried.  pname determines which
33       parameter is returned:
34
35       GL_CONVOLUTION_BORDER_MODE
36
37           The convolution border mode. See glConvolutionParameter() for a
38           list of border modes.
39
40       GL_CONVOLUTION_BORDER_COLOR
41
42           The current convolution border color.  params must be a pointer to
43           an array of four elements, which will receive the red, green, blue,
44           and alpha border colors.
45
46       GL_CONVOLUTION_FILTER_SCALE
47
48           The current filter scale factors.  params must be a pointer to an
49           array of four elements, which will receive the red, green, blue,
50           and alpha filter scale factors in that order.
51
52       GL_CONVOLUTION_FILTER_BIAS
53
54           The current filter bias factors.  params must be a pointer to an
55           array of four elements, which will receive the red, green, blue,
56           and alpha filter bias terms in that order.
57
58       GL_CONVOLUTION_FORMAT
59
60           The current internal format. See glConvolutionFilter1D(),
61           glConvolutionFilter2D(), and glSeparableFilter2D() for lists of
62           allowable formats.
63
64       GL_CONVOLUTION_WIDTH
65
66           The current filter image width.
67
68       GL_CONVOLUTION_HEIGHT
69
70           The current filter image height.
71
72       GL_MAX_CONVOLUTION_WIDTH
73
74           The maximum acceptable filter image width.
75
76       GL_MAX_CONVOLUTION_HEIGHT
77
78           The maximum acceptable filter image height.
79

ERRORS

81       GL_INVALID_ENUM is generated if target is not one of the allowable
82       values.
83
84       GL_INVALID_ENUM is generated if pname is not one of the allowable
85       values.
86
87       GL_INVALID_ENUM is generated if target is GL_CONVOLUTION_1D and pname
88       is GL_CONVOLUTION_HEIGHT or GL_MAX_CONVOLUTION_HEIGHT.
89
90       GL_INVALID_OPERATION is generated if glGetConvolutionParameter is
91       executed between the execution of glBegin() and the corresponding
92       execution of glEnd().
93

SEE ALSO

95       glGetConvolutionFilter(), glGetSeparableFilter(),
96       glConvolutionParameter()
97

99       Copyright © 1991-2006 Silicon Graphics, Inc. This document is licensed
100       under the SGI Free Software B License. For details, see
101       http://oss.sgi.com/projects/FreeB/.
102

AUTHORS

104       opengl.org
105
106
107
108opengl.org                        07/13/2018          GLGETCONVOLUTIONPARA(3G)
Impressum