← 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/alphafunc.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/alphafunc.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|eqn)_C_
 
36
_C_      eqn is automatically replaced with neqn for nroff
 
37
_header(AlphaFunc,specify the alpha test function)
 
38
_names(AlphaFunc)
 
39
.SH PARAMETERS
 
40
_phead(_param1)
 
41
Specifies the alpha comparison function.
 
42
Symbolic constants
 
43
_const(NEVER),
 
44
_const(LESS),
 
45
_const(EQUAL),
 
46
_const(LEQUAL),
 
47
_const(GREATER),
 
48
_const(NOTEQUAL),
 
49
_const(GEQUAL), and
 
50
_const(ALWAYS) are accepted. The initial value is _const(ALWAYS).
 
51
_phead(_param2)
 
52
Specifies the reference value that incoming alpha values are compared to.
 
53
This value is clamped to the range [0,\ 1],
 
54
where 0 represents the lowest possible alpha value
 
55
and 1 the highest possible value.
 
56
The initial reference value is 0.
 
57
.SH DESCRIPTION
 
58
The alpha test discards fragments depending on the outcome of a comparison
 
59
between an incoming fragment's alpha value and a constant reference value.
 
60
_cmnd specifies the reference value and the comparison function.
 
61
The comparison is performed only if alpha testing is enabled. By
 
62
default, it is not enabled. 
 
63
(See 
 
64
_cmnd(Enable) and _cmnd(Disable) of _const(ALPHA_TEST).)
 
65
.P
 
66
_param1 and _param2 specify the conditions under which
 
67
the pixel is drawn.
 
68
The incoming alpha value is compared to _param2
 
69
using the function specified by _param1.
 
70
If the value passes the comparison,
 
71
the incoming fragment is drawn
 
72
if it also passes subsequent stencil and depth buffer tests. 
 
73
If the value fails the comparison,
 
74
no change is made to the frame buffer at that pixel location. The
 
75
comparison functions are as follows: 
 
76
.TP 18
 
77
_const(NEVER)
 
78
Never passes. 
 
79
.TP
 
80
_const(LESS)
 
81
Passes if the incoming alpha value is less than the reference value.
 
82
.TP
 
83
_const(EQUAL)
 
84
Passes if the incoming alpha value is equal to the reference value.
 
85
.TP
 
86
_const(LEQUAL)
 
87
Passes if the incoming alpha value is less than or equal to the reference value.
 
88
.TP
 
89
_const(GREATER) 
 
90
Passes if the incoming alpha value is greater than the reference value.
 
91
.TP
 
92
_const(NOTEQUAL)
 
93
Passes if the incoming alpha value is not equal to the reference value.
 
94
.TP
 
95
_const(GEQUAL)
 
96
Passes if the incoming alpha value is greater than or equal to
 
97
the reference value.
 
98
.TP
 
99
_const(ALWAYS)
 
100
Always passes (initial value). 
 
101
.P
 
102
_cmnd operates on all pixel write operations,
 
103
including those resulting from the scan conversion of points,
 
104
lines,
 
105
polygons,
 
106
and bitmaps,
 
107
and from pixel draw and copy operations.
 
108
_cmnd does not affect screen clear operations.
 
109
.SH NOTES
 
110
Alpha testing is performed only in RGBA mode.
 
111
.SH ERRORS
 
112
_const(INVALID_ENUM) is generated if _param1 is not an accepted value.
 
113
.P
 
114
_const(INVALID_OPERATION) is generated if _cmnd
 
115
is executed between the execution of _cmnd(Begin)
 
116
and the corresponding execution of _cmnd(End).
 
117
.SH ASSOCIATED GETS
 
118
_cmnd(Get) with argument _const(ALPHA_TEST_FUNC)
 
119
.br
 
120
_cmnd(Get) with argument _const(ALPHA_TEST_REF)
 
121
.br
 
122
_cmnd(IsEnabled) with argument _const(ALPHA_TEST)
 
123
.SH SEE ALSO
 
124
_cmnd(BlendFunc),
 
125
_cmnd(Clear),
 
126
_cmnd(DepthFunc),
 
127
_cmnd(Enable),
 
128
_cmnd(StencilFunc)