← 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/clear.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/clear.3gl
 
1
'\" te
 
2
'\"! tbl|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 clear.gl 
 
9
.ds Xs 16977 5 clear.gl
 
10
.TH GLCLEAR 3G
 
11
.SH NAME
 
12
.B "glClear
 
13
\- clear buffers to preset values
 
14
 
 
15
.SH C SPECIFICATION
 
16
void \f3glClear\fP(
 
17
GLbitfield \fImask\fP )
 
18
.nf
 
19
.fi
 
20
 
 
21
.SH PARAMETERS
 
22
.TP \w'\f2mask\fP\ \ 'u 
 
23
\f2mask\fP
 
24
Bitwise OR of masks that indicate the buffers to be cleared.
 
25
The four masks are
 
26
\%\f3GL_COLOR_BUFFER_BIT\fP,
 
27
\%\f3GL_DEPTH_BUFFER_BIT\fP,
 
28
\%\f3GL_ACCUM_BUFFER_BIT\fP, and
 
29
\%\f3GL_STENCIL_BUFFER_BIT\fP.
 
30
.SH DESCRIPTION
 
31
\%\f3glClear\fP sets the bitplane area of the window to values previously selected
 
32
by \%\f3glClearColor\fP, \%\f3glClearIndex\fP, \%\f3glClearDepth\fP, 
 
33
\%\f3glClearStencil\fP, and \%\f3glClearAccum\fP.
 
34
Multiple color buffers can be cleared simultaneously by selecting
 
35
more than one buffer at a time using \%\f3glDrawBuffer\fP.
 
36
.P
 
37
The pixel ownership test,
 
38
the scissor test,
 
39
dithering, and the buffer writemasks affect the operation of \%\f3glClear\fP.
 
40
The scissor box bounds the cleared region.
 
41
Alpha function,
 
42
blend function,
 
43
logical operation,
 
44
stenciling,
 
45
texture mapping,
 
46
and depth-buffering are ignored by \%\f3glClear\fP.
 
47
.P
 
48
\%\f3glClear\fP takes a single argument that is the bitwise OR of several
 
49
values indicating which buffer is to be cleared.
 
50
.P
 
51
The values are as follows: 
 
52
.TP 28
 
53
\%\f3GL_COLOR_BUFFER_BIT\fP
 
54
Indicates the buffers currently enabled for color
 
55
writing.
 
56
.TP
 
57
\%\f3GL_DEPTH_BUFFER_BIT\fP
 
58
Indicates the depth buffer.
 
59
.TP
 
60
\%\f3GL_ACCUM_BUFFER_BIT\fP
 
61
Indicates the accumulation buffer. 
 
62
.TP
 
63
\%\f3GL_STENCIL_BUFFER_BIT\fP
 
64
Indicates the stencil buffer.
 
65
.P
 
66
The value to which each buffer is cleared depends on the setting of the
 
67
clear value for that buffer.  
 
68
.SH NOTES
 
69
If a buffer is not present,
 
70
then a \%\f3glClear\fP directed at that buffer has no effect.
 
71
.SH ERRORS
 
72
\%\f3GL_INVALID_VALUE\fP is generated if any bit other than the four defined
 
73
bits is set in \f2mask\fP.
 
74
.P
 
75
\%\f3GL_INVALID_OPERATION\fP is generated if \%\f3glClear\fP
 
76
is executed between the execution of \%\f3glBegin\fP
 
77
and the corresponding execution of \%\f3glEnd\fP.
 
78
.SH ASSOCIATED GETS
 
79
\%\f3glGet\fP with argument \%\f3GL_ACCUM_CLEAR_VALUE\fP
 
80
.br
 
81
\%\f3glGet\fP with argument \%\f3GL_DEPTH_CLEAR_VALUE\fP
 
82
.br
 
83
\%\f3glGet\fP with argument \%\f3GL_INDEX_CLEAR_VALUE\fP
 
84
.br
 
85
\%\f3glGet\fP with argument \%\f3GL_COLOR_CLEAR_VALUE\fP
 
86
.br
 
87
\%\f3glGet\fP with argument \%\f3GL_STENCIL_CLEAR_VALUE\fP
 
88
.SH SEE ALSO
 
89
\%\f3glClearAccum(3G)\fP,
 
90
\%\f3glClearColor(3G)\fP,
 
91
\%\f3glClearDepth(3G)\fP,
 
92
\%\f3glClearIndex(3G)\fP,
 
93
\%\f3glClearStencil(3G)\fP,
 
94
\%\f3glColorMask(3G)\fP,
 
95
\%\f3glDepthMask(3G)\fP,
 
96
\%\f3glDrawBuffer(3G)\fP,
 
97
\%\f3glScissor(3G)\fP,
 
98
\%\f3glStencilMask(3G)\fP