Frontend::Graphics::DepthStencilStateDescriptor

Frontend::Graphics::DepthStencilStateDescriptor Class Reference

Describes the settings desired for a DepthStencilState object. More...

#include <Frontend2Graphics.h>

List of all members.

Public Member Functions

 DepthStencilStateDescriptor ()
 Initializes the descriptor with default values.
bool operator< (DepthStencilStateDescriptor &s)
 Defines less-than relation between two descriptors.
bool operator== (DepthStencilStateDescriptor &s)
 Compares two descriptors.

Public Attributes

bool DepthTestEnabled
 Wether or not Z-testing should be enabled.
CompareFunction DepthFunction
 Condition for a pixel passing the depth test.
bool DepthWriteMask
 Wether on not to write the depth-value to the depth buffer if the depth test is passed.
bool StencilTestEnabled
 Wether or not stencil testing should be enabled.
CompareFunction StencilFunction
 Condition for a pixel passing the stencil test.
int StencilReferenceValue
 Reference value for the stencil test.
int StencilOperandMask
 A bitmask for the operands of the stencil test.
int StencilMask
 A bitmask for writing to the stencil buffer.
StencilOperation StencilFailOperation
 What to do in the stencil buffer if the stencil test fails for a pixel.
StencilOperation StencilDepthFailOperation
 What to do in the stencil buffer if the depth test fails for pixel.
StencilOperation StencilDepthPassOperation
 What to do in the stencil buffer if the depth test passes for a pixel.

Detailed Description

Describes the settings desired for a DepthStencilState object.

Constructor & Destructor Documentation

Frontend::Graphics::DepthStencilStateDescriptor::DepthStencilStateDescriptor (   )  [inline]
 

Initializes the descriptor with default values.

Member Function Documentation

bool Frontend::Graphics::DepthStencilStateDescriptor::operator< (  DepthStencilStateDescriptor &  s  )  [inline]
 

Defines less-than relation between two descriptors.

This allows this class to be used in binary search trees.

bool Frontend::Graphics::DepthStencilStateDescriptor::operator== (  DepthStencilStateDescriptor &  s  )  [inline]
 

Compares two descriptors.

This allows this class to be used in maps.

Member Data Documentation

CompareFunction Frontend::Graphics::DepthStencilStateDescriptor::DepthFunction
 

Condition for a pixel passing the depth test.

Only considered if DepthTestEnabled is true. The default value is CompareFunctionLess.

bool Frontend::Graphics::DepthStencilStateDescriptor::DepthTestEnabled
 

Wether or not Z-testing should be enabled.

The default value is false.

bool Frontend::Graphics::DepthStencilStateDescriptor::DepthWriteMask
 

Wether on not to write the depth-value to the depth buffer if the depth test is passed.

Only considered if DepthTestEnabled is true. The default value is true.

StencilOperation Frontend::Graphics::DepthStencilStateDescriptor::StencilDepthFailOperation
 

What to do in the stencil buffer if the depth test fails for pixel.

Only considered if StencilTestEnabled is true. Only considered if DepthTestEnabled is true. The default value is StencilOperationKeep.

StencilOperation Frontend::Graphics::DepthStencilStateDescriptor::StencilDepthPassOperation
 

What to do in the stencil buffer if the depth test passes for a pixel.

Only considered if StencilTestEnabled is true. Only considered if DepthTestEnabled is true. The default value is StencilOperationKeep.

StencilOperation Frontend::Graphics::DepthStencilStateDescriptor::StencilFailOperation
 

What to do in the stencil buffer if the stencil test fails for a pixel.

Only considered if StencilTestEnabled is true. The default value is StencilOperationKeep.

CompareFunction Frontend::Graphics::DepthStencilStateDescriptor::StencilFunction
 

Condition for a pixel passing the stencil test.

Only considered if StencilTestEnabled is true. The default value is CompareFunctionLess.

int Frontend::Graphics::DepthStencilStateDescriptor::StencilMask
 

A bitmask for writing to the stencil buffer.

Only considered if StencilTestEnabled is true. The default value is ~0.

int Frontend::Graphics::DepthStencilStateDescriptor::StencilOperandMask
 

A bitmask for the operands of the stencil test.

Only considered if StencilTestEnabled is true. The default value is ~0.

int Frontend::Graphics::DepthStencilStateDescriptor::StencilReferenceValue
 

Reference value for the stencil test.

Only considered if StencilTestEnabled is true. The default value is 0.

bool Frontend::Graphics::DepthStencilStateDescriptor::StencilTestEnabled
 

Wether or not stencil testing should be enabled.

The default value is false.

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