Public Attributes | List of all members
HgiDepthStencilState Struct Reference

Properties to configure depth and stencil test. More...

Public Attributes

bool depthTestEnabled
 
bool depthWriteEnabled
 
HgiCompareFunction depthCompareFn
 
bool depthBiasEnabled
 
float depthBiasConstantFactor
 
float depthBiasSlopeFactor
 
bool stencilTestEnabled
 
HgiStencilState stencilFront
 
HgiStencilState stencilBack
 

Detailed Description

Properties to configure depth and stencil test.

  • depthTestEnabled: When enabled uses depthCompareFn to test if a fragment passes the depth test. Note that depth writes are automatically disabled when depthTestEnabled is false.
  • depthWriteEnabled: When enabled uses depthCompareFn to test if a fragment passes the depth test. Note that depth writes are automatically disabled when depthTestEnabled is false.
  • depthCompareFn: The function used to test depth values.
  • depthBiasEnabled: When enabled applies a bias to depth values before the depth test.
  • depthBiasConstantFactor: The constant depth bias.
  • depthBiasSlopeFactor: The depth bias that scales with the gradient of the primitive.
  • stencilTestEnabled: Enables the stencil test.
  • stencilFront: Stencil operation for front faces.
  • stencilBack: Stencil operation for back faces.

Definition at line 286 of file graphicsPipeline.h.

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