NAME

glGetConvolutionFilter - get current 1D or 2D convolution filter kernel

C SPECIFICATION

void ggllGGeettCCoonnvvoolluuttiioonnFFiilltteerr( GLenum _t_a_r_g_e_t,
                             GLenum _f_o_r_m_a_t,
                             GLenum _t_y_p_e,
                             GLvoid _*_i_m_a_g_e )

PARAMETERS

_t_a_r_g_e_t
The filter to be retrieved. Must be one of GGLL__CCOONNVVOOLLUUTTIIOONN__11DD or GGLL__CCOONNVVOOLLUUTTIIOONN__22DD.
_f_o_r_m_a_t
Format of the output image. Must be one of GGLL__RREEDD, GGLL__GGRREEEENN, GGLL__BBLLUUEE, GGLL__AALLPPHHAA, GGLL__RRGGBB, GGLL__BBGGRR, GGLL__RRGGBBAA, GGLL__BBGGRRAA, GGLL__LLUUMMIINNAANNCCEE, or GGLL__LLUUMMIINNAANNCCEE__AALLPPHHAA.
_t_y_p_e
Data type of components in the output image. Symbolic constants GGLL__UUNNSSIIGGNNEEDD__BBYYTTEE, GGLL__BBYYTTEE, GGLL__BBIITTMMAAPP, GGLL__UUNNSSIIGGNNEEDD__SSHHOORRTT, GGLL__SSHHOORRTT, GGLL__UUNNSSIIGGNNEEDD__IINNTT, GGLL__IINNTT, GGLL__FFLLOOAATT, GGLL__UUNNSSIIGGNNEEDD__BBYYTTEE__33__33__22, GGLL__UUNNSSIIGGNNEEDD__BBYYTTEE__22__33__33__RREEVV, GGLL__UUNNSSIIGGNNEEDD__SSHHOORRTT__55__66__55, GGLL__UUNNSSIIGGNNEEDD__SSHHOORRTT__55__66__55__RREEVV, GGLL__UUNNSSIIGGNNEEDD__SSHHOORRTT__44__44__44__44, GGLL__UUNNSSIIGGNNEEDD__SSHHOORRTT__44__44__44__44__RREEVV, GGLL__UUNNSSIIGGNNEEDD__SSHHOORRTT__55__55__55__11, GGLL__UUNNSSIIGGNNEEDD__SSHHOORRTT__11__55__55__55__RREEVV, GGLL__UUNNSSIIGGNNEEDD__IINNTT__88__88__88__88, GGLL__UUNNSSIIGGNNEEDD__IINNTT__88__88__88__88__RREEVV, GGLL__UUNNSSIIGGNNEEDD__IINNTT__1100__1100__1100__22, and GGLL__UUNNSSIIGGNNEEDD__IINNTT__22__1100__1100__1100__RREEVV are accepted.
_i_m_a_g_e
Pointer to storage for the output image.

DESCRIPTION

ggllGGeettCCoonnvvoolluuttiioonnFFiilltteerr returns the current 1D or 2D convolution filter kernel as an image. The one- or two-dimensional image is placed in _i_m_a_g_e according to the specifications in _f_o_r_m_a_t and _t_y_p_e. No pixel transfer operations are performed on this image, but the relevant pixel storage modes are applied.

Color components that are present in _f_o_r_m_a_t but not included in the internal of the filter are returned as zero. The assignments of internal color components to the components of _f_o_r_m_a_t are as follows.
center;
lb lb
l l.
_
Internal Component           Resulting Component
_
Red                          Red
Green                        Green
Blue                         Blue
Alpha                        Alpha
Luminance                    Red
Intensity                    Red
_

NOTES

ggllGGeettCCoonnvvoolluuttiioonnFFiilltteerr is present only if GGLL__AARRBB__iimmaaggiinngg is returned when ggllGGeettSSttrriinngg is called with an argument of GGLL__EEXXTTEENNSSIIOONNSS.

The current separable 2D filter must be retrieved with ggllGGeettSSeeppaarraabblleeFFiilltteerr rather than ggllGGeettCCoonnvvoolluuttiioonnFFiilltteerr.

ERRORS

GGLL__IINNVVAALLIIDD__EENNUUMM is generated if _t_a_r_g_e_t is not one of the allowable values.

GGLL__IINNVVAALLIIDD__EENNUUMM is generated if _f_o_r_m_a_t is not one of the allowable values.

GGLL__IINNVVAALLIIDD__EENNUUMM is generated if _t_y_p_e is not one of the allowable values.

GGLL__IINNVVAALLIIDD__OOPPEERRAATTIIOONN is generated if ggllGGeettCCoonnvvoolluuttiioonnFFiilltteerr is executed between the execution of ggllBBeeggiinn and the corresponding execution of ggllEEnndd.

GGLL__IINNVVAALLIIDD__OOPPEERRAATTIIOONN is generated if _t_y_p_e is one of GGLL__UUNNSSIIGGNNEEDD__BBYYTTEE__33__33__22, GGLL__UUNNSSIIGGNNEEDD__BBYYTTEE__22__33__33__RREEVV, GGLL__UUNNSSIIGGNNEEDD__SSHHOORRTT__55__66__55, or GGLL__UUNNSSIIGGNNEEDD__SSHHOORRTT__55__66__55__RREEVV and _f_o_r_m_a_t is not GGLL__RRGGBB.

GGLL__IINNVVAALLIIDD__OOPPEERRAATTIIOONN is generated if _t_y_p_e is one of GGLL__UUNNSSIIGGNNEEDD__SSHHOORRTT__44__44__44__44, GGLL__UUNNSSIIGGNNEEDD__SSHHOORRTT__44__44__44__44__RREEVV, GGLL__UUNNSSIIGGNNEEDD__SSHHOORRTT__55__55__55__11, GGLL__UUNNSSIIGGNNEEDD__SSHHOORRTT__11__55__55__55__RREEVV, GGLL__UUNNSSIIGGNNEEDD__IINNTT__88__88__88__88, GGLL__UUNNSSIIGGNNEEDD__IINNTT__88__88__88__88__RREEVV, GGLL__UUNNSSIIGGNNEEDD__IINNTT__1100__1100__1100__22, or GGLL__UUNNSSIIGGNNEEDD__IINNTT__22__1100__1100__1100__RREEVV and _f_o_r_m_a_t is neither GGLL__RRGGBBAA nor GGLL__BBGGRRAA.

ASSOCIATED GETS

ggllGGeettCCoonnvvoolluuttiioonnPPaarraammeetteerr

SEE ALSO

ggllGGeettSSeeppaarraabblleeFFiilltteerr((33GG)), ggllCCoonnvvoolluuttiioonnPPaarraammeetteerr((33GG)), ggllCCoonnvvoolluuttiioonnFFiilltteerr11DD((33GG)), ggllCCoonnvvoolluuttiioonnFFiilltteerr22DD((33GG))