← Back to branch summary

~ubuntu-branches/ubuntu/gutsy/vnc4/gutsy

« back to all changes in this revision

Viewing changes to unix/xc/doc/man/GL/gl/getconvolutionfilter.3gl

  • Committer: Bazaar Package Importer
  • Author(s): Ola Lundqvist
  • Date: 2006-05-15 20:35:17 UTC
  • mfrom: (1.1.2 upstream)
  • Revision ID: james.westby@ubuntu.com-20060515203517-l4lre1ku942mn26k
Tags: 4.1.1+X4.3.0-10
* Correction of critical security issue. Thanks to Martin Kogler
  <e9925248@student.tuwien.ac.at> that informed me about the issue,
  and provided the patch.
  This flaw was originally found by Steve Wiseman of intelliadmin.com.
* Applied patch from Javier Kohen <jkohen@users.sourceforge.net> that
  inform the user that only 8 first characters of the password will
  actually be used when typing more than 8 characters, closes:
  #355619.

Show diffs side-by-side

added added

removed removed

Lines of Context:
unix/xc/doc/man/GL/gl/getconvolutionfilter.3gl
 
1
'\" t
 
2
'\"! tbl | mmdoc
 
3
'\"macro stdmacro
 
4
.ds Vn Version 1.2
 
5
.ds Dt 24 September 1999
 
6
.ds Re Release 1.2.1
 
7
.ds Dp Jan 14 18:30
 
8
.ds Dm 01 getconvol
 
9
.ds Xs 38054 6 getconvolutionfilter.gl
 
10
.TH GLGETCONVOLUTIONFILTER 3G
 
11
.SH NAME
 
12
.B "glGetConvolutionFilter
 
13
\- get current 1D or 2D convolution filter kernel
 
14
 
 
15
.SH C SPECIFICATION
 
16
void \f3glGetConvolutionFilter\fP(
 
17
GLenum \fItarget\fP,
 
18
.nf
 
19
.ta \w'\f3void \fPglGetConvolutionFilter( 'u
 
20
        GLenum \fIformat\fP,
 
21
        GLenum \fItype\fP,
 
22
        GLvoid \fI*image\fP )
 
23
.fi
 
24
 
 
25
.SH PARAMETERS
 
26
.TP \w'\f2target\fP\ \ 'u 
 
27
\f2target\fP
 
28
The filter to be retrieved.
 
29
Must be one of
 
30
\%\f3GL_CONVOLUTION_1D\fP or
 
31
\%\f3GL_CONVOLUTION_2D\fP.
 
32
.TP
 
33
\f2format\fP
 
34
Format of the output image.
 
35
Must be one of
 
36
\%\f3GL_RED\fP,
 
37
\%\f3GL_GREEN\fP,
 
38
\%\f3GL_BLUE\fP,
 
39
\%\f3GL_ALPHA\fP,
 
40
\%\f3GL_RGB\fP,
 
41
\%\f3GL_BGR\fP,
 
42
\%\f3GL_RGBA\fP,
 
43
\%\f3GL_BGRA\fP,
 
44
\%\f3GL_LUMINANCE\fP, or
 
45
\%\f3GL_LUMINANCE_ALPHA\fP.
 
46
.TP
 
47
\f2type\fP
 
48
Data type of components in the output image.
 
49
Symbolic constants
 
50
\%\f3GL_UNSIGNED_BYTE\fP,
 
51
\%\f3GL_BYTE\fP,
 
52
\%\f3GL_BITMAP\fP,
 
53
\%\f3GL_UNSIGNED_SHORT\fP,
 
54
\%\f3GL_SHORT\fP,
 
55
\%\f3GL_UNSIGNED_INT\fP,
 
56
\%\f3GL_INT\fP,
 
57
\%\f3GL_FLOAT\fP,
 
58
\%\f3GL_UNSIGNED_BYTE_3_3_2\fP,
 
59
\%\f3GL_UNSIGNED_BYTE_2_3_3_REV\fP,
 
60
\%\f3GL_UNSIGNED_SHORT_5_6_5\fP,
 
61
\%\f3GL_UNSIGNED_SHORT_5_6_5_REV\fP,
 
62
\%\f3GL_UNSIGNED_SHORT_4_4_4_4\fP,
 
63
\%\f3GL_UNSIGNED_SHORT_4_4_4_4_REV\fP,
 
64
\%\f3GL_UNSIGNED_SHORT_5_5_5_1\fP,
 
65
\%\f3GL_UNSIGNED_SHORT_1_5_5_5_REV\fP,
 
66
\%\f3GL_UNSIGNED_INT_8_8_8_8\fP,
 
67
\%\f3GL_UNSIGNED_INT_8_8_8_8_REV\fP,
 
68
\%\f3GL_UNSIGNED_INT_10_10_10_2\fP, and
 
69
\%\f3GL_UNSIGNED_INT_2_10_10_10_REV\fP
 
70
are accepted.
 
71
.TP
 
72
\f2image\fP
 
73
Pointer to storage for the output image.
 
74
.SH DESCRIPTION
 
75
\%\f3glGetConvolutionFilter\fP returns the current 1D or 2D convolution filter kernel as an image.
 
76
The one- or two-dimensional image is placed in \f2image\fP according to the
 
77
specifications in \f2format\fP and \f2type\fP.
 
78
No pixel transfer operations are performed on this image, but the relevant
 
79
pixel storage modes are applied.
 
80
.sp
 
81
Color components that are present in \f2format\fP but not included in the
 
82
internal  of the filter are returned as zero.
 
83
The assignments of internal color components to the components of \f2format\fP
 
84
are as follows.
 
85
.br
 
86
.bp
 
87
.TS
 
88
center;
 
89
lb lb
 
90
l l.
 
91
_
 
92
Internal Component      Resulting Component
 
93
_
 
94
Red     Red
 
95
Green   Green
 
96
Blue    Blue
 
97
Alpha   Alpha
 
98
Luminance       Red
 
99
Intensity       Red
 
100
_
 
101
.TE
 
102
.SH NOTES
 
103
\%\f3glGetConvolutionFilter\fP is present only if \%\f3GL_ARB_imaging\fP is returned when \%\f3glGetString\fP
 
104
is called with an argument of \%\f3GL_EXTENSIONS\fP.
 
105
.P
 
106
The current separable 2D filter must be retrieved with
 
107
\%\f3glGetSeparableFilter\fP rather than \%\f3glGetConvolutionFilter\fP.
 
108
.SH ERRORS
 
109
\%\f3GL_INVALID_ENUM\fP is generated if \f2target\fP is not one of the allowable
 
110
values.
 
111
.P
 
112
\%\f3GL_INVALID_ENUM\fP is generated if \f2format\fP is not one of the allowable
 
113
values.
 
114
.P
 
115
\%\f3GL_INVALID_ENUM\fP is generated if \f2type\fP is not one of the allowable
 
116
values.
 
117
.P
 
118
\%\f3GL_INVALID_OPERATION\fP is generated if \%\f3glGetConvolutionFilter\fP is executed
 
119
between the execution of \%\f3glBegin\fP and the corresponding
 
120
execution of \%\f3glEnd\fP.
 
121
.P
 
122
\%\f3GL_INVALID_OPERATION\fP is generated if \f2type\fP is one of
 
123
\%\f3GL_UNSIGNED_BYTE_3_3_2\fP,
 
124
\%\f3GL_UNSIGNED_BYTE_2_3_3_REV\fP,
 
125
\%\f3GL_UNSIGNED_SHORT_5_6_5\fP, or
 
126
\%\f3GL_UNSIGNED_SHORT_5_6_5_REV\fP
 
127
and \f2format\fP is not \%\f3GL_RGB\fP.
 
128
.P
 
129
\%\f3GL_INVALID_OPERATION\fP is generated if \f2type\fP is one of
 
130
\%\f3GL_UNSIGNED_SHORT_4_4_4_4\fP,
 
131
\%\f3GL_UNSIGNED_SHORT_4_4_4_4_REV\fP,
 
132
\%\f3GL_UNSIGNED_SHORT_5_5_5_1\fP,
 
133
\%\f3GL_UNSIGNED_SHORT_1_5_5_5_REV\fP,
 
134
\%\f3GL_UNSIGNED_INT_8_8_8_8\fP,
 
135
\%\f3GL_UNSIGNED_INT_8_8_8_8_REV\fP,
 
136
\%\f3GL_UNSIGNED_INT_10_10_10_2\fP, or
 
137
\%\f3GL_UNSIGNED_INT_2_10_10_10_REV\fP
 
138
and \f2format\fP is neither \%\f3GL_RGBA\fP nor \%\f3GL_BGRA\fP.
 
139
.SH ASSOCIATED GETS
 
140
\%\f3glGetConvolutionParameter\fP
 
141
.SH SEE ALSO
 
142
\%\f3glGetSeparableFilter(3G)\fP,
 
143
\%\f3glConvolutionParameter(3G)\fP,
 
144
\%\f3glConvolutionFilter1D(3G)\fP,
 
145
\%\f3glConvolutionFilter2D(3G)\fP