Loading...
Searching...
No Matches
HgiStencilState Struct Reference

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

#include <graphicsPipeline.h>

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.

Member Data Documentation

◆ compareFn

HgiCompareFunction compareFn

Definition at line 238 of file graphicsPipeline.h.

◆ depthFailOp

HgiStencilOp depthFailOp

Definition at line 241 of file graphicsPipeline.h.

◆ depthStencilPassOp

HgiStencilOp depthStencilPassOp

Definition at line 242 of file graphicsPipeline.h.

◆ readMask

uint32_t readMask

Definition at line 243 of file graphicsPipeline.h.

◆ referenceValue

uint32_t referenceValue

Definition at line 239 of file graphicsPipeline.h.

◆ stencilFailOp

HgiStencilOp stencilFailOp

Definition at line 240 of file graphicsPipeline.h.

◆ writeMask

uint32_t writeMask

Definition at line 244 of file graphicsPipeline.h.


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