Struct vulkano::pipeline::graphics::depth_stencil::StencilOpState

pub struct StencilOpState {
    pub ops: StencilOps,
    pub compare_mask: u32,
    pub write_mask: u32,
    pub reference: u32,
}

Stencil test operations for a single face.

Fields

ops: StencilOps

The stencil operations to perform.

The default value is StencilOps::default().

compare_mask: u32

A bitmask that selects the bits of the unsigned integer stencil values participating in the stencil test. Ignored if compare_op is Never or Always.

The default value is u32::MAX.

write_mask: u32

A bitmask that selects the bits of the unsigned integer stencil values updated by the stencil test in the stencil framebuffer attachment. Ignored if the relevant operation is Keep.

The default value is u32::MAX.

reference: u32

Reference value that is used in the unsigned stencil comparison. The stencil test is considered to pass if the compare_op between the stencil buffer value and this reference value yields true.

On portability subset devices, if culling is disabled, and the reference values of the front and back face are not equal, then the separate_stencil_mask_ref feature must be enabled on the device.

The default value is u32::MAX.

Trait Implementations

impl Clone for StencilOpState

fn clone(&self) -> StencilOpState

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for StencilOpState

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for StencilOpState

fn default() -> StencilOpState

Returns the “default value” for a type.

impl Copy for StencilOpState