Commit | Line | Data |
---|---|---|
7faf1d71 AW |
1 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd"> |
2 | <!-- saved from url=(0013)about:internet --> | |
3 | <?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" /><title>glGetConvolutionParameter</title><meta name="generator" content="DocBook XSL Stylesheets V1.73.2" /></head><body><div class="refentry" lang="en" xml:lang="en"><a id="glGetConvolutionParameter"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glGetConvolutionParameter — get convolution parameters</p></div><div class="refsynopsisdiv"><h2>C Specification</h2><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"><tr><td><code class="funcdef">void <b class="fsfunc">glGetConvolutionParameterfv</b>(</code></td><td>GLenum </td><td><var class="pdparam">target</var>, </td></tr><tr><td> </td><td>GLenum </td><td><var class="pdparam">pname</var>, </td></tr><tr><td> </td><td>GLfloat * </td><td><var class="pdparam">params</var><code>)</code>;</td></tr></table></div><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"><tr><td><code class="funcdef">void <b class="fsfunc">glGetConvolutionParameteriv</b>(</code></td><td>GLenum </td><td><var class="pdparam">target</var>, </td></tr><tr><td> </td><td>GLenum </td><td><var class="pdparam">pname</var>, </td></tr><tr><td> </td><td>GLint * </td><td><var class="pdparam">params</var><code>)</code>;</td></tr></table></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="parameters"></a><h2>Parameters</h2><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>target</code></em></span></dt><dd><p> | |
4 | The filter whose parameters are to be retrieved. | |
5 | Must be one of | |
6 | <code class="constant">GL_CONVOLUTION_1D</code>, | |
7 | <code class="constant">GL_CONVOLUTION_2D</code>, or | |
8 | <code class="constant">GL_SEPARABLE_2D</code>. | |
9 | </p></dd><dt><span class="term"><em class="parameter"><code>pname</code></em></span></dt><dd><p> | |
10 | The parameter to be retrieved. | |
11 | Must be one of | |
12 | <code class="constant">GL_CONVOLUTION_BORDER_MODE</code>, | |
13 | <code class="constant">GL_CONVOLUTION_BORDER_COLOR</code>, | |
14 | <code class="constant">GL_CONVOLUTION_FILTER_SCALE</code>, | |
15 | <code class="constant">GL_CONVOLUTION_FILTER_BIAS</code>, | |
16 | <code class="constant">GL_CONVOLUTION_FORMAT</code>, | |
17 | <code class="constant">GL_CONVOLUTION_WIDTH</code>, | |
18 | <code class="constant">GL_CONVOLUTION_HEIGHT</code>, | |
19 | <code class="constant">GL_MAX_CONVOLUTION_WIDTH</code>, or | |
20 | <code class="constant">GL_MAX_CONVOLUTION_HEIGHT</code>. | |
21 | </p></dd><dt><span class="term"><em class="parameter"><code>params</code></em></span></dt><dd><p> | |
22 | Pointer to storage for the parameters to be retrieved. | |
23 | </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p> | |
24 | <code class="function">glGetConvolutionParameter</code> retrieves convolution parameters. | |
25 | <em class="parameter"><code>target</code></em> determines which convolution filter is queried. | |
26 | <em class="parameter"><code>pname</code></em> determines which parameter is returned: | |
27 | </p><div class="variablelist"><dl><dt><span class="term"><code class="constant">GL_CONVOLUTION_BORDER_MODE</code></span></dt><dd><p> | |
28 | </p><p> | |
29 | The convolution border mode. | |
30 | See <a class="citerefentry" href="glConvolutionParameter.xml"><span class="citerefentry"><span class="refentrytitle">glConvolutionParameter</span></span></a> for a list of border modes. | |
31 | </p></dd><dt><span class="term"><code class="constant">GL_CONVOLUTION_BORDER_COLOR</code></span></dt><dd><p> | |
32 | </p><p> | |
33 | The current convolution border color. | |
34 | <em class="parameter"><code>params</code></em> must be a pointer to an array of four elements, | |
35 | which will receive the red, green, blue, and alpha border colors. | |
36 | </p></dd><dt><span class="term"><code class="constant">GL_CONVOLUTION_FILTER_SCALE</code></span></dt><dd><p> | |
37 | </p><p> | |
38 | The current filter scale factors. | |
39 | <em class="parameter"><code>params</code></em> must be a pointer to an array of four elements, | |
40 | which will receive the red, green, blue, and alpha filter scale | |
41 | factors in that order. | |
42 | </p></dd><dt><span class="term"><code class="constant">GL_CONVOLUTION_FILTER_BIAS</code></span></dt><dd><p> | |
43 | </p><p> | |
44 | The current filter bias factors. | |
45 | <em class="parameter"><code>params</code></em> must be a pointer to an array of four elements, | |
46 | which will receive the red, green, blue, and alpha filter bias | |
47 | terms in that order. | |
48 | </p></dd><dt><span class="term"><code class="constant">GL_CONVOLUTION_FORMAT</code></span></dt><dd><p> | |
49 | </p><p> | |
50 | The current internal format. | |
51 | See <a class="citerefentry" href="glConvolutionFilter1D.xml"><span class="citerefentry"><span class="refentrytitle">glConvolutionFilter1D</span></span></a>, <a class="citerefentry" href="glConvolutionFilter2D.xml"><span class="citerefentry"><span class="refentrytitle">glConvolutionFilter2D</span></span></a>, | |
52 | and <a class="citerefentry" href="glSeparableFilter2D.xml"><span class="citerefentry"><span class="refentrytitle">glSeparableFilter2D</span></span></a> for lists of allowable | |
53 | formats. | |
54 | </p></dd><dt><span class="term"><code class="constant">GL_CONVOLUTION_WIDTH</code></span></dt><dd><p> | |
55 | </p><p> | |
56 | The current filter image width. | |
57 | </p></dd><dt><span class="term"><code class="constant">GL_CONVOLUTION_HEIGHT</code></span></dt><dd><p> | |
58 | </p><p> | |
59 | The current filter image height. | |
60 | </p></dd><dt><span class="term"><code class="constant">GL_MAX_CONVOLUTION_WIDTH</code></span></dt><dd><p> | |
61 | </p><p> | |
62 | The maximum acceptable filter image width. | |
63 | </p></dd><dt><span class="term"><code class="constant">GL_MAX_CONVOLUTION_HEIGHT</code></span></dt><dd><p> | |
64 | </p><p> | |
65 | The maximum acceptable filter image height. | |
66 | </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p> | |
67 | <code class="constant">GL_INVALID_ENUM</code> is generated if <em class="parameter"><code>target</code></em> is not one of the allowable | |
68 | values. | |
69 | </p><p> | |
70 | <code class="constant">GL_INVALID_ENUM</code> is generated if <em class="parameter"><code>pname</code></em> is not one of the allowable | |
71 | values. | |
72 | </p><p> | |
73 | <code class="constant">GL_INVALID_ENUM</code> is generated if <em class="parameter"><code>target</code></em> is <code class="constant">GL_CONVOLUTION_1D</code> | |
74 | and <em class="parameter"><code>pname</code></em> is <code class="constant">GL_CONVOLUTION_HEIGHT</code> or | |
75 | <code class="constant">GL_MAX_CONVOLUTION_HEIGHT</code>. | |
76 | </p><p> | |
77 | <code class="constant">GL_INVALID_OPERATION</code> is generated if <code class="function">glGetConvolutionParameter</code> is executed | |
78 | between the execution of <a class="citerefentry" href="glBegin.xml"><span class="citerefentry"><span class="refentrytitle">glBegin</span></span></a> and the corresponding | |
79 | execution of <a class="citerefentry" href="glEnd.xml"><span class="citerefentry"><span class="refentrytitle">glEnd</span></span></a>. | |
80 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p> | |
81 | <a class="citerefentry" href="glGetConvolutionFilter.xml"><span class="citerefentry"><span class="refentrytitle">glGetConvolutionFilter</span></span></a>, | |
82 | <a class="citerefentry" href="glGetSeparableFilter.xml"><span class="citerefentry"><span class="refentrytitle">glGetSeparableFilter</span></span></a>, | |
83 | <a class="citerefentry" href="glConvolutionParameter.xml"><span class="citerefentry"><span class="refentrytitle">glConvolutionParameter</span></span></a> | |
84 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p> | |
85 | Copyright <span class="trademark"></span>© 1991-2006 | |
86 | Silicon Graphics, Inc. This document is licensed under the SGI | |
87 | Free Software B License. For details, see | |
88 | <a class="ulink" href="http://oss.sgi.com/projects/FreeB/" target="_top">http://oss.sgi.com/projects/FreeB/</a>. | |
89 | </p></div></div></body></html> |