MyWebUniversity.com Home Page
 



Darwin Mac OS X man pages main menu
GLGETCONVOLUTIONPARAMETER(3G)                    GLGETCONVOLUTIONPARAMETER(3G)



NAME
       glGetConvolutionParameterfv,, glGetConvolutionParameteriv - get convolu-
       tion parameters


C SPECIFICATION
       void glGetConvolutionParameterfv( GLenum target,
                                         GLenum pname,
                                         GLfloat *params )
       void glGetConvolutionParameteriv( GLenum target,
                                         GLenum pname,
                                         GLint *params )


PARAMETERS
       target  The filter whose parameters are to be retrieved.  Must  be  one
               of GLCONVOLUTION1D, GLCONVOLUTION2D, or GLSEPARABLE2D.

       pname   The    parameter   to   be   retrieved.    Must   be   one   of
               GLCONVOLUTIONBORDERMODE,        GLCONVOLUTIONBORDERCOLOR,
               GLCONVOLUTIONFILTERSCALE,        GLCONVOLUTIONFILTERBIAS,
               GLCONVOLUTIONFORMAT,                    GLCONVOLUTIONWIDTH,
               GLCONVOLUTIONHEIGHT,       GLMAXCONVOLUTIONWIDTH,       or
               GLMAXCONVOLUTIONHEIGHT.

       params  Pointer to storage for the parameters to be retrieved.

DESCRIPTION
       glGetConvolutionParameter  retrieves  convolution  parameters.   target
       determines which convolution filter is queried.  pname determines which
       parameter is returned:

       GLCONVOLUTIONBORDERMODE
              The convolution border mode.  See glConvolutionParameter  for  a
              list of border modes.

       GLCONVOLUTIONBORDERCOLOR
              The  current convolution border color.  params must be a pointer
              to an array of four elements, which will receive the red, green,
              blue, and alpha border colors.

       GLCONVOLUTIONFILTERSCALE
              The  current  filter scale factors.  params 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.

       GLCONVOLUTIONFILTERBIAS
              The current filter bias factors.  params 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.

       GLCONVOLUTIONFORMAT
              The    current    internal    .     See   glConvolutionFilter1D,
              glConvolutionFilter2D,  and  glSeparableFilter2D  for  lists  of
              allowable formats.

       GLCONVOLUTIONWIDTH
              The current filter image width.

       GLCONVOLUTIONHEIGHT
              The current filter image height.

       GLMAXCONVOLUTIONWIDTH
              The maximum acceptable filter image width.

       GLMAXCONVOLUTIONHEIGHT
              The maximum acceptable filter image height.

ERORS
       GLINVALIDENUM is generated if target is not one of the allowable val-
       ues.

       GLINVALIDENUM is generated if pname is not one of the allowable  val-
       ues.

       GLINVALIDENUM  is  generated if target is GLCONVOLUTION1D and pname
       is GLCONVOLUTIONHEIGHT or GLMAXCONVOLUTIONHEIGHT.

       GLINVALIDOPERATION is generated if glGetConvolutionParameter is  exe-
       cuted  between the execution of glBegin and the corresponding execution
       of glEnd.

SEE ALSO
       glGetConvolutionFilter, glGetSeparableFilter2D, glConvolutionParameter



                                                 GLGETCONVOLUTIONPARAMETER(3G)
Darwin Mac OS X man pages main menu

Contact us      |       About us      |       Term of use      |       Copyright © 2000-2010 MyWebUniversity.com ™