← 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/rasterpos.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/rasterpos.3gl
 
1
'\" e
 
2
'\"! eqn | 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 rasterpos
 
9
.ds Xs 20383 7 rasterpos.gl
 
10
.TH GLRASTERPOS 3G
 
11
.SH NAME
 
12
.B "glRasterPos2d, glRasterPos2f, glRasterPos2i, glRasterPos2s, glRasterPos3d, glRasterPos3f, glRasterPos3i, glRasterPos3s, glRasterPos4d, glRasterPos4f, glRasterPos4i, glRasterPos4s, glRasterPos2dv, glRasterPos2fv, glRasterPos2iv, glRasterPos2sv, glRasterPos3dv, glRasterPos3fv, glRasterPos3iv, glRasterPos3sv, glRasterPos4dv, glRasterPos4fv, glRasterPos4iv, glRasterPos4sv
 
13
\- specify the raster position for pixel operations
 
14
 
 
15
.SH C SPECIFICATION
 
16
void \f3glRasterPos2d\fP(
 
17
GLdouble \fIx\fP,
 
18
.nf
 
19
.ta \w'\f3void \fPglRasterPos2d( 'u
 
20
        GLdouble \fIy\fP )
 
21
.fi
 
22
void \f3glRasterPos2f\fP(
 
23
GLfloat \fIx\fP,
 
24
.nf
 
25
.ta \w'\f3void \fPglRasterPos2f( 'u
 
26
        GLfloat \fIy\fP )
 
27
.fi
 
28
void \f3glRasterPos2i\fP(
 
29
GLint \fIx\fP,
 
30
.nf
 
31
.ta \w'\f3void \fPglRasterPos2i( 'u
 
32
        GLint \fIy\fP )
 
33
.fi
 
34
void \f3glRasterPos2s\fP(
 
35
GLshort \fIx\fP,
 
36
.nf
 
37
.ta \w'\f3void \fPglRasterPos2s( 'u
 
38
        GLshort \fIy\fP )
 
39
.fi
 
40
void \f3glRasterPos3d\fP(
 
41
GLdouble \fIx\fP,
 
42
.nf
 
43
.ta \w'\f3void \fPglRasterPos3d( 'u
 
44
        GLdouble \fIy\fP,
 
45
        GLdouble \fIz\fP )
 
46
.fi
 
47
void \f3glRasterPos3f\fP(
 
48
GLfloat \fIx\fP,
 
49
.nf
 
50
.ta \w'\f3void \fPglRasterPos3f( 'u
 
51
        GLfloat \fIy\fP,
 
52
        GLfloat \fIz\fP )
 
53
.fi
 
54
void \f3glRasterPos3i\fP(
 
55
GLint \fIx\fP,
 
56
.nf
 
57
.ta \w'\f3void \fPglRasterPos3i( 'u
 
58
        GLint \fIy\fP,
 
59
        GLint \fIz\fP )
 
60
.fi
 
61
void \f3glRasterPos3s\fP(
 
62
GLshort \fIx\fP,
 
63
.nf
 
64
.ta \w'\f3void \fPglRasterPos3s( 'u
 
65
        GLshort \fIy\fP,
 
66
        GLshort \fIz\fP )
 
67
.fi
 
68
void \f3glRasterPos4d\fP(
 
69
GLdouble \fIx\fP,
 
70
.nf
 
71
.ta \w'\f3void \fPglRasterPos4d( 'u
 
72
        GLdouble \fIy\fP,
 
73
        GLdouble \fIz\fP,
 
74
        GLdouble \fIw\fP )
 
75
.fi
 
76
void \f3glRasterPos4f\fP(
 
77
GLfloat \fIx\fP,
 
78
.nf
 
79
.ta \w'\f3void \fPglRasterPos4f( 'u
 
80
        GLfloat \fIy\fP,
 
81
        GLfloat \fIz\fP,
 
82
        GLfloat \fIw\fP )
 
83
.fi
 
84
void \f3glRasterPos4i\fP(
 
85
GLint \fIx\fP,
 
86
.nf
 
87
.ta \w'\f3void \fPglRasterPos4i( 'u
 
88
        GLint \fIy\fP,
 
89
        GLint \fIz\fP,
 
90
        GLint \fIw\fP )
 
91
.fi
 
92
void \f3glRasterPos4s\fP(
 
93
GLshort \fIx\fP,
 
94
.nf
 
95
.ta \w'\f3void \fPglRasterPos4s( 'u
 
96
        GLshort \fIy\fP,
 
97
        GLshort \fIz\fP,
 
98
        GLshort \fIw\fP )
 
99
.fi
 
100
 
 
101
.EQ
 
102
delim $$
 
103
.EN
 
104
.SH PARAMETERS
 
105
.TP \w'\f2x\fP\ \f2y\fP\ \f2z\fP\ \f2w\fP\ \ 'u 
 
106
\f2x\fP, \f2y\fP, \f2z\fP, \f2w\fP
 
107
Specify the $x$, $y$, $z$, and $w$ object coordinates
 
108
(if present)
 
109
for the raster position.
 
110
.SH C SPECIFICATION
 
111
void \f3glRasterPos2dv\fP(
 
112
const GLdouble \fI*v\fP )
 
113
.nf
 
114
.fi
 
115
void \f3glRasterPos2fv\fP(
 
116
const GLfloat \fI*v\fP )
 
117
.nf
 
118
.fi
 
119
void \f3glRasterPos2iv\fP(
 
120
const GLint \fI*v\fP )
 
121
.nf
 
122
.fi
 
123
void \f3glRasterPos2sv\fP(
 
124
const GLshort \fI*v\fP )
 
125
.nf
 
126
.fi
 
127
void \f3glRasterPos3dv\fP(
 
128
const GLdouble \fI*v\fP )
 
129
.nf
 
130
.fi
 
131
void \f3glRasterPos3fv\fP(
 
132
const GLfloat \fI*v\fP )
 
133
.nf
 
134
.fi
 
135
void \f3glRasterPos3iv\fP(
 
136
const GLint \fI*v\fP )
 
137
.nf
 
138
.fi
 
139
void \f3glRasterPos3sv\fP(
 
140
const GLshort \fI*v\fP )
 
141
.nf
 
142
.fi
 
143
void \f3glRasterPos4dv\fP(
 
144
const GLdouble \fI*v\fP )
 
145
.nf
 
146
.fi
 
147
void \f3glRasterPos4fv\fP(
 
148
const GLfloat \fI*v\fP )
 
149
.nf
 
150
.fi
 
151
void \f3glRasterPos4iv\fP(
 
152
const GLint \fI*v\fP )
 
153
.nf
 
154
.fi
 
155
void \f3glRasterPos4sv\fP(
 
156
const GLshort \fI*v\fP )
 
157
.nf
 
158
.fi
 
159
 
 
160
.SH PARAMETERS
 
161
.TP
 
162
\f2v\fP
 
163
Specifies a pointer to an array of two,
 
164
three,
 
165
or four elements,
 
166
specifying $x$, $y$, $z$, and $w$ coordinates, respectively.
 
167
.SH DESCRIPTION
 
168
The GL maintains a 3D position in window coordinates.
 
169
This position,
 
170
called the raster position,
 
171
is used to position pixel and bitmap write operations. It is
 
172
maintained with subpixel accuracy.
 
173
See \%\f3glBitmap\fP, \%\f3glDrawPixels\fP, and \%\f3glCopyPixels\fP.
 
174
.P
 
175
The current raster position consists of three window coordinates
 
176
($x$, $y$, $z$),
 
177
a clip coordinate value ($w$),
 
178
an eye coordinate distance,
 
179
a valid bit,
 
180
and associated color data and texture coordinates.
 
181
The $w$ coordinate is a clip coordinate,
 
182
because $w$ is not projected to window coordinates.
 
183
\%\f3glRasterPos4\fP specifies object coordinates $x$, $y$, $z$, and $w$
 
184
explicitly.
 
185
\%\f3glRasterPos3\fP specifies object coordinate $x$, $y$, and $z$ explicitly,
 
186
while $w$ is implicitly set to 1.
 
187
\%\f3glRasterPos2\fP uses the argument values for $x$ and $y$ while
 
188
implicitly setting $z$ and $w$ to 0 and 1.  
 
189
.P
 
190
The object coordinates presented by \%\f3glRasterPos\fP are treated just like those
 
191
of a \%\f3glVertex\fP command:
 
192
They are transformed by the current modelview and projection matrices
 
193
and passed to the clipping stage.
 
194
If the vertex is not culled,
 
195
then it is projected and scaled to window coordinates,
 
196
which become the new current raster position,
 
197
and the \%\f3GL_CURRENT_RASTER_POSITION_VALID\fP flag is set.
 
198
If the vertex 
 
199
.I is
 
200
culled,
 
201
then the valid bit is cleared and the current raster position
 
202
and associated color and texture coordinates are undefined.
 
203
.P
 
204
The current raster position also includes some associated color data
 
205
and texture coordinates.
 
206
If lighting is enabled,
 
207
then \%\f3GL_CURRENT_RASTER_COLOR\fP
 
208
(in RGBA mode)
 
209
or \%\f3GL_CURRENT_RASTER_INDEX\fP
 
210
(in color index mode)
 
211
is set to the color produced by the lighting calculation
 
212
(see \%\f3glLight\fP, \%\f3glLightModel\fP, and 
 
213
.br
 
214
\%\f3glShadeModel\fP).
 
215
If lighting is disabled, 
 
216
current color
 
217
(in RGBA mode, state variable \%\f3GL_CURRENT_COLOR\fP)
 
218
or color index
 
219
(in color index mode, state variable \%\f3GL_CURRENT_INDEX\fP)
 
220
is used to update the current raster color.
 
221
.P
 
222
Likewise,
 
223
\%\f3GL_CURRENT_RASTER_TEXTURE_COORDS\fP is updated as a function
 
224
of \%\f3GL_CURRENT_TEXTURE_COORDS\fP,
 
225
based on the texture matrix and the texture generation functions
 
226
(see \%\f3glTexGen\fP).
 
227
Finally,
 
228
the distance from the origin of the eye coordinate system to the
 
229
vertex as transformed by only the modelview matrix replaces
 
230
\%\f3GL_CURRENT_RASTER_DISTANCE\fP.
 
231
.P
 
232
Initially, the current raster position is (0, 0, 0, 1),
 
233
the current raster distance is 0,
 
234
the valid bit is set,
 
235
the associated RGBA color is (1, 1, 1, 1),
 
236
the associated color index is 1,
 
237
and the associated texture coordinates are (0, 0, 0, 1).
 
238
In RGBA mode,
 
239
\%\f3GL_CURRENT_RASTER_INDEX\fP is always 1;
 
240
in color index mode,
 
241
the current raster RGBA color always maintains its initial value.
 
242
.SH NOTES
 
243
The raster position is modified both by \%\f3glRasterPos\fP and by \%\f3glBitmap\fP. 
 
244
.P
 
245
When the raster position coordinates are invalid,
 
246
drawing commands that are based on the raster position are
 
247
ignored (that is, they do not result in changes to GL state).
 
248
.P
 
249
Calling \%\f3glDrawElements\fP, or \%\f3glDrawRangeElements\fP may leave the
 
250
current color or index indeterminate.
 
251
If \%\f3glRasterPos\fP is executed while the current color or index is indeterminate, the
 
252
current raster color or current raster index remains indeterminate.
 
253
.P
 
254
To set a valid raster position outside the viewport, first set a valid
 
255
raster position, then call \%\f3glBitmap\fP with NULL as the \f2bitmap\fP
 
256
parameter.
 
257
.P
 
258
When the \%\f3GL_ARB_imaging\fP extension is supported, there are distinct
 
259
raster texture coordinates for each texture unit. Each texture unit's
 
260
current ratster texture coordinates are updated by \%\f3glRasterPos\fP.
 
261
.SH ERRORS
 
262
\%\f3GL_INVALID_OPERATION\fP is generated if \%\f3glRasterPos\fP
 
263
is executed between the execution of \%\f3glBegin\fP
 
264
and the corresponding execution of \%\f3glEnd\fP.
 
265
.SH ASSOCIATED GETS
 
266
\%\f3glGet\fP with argument \%\f3GL_CURRENT_RASTER_POSITION\fP
 
267
.br
 
268
\%\f3glGet\fP with argument \%\f3GL_CURRENT_RASTER_POSITION_VALID\fP
 
269
.br
 
270
\%\f3glGet\fP with argument \%\f3GL_CURRENT_RASTER_DISTANCE\fP
 
271
.br
 
272
\%\f3glGet\fP with argument \%\f3GL_CURRENT_RASTER_COLOR\fP
 
273
.br
 
274
\%\f3glGet\fP with argument \%\f3GL_CURRENT_RASTER_INDEX\fP
 
275
.br
 
276
\%\f3glGet\fP with argument \%\f3GL_CURRENT_RASTER_TEXTURE_COORDS\fP
 
277
.SH SEE ALSO
 
278
\%\f3glBitmap(3G)\fP,
 
279
\%\f3glCopyPixels(3G)\fP,
 
280
\%\f3glDrawArrays(3G)\fP,
 
281
\%\f3glDrawElements(3G)\fP,
 
282
\%\f3glDrawRangeElements(3G)\fP,
 
283
\%\f3glDrawPixels(3G)\fP,
 
284
\%\f3glTexCoord(3G)\fP,
 
285
\%\f3glTexGen(3G)\fP,
 
286
\%\f3glVertex(3G)\fP