WisStencilDesc Struct Reference

Detailed Description

Specification

---

C version:

// Provided by Wisdom 0.7.0.
typedef struct  WisStencilDesc {
    WisStencilOp fail_op;
    WisStencilOp depth_fail_op;
    WisStencilOp pass_op;
    WisCompareOp stencil_comp;
    uint8_t      read_mask;
    uint8_t      write_mask;
} WisStencilDesc;

C++ version:

namespace wis{
// Provided by Wisdom 0.7.0.
struct  StencilDesc {
    wis::StencilOp fail_op;
    wis::StencilOp depth_fail_op;
    wis::StencilOp pass_op;
    wis::CompareOp stencil_comp;
    std::uint8_t   read_mask;
    std::uint8_t   write_mask;
};
}

Members

---

• fail_op specifies stencil operation if the stencil test fails. Default is WisStencilOpKeep.
• depth_fail_op specifies stencil operation if the stencil test passes and the depth test fails. Default is WisStencilOpKeep.
• pass_op describes stencil operation if the stencil test passes. Default is WisStencilOpKeep.
• stencil_comp defines stencil comparison function. Default is .
• read_mask indicates stencil read mask. Default is 0xff.
• write_mask specifies stencil write mask. Default is 0xff.

Description

---

See Also

---

See also

Structs: WisDepthStencilDesc