HgiStencilState Struct Reference

stencilFailOp: The operation executed when the stencil test fails. More...

Public Attributes

HgiCompareFunction compareFn
 
uint32_t referenceValue
 
HgiStencilOp stencilFailOp
 
HgiStencilOp depthFailOp
 
HgiStencilOp depthStencilPassOp
 
uint32_t readMask
 
uint32_t writeMask
 

Detailed Description

stencilFailOp: The operation executed when the stencil test fails.

Properties controlling the operation of the stencil test.

depthFailOp: The operation executed when the stencil test passes but the depth test fails. depthStencilPassOp: The operation executed when both stencil and depth tests pass. readMask: The mask applied to values before the stencil test function. writeMask: The mask applied when writing to the stencil buffer.

  • compareFn: The function used to test the reference value with the masked value read from the stencil buffer.
  • referenceValue:

Definition at line 233 of file graphicsPipeline.h.


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