Struct vulkano::pipeline::graphics::depth_stencil::StencilOpState
source · [−]pub struct StencilOpState {
pub ops: StateMode<StencilOps>,
pub compare_mask: StateMode<u32>,
pub write_mask: StateMode<u32>,
pub reference: StateMode<u32>,
}
Expand description
Stencil test operations for a single face.
Fields
ops: StateMode<StencilOps>
The stencil operations to perform.
If set to Dynamic
, the
extended_dynamic_state
feature must be
enabled on the device.
compare_mask: StateMode<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
.
write_mask: StateMode<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
.
reference: StateMode<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.
Trait Implementations
Creates a StencilOpState
with no dynamic state, compare_op
set to Never
, the stencil
operations set to Keep
, and the masks and reference values set to u32::MAX
.
Auto Trait Implementations
impl RefUnwindSafe for StencilOpState
impl Send for StencilOpState
impl Sync for StencilOpState
impl Unpin for StencilOpState
impl UnwindSafe for StencilOpState
Blanket Implementations
Mutably borrows from an owned value. Read more
Builds a pointer to this type from a raw pointer.
Returns true if the size is suitable to store a type like this.
Returns the size of an individual element.