kanzi::DepthStencilStateCache Class Reference

Use a Depth Stencil State Cache to lookup a Kanzi graphics Depth Stencil State. More...

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

Public Member Functions
	DepthStencilStateCache ()=default
	Constructor.
	DepthStencilStateCache (const DepthStencilStateCache &)=delete
	DepthStencilStateCache (DepthStencilStateCache &&)=delete
gfx::DepthStencilStateHandleGuard	get (GraphicsCompareFunction depthFunc, bool depthWrite, GraphicsCompareFunction stencilFunc, uint32_t referenceValue, uint32_t maskValue, GraphicsStencilOperation stencilFail, GraphicsStencilOperation stencilPassDepthFail, GraphicsStencilOperation stencilPassDepthPass, bool stencilWrite)
	Gets or creates a Graphics Depth Stencil State for the requested state.
void	invalidate ()
	Invalidates the cache and releases all kanzi graphics handles.
DepthStencilStateCache &	operator= (const DepthStencilStateCache &)=delete
DepthStencilStateCache &	operator= (DepthStencilStateCache &&)=delete

Detailed Description

Use a Depth Stencil State Cache to lookup a Kanzi graphics Depth Stencil State.

Since

Kanzi 4.0.0

Constructor & Destructor Documentation

DepthStencilStateCache() [1/3]

kanzi::DepthStencilStateCache::DepthStencilStateCache ( )

default

Constructor.

DepthStencilStateCache() [2/3]

kanzi::DepthStencilStateCache::DepthStencilStateCache ( const DepthStencilStateCache & )

delete

DepthStencilStateCache() [3/3]

kanzi::DepthStencilStateCache::DepthStencilStateCache ( DepthStencilStateCache && )

delete

Member Function Documentation

operator=() [1/2]

DepthStencilStateCache & kanzi::DepthStencilStateCache::operator= ( const DepthStencilStateCache & )

delete

operator=() [2/2]

DepthStencilStateCache & kanzi::DepthStencilStateCache::operator= ( DepthStencilStateCache && )

delete

get()

gfx::DepthStencilStateHandleGuard kanzi::DepthStencilStateCache::get	(	GraphicsCompareFunction	depthFunc,
		bool	depthWrite,
		GraphicsCompareFunction	stencilFunc,
		uint32_t	referenceValue,
		uint32_t	maskValue,
		GraphicsStencilOperation	stencilFail,
		GraphicsStencilOperation	stencilPassDepthFail,
		GraphicsStencilOperation	stencilPassDepthPass,
		bool	stencilWrite )

Gets or creates a Graphics Depth Stencil State for the requested state.

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.

Returns

The Kanzi graphics DepthStencil State handle.

invalidate()

void kanzi::DepthStencilStateCache::invalidate

(

)

Invalidates the cache and releases all kanzi graphics handles.

---

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

• kanzi/core.ui/graphics/depth_stencil_state_cache.hpp