HgiStencilState Struct Reference

#include <graphicsPipeline.h>

Public Member Functions
HGI_API	HgiStencilState ()

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. 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.

Properties controlling the operation of the stencil test.

• 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.

Constructor & Destructor Documentation

HGI_API HgiStencilState::HgiStencilState

(

)

Member Data Documentation

HgiCompareFunction HgiStencilState::compareFn

Definition at line 238 of file graphicsPipeline.h.

HgiStencilOp HgiStencilState::depthFailOp

Definition at line 241 of file graphicsPipeline.h.

HgiStencilOp HgiStencilState::depthStencilPassOp

Definition at line 242 of file graphicsPipeline.h.

uint32_t HgiStencilState::readMask

Definition at line 243 of file graphicsPipeline.h.

uint32_t HgiStencilState::referenceValue

Definition at line 239 of file graphicsPipeline.h.

HgiStencilOp HgiStencilState::stencilFailOp

Definition at line 240 of file graphicsPipeline.h.

uint32_t HgiStencilState::writeMask

Definition at line 244 of file graphicsPipeline.h.

---

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

• pxr/imaging/hgi/graphicsPipeline.h