1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56
|
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.1 plus MathML 2.0//EN" "http://www.w3.org/TR/MathML2/dtd/xhtml-math11-f.dtd">
<html
xmlns="http://www.w3.org/1999/xhtml"
xmlns:mml="http://www.w3.org/1998/Math/MathML"
><head><title>glGetConvolutionParameter</title><link rel="stylesheet" href="style.css" type="text/css"/><meta name="generator" content="DocBook XSL Stylesheets V1.59.1"/><link rel="home" href="index.xml" title="PyOpenGL 2.0.1.07 Man Pages"/><link rel="up" href="reference-GL.xml" title="GL"/><link rel="previous" href="glGetConvolutionFilter.3G.xml" title="glGetConvolutionFilter"/><link rel="next" href="glGetError.3G.xml" title="glGetError"/></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">glGetConvolutionParameter</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="glGetConvolutionFilter.3G.xml">Prev</a></td><th width="60%" align="center">GL</th><td width="20%" align="right"><a accesskey="n" href="glGetError.3G.xml">Next</a></td></tr></table><hr/></div><div class="refentry" lang="en"><a name="glGetConvolutionParameter.3G"/><div class="titlepage"/><div class="refnamediv"><a name="glGetConvolutionParameter.3G-name"/><h2>Name</h2><p>glGetConvolutionParameterfv, glGetConvolutionParameteriv — get convolution parameters</p></div><div class="refsynopsisdiv"><a name="glGetConvolutionParameter.3G-c_spec"/><h2>C Specification</h2><table class="funcprototype" border="0" cellpadding="0" cellspacing="0"><tr><td valign="top"><code>void<tt>glGetConvolutionParameterfv</tt></code></td><td valign="top"><code>(</code></td><td valign="top"><code>GLenum<i><tt>target</tt></i>, GLenum<i><tt>pname</tt></i>, GLfloat*<i><tt>params</tt></i>);</code></td></tr><tr><td valign="top"><code>void<tt>glGetConvolutionParameteriv</tt></code></td><td valign="top"><code>(</code></td><td valign="top"><code>GLenum<i><tt>target</tt></i>, GLenum<i><tt>pname</tt></i>, GLint*<i><tt>params</tt></i>);</code></td></tr></table></div><div class="refsynopsisdiv"><a name="glGetConvolutionParameter.3G-python_spec"/><h2>Python Specification</h2><table class="funcprototype" border="0" cellpadding="0" cellspacing="0"><tr><td valign="top"><code><tt>glGetConvolutionParameterfv</tt></code></td><td valign="top"><code>(</code></td><td valign="top"><code><i><tt>target</tt></i>, <i><tt>pname</tt></i>) →<i><tt>params</tt></i></code></td></tr><tr><td valign="top"><code><tt>glGetConvolutionParameteriv</tt></code></td><td valign="top"><code>(</code></td><td valign="top"><code><i><tt>target</tt></i>, <i><tt>pname</tt></i>) →<i><tt>params</tt></i></code></td></tr></table></div><div class="refsect1" lang="en"><a name="glGetConvolutionParameter.3G-parameters"/><h2>Parameters</h2><div class="variablelist"><dl><dt><span class="term"><i><tt>target</tt></i></span></dt><dd>
The filter whose parameters are to be retrieved. Must be one of <tt>GL_CONVOLUTION_1D</tt>,
<tt>GL_CONVOLUTION_2D</tt>, or <tt>GL_SEPARABLE_2D</tt>.
</dd><dt><span class="term"><i><tt>pname</tt></i></span></dt><dd>
The parameter to be retrieved. Must be one of <tt>GL_CONVOLUTION_BORDER_MODE</tt>,
<tt>GL_CONVOLUTION_BORDER_COLOR</tt>, <tt>GL_CONVOLUTION_FILTER_SCALE</tt>,
<tt>GL_CONVOLUTION_FILTER_BIAS</tt>, <tt>GL_CONVOLUTION_FORMAT</tt>,
<tt>GL_CONVOLUTION_WIDTH</tt>, <tt>GL_CONVOLUTION_HEIGHT</tt>,
<tt>GL_MAX_CONVOLUTION_WIDTH</tt>, or <tt>GL_MAX_CONVOLUTION_HEIGHT</tt>.
</dd><dt><span class="term"><i><tt>params</tt></i></span></dt><dd>
Pointer to storage for the parameters to be retrieved.
</dd></dl></div></div><div class="refsect1" lang="en"><a name="glGetConvolutionParameter.3G-description"/><h2>Description</h2><p>
<tt>glGetConvolutionParameter</tt> retrieves convolution parameters.
<i><tt>target</tt></i> determines which convolution filter is queried. <i><tt>pname</tt></i> determines
which parameter is returned:
</p><div class="variablelist"><dl><dt><span class="term"><tt>GL_CONVOLUTION_BORDER_MODE</tt></span></dt><dd>
The convolution border mode. See <tt>glConvolutionParameter</tt> for a list
of border modes.
</dd><dt><span class="term"><tt>GL_CONVOLUTION_BORDER_COLOR</tt></span></dt><dd>
The current convolution border color. <i><tt>params</tt></i> must be a pointer to an array of four
elements, which will receive the red, green, blue, and alpha border colors.
</dd><dt><span class="term"><tt>GL_CONVOLUTION_FILTER_SCALE</tt></span></dt><dd>
The current filter scale factors. <i><tt>params</tt></i> 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.
</dd><dt><span class="term"><tt>GL_CONVOLUTION_FILTER_BIAS</tt></span></dt><dd>
The current filter bias factors. <i><tt>params</tt></i> 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.
</dd><dt><span class="term"><tt>GL_CONVOLUTION_FORMAT</tt></span></dt><dd>
The current internal . See <a href="glConvolutionFilter1D.3G.xml"><tt>glConvolutionFilter1D</tt></a>, <a href="glConvolutionFilter2D.3G.xml"><tt>glConvolutionFilter2D</tt></a>, and <a href="glSeparableFilter2D.3G.xml"><tt>glSeparableFilter2D</tt></a> for lists of allowable formats.
</dd><dt><span class="term"><tt>GL_CONVOLUTION_WIDTH</tt></span></dt><dd>
The current filter image width.
</dd><dt><span class="term"><tt>GL_CONVOLUTION_HEIGHT</tt></span></dt><dd>
The current filter image height.
</dd><dt><span class="term"><tt>GL_MAX_CONVOLUTION_WIDTH</tt></span></dt><dd>
The maximum acceptable filter image width.
</dd><dt><span class="term"><tt>GL_MAX_CONVOLUTION_HEIGHT</tt></span></dt><dd>
The maximum acceptable filter image height.
</dd></dl></div></div><div class="refsect1" lang="en"><a name="glGetConvolutionParameter.3G-errors"/><h2>Errors</h2><p>
<tt>GL_INVALID_ENUM</tt> is generated if <i><tt>target</tt></i> is not one of the allowable values.
</p><p>
<tt>GL_INVALID_ENUM</tt> is generated if <i><tt>pname</tt></i> is not one of the allowable values.
</p><p>
<tt>GL_INVALID_ENUM</tt> is generated if <i><tt>target</tt></i> is
<tt>GL_CONVOLUTION_1D</tt> and <i><tt>pname</tt></i> is <tt>GL_CONVOLUTION_HEIGHT</tt>
or <tt>GL_MAX_CONVOLUTION_HEIGHT</tt>.
</p><p>
<tt>GL_INVALID_OPERATION</tt> is generated if <tt>glGetConvolutionParameter</tt> is executed between the execution of <a href="glBegin.3G.xml"><tt>glBegin</tt></a> and the corresponding execution of <a href="glBegin.3G.xml"><tt>glEnd</tt></a>.
</p></div><div class="refsect1" lang="en"><a name="glGetConvolutionParameter.3G-see_also"/><h2>See Also</h2><p>
<span class="simplelist"><a href="glGetConvolutionFilter.3G.xml">glGetConvolutionFilter</a>, <a href="glGetSeparableFilter2D.3G.xml">glGetSeparableFilter2D</a>, <a href="glConvolutionParameter.3G.xml">glConvolutionParameter</a></span>
</p></div></div><div class="navfooter"><hr/><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="glGetConvolutionFilter.3G.xml">Prev</a></td><td width="20%" align="center"><a accesskey="u" href="reference-GL.xml">Up</a></td><td width="40%" align="right"><a accesskey="n" href="glGetError.3G.xml">Next</a></td></tr><tr><td width="40%" align="left" valign="top">glGetConvolutionFilter</td><td width="20%" align="center"><a accesskey="h" href="index.xml">Home</a></td><td width="40%" align="right" valign="top">glGetError</td></tr></table></div></body></html>
|