OpenSceneGraph 3.6.5
StencilTwoSided
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_STENCILTWOSIDED
15#define OSG_STENCILTWOSIDED 1
16
17#include <osg/Stencil>
18
19namespace osg {
20
21#ifndef GL_STENCIL_TEST_TWO_SIDE
22#define GL_STENCIL_TEST_TWO_SIDE 0x8910
23#endif
24
39{
40 public :
41
42
44
47
49
51 virtual int compare(const StateAttribute& sa) const;
52
53 virtual bool getModeUsage(StateAttribute::ModeUsage& usage) const
54 {
55 usage.usesMode(GL_STENCIL_TEST);
56 return true;
57 }
58
59 enum Face
60 {
61 FRONT = 0,
62 BACK = 1
63 };
64
66 {
67 NEVER = GL_NEVER,
68 LESS = GL_LESS,
69 EQUAL = GL_EQUAL,
70 LEQUAL = GL_LEQUAL,
71 GREATER = GL_GREATER,
72 NOTEQUAL = GL_NOTEQUAL,
73 GEQUAL = GL_GEQUAL,
74 ALWAYS = GL_ALWAYS
75 };
76
77 inline void setFunction(Face face, Function func,int ref,unsigned int mask)
78 {
79 _func[face] = func;
80 _funcRef[face] = ref;
81 _funcMask[face] = mask;
82 }
83
84 inline void setFunction(Face face, Function func) { _func[face] = func; }
85 inline Function getFunction(Face face) const { return _func[face]; }
86
87 inline void setFunctionRef(Face face, int ref) { _funcRef[face]=ref; }
88 inline int getFunctionRef(Face face) const { return _funcRef[face]; }
89
90 inline void setFunctionMask(Face face, unsigned int mask) { _funcMask[face]=mask; }
91 inline unsigned int getFunctionMask(Face face) const { return _funcMask[face]; }
92
93
95 {
96 KEEP = GL_KEEP,
97 ZERO = GL_ZERO,
98 REPLACE = GL_REPLACE,
99 INCR = GL_INCR,
100 DECR = GL_DECR,
101 INVERT = GL_INVERT,
104 };
105
113 inline void setOperation(Face face, Operation sfail, Operation zfail, Operation zpass)
114 {
115 _sfail[face] = sfail;
116 _zfail[face] = zfail;
117 _zpass[face] = zpass;
118 }
119
121 inline void setStencilFailOperation(Face face, Operation sfail) { _sfail[face] = sfail; }
122
124 inline Operation getStencilFailOperation(Face face) const { return _sfail[face]; }
125
127 inline void setStencilPassAndDepthFailOperation(Face face, Operation zfail) { _zfail[face]=zfail; }
128
130 inline Operation getStencilPassAndDepthFailOperation(Face face) const { return _zfail[face]; }
131
133 inline void setStencilPassAndDepthPassOperation(Face face, Operation zpass) { _zpass[face]=zpass; }
134
136 inline Operation getStencilPassAndDepthPassOperation(Face face) const { return _zpass[face]; }
137
138
139 inline void setWriteMask(Face face, unsigned int mask) { _writeMask[face] = mask; }
140
141 inline unsigned int getWriteMask(Face face) const { return _writeMask[face]; }
142
143
144 virtual void apply(State& state) const;
145
146 protected:
147
149
151 int _funcRef[2];
152 unsigned int _funcMask[2];
153
157
158 unsigned int _writeMask[2];
159
160};
161
162}
163
164#endif
#define GL_DECR_WRAP
Definition Stencil:23
#define GL_INCR_WRAP
Definition Stencil:22
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
unsigned int getFunctionMask(Face face) const
Definition StencilTwoSided:91
void setStencilPassAndDepthPassOperation(Face face, Operation zpass)
set the operation when both the stencil test and the depth test pass.
Definition StencilTwoSided:133
Function getFunction(Face face) const
Definition StencilTwoSided:85
virtual bool getModeUsage(StateAttribute::ModeUsage &usage) const
Return the modes associated with this StateAttribute.
Definition StencilTwoSided:53
Face
Definition StencilTwoSided:60
@ FRONT
Definition StencilTwoSided:61
@ BACK
Definition StencilTwoSided:62
void setStencilPassAndDepthFailOperation(Face face, Operation zfail)
set the operation when the stencil test passes but the depth test fails.
Definition StencilTwoSided:127
virtual ~StencilTwoSided()
void setFunctionMask(Face face, unsigned int mask)
Definition StencilTwoSided:90
void setWriteMask(Face face, unsigned int mask)
Definition StencilTwoSided:139
META_StateAttribute(osg, StencilTwoSided, STENCIL)
unsigned int _funcMask[2]
Definition StencilTwoSided:152
void setStencilFailOperation(Face face, Operation sfail)
set the operation when the stencil test fails.
Definition StencilTwoSided:121
unsigned int _writeMask[2]
Definition StencilTwoSided:158
Function _func[2]
Definition StencilTwoSided:150
int getFunctionRef(Face face) const
Definition StencilTwoSided:88
Operation _zfail[2]
Definition StencilTwoSided:155
unsigned int getWriteMask(Face face) const
Definition StencilTwoSided:141
Operation getStencilFailOperation(Face face) const
get the operation when the stencil test fails.
Definition StencilTwoSided:124
virtual int compare(const StateAttribute &sa) const
return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs.
void setOperation(Face face, Operation sfail, Operation zfail, Operation zpass)
set the operations to apply when the various stencil and depth tests fail or pass.
Definition StencilTwoSided:113
void setFunction(Face face, Function func)
Definition StencilTwoSided:84
Operation _zpass[2]
Definition StencilTwoSided:156
StencilTwoSided(const StencilTwoSided &stencil, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
Copy constructor using CopyOp to manage deep vs shallow copy.
Operation _sfail[2]
Definition StencilTwoSided:154
virtual void apply(State &state) const
apply the OpenGL state attributes.
void setFunction(Face face, Function func, int ref, unsigned int mask)
Definition StencilTwoSided:77
Operation
Definition StencilTwoSided:95
@ INVERT
Definition StencilTwoSided:101
@ DECR
Definition StencilTwoSided:100
@ DECR_WRAP
Definition StencilTwoSided:103
@ REPLACE
Definition StencilTwoSided:98
@ INCR_WRAP
Definition StencilTwoSided:102
@ ZERO
Definition StencilTwoSided:97
@ INCR
Definition StencilTwoSided:99
@ KEEP
Definition StencilTwoSided:96
void setFunctionRef(Face face, int ref)
Definition StencilTwoSided:87
Operation getStencilPassAndDepthFailOperation(Face face) const
get the operation when the stencil test passes but the depth test fails.
Definition StencilTwoSided:130
Operation getStencilPassAndDepthPassOperation(Face face) const
get the operation when both the stencil test and the depth test pass.
Definition StencilTwoSided:136
int _funcRef[2]
Definition StencilTwoSided:151
Function
Definition StencilTwoSided:66
@ GREATER
Definition StencilTwoSided:71
@ GEQUAL
Definition StencilTwoSided:73
@ ALWAYS
Definition StencilTwoSided:74
@ LESS
Definition StencilTwoSided:68
@ NOTEQUAL
Definition StencilTwoSided:72
@ LEQUAL
Definition StencilTwoSided:70
@ EQUAL
Definition StencilTwoSided:69
@ NEVER
Definition StencilTwoSided:67
#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.