struct
DepthStencilStateInformation
Describes a depth stencil state on a graphics pipeline.
Public
Methods
staticGenerateHash
Generates a hash value from a depth-stencil state descriptor.
Fields
DepthReadEnable
If enabled, any pixel about to be written will be tested against the depth value currently in the buffer.
If the depth test passes (depending on the set valueand chosen depth comparison function), that pixel is written and depth is updated (if depth write is enabled).
DepthWriteEnable
If enabled rendering pixels will update the depth buffer value.
DepthComparisonFunc
Determines what operation should the renderer use when comparing previous and current depth value.
If the operation passes, pixel with the current depth value will be considered visible.
StencilEnable
If true then stencil buffer will also be updated when a pixel is written, and pixels will be tested against the stencil buffer before rendering.
StencilReadMask
Mask to apply to any value read from the stencil buffer, before applying the stencil comparison function.
StencilWriteMask
Mask to apply to any value about to be written in the stencil buffer.
FrontStencilFailOp
Operation that happens when stencil comparison function fails on a front facing polygon.
FrontStencilZFailOp
Operation that happens when stencil comparison function passes but depth test fails on a front facing polygon.
FrontStencilPassOp
Operation that happens when stencil comparison function passes on a front facing polygon.
FrontStencilComparisonFunc
Stencil comparison function used for front facing polygons.
Stencil buffer will be modified according to previously set stencil operations depending whether this comparison passes or fails.
BackStencilFailOp
Operation that happens when stencil comparison function fails on a back facing polygon.
BackStencilZFailOp
Operation that happens when stencil comparison function passes but depth test fails on a back facing polygon.
BackStencilPassOp
Operation that happens when stencil comparison function passes on a back facing polygon.
BackStencilComparisonFunc
Stencil comparison function used for back facing polygons.
Stencil buffer will be modified according to previously set stencil operations depending whether this comparison passes or fails.