Depth/Stencil state. More...

#include <kanzi/core.ui/graphics/composition_stack.hpp>

Public Member Functions
void	apply (Renderer &renderer)
	Applies blend mode state.

	DepthStencilState (GraphicsCompareFunction depthFunc, bool depthWrite, GraphicsCompareFunction stencilFunc, unsigned int referenceValue, unsigned int maskValue, GraphicsStencilOperation stencilFail, GraphicsStencilOperation stencilPassDepthFail, GraphicsStencilOperation stencilPassDepthPass, bool stencilWrite)
	Constructor.

Public Attributes
GraphicsCompareFunction	depthFunc
	Depth testing mode. Use GraphicsCompareFunctionDisabled for turning off depth test completely.

bool	depthWrite
	Depth write enabled or not.

unsigned int	maskValue
	Stencil mask value.

unsigned int	referenceValue
	Stencil reference value.

GraphicsStencilOperation	stencilFail
	Operation for stencil test failing.

GraphicsCompareFunction	stencilFunc
	Stencil compare function. Use GraphicsCompareFunctionDisabled for turning off stencil test completely.

GraphicsStencilOperation	stencilPassDepthFail
	Operation for stencil test passing but depth test failing.

GraphicsStencilOperation	stencilPassDepthPass
	Operation for stencil and depth tests passing.

bool	stencilWrite
	Stencil write enabled or not.

Detailed Description

Depth/Stencil state.

Constructor & Destructor Documentation

◆ DepthStencilState()

kanzi::CompositionStack::DepthStencilState::DepthStencilState	(	GraphicsCompareFunction	depthFunc,
		bool	depthWrite,
		GraphicsCompareFunction	stencilFunc,
		unsigned int	referenceValue,
		unsigned int	maskValue,
		GraphicsStencilOperation	stencilFail,
		GraphicsStencilOperation	stencilPassDepthFail,
		GraphicsStencilOperation	stencilPassDepthPass,
		bool	stencilWrite )

inlineexplicit

Constructor.

Parameters

depthFunc	Depth test function.
depthWrite	Depth write enabled?
stencilFunc	Stencil test function to use.
referenceValue	Stencil reference value.
maskValue	Stencil mask value.
stencilFail	Operation for stencil failing.
stencilPassDepthFail	Operation for stencil passing but depth failing.
stencilPassDepthPass	Operation for stencil and depth passing.
stencilWrite	Stencil write enabled?

Member Function Documentation

◆ apply()

void kanzi::CompositionStack::DepthStencilState::apply ( Renderer & renderer )

Applies blend mode state.

Parameters

renderer Renderer to use.

Member Data Documentation

◆ depthFunc

GraphicsCompareFunction kanzi::CompositionStack::DepthStencilState::depthFunc

Depth testing mode. Use GraphicsCompareFunctionDisabled for turning off depth test completely.

◆ depthWrite

bool kanzi::CompositionStack::DepthStencilState::depthWrite

Depth write enabled or not.

◆ stencilFunc

GraphicsCompareFunction kanzi::CompositionStack::DepthStencilState::stencilFunc

Stencil compare function. Use GraphicsCompareFunctionDisabled for turning off stencil test completely.

◆ referenceValue

unsigned int kanzi::CompositionStack::DepthStencilState::referenceValue

Stencil reference value.

◆ maskValue

unsigned int kanzi::CompositionStack::DepthStencilState::maskValue

Stencil mask value.

◆ stencilFail

GraphicsStencilOperation kanzi::CompositionStack::DepthStencilState::stencilFail

Operation for stencil test failing.

◆ stencilPassDepthFail

GraphicsStencilOperation kanzi::CompositionStack::DepthStencilState::stencilPassDepthFail

Operation for stencil test passing but depth test failing.

◆ stencilPassDepthPass

GraphicsStencilOperation kanzi::CompositionStack::DepthStencilState::stencilPassDepthPass

Operation for stencil and depth tests passing.

◆ stencilWrite

bool kanzi::CompositionStack::DepthStencilState::stencilWrite

Stencil write enabled or not.

The documentation for this struct was generated from the following file:

kanzi/core.ui/graphics/composition_stack.hpp

Public Member Functions

Public Attributes