StencilOperation Class Reference

This reference page is linked to from the following overview topics: Nitrous Graphics SDK Extensions.

---

Search for all occurrences

#include <RenderStates.h>

Inheritance diagram for StencilOperation:

---

Class Description

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

---

Constructor & Destructor Documentation

StencilOperation

(

)

[protected]

virtual ~StencilOperation

(

)

[inline, protected, virtual]

{}

---

Member Function Documentation

virtual void SetStencilFailOperation

(

StencilOperationType

op

)

[virtual]

Search for all occurrences

Set stencil operation when stencil test fails.

By default, it is StencilOperationKeep. /param op operation when stencil test fails.

virtual StencilOperationType GetStencilFailOperation

(

)

const [virtual]

Search for all occurrences

Get stencil fail operation /return stencil fail operation.

virtual void SetStencilDepthFailOperation

(

StencilOperationType

op

)

[virtual]

Search for all occurrences

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]

Search for all occurrences

Get stencil operation when stencil test passes and depth test fails.

/return depth fail operation

virtual void SetStencilPassOperation

(

StencilOperationType

op

)

[virtual]

Search for all occurrences

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]

Search for all occurrences

Get stencil operation when stencil test and depth test all pass.

/return stencil and depth pass operation

virtual void SetStencilFunction

(

CompareFunction

func

)

[virtual]

Search for all occurrences

Set compare function for stencil test.

By default, it is CompareFunctionAlways. /param func compare function for stencil test.

virtual CompareFunction GetStencilFunction

(

)

const [virtual]

Search for all occurrences

Get compare function for stencil test.

/return compare function for stencil test.

---

Friends And Related Function Documentation

friend class DepthStencilState [friend]

Search for all occurrences

---

Member Data Documentation

StencilOperationType mStencilFailOp [protected]

Search for all occurrences

Stencil operation when stencil test fails.

By default, it is StencilOperationKeep.

StencilOperationType mStencilDepthFailOp [protected]

Search for all occurrences

Stencil operation when stencil test passes and depth test fails.

By default, it is StencilOperationKeep.

StencilOperationType mStencilPassOp [protected]

Search for all occurrences

Stencil operation when stencil test and depth test all pass.

By default, it is StencilOperationKeep.

CompareFunction mStencilFunc [protected]

Search for all occurrences

Compare function for stencil test.

By default, it is CompareFunctionAlways.