← Back to branch summary

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

« back to all changes in this revision

Viewing changes to unix/xc/extras/ogl-sample/main/doc/man/mangl/standard/getseparablefilter.gl

  • 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/extras/ogl-sample/main/doc/man/mangl/standard/getseparablefilter.gl
 
1
_C_ License Applicability. Except to the extent portions of this file are
 
2
_C_ made subject to an alternative license as permitted in the SGI Free
 
3
_C_ Software License B, Version 1.1 (the "License"), the contents of this
 
4
_C_ file are subject only to the provisions of the License. You may not use
 
5
_C_ this file except in compliance with the License. You may obtain a copy
 
6
_C_ of the License at Silicon Graphics, Inc., attn: Legal Services, 1600
 
7
_C_ Amphitheatre Parkway, Mountain View, CA 94043-1351, or at:
 
8
_C_ 
 
9
_C_ http://oss.sgi.com/projects/FreeB
 
10
_C_ 
 
11
_C_ Note that, as provided in the License, the Software is distributed on an
 
12
_C_ "AS IS" basis, with ALL EXPRESS AND IMPLIED WARRANTIES AND CONDITIONS
 
13
_C_ DISCLAIMED, INCLUDING, WITHOUT LIMITATION, ANY IMPLIED WARRANTIES AND
 
14
_C_ CONDITIONS OF MERCHANTABILITY, SATISFACTORY QUALITY, FITNESS FOR A
 
15
_C_ PARTICULAR PURPOSE, AND NON-INFRINGEMENT.
 
16
_C_ 
 
17
_C_ Original Code. The Original Code is: OpenGL Sample Implementation,
 
18
_C_ Version 1.2.1, released January 26, 2000, developed by Silicon Graphics,
 
19
_C_ Inc. The Original Code is Copyright (c) 1991-2000 Silicon Graphics, Inc.
 
20
_C_ Copyright in any portions created by third parties is as indicated
 
21
_C_ elsewhere herein. All Rights Reserved.
 
22
_C_ 
 
23
_C_ Additional Notice Provisions: The application programming interfaces
 
24
_C_ established by SGI in conjunction with the Original Code are The
 
25
_C_ OpenGL(R) Graphics System: A Specification (Version 1.2.1), released
 
26
_C_ April 1, 1999; The OpenGL(R) Graphics System Utility Library (Version
 
27
_C_ 1.3), released November 4, 1998; and OpenGL(R) Graphics with the X
 
28
_C_ Window System(R) (Version 1.3), released October 19, 1998. This software
 
29
_C_ was created using the OpenGL(R) version 1.2.1 Sample Implementation
 
30
_C_ published by SGI, but has not been independently verified as being
 
31
_C_ compliant with the OpenGL(R) version 1.2.1 Specification.
 
32
_C_
 
33
_C_ The first character in this file must be an '_'!
 
34
_C_ Anything on a line after _C_ is ignored
 
35
_define(_filters,tbl)_C_
 
36
_header(GetSeparableFilter,get separable convolution filter kernel images)
 
37
_names(GetSeparableFilter)
 
38
_define(@<__target>@,@<_param1>@)_C_
 
39
_define(@<__format>@,@<_param2>@)_C_
 
40
_define(@<__type>@,@<_param3>@)_C_
 
41
_define(@<__row>@,@<_param4>@)_C_
 
42
_define(@<__column>@,@<_param5>@)_C_
 
43
_define(@<__span>@,@<_param6>@)_C_
 
44
.SH PARAMETERS
 
45
_phead(__target)
 
46
The separable filter to be retrieved.
 
47
Must be
 
48
_const(SEPARABLE_2D).
 
49
_phead(__format)
 
50
Format of the output images.
 
51
Must be one of
 
52
_const(RED),
 
53
_const(GREEN),
 
54
_const(BLUE),
 
55
_const(ALPHA),
 
56
_const(RGB),
 
57
_const(BGR)
 
58
_const(RGBA),
 
59
_const(BGRA),
 
60
_const(LUMINANCE), or
 
61
_const(LUMINANCE_ALPHA).
 
62
_phead(__type)
 
63
Data type of components in the output images.
 
64
Symbolic constants
 
65
_const(UNSIGNED_BYTE),
 
66
_const(BYTE),
 
67
_const(BITMAP),
 
68
_const(UNSIGNED_SHORT),
 
69
_const(SHORT),
 
70
_const(UNSIGNED_INT),
 
71
_const(INT),
 
72
_const(FLOAT),
 
73
_const(UNSIGNED_BYTE_3_3_2),
 
74
_const(UNSIGNED_BYTE_2_3_3_REV),
 
75
_const(UNSIGNED_SHORT_5_6_5),
 
76
_const(UNSIGNED_SHORT_5_6_5_REV),
 
77
_const(UNSIGNED_SHORT_4_4_4_4),
 
78
_const(UNSIGNED_SHORT_4_4_4_4_REV),
 
79
_const(UNSIGNED_SHORT_5_5_5_1),
 
80
_const(UNSIGNED_SHORT_1_5_5_5_REV),
 
81
_const(UNSIGNED_INT_8_8_8_8),
 
82
_const(UNSIGNED_INT_8_8_8_8_REV),
 
83
_const(UNSIGNED_INT_10_10_10_2), and
 
84
_const(UNSIGNED_INT_2_10_10_10_REV)
 
85
are accepted.
 
86
_phead(__row)
 
87
Pointer to storage for the row filter image.
 
88
_phead(__column)
 
89
Pointer to storage for the column filter image.
 
90
_phead(__span)
 
91
Pointer to storage for the span filter image (currently unused).
 
92
.SH DESCRIPTION
 
93
_cmnd returns the two one-dimensional filter kernel images for the
 
94
current separable 2D convolution filter.
 
95
The row image is placed in __row and the column image is placed in
 
96
__column according to the specifications in __format and __type.
 
97
(In the current implementation, __span is not affected in any way.)
 
98
No pixel transfer operations are performed on the images, but the relevant
 
99
pixel storage modes are applied.
 
100
.sp
 
101
Color components that are present in __format but not included in the
 
102
internal format of the filters are returned as zero.
 
103
The assignments of internal color components to the components of __format
 
104
are as follows:
 
105
.sp
 
106
 
 
107
.TS
 
108
center;
 
109
cb cb
 
110
l l.
 
111
_
 
112
Internal Component      Resulting Component
 
113
_
 
114
Red     Red
 
115
Green   Green
 
116
Blue    Blue
 
117
Alpha   Alpha
 
118
Luminance       Red
 
119
Intensity       Red
 
120
_
 
121
.TE
 
122
 
 
123
.SH NOTES
 
124
_cmnd is present only if _arbstring(imaging) is returned when _cmnd(GetString)
 
125
is called with an argument of _const(EXTENSIONS).
 
126
.P
 
127
Non-separable 2D filters must be retrieved with _cmnd(GetConvolutionFilter).
 
128
.SH ERRORS
 
129
_const(INVALID_ENUM) is generated if __target is not _const(SEPARABLE_2D).
 
130
.P
 
131
_const(INVALID_ENUM) is generated if __format is not one of the allowable
 
132
values.
 
133
.P
 
134
_const(INVALID_ENUM) is generated if __type is not one of the allowable
 
135
values.
 
136
.P
 
137
_const(INVALID_OPERATION) is generated if _cmnd is executed
 
138
between the execution of _cmnd(Begin) and the corresponding
 
139
execution of _cmnd(End).
 
140
.P
 
141
_const(INVALID_OPERATION) is generated if __type is one of
 
142
_const(UNSIGNED_BYTE_3_3_2),
 
143
_const(UNSIGNED_BYTE_2_3_3_REV),
 
144
_const(UNSIGNED_SHORT_5_6_5), or
 
145
_const(UNSIGNED_SHORT_5_6_5_REV)
 
146
and __format is not _const(RGB).
 
147
.P
 
148
_const(INVALID_OPERATION) is generated if __type is one of
 
149
_const(UNSIGNED_SHORT_4_4_4_4),
 
150
_const(UNSIGNED_SHORT_4_4_4_4_REV),
 
151
_const(UNSIGNED_SHORT_5_5_5_1),
 
152
_const(UNSIGNED_SHORT_1_5_5_5_REV),
 
153
_const(UNSIGNED_INT_8_8_8_8),
 
154
_const(UNSIGNED_INT_8_8_8_8_REV),
 
155
_const(UNSIGNED_INT_10_10_10_2), or
 
156
_const(UNSIGNED_INT_2_10_10_10_REV)
 
157
and __format is neither _const(RGBA) nor _const(BGRA).
 
158
.SH ASSOCIATED GETS
 
159
_cmnd(GetConvolutionParameter)
 
160
.SH SEE ALSO
 
161
_cmnd(GetConvolutionFilter),
 
162
_cmnd(ConvolutionParameter),
 
163
_cmnd(SeparableFilter2D)