home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / g_man / cat3 / OpenGL / glconvolutionparameter.z / glconvolutionparameter
Encoding:
Text File  |  2001-04-17  |  15.7 KB  |  205 lines
  1.  
  2.  
  3.  
  4. ggggllllCCCCoooonnnnvvvvoooolllluuuuttttiiiioooonnnnPPPPaaaarrrraaaammmmeeeetttteeeerrrr((((3333GGGG))))     OOOOppppeeeennnnGGGGLLLL RRRReeeeffffeeeerrrreeeennnncccceeee     ggggllllCCCCoooonnnnvvvvoooolllluuuuttttiiiioooonnnnPPPPaaaarrrraaaammmmeeeetttteeeerrrr((((3333GGGG))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      ggggllllCCCCoooonnnnvvvvoooolllluuuuttttiiiioooonnnnPPPPaaaarrrraaaammmmeeeetttteeeerrrrffff,,,, ggggllllCCCCoooonnnnvvvvoooolllluuuuttttiiiioooonnnnPPPPaaaarrrraaaammmmeeeetttteeeerrrriiii,,,,
  10.      ggggllllCCCCoooonnnnvvvvoooolllluuuuttttiiiioooonnnnPPPPaaaarrrraaaammmmeeeetttteeeerrrrffffvvvv,,,, ggggllllCCCCoooonnnnvvvvoooolllluuuuttttiiiioooonnnnPPPPaaaarrrraaaammmmeeeetttteeeerrrriiiivvvv - set convolution
  11.      parameters
  12.  
  13.  
  14. CCCC SSSSPPPPEEEECCCCIIIIFFFFIIIICCCCAAAATTTTIIIIOOOONNNN
  15.      void ggggllllCCCCoooonnnnvvvvoooolllluuuuttttiiiioooonnnnPPPPaaaarrrraaaammmmeeeetttteeeerrrrffff( GLenum _t_a_r_g_e_t,
  16.                                    GLenum _p_n_a_m_e,
  17.                                    GLfloat _p_a_r_a_m_s )
  18.      void ggggllllCCCCoooonnnnvvvvoooolllluuuuttttiiiioooonnnnPPPPaaaarrrraaaammmmeeeetttteeeerrrriiii( GLenum _t_a_r_g_e_t,
  19.                                    GLenum _p_n_a_m_e,
  20.                                    GLint _p_a_r_a_m_s )
  21.  
  22.  
  23.  
  24.  
  25. PPPPAAAARRRRAAAAMMMMEEEETTTTEEEERRRRSSSS
  26.      _t_a_r_g_e_t  The target for the convolution parameter.  Must be one of
  27.              GGGGLLLL____CCCCOOOONNNNVVVVOOOOLLLLUUUUTTTTIIIIOOOONNNN____1111DDDD, GGGGLLLL____CCCCOOOONNNNVVVVOOOOLLLLUUUUTTTTIIIIOOOONNNN____2222DDDD, or GGGGLLLL____SSSSEEEEPPPPAAAARRRRAAAABBBBLLLLEEEE____2222DDDD.
  28.  
  29.      _p_n_a_m_e   The parameter to be set.  Must be GGGGLLLL____CCCCOOOONNNNVVVVOOOOLLLLUUUUTTTTIIIIOOOONNNN____BBBBOOOORRRRDDDDEEEERRRR____MMMMOOOODDDDEEEE.
  30.  
  31.      _p_a_r_a_m_s  The parameter value.  Must be one of GGGGLLLL____RRRREEEEDDDDUUUUCCCCEEEE,
  32.              GGGGLLLL____CCCCOOOONNNNSSSSTTTTAAAANNNNTTTT____BBBBOOOORRRRDDDDEEEERRRR, GGGGLLLL____RRRREEEEPPPPLLLLIIIICCCCAAAATTTTEEEE____BBBBOOOORRRRDDDDEEEERRRR.
  33.  
  34.  
  35.  
  36. CCCC SSSSPPPPEEEECCCCIIIIFFFFIIIICCCCAAAATTTTIIIIOOOONNNN
  37.      void ggggllllCCCCoooonnnnvvvvoooolllluuuuttttiiiioooonnnnPPPPaaaarrrraaaammmmeeeetttteeeerrrrffffvvvv( GLenum _t_a_r_g_e_t,
  38.                                     GLenum _p_n_a_m_e,
  39.                                     const GLfloat *_p_a_r_a_m_s )
  40.      void ggggllllCCCCoooonnnnvvvvoooolllluuuuttttiiiioooonnnnPPPPaaaarrrraaaammmmeeeetttteeeerrrriiiivvvv( GLenum _t_a_r_g_e_t,
  41.                                     GLenum _p_n_a_m_e,
  42.                                     const GLint *_p_a_r_a_m_s )
  43.  
  44.  
  45.  
  46.  
  47. PPPPAAAARRRRAAAAMMMMEEEETTTTEEEERRRRSSSS
  48.      _t_a_r_g_e_t
  49.           The target for the convolution parameter.  Must be one of
  50.           GGGGLLLL____CCCCOOOONNNNVVVVOOOOLLLLUUUUTTTTIIIIOOOONNNN____1111DDDD, GGGGLLLL____CCCCOOOONNNNVVVVOOOOLLLLUUUUTTTTIIIIOOOONNNN____2222DDDD, or GGGGLLLL____SSSSEEEEPPPPAAAARRRRAAAABBBBLLLLEEEE____2222DDDD.
  51.  
  52.      _p_n_a_m_e
  53.           The parameter to be set.  Must be one of GGGGLLLL____CCCCOOOONNNNVVVVOOOOLLLLUUUUTTTTIIIIOOOONNNN____BBBBOOOORRRRDDDDEEEERRRR____MMMMOOOODDDDEEEE,
  54.           GGGGLLLL____CCCCOOOONNNNVVVVOOOOLLLLUUUUTTTTIIIIOOOONNNN____BBBBOOOORRRRDDDDEEEERRRR____CCCCOOOOLLLLOOOORRRR, GGGGLLLL____CCCCOOOONNNNVVVVOOOOLLLLUUUUTTTTIIIIOOOONNNN____FFFFIIIILLLLTTTTEEEERRRR____SSSSCCCCAAAALLLLEEEE, or
  55.           GGGGLLLL____CCCCOOOONNNNVVVVOOOOLLLLUUUUTTTTIIIIOOOONNNN____FFFFIIIILLLLTTTTEEEERRRR____BBBBIIIIAAAASSSS.
  56.  
  57.      _p_a_r_a_m_s
  58.           The parameter value.  If _p_n_a_m_e is GGGGLLLL____CCCCOOOONNNNVVVVOOOOLLLLUUUUTTTTIIIIOOOONNNN____BBBBOOOORRRRDDDDEEEERRRR____MMMMOOOODDDDEEEE, _p_a_r_a_m_s
  59.           must be one of GGGGLLLL____RRRREEEEDDDDUUUUCCCCEEEE, GGGGLLLL____CCCCOOOONNNNSSSSTTTTAAAANNNNTTTT____BBBBOOOORRRRDDDDEEEERRRR, or
  60.           GGGGLLLL____RRRREEEEPPPPLLLLIIIICCCCAAAATTTTEEEE____BBBBOOOORRRRDDDDEEEERRRR.  Otherwise, must be a vector of four values
  61.           (for red, green, blue, and alpha, respectively) to be used for
  62.           scaling (when _p_n_a_m_e is GGGGLLLL____CCCCOOOONNNNVVVVOOOOLLLLUUUUTTTTIIIIOOOONNNN____FFFFIIIILLLLTTTTEEEERRRR____SSSSCCCCAAAALLLLEEEE), or biasing
  63.           (when _p_n_a_m_e is GGGGLLLL____CCCCOOOONNNNVVVVOOOOLLLLUUUUTTTTIIIIOOOONNNN____FFFFIIIILLLLTTTTEEEERRRR____BBBBIIIIAAAASSSS) a convolution filter
  64.           kernel or setting the constant border color (when _p_n_a_m_e is
  65.           GGGGLLLL____CCCCOOOONNNNVVVVOOOOLLLLUUUUTTTTIIIIOOOONNNN____BBBBOOOORRRRDDDDEEEERRRR____CCCCOOOOLLLLOOOORRRR.
  66.  
  67.  
  68.  
  69.                                                                         PPPPaaaaggggeeee 1111
  70.  
  71.  
  72.  
  73.  
  74.  
  75.  
  76. ggggllllCCCCoooonnnnvvvvoooolllluuuuttttiiiioooonnnnPPPPaaaarrrraaaammmmeeeetttteeeerrrr((((3333GGGG))))     OOOOppppeeeennnnGGGGLLLL RRRReeeeffffeeeerrrreeeennnncccceeee     ggggllllCCCCoooonnnnvvvvoooolllluuuuttttiiiioooonnnnPPPPaaaarrrraaaammmmeeeetttteeeerrrr((((3333GGGG))))
  77.  
  78.  
  79.  
  80. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  81.      ggggllllCCCCoooonnnnvvvvoooolllluuuuttttiiiioooonnnnPPPPaaaarrrraaaammmmeeeetttteeeerrrr sets the value of a convolution parameter.
  82.  
  83.      _t_a_r_g_e_t selects the convolution filter to be affected:  GGGGLLLL____CCCCOOOONNNNVVVVOOOOLLLLUUUUTTTTIIIIOOOONNNN____1111DDDD,
  84.      GGGGLLLL____CCCCOOOONNNNVVVVOOOOLLLLUUUUTTTTIIIIOOOONNNN____2222DDDD, or GGGGLLLL____SSSSEEEEPPPPAAAARRRRAAAABBBBLLLLEEEE____2222DDDD for the 1D, 2D, or separable 2D
  85.      filter, respectively.
  86.  
  87.      _p_n_a_m_e selects the parameter to be changed.  GGGGLLLL____CCCCOOOONNNNVVVVOOOOLLLLUUUUTTTTIIIIOOOONNNN____FFFFIIIILLLLTTTTEEEERRRR____SSSSCCCCAAAALLLLEEEE
  88.      and GGGGLLLL____CCCCOOOONNNNVVVVOOOOLLLLUUUUTTTTIIIIOOOONNNN____FFFFIIIILLLLTTTTEEEERRRR____BBBBIIIIAAAASSSS affect the definition of the convolution
  89.      filter kernel; see ggggllllCCCCoooonnnnvvvvoooolllluuuuttttiiiioooonnnnFFFFiiiilllltttteeeerrrr1111DDDD, ggggllllCCCCoooonnnnvvvvoooolllluuuuttttiiiioooonnnnFFFFiiiilllltttteeeerrrr2222DDDD, and
  90.      ggggllllSSSSeeeeppppaaaarrrraaaabbbblllleeeeFFFFiiiilllltttteeeerrrr2222DDDD for details.  In these cases, _p_a_r_a_m_s is an array of
  91.      four values to be applied to red, green, blue, and alpha values,
  92.      respectively. The initial value for GGGGLLLL____CCCCOOOONNNNVVVVOOOOLLLLUUUUTTTTIIIIOOOONNNN____FFFFIIIILLLLTTTTEEEERRRR____SSSSCCCCAAAALLLLEEEE is (1, 1,
  93.      1, 1), and the initial value for GGGGLLLL____CCCCOOOONNNNVVVVOOOOLLLLUUUUTTTTIIIIOOOONNNN____FFFFIIIILLLLTTTTEEEERRRR____BBBBIIIIAAAASSSS is (0, 0, 0,
  94.      0).
  95.  
  96.      A _p_n_a_m_e value of GGGGLLLL____CCCCOOOONNNNVVVVOOOOLLLLUUUUTTTTIIIIOOOONNNN____BBBBOOOORRRRDDDDEEEERRRR____MMMMOOOODDDDEEEE controls the convolution
  97.      border mode. The accepted modes are:
  98.  
  99.      GGGGLLLL____RRRREEEEDDDDUUUUCCCCEEEE
  100.           The image resulting from convolution is smaller than the source
  101.           image.  If the filter width is _W_f and height is _H_f, and the source
  102.           image width is _W_s and height is _H_s, then the convolved image width
  103.           will be _W_s - _W_f + 1 and height will be _H_s - _H_f + 1.  (If this
  104.           reduction would generate an image with zero or negative width and/or
  105.           height, the output is simply null, with no error generated.)  The
  106.           coordinates of the image resulting from convolution are zero through
  107.           _W_s - _W_f in width and zero through _H_s - _H_f in height.
  108.  
  109.      GGGGLLLL____CCCCOOOONNNNSSSSTTTTAAAANNNNTTTT____BBBBOOOORRRRDDDDEEEERRRR
  110.           The image resulting from convolution is the same size as the source
  111.           image, and processed as if the source image were surrounded by
  112.           pixels with their color specified by the
  113.           GGGGLLLL____CCCCOOOONNNNVVVVOOOOLLLLUUUUTTTTIIIIOOOONNNN____BBBBOOOORRRRDDDDEEEERRRR____CCCCOOOOLLLLOOOORRRR.
  114.  
  115.      GGGGLLLL____RRRREEEEPPPPLLLLIIIICCCCAAAATTTTEEEE____BBBBOOOORRRRDDDDEEEERRRR
  116.           The image resulting from convolution is the same size as the source
  117.           image, and processed as if the outermost pixel on the border of the
  118.           source image were replicated.
  119.  
  120. NNNNOOOOTTTTEEEESSSS
  121.      ggggllllCCCCoooonnnnvvvvoooolllluuuuttttiiiioooonnnnPPPPaaaarrrraaaammmmeeeetttteeeerrrr is present only if GGGGLLLL____AAAARRRRBBBB____iiiimmmmaaaaggggiiiinnnngggg is returned when
  122.      ggggllllGGGGeeeettttSSSSttttrrrriiiinnnngggg is called with an argument of GGGGLLLL____EEEEXXXXTTTTEEEENNNNSSSSIIIIOOOONNNNSSSS.
  123.  
  124.      In cases where errors can result from the specification of invalid image
  125.      dimensions, it is the dimensions after convolution that are tested, not
  126.      the dimensions of the source image.  For example, ggggllllTTTTeeeexxxxIIIImmmmaaaaggggeeee1111DDDD requires
  127.      power-of-two image size.  When GGGGLLLL____RRRREEEEDDDDUUUUCCCCEEEE border mode is in effect, the
  128.      source image must be larger than the final power-of-two size by one less
  129.      than the size of the 1D filter kernel.
  130.  
  131.  
  132.  
  133.  
  134.  
  135.                                                                         PPPPaaaaggggeeee 2222
  136.  
  137.  
  138.  
  139.  
  140.  
  141.  
  142. ggggllllCCCCoooonnnnvvvvoooolllluuuuttttiiiioooonnnnPPPPaaaarrrraaaammmmeeeetttteeeerrrr((((3333GGGG))))     OOOOppppeeeennnnGGGGLLLL RRRReeeeffffeeeerrrreeeennnncccceeee     ggggllllCCCCoooonnnnvvvvoooolllluuuuttttiiiioooonnnnPPPPaaaarrrraaaammmmeeeetttteeeerrrr((((3333GGGG))))
  143.  
  144.  
  145.  
  146. EEEERRRRRRRROOOORRRRSSSS
  147.      GGGGLLLL____IIIINNNNVVVVAAAALLLLIIIIDDDD____EEEENNNNUUUUMMMM is generated if _t_a_r_g_e_t is not one of the allowable
  148.      values.
  149.  
  150.      GGGGLLLL____IIIINNNNVVVVAAAALLLLIIIIDDDD____EEEENNNNUUUUMMMM is generated if _p_n_a_m_e is not one of the allowable values.
  151.  
  152.      GGGGLLLL____IIIINNNNVVVVAAAALLLLIIIIDDDD____EEEENNNNUUUUMMMM is generated if _p_n_a_m_e is GGGGLLLL____CCCCOOOONNNNVVVVOOOOLLLLUUUUTTTTIIIIOOOONNNN____BBBBOOOORRRRDDDDEEEERRRR____MMMMOOOODDDDEEEE and
  153.      _p_a_r_a_m_s is not one of GGGGLLLL____RRRREEEEDDDDUUUUCCCCEEEE, GGGGLLLL____CCCCOOOONNNNSSSSTTTTAAAANNNNTTTT____BBBBOOOORRRRDDDDEEEERRRR, or
  154.      GGGGLLLL____RRRREEEEPPPPLLLLIIIICCCCAAAATTTTEEEE____BBBBOOOORRRRDDDDEEEERRRR.
  155.  
  156.      GGGGLLLL____IIIINNNNVVVVAAAALLLLIIIIDDDD____OOOOPPPPEEEERRRRAAAATTTTIIIIOOOONNNN is generated if ggggllllCCCCoooonnnnvvvvoooolllluuuuttttiiiioooonnnnPPPPaaaarrrraaaammmmeeeetttteeeerrrr is executed
  157.      between the execution of ggggllllBBBBeeeeggggiiiinnnn and the corresponding execution of
  158.      ggggllllEEEEnnnndddd.
  159.  
  160. AAAASSSSSSSSOOOOCCCCIIIIAAAATTTTEEEEDDDD GGGGEEEETTTTSSSS
  161.      ggggllllGGGGeeeettttCCCCoooonnnnvvvvoooolllluuuuttttiiiioooonnnnPPPPaaaarrrraaaammmmeeeetttteeeerrrr
  162.  
  163.  
  164. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  165.      ggggllllCCCCoooonnnnvvvvoooolllluuuuttttiiiioooonnnnFFFFiiiilllltttteeeerrrr1111DDDD, ggggllllCCCCoooonnnnvvvvoooolllluuuuttttiiiioooonnnnFFFFiiiilllltttteeeerrrr2222DDDD, ggggllllSSSSeeeeppppaaaarrrraaaabbbblllleeeeFFFFiiiilllltttteeeerrrr2222DDDD,
  166.      ggggllllGGGGeeeettttCCCCoooonnnnvvvvoooolllluuuuttttiiiioooonnnnPPPPaaaarrrraaaammmmeeeetttteeeerrrr
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.  
  196.  
  197.  
  198.  
  199.  
  200.  
  201.                                                                         PPPPaaaaggggeeee 3333
  202.  
  203.  
  204.  
  205.