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

« back to all changes in this revision

Viewing changes to unix/xc/doc/man/GL/gl/logicop.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:
 
1
'\" et
 
2
'\"! eqn|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 logicop.g
 
9
.ds Xs 60568 5 logicop.gl
 
10
.TH GLLOGICOP 3G
 
11
.SH NAME
 
12
.B "glLogicOp
 
13
\- specify a logical pixel operation for color index rendering
 
14
 
 
15
.SH C SPECIFICATION
 
16
void \f3glLogicOp\fP(
 
17
GLenum \fIopcode\fP )
 
18
.nf
 
19
.fi
 
20
 
 
21
.SH PARAMETERS
 
22
.TP \w'\f2opcode\fP\ \ 'u 
 
23
\f2opcode\fP
 
24
Specifies a symbolic constant that selects a logical operation.
 
25
The following symbols are accepted:
 
26
\%\f3GL_CLEAR\fP,
 
27
\%\f3GL_SET\fP,
 
28
\%\f3GL_COPY\fP,
 
29
\%\f3GL_COPY_INVERTED\fP,
 
30
\%\f3GL_NOOP\fP,
 
31
\%\f3GL_INVERT\fP,
 
32
\%\f3GL_AND\fP,
 
33
\%\f3GL_NAND\fP,
 
34
\%\f3GL_OR\fP,
 
35
\%\f3GL_NOR\fP,
 
36
\%\f3GL_XOR\fP,
 
37
\%\f3GL_EQUIV\fP,
 
38
\%\f3GL_AND_REVERSE\fP,
 
39
\%\f3GL_AND_INVERTED\fP,
 
40
\%\f3GL_OR_REVERSE\fP, and
 
41
\%\f3GL_OR_INVERTED\fP. The initial value is \%\f3GL_COPY\fP.
 
42
.SH DESCRIPTION
 
43
\%\f3glLogicOp\fP specifies a logical operation that,
 
44
when enabled,
 
45
is applied between the incoming color index or RGBA color
 
46
and the color index or RGBA color at the corresponding location in the
 
47
frame buffer. 
 
48
To enable or disable the logical operation, call
 
49
\%\f3glEnable\fP and \%\f3glDisable\fP
 
50
using the symbolic constant \%\f3GL_COLOR_LOGIC_OP\fP for RGBA mode or
 
51
\%\f3GL_INDEX_LOGIC_OP\fP for color index mode. The initial value is
 
52
disabled for both operations.
 
53
.P
 
54
.ne
 
55
.TS
 
56
center;
 
57
lb lb
 
58
l c.
 
59
_
 
60
Opcode  Resulting Operation
 
61
_
 
62
\%\f3GL_CLEAR\fP        0
 
63
\%\f3GL_SET\fP  1
 
64
\%\f3GL_COPY\fP s
 
65
\%\f3GL_COPY_INVERTED\fP        ~s
 
66
\%\f3GL_NOOP\fP d
 
67
\%\f3GL_INVERT\fP       ~d
 
68
\%\f3GL_AND\fP  s & d
 
69
\%\f3GL_NAND\fP ~(s & d)
 
70
\%\f3GL_OR\fP   s | d
 
71
\%\f3GL_NOR\fP  ~(s | d)
 
72
\%\f3GL_XOR\fP  s ^ d
 
73
\%\f3GL_EQUIV\fP        ~(s ^ d)
 
74
\%\f3GL_AND_REVERSE\fP  s & ~d
 
75
\%\f3GL_AND_INVERTED\fP ~s & d
 
76
\%\f3GL_OR_REVERSE\fP   s | ~d
 
77
\%\f3GL_OR_INVERTED\fP  ~s | d
 
78
_
 
79
.TE
 
80
 
 
81
\f2opcode\fP is a symbolic constant chosen from the list above.
 
82
In the explanation of the logical operations,
 
83
\f2s\fP represents the incoming color index and
 
84
\f2d\fP represents the index in the frame buffer.
 
85
Standard C-language operators are used.
 
86
As these bitwise operators suggest,
 
87
the logical operation is applied independently to each bit pair of the
 
88
source and destination indices or colors.
 
89
.SH NOTES
 
90
Color index logical operations are always supported. RGBA logical
 
91
operations are supported only if the GL version is 1.1 or greater.  
 
92
.P
 
93
When more than one RGBA color or index buffer is enabled for drawing,
 
94
logical operations are performed separately for each enabled buffer,
 
95
using for the destination value the contents of that buffer
 
96
(see \%\f3glDrawBuffer\fP).
 
97
.SH ERRORS
 
98
\%\f3GL_INVALID_ENUM\fP is generated if \f2opcode\fP is not an accepted value.
 
99
.P
 
100
\%\f3GL_INVALID_OPERATION\fP is generated if \%\f3glLogicOp\fP
 
101
is executed between the execution of \%\f3glBegin\fP
 
102
and the corresponding execution of \%\f3glEnd\fP.
 
103
.SH ASSOCIATED GETS
 
104
\%\f3glGet\fP with argument \%\f3GL_LOGIC_OP_MODE\fP.
 
105
.br
 
106
\%\f3glIsEnabled\fP with argument \%\f3GL_COLOR_LOGIC_OP\fP or \%\f3GL_INDEX_LOGIC_OP\fP.
 
107
.SH SEE ALSO
 
108
\%\f3glAlphaFunc(3G)\fP,
 
109
\%\f3glBlendFunc(3G)\fP,
 
110
\%\f3glDrawBuffer(3G)\fP,
 
111
\%\f3glEnable(3G)\fP,
 
112
\%\f3glStencilOp(3G)\fP