Inheritance diagram for iDepthStencilStates:

Detailed Description

DepthStencil states {Serialize}.

Public Member Functions
virtual tPtr	GetDescStructPtr () const =0
	Get the states description structure pointer. {Property}. More...

virtual ni::tBool	SerializeDataTable (ni::iDataTable *apDT, tSerializeFlags aFlags)=0
	Serialize the states. More...

Public Member Functions inherited from iUnknown
virtual tBool	IsOK () const =0
	Check if the object is valid. More...

virtual tI32	AddRef ()=0
	Signal that one more reference of the object has been created. More...

virtual tI32	Release ()=0
	Release a reference of the object. More...

virtual void	DeleteThis ()=0
	Bypass any reference counting and delete this object. More...

virtual void	Invalidate ()=0
	Invalidate the object. More...

virtual iUnknown *	QueryInterface (const tUUID &aIID)=0
	Query an interface. More...

virtual void	ListInterfaces (iMutableCollection *apLst, tU32 anFlags) const =0
	Fill a UUID list containing the UUIDs of the implemented interfaces. More...

virtual tI32	SetNumRefs (tI32 anNumRefs)=0
	Set the reference counter directly. More...

virtual tI32	GetNumRefs () const =0
	Get the number of references to this object. More...

General
virtual tBool	Copy (const iDepthStencilStates *apStates)=0
	Copy another depth-stencil states. More...

virtual iDepthStencilStates *	Clone () const =0
	Clone this depth-stencil states. More...

virtual tBool	GetIsCompiled () const =0
	Return whether the depth-stencil states are compiled (read-only) {Property}. More...

Depth test
virtual tBool	SetDepthTest (tBool aVal)=0
	Set whether the depth test is enabled. (default false) {Property}{Serialize}. More...

virtual tBool	GetDepthTest () const =0
	Get whether the depth test is enabled. {Property}{Serialize}. More...

virtual tBool	SetDepthTestWrite (tBool aVal)=0
	Set whether the depth test write is enabled. (default true) {Property}{Serialize}. More...

virtual tBool	GetDepthTestWrite () const =0
	Get whether the depth test write is enabled. {Property}{Serialize}. More...

virtual tBool	SetDepthTestCompare (eGraphicsCompare aVal)=0
	Set depth test compare function. (default eGraphicsCompare_LessEqual) {Property}{Serialize}. More...

virtual eGraphicsCompare	GetDepthTestCompare () const =0
	Get depth test compare function. {Property}{Serialize}. More...

Stencil
virtual tBool	SetStencilMode (eStencilMode aVal)=0
	Set the stencil mode. (default eStencilMode_None) {Property}{Serialize}. More...

virtual eStencilMode	GetStencilMode () const =0
	Get the stencil mode. {Property}{Serialize}. More...

virtual tBool	SetStencilRef (tI32 aVal)=0
	Set the stencil reference value. (default 0) {Property}{Serialize}. More...

virtual tI32	GetStencilRef () const =0
	Get the stencil reference value. {Property}{Serialize}. More...

virtual tBool	SetStencilMask (tU32 aVal)=0
	Set the stencil mask. (default 0xFFFFFFFF) {Property}{Serialize}. More...

virtual tU32	GetStencilMask () const =0
	Get the stencil mask. {Property}{Serialize}. More...

virtual tBool	SetStencilFrontCompare (eGraphicsCompare aVal)=0
	Set the stencil front test compare function. (eGraphicsCompare_Never) {Property}{Serialize}. More...

virtual eGraphicsCompare	GetStencilFrontCompare () const =0
	Get the stencil front test compare function. {Property}{Serialize}. More...

virtual tBool	SetStencilFrontFail (eStencilOp aVal)=0
	Set the stencil operation when the stencil front test fail. (eStencilOp_Keep) {Property}{Serialize}. More...

virtual eStencilOp	GetStencilFrontFail () const =0
	Get the stencil operation when the stencil front test fail. {Property}{Serialize}. More...

virtual tBool	SetStencilFrontPassDepthFail (eStencilOp aVal)=0
	Set the stencil operation when the stencil front test pass and the depth test fail. (eStencilOp_Keep) {Property}{Serialize}. More...

virtual eStencilOp	GetStencilFrontPassDepthFail () const =0
	Get the stencil operation when the stencil front test pass and the depth test fail. (eStencilOp_Keep) {Property}{Serialize}. More...

virtual tBool	SetStencilFrontPassDepthPass (eStencilOp aVal)=0
	Set the stencil operation when the stencil front test pass and the depth test pass. (eStencilOp_Keep) {Property}{Serialize}. More...

virtual eStencilOp	GetStencilFrontPassDepthPass () const =0
	Get the stencil operation when the stencil front test pass and the depth test pass. {Property}{Serialize}. More...

virtual tBool	SetStencilBackCompare (eGraphicsCompare aVal)=0
	Set the stencil back test compare function. (eGraphicsCompare_Never) {Property}{Serialize}. More...

virtual eGraphicsCompare	GetStencilBackCompare () const =0
	Get the stencil back test compare function. {Property}{Serialize}. More...

virtual tBool	SetStencilBackFail (eStencilOp aVal)=0
	Set the stencil operation when the stencil back test fail. (eStencilOp_Keep) {Property}{Serialize}. More...

virtual eStencilOp	GetStencilBackFail () const =0
	Get the stencil operation when the stencil back test fail. {Property}{Serialize}. More...

virtual tBool	SetStencilBackPassDepthFail (eStencilOp aVal)=0
	Set the stencil operation when the stencil back test pass and the depth test fail. (eStencilOp_Keep) {Property}{Serialize}. More...

virtual eStencilOp	GetStencilBackPassDepthFail () const =0
	Get the stencil operation when the stencil back test pass and the depth test fail. {Property}{Serialize}. More...

virtual tBool	SetStencilBackPassDepthPass (eStencilOp aVal)=0
	Set the stencil operation when the stencil back test pass and the depth test pass. (eStencilOp_Keep) {Property}{Serialize}. More...

virtual eStencilOp	GetStencilBackPassDepthPass () const =0
	Get the stencil operation when the stencil back test pass and the depth test pass. {Property}{Serialize}. More...

Member Function Documentation

virtual tBool Copy ( const iDepthStencilStates * apStates )

pure virtual

Copy another depth-stencil states.

virtual iDepthStencilStates* Clone ( ) const

pure virtual

Clone this depth-stencil states.

virtual tBool GetIsCompiled ( ) const

pure virtual

Return whether the depth-stencil states are compiled (read-only) {Property}.

virtual tBool SetDepthTest ( tBool aVal )

pure virtual

Set whether the depth test is enabled. (default false) {Property}{Serialize}.

virtual tBool GetDepthTest ( ) const

pure virtual

Get whether the depth test is enabled. {Property}{Serialize}.

virtual tBool SetDepthTestWrite ( tBool aVal )

pure virtual

Set whether the depth test write is enabled. (default true) {Property}{Serialize}.

virtual tBool GetDepthTestWrite ( ) const

pure virtual

Get whether the depth test write is enabled. {Property}{Serialize}.

virtual tBool SetDepthTestCompare ( eGraphicsCompare aVal )

pure virtual

Set depth test compare function. (default eGraphicsCompare_LessEqual) {Property}{Serialize}.

virtual eGraphicsCompare GetDepthTestCompare ( ) const

pure virtual

Get depth test compare function. {Property}{Serialize}.

virtual tBool SetStencilMode ( eStencilMode aVal )

pure virtual

Set the stencil mode. (default eStencilMode_None) {Property}{Serialize}.

virtual eStencilMode GetStencilMode ( ) const

pure virtual

Get the stencil mode. {Property}{Serialize}.

virtual tBool SetStencilRef ( tI32 aVal )

pure virtual

Set the stencil reference value. (default 0) {Property}{Serialize}.

virtual tI32 GetStencilRef ( ) const

pure virtual

Get the stencil reference value. {Property}{Serialize}.

virtual tBool SetStencilMask ( tU32 aVal )

pure virtual

Set the stencil mask. (default 0xFFFFFFFF) {Property}{Serialize}.

virtual tU32 GetStencilMask ( ) const

pure virtual

Get the stencil mask. {Property}{Serialize}.

virtual tBool SetStencilFrontCompare ( eGraphicsCompare aVal )

pure virtual

Set the stencil front test compare function. (eGraphicsCompare_Never) {Property}{Serialize}.

virtual eGraphicsCompare GetStencilFrontCompare ( ) const

pure virtual

Get the stencil front test compare function. {Property}{Serialize}.

virtual tBool SetStencilFrontFail ( eStencilOp aVal )

pure virtual

Set the stencil operation when the stencil front test fail. (eStencilOp_Keep) {Property}{Serialize}.

virtual eStencilOp GetStencilFrontFail ( ) const

pure virtual

Get the stencil operation when the stencil front test fail. {Property}{Serialize}.

virtual tBool SetStencilFrontPassDepthFail ( eStencilOp aVal )

pure virtual

Set the stencil operation when the stencil front test pass and the depth test fail. (eStencilOp_Keep) {Property}{Serialize}.

virtual eStencilOp GetStencilFrontPassDepthFail ( ) const

pure virtual

Get the stencil operation when the stencil front test pass and the depth test fail. (eStencilOp_Keep) {Property}{Serialize}.

virtual tBool SetStencilFrontPassDepthPass ( eStencilOp aVal )

pure virtual

Set the stencil operation when the stencil front test pass and the depth test pass. (eStencilOp_Keep) {Property}{Serialize}.

virtual eStencilOp GetStencilFrontPassDepthPass ( ) const

pure virtual

Get the stencil operation when the stencil front test pass and the depth test pass. {Property}{Serialize}.

virtual tBool SetStencilBackCompare ( eGraphicsCompare aVal )

pure virtual

Set the stencil back test compare function. (eGraphicsCompare_Never) {Property}{Serialize}.

virtual eGraphicsCompare GetStencilBackCompare ( ) const

pure virtual

Get the stencil back test compare function. {Property}{Serialize}.

virtual tBool SetStencilBackFail ( eStencilOp aVal )

pure virtual

Set the stencil operation when the stencil back test fail. (eStencilOp_Keep) {Property}{Serialize}.

virtual eStencilOp GetStencilBackFail ( ) const

pure virtual

Get the stencil operation when the stencil back test fail. {Property}{Serialize}.

virtual tBool SetStencilBackPassDepthFail ( eStencilOp aVal )

pure virtual

Set the stencil operation when the stencil back test pass and the depth test fail. (eStencilOp_Keep) {Property}{Serialize}.

virtual eStencilOp GetStencilBackPassDepthFail ( ) const

pure virtual

Get the stencil operation when the stencil back test pass and the depth test fail. {Property}{Serialize}.

virtual tBool SetStencilBackPassDepthPass ( eStencilOp aVal )

pure virtual

Set the stencil operation when the stencil back test pass and the depth test pass. (eStencilOp_Keep) {Property}{Serialize}.

virtual eStencilOp GetStencilBackPassDepthPass ( ) const

pure virtual

Get the stencil operation when the stencil back test pass and the depth test pass. {Property}{Serialize}.

virtual tPtr GetDescStructPtr ( ) const

pure virtual

Get the states description structure pointer. {Property}.

virtual ni::tBool SerializeDataTable	(	ni::iDataTable *	apDT,
		tSerializeFlags	aFlags
	)

pure virtual

Serialize the states.

Detailed Description

Public Member Functions

General

Depth test

Stencil

Member Function Documentation