This reference page is linked to from the following overview topics: Nitrous Graphics SDK Extensions.
#include <RenderStates.h>
This class encapsulates a complete set of stencil buffer operations for stencil test.
Public Member Functions |
|
virtual void | SetStencilFailOperation (StencilOperationType op) |
Set stencil operation when stencil test
fails. |
|
virtual StencilOperationType | GetStencilFailOperation () const |
Get stencil fail operation /return stencil
fail operation. |
|
virtual void | SetStencilDepthFailOperation (StencilOperationType op) |
Set stencil operation when stencil test
passes and depth test fails. |
|
virtual StencilOperationType | GetStencilDepthFailOperation () const |
Get stencil operation when stencil test
passes and depth test fails. |
|
virtual void | SetStencilPassOperation (StencilOperationType op) |
Set stencil operation when stencil test and
depth test all pass. |
|
virtual StencilOperationType | GetStencilPassOperation () const |
Get stencil operation when stencil test and
depth test all pass. |
|
virtual void | SetStencilFunction (CompareFunction func) |
Set compare function for stencil test.
|
|
virtual CompareFunction | GetStencilFunction () const |
Get compare function for stencil test.
|
|
Protected Member Functions |
|
StencilOperation () | |
virtual | ~StencilOperation () |
Protected Attributes |
|
StencilOperationType | mStencilFailOp |
Stencil operation when stencil test fails.
|
|
StencilOperationType | mStencilDepthFailOp |
Stencil operation when stencil test passes
and depth test fails. |
|
StencilOperationType | mStencilPassOp |
Stencil operation when stencil test and
depth test all pass. |
|
CompareFunction | mStencilFunc |
Compare function for stencil test. |
|
Friends |
|
class | DepthStencilState |
StencilOperation | ( | ) | [protected] |
virtual ~StencilOperation | ( | ) | [inline, protected, virtual] |
{}
virtual void SetStencilFailOperation | ( | StencilOperationType | op | ) | [virtual] |
Set stencil operation when stencil test fails.
By default, it is StencilOperationKeep. /param op operation when stencil test fails.
virtual StencilOperationType GetStencilFailOperation | ( | ) | const [virtual] |
Get stencil fail operation /return stencil fail operation.
virtual void SetStencilDepthFailOperation | ( | StencilOperationType | op | ) | [virtual] |
Set stencil operation when stencil test passes and depth test fails.
By default, it is StencilOperationKeep. /param op operation when depth fail
virtual StencilOperationType GetStencilDepthFailOperation | ( | ) | const [virtual] |
Get stencil operation when stencil test passes and depth test fails.
/return depth fail operation
virtual void SetStencilPassOperation | ( | StencilOperationType | op | ) | [virtual] |
Set stencil operation when stencil test and depth test all pass.
By default, it is StencilOperationKeep. /param op operation when stencil pass
virtual StencilOperationType GetStencilPassOperation | ( | ) | const [virtual] |
Get stencil operation when stencil test and depth test all pass.
/return stencil and depth pass operation
virtual void SetStencilFunction | ( | CompareFunction | func | ) | [virtual] |
Set compare function for stencil test.
By default, it is CompareFunctionAlways. /param func compare function for stencil test.
virtual CompareFunction GetStencilFunction | ( | ) | const [virtual] |
Get compare function for stencil test.
/return compare function for stencil test.
friend class DepthStencilState
[friend] |
StencilOperationType
mStencilFailOp [protected] |
Stencil operation when stencil test fails.
By default, it is StencilOperationKeep.
StencilOperationType
mStencilDepthFailOp [protected] |
Stencil operation when stencil test passes and depth test fails.
By default, it is StencilOperationKeep.
StencilOperationType
mStencilPassOp [protected] |
Stencil operation when stencil test and depth test all pass.
By default, it is StencilOperationKeep.
CompareFunction
mStencilFunc [protected] |
Compare function for stencil test.
By default, it is CompareFunctionAlways.