Loading...
Searching...
No Matches
Public Attributes | List of all members
HgiDepthStencilState Struct Reference

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

#include <graphicsPipeline.h>

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 269 of file graphicsPipeline.h.

Member Data Documentation

◆ depthBiasConstantFactor

float depthBiasConstantFactor

Definition at line 279 of file graphicsPipeline.h.

◆ depthBiasEnabled

bool depthBiasEnabled

Definition at line 278 of file graphicsPipeline.h.

◆ depthBiasSlopeFactor

float depthBiasSlopeFactor

Definition at line 280 of file graphicsPipeline.h.

◆ depthCompareFn

HgiCompareFunction depthCompareFn

Definition at line 276 of file graphicsPipeline.h.

◆ depthTestEnabled

bool depthTestEnabled

Definition at line 274 of file graphicsPipeline.h.

◆ depthWriteEnabled

bool depthWriteEnabled

Definition at line 275 of file graphicsPipeline.h.

◆ stencilBack

HgiStencilState stencilBack

Definition at line 284 of file graphicsPipeline.h.

◆ stencilFront

HgiStencilState stencilFront

Definition at line 283 of file graphicsPipeline.h.

◆ stencilTestEnabled

bool stencilTestEnabled

Definition at line 282 of file graphicsPipeline.h.

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