XII Release 0.1.0
Loading...
Searching...
No Matches
xiiGALStencilOperationDescription Struct Reference

This describes the stencil operation that are performed on the results of the depth test. More...

#include <DepthStencilState.h>

Inheritance diagram for xiiGALStencilOperationDescription:
[legend]

Public Member Functions

 XII_DECLARE_POD_TYPE ()
 
- Public Member Functions inherited from xiiHashableStruct< xiiGALStencilOperationDescription >
 xiiHashableStruct (const xiiHashableStruct< xiiGALStencilOperationDescription > &other)
 
void operator= (const xiiHashableStruct< xiiGALStencilOperationDescription > &other)
 
XII_ALWAYS_INLINE constexpr bool operator== (const xiiHashableStruct< xiiGALStencilOperationDescription > &rhs) const=default
 
xiiUInt32 CalculateHash () const
 Calculates the 32 bit hash of the struct and returns it.
 

Public Attributes

xiiEnum< xiiGALStencilOperationm_StencilFailOperation = xiiGALStencilOperation::Keep
 The stencil operation to perform when stencil testing fails. The default is Keep.
 
xiiEnum< xiiGALStencilOperationm_StencilDepthFailOperation = xiiGALStencilOperation::Keep
 The stencil operation to perform when stencil testing passes and depth testing fails. The default is Keep.
 
xiiEnum< xiiGALStencilOperationm_StencilPassOperation = xiiGALStencilOperation::Keep
 The stencil operation to perform when stencil testing and depth testing both pass. The default is Keep.
 
xiiEnum< xiiGALComparisonFunctionm_ComparisonFunction = xiiGALComparisonFunction::Always
 A function that compares stencil data against existing stencil data. The default is Always.
 

Detailed Description

This describes the stencil operation that are performed on the results of the depth test.

The structure generally mirrors D3D11_DEPTH_STENCILOP_DESC/D3D12_DEPTH_STENCILOP_DESC structure.


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