wisdom
Loading...
Searching...
No Matches
wis::StencilDesc Struct Reference

Detailed Description

Stencil description for wis::DepthStencilDesc.

struct StencilDesc {
uint8_t read_mask = 0xff;
uint8_t write_mask = 0xff;
};
StencilOp
Stencil operation for depth and stencil operations.
Definition api.hpp:905
@ Keep
Keep the current value.
Compare
Comparison function for depth and stencil operations.
Definition api.hpp:887
@ Always
Always pass the comparison.
Stencil description for wis::DepthStencilDesc.
Definition api.hpp:1680

Definition at line 1680 of file api.hpp.

#include <api.hpp>

Public Attributes

wis::StencilOp fail_op = wis::StencilOp::Keep
 Stencil operation if the stencil test fails. Default is wis::StencilOp::Keep.
 
wis::StencilOp depth_fail_op = wis::StencilOp::Keep
 Stencil operation if the stencil test passes and the depth test fails. Default is wis::StencilOp::Keep.
 
wis::StencilOp pass_op = wis::StencilOp::Keep
 Stencil operation if the stencil test passes. Default is wis::StencilOp::Keep.
 
wis::Compare comparison = wis::Compare::Always
 Stencil comparison function. Default is wis::Compare::Always.
 
uint8_t read_mask = 0xff
 Stencil read mask. Default is 0xff.
 
uint8_t write_mask = 0xff
 Stencil write mask. Default is 0xff.
 

Data Members

◆ comparison

wis::Compare wis::StencilDesc::comparison = wis::Compare::Always

Stencil comparison function. Default is wis::Compare::Always.

Definition at line 1684 of file api.hpp.

◆ depth_fail_op

wis::StencilOp wis::StencilDesc::depth_fail_op = wis::StencilOp::Keep

Stencil operation if the stencil test passes and the depth test fails. Default is wis::StencilOp::Keep.

Definition at line 1682 of file api.hpp.

◆ fail_op

wis::StencilOp wis::StencilDesc::fail_op = wis::StencilOp::Keep

Stencil operation if the stencil test fails. Default is wis::StencilOp::Keep.

Definition at line 1681 of file api.hpp.

◆ pass_op

wis::StencilOp wis::StencilDesc::pass_op = wis::StencilOp::Keep

Stencil operation if the stencil test passes. Default is wis::StencilOp::Keep.

Definition at line 1683 of file api.hpp.

◆ read_mask

uint8_t wis::StencilDesc::read_mask = 0xff

Stencil read mask. Default is 0xff.

Definition at line 1685 of file api.hpp.

◆ write_mask

uint8_t wis::StencilDesc::write_mask = 0xff

Stencil write mask. Default is 0xff.

Definition at line 1686 of file api.hpp.


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