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 device API version must be at least 1.3, or 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
sourceimpl Clone for StencilOpState
impl Clone for StencilOpState
sourcefn clone(&self) -> StencilOpState
fn clone(&self) -> StencilOpState
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresourceimpl Debug for StencilOpState
impl Debug for StencilOpState
sourceimpl Default for StencilOpState
impl Default for StencilOpState
sourcefn default() -> StencilOpState
fn default() -> StencilOpState
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
.