uicore::DepthStencilStateDescription Class Reference

DepthStencil state description. More...

#include <depth_stencil_state_description.h>

Public Member Functions
	DepthStencilStateDescription ()
DepthStencilStateDescription	clone () const
CompareFunction	depth_compare_function () const
void	enable_depth_test (bool enabled)
	Enables/disables depth testing. More...
void	enable_depth_write (bool enabled)
	Enables/disables depth writing. More...
void	enable_stencil_test (bool enabled)
	Enables/disables stencil testing. More...
bool	is_depth_test_enabled () const
bool	is_depth_write_enabled () const
bool	is_stencil_test_enabled () const
bool	operator< (const DepthStencilStateDescription &other) const
bool	operator== (const DepthStencilStateDescription &other) const
void	set_depth_compare_function (CompareFunction func)
	Set depth test function. More...
void	set_stencil_compare_back (CompareFunction back, int back_ref, int back_mask)
	Set stencil compare function. More...
void	set_stencil_compare_front (CompareFunction front, int front_ref, int front_mask)
	Set stencil compare function. More...
void	set_stencil_op_back (StencilOp fail_back, StencilOp pass_depth_fail_back, StencilOp pass_depth_pass_back)
	Set stencil operations. More...
void	set_stencil_op_front (StencilOp fail_front, StencilOp pass_depth_fail_front, StencilOp pass_depth_pass_front)
	Set stencil operations. More...
void	set_stencil_write_mask (unsigned char front_facing_mask, unsigned char back_facing_mask)
	Set stencil write masks. More...
void	stencil_compare_back (CompareFunction &out_back, int &out_back_ref, int &out_back_mask) const
void	stencil_compare_front (CompareFunction &out_front, int &out_front_ref, int &out_front_mask) const
void	stencil_op_back (StencilOp &out_fail_back, StencilOp &out_pass_depth_fail_back, StencilOp &out_pass_depth_pass_back) const
void	stencil_op_front (StencilOp &out_fail_front, StencilOp &out_pass_depth_fail_front, StencilOp &out_pass_depth_pass_front) const
void	stencil_write_mask (unsigned char &out_front_facing_mask, unsigned char &out_back_facing_mask) const

Detailed Description

DepthStencil state description.

Constructor & Destructor Documentation

uicore::DepthStencilStateDescription::DepthStencilStateDescription

(

)

Member Function Documentation

DepthStencilStateDescription uicore::DepthStencilStateDescription::clone

(

)

const

CompareFunction uicore::DepthStencilStateDescription::depth_compare_function

(

)

const

void uicore::DepthStencilStateDescription::enable_depth_test

(

bool

enabled

)

Enables/disables depth testing.

void uicore::DepthStencilStateDescription::enable_depth_write

(

bool

enabled

)

Enables/disables depth writing.

void uicore::DepthStencilStateDescription::enable_stencil_test

(

bool

enabled

)

Enables/disables stencil testing.

bool uicore::DepthStencilStateDescription::is_depth_test_enabled

(

)

const

bool uicore::DepthStencilStateDescription::is_depth_write_enabled

(

)

const

bool uicore::DepthStencilStateDescription::is_stencil_test_enabled

(

)

const

bool uicore::DepthStencilStateDescription::operator<

(

const DepthStencilStateDescription &

other

)

const

bool uicore::DepthStencilStateDescription::operator==

(

const DepthStencilStateDescription &

other

)

const

void uicore::DepthStencilStateDescription::set_depth_compare_function

(

CompareFunction

func

)

Set depth test function.

void uicore::DepthStencilStateDescription::set_stencil_compare_back	(	CompareFunction	back,
		int	back_ref,
		int	back_mask
	)

Set stencil compare function.

void uicore::DepthStencilStateDescription::set_stencil_compare_front	(	CompareFunction	front,
		int	front_ref,
		int	front_mask
	)

Set stencil compare function.

void uicore::DepthStencilStateDescription::set_stencil_op_back	(	StencilOp	fail_back,
		StencilOp	pass_depth_fail_back,
		StencilOp	pass_depth_pass_back
	)

Set stencil operations.

Set stencil failed test operations. Set stencil passed test operations. Set stencil passed depth test but failed stencil test operations.

void uicore::DepthStencilStateDescription::set_stencil_op_front	(	StencilOp	fail_front,
		StencilOp	pass_depth_fail_front,
		StencilOp	pass_depth_pass_front
	)

Set stencil operations.

Set stencil failed test operations. Set stencil passed test operations. Set stencil passed depth test but failed stencil test operations.

void uicore::DepthStencilStateDescription::set_stencil_write_mask	(	unsigned char	front_facing_mask,
		unsigned char	back_facing_mask
	)

Set stencil write masks.

void uicore::DepthStencilStateDescription::stencil_compare_back	(	CompareFunction &	out_back,
		int &	out_back_ref,
		int &	out_back_mask
	)		const

void uicore::DepthStencilStateDescription::stencil_compare_front	(	CompareFunction &	out_front,
		int &	out_front_ref,
		int &	out_front_mask
	)		const

void uicore::DepthStencilStateDescription::stencil_op_back	(	StencilOp &	out_fail_back,
		StencilOp &	out_pass_depth_fail_back,
		StencilOp &	out_pass_depth_pass_back
	)		const

void uicore::DepthStencilStateDescription::stencil_op_front	(	StencilOp &	out_fail_front,
		StencilOp &	out_pass_depth_fail_front,
		StencilOp &	out_pass_depth_pass_front
	)		const

void uicore::DepthStencilStateDescription::stencil_write_mask	(	unsigned char &	out_front_facing_mask,
		unsigned char &	out_back_facing_mask
	)		const

---

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

• depth_stencil_state_description.h