OpenSceneGraph 3.6.5
Stencil
Go to the documentation of this file.
1/* -*-c++-*- OpenSceneGraph - Copyright (C) 1998-2006 Robert Osfield
2 *
3 * This library is open source and may be redistributed and/or modified under
4 * the terms of the OpenSceneGraph Public License (OSGPL) version 0.0 or
5 * (at your option) any later version. The full license is in LICENSE file
6 * included with this distribution, and on the openscenegraph.org website.
7 *
8 * This library is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * OpenSceneGraph Public License for more details.
12*/
13
14#ifndef OSG_STENCIL
15#define OSG_STENCIL 1
16
17#include <osg/StateAttribute>
18
19namespace osg {
20
21#ifndef GL_INCR_WRAP
22#define GL_INCR_WRAP 0x8507
23#define GL_DECR_WRAP 0x8508
24#endif
25
26
40{
41 public :
42
43
45
47 Stencil(const Stencil& stencil,const CopyOp& copyop=CopyOp::SHALLOW_COPY):
48 StateAttribute(stencil,copyop),
49 _func(stencil._func),
50 _funcRef(stencil._funcRef),
51 _funcMask(stencil._funcMask),
52 _sfail(stencil._sfail),
53 _zfail(stencil._zfail),
54 _zpass(stencil._zpass),
55 _writeMask(stencil._writeMask) {}
56
57
59
61 virtual int compare(const StateAttribute& sa) const
62 {
63 // check the types are equal and then create the rhs variable
64 // used by the COMPARE_StateAttribute_Parameter macros below.
66
67 // compare each parameter in turn against the rhs.
75
76 return 0; // passed all the above comparison macros, must be equal.
77 }
78
79 virtual bool getModeUsage(StateAttribute::ModeUsage& usage) const
80 {
81 usage.usesMode(GL_STENCIL_TEST);
82 return true;
83 }
84
86 {
87 NEVER = GL_NEVER,
88 LESS = GL_LESS,
89 EQUAL = GL_EQUAL,
90 LEQUAL = GL_LEQUAL,
91 GREATER = GL_GREATER,
92 NOTEQUAL = GL_NOTEQUAL,
93 GEQUAL = GL_GEQUAL,
94 ALWAYS = GL_ALWAYS
95 };
96
97 inline void setFunction(Function func,int ref,unsigned int mask)
98 {
99 _func = func;
100 _funcRef = ref;
101 _funcMask = mask;
102 }
103
104 inline void setFunction(Function func) { _func = func; }
105 inline Function getFunction() const { return _func; }
106
107 inline void setFunctionRef(int ref) { _funcRef=ref; }
108 inline int getFunctionRef() const { return _funcRef; }
109
110 inline void setFunctionMask(unsigned int mask) { _funcMask=mask; }
111 inline unsigned int getFunctionMask() const { return _funcMask; }
112
113
115 {
116 KEEP = GL_KEEP,
117 ZERO = GL_ZERO,
118 REPLACE = GL_REPLACE,
119 INCR = GL_INCR,
120 DECR = GL_DECR,
121 INVERT = GL_INVERT,
124 };
125
133 inline void setOperation(Operation sfail, Operation zfail, Operation zpass)
134 {
135 _sfail = sfail;
136 _zfail = zfail;
137 _zpass = zpass;
138 }
139
141 inline void setStencilFailOperation(Operation sfail) { _sfail = sfail; }
142
144 inline Operation getStencilFailOperation() const { return _sfail; }
145
148
151
154
157
158
159 inline void setWriteMask(unsigned int mask) { _writeMask = mask; }
160
161 inline unsigned int getWriteMask() const { return _writeMask; }
162
163
164 virtual void apply(State& state) const;
165
166
167 protected:
168
169 virtual ~Stencil();
170
173 unsigned int _funcMask;
174
178
179 unsigned int _writeMask;
180
181};
182
183}
184
185#endif
#define GL_DECR_WRAP
Definition Stencil:23
#define GL_INCR_WRAP
Definition Stencil:22
#define COMPARE_StateAttribute_Parameter(parameter)
COMPARE_StateAttribute_Parameter macro is a helper for implementing the StatateAtribute::compare(....
Definition StateAttribute:69
#define COMPARE_StateAttribute_Types(TYPE, rhs_attribute)
COMPARE_StateAttribute_Types macro is a helper for implementing the StateAtribute::compare(....
Definition StateAttribute:57
The core osg library provides the basic scene graph classes such as Nodes, State and Drawables,...
Definition AlphaFunc:19
Copy Op(erator) used to control whether shallow or deep copy is used during copy construction and clo...
Definition CopyOp:41
@ SHALLOW_COPY
Definition CopyOp:47
int ref() const
Increment the reference count by one, indicating that this object has another pointer which is refere...
Definition Referenced:161
Encapsulates the current applied OpenGL modes, attributes and vertex arrays settings,...
Definition State:80
@ STENCIL
Definition StateAttribute:152
Definition StateAttribute:308
virtual void usesMode(GLMode mode)=0
Function _func
Definition Stencil:171
void setFunctionMask(unsigned int mask)
Definition Stencil:110
void setStencilPassAndDepthFailOperation(Operation zfail)
set the operation when the stencil test passes but the depth test fails.
Definition Stencil:147
Operation
Definition Stencil:115
@ INCR_WRAP
Definition Stencil:122
@ DECR
Definition Stencil:120
@ ZERO
Definition Stencil:117
@ INVERT
Definition Stencil:121
@ KEEP
Definition Stencil:116
@ INCR
Definition Stencil:119
@ DECR_WRAP
Definition Stencil:123
@ REPLACE
Definition Stencil:118
META_StateAttribute(osg, Stencil, STENCIL)
Operation _zfail
Definition Stencil:176
Function
Definition Stencil:86
@ GEQUAL
Definition Stencil:93
@ EQUAL
Definition Stencil:89
@ LEQUAL
Definition Stencil:90
@ GREATER
Definition Stencil:91
@ NOTEQUAL
Definition Stencil:92
@ LESS
Definition Stencil:88
@ NEVER
Definition Stencil:87
@ ALWAYS
Definition Stencil:94
void setStencilFailOperation(Operation sfail)
set the operation when the stencil test fails.
Definition Stencil:141
void setFunction(Function func, int ref, unsigned int mask)
Definition Stencil:97
virtual int compare(const StateAttribute &sa) const
return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs.
Definition Stencil:61
void setFunctionRef(int ref)
Definition Stencil:107
int _funcRef
Definition Stencil:172
virtual void apply(State &state) const
apply the OpenGL state attributes.
Operation getStencilPassAndDepthPassOperation() const
get the operation when both the stencil test and the depth test pass.
Definition Stencil:156
Operation _sfail
Definition Stencil:175
unsigned int _writeMask
Definition Stencil:179
void setFunction(Function func)
Definition Stencil:104
Operation getStencilPassAndDepthFailOperation() const
get the operation when the stencil test passes but the depth test fails.
Definition Stencil:150
virtual ~Stencil()
void setWriteMask(unsigned int mask)
Definition Stencil:159
virtual bool getModeUsage(StateAttribute::ModeUsage &usage) const
Return the modes associated with this StateAttribute.
Definition Stencil:79
unsigned int getFunctionMask() const
Definition Stencil:111
int getFunctionRef() const
Definition Stencil:108
unsigned int _funcMask
Definition Stencil:173
Operation getStencilFailOperation() const
get the operation when the stencil test fails.
Definition Stencil:144
unsigned int getWriteMask() const
Definition Stencil:161
void setStencilPassAndDepthPassOperation(Operation zpass)
set the operation when both the stencil test and the depth test pass.
Definition Stencil:153
void setOperation(Operation sfail, Operation zfail, Operation zpass)
set the operations to apply when the various stencil and depth tests fail or pass.
Definition Stencil:133
Operation _zpass
Definition Stencil:177
Function getFunction() const
Definition Stencil:105
Stencil(const Stencil &stencil, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
Copy constructor using CopyOp to manage deep vs shallow copy.
Definition Stencil:47
#define OSG_EXPORT
Definition Export:39

osg logo
Generated at Wed Jul 23 2025 00:00:00 for the OpenSceneGraph by doxygen 1.14.0.