Struct wgpu::StencilState

pub struct StencilState {
    pub front: StencilFaceState,
    pub back: StencilFaceState,
    pub read_mask: u32,
    pub write_mask: u32,
}

State of the stencil operation (fixed-pipeline stage).

For use in DepthStencilState.

Corresponds to a portion of WebGPU GPUDepthStencilState.

Fields

front: StencilFaceState

Front face mode.

back: StencilFaceState

Back face mode.

read_mask: u32

Stencil values are AND’d with this mask when reading and writing from the stencil buffer. Only low 8 bits are used.

write_mask: u32

Stencil values are AND’d with this mask when writing to the stencil buffer. Only low 8 bits are used.

Implementations

impl StencilState

pub fn is_enabled(&self) -> bool

Returns true if the stencil test is enabled.

pub fn is_read_only(&self, cull_mode: Option<Face>) -> bool

Returns true if the state doesn’t mutate the target values.

pub fn needs_ref_value(&self) -> bool

Returns true if the stencil state uses the reference value for testing.

Trait Implementations

impl Clone for StencilState

fn clone(&self) -> StencilState

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StencilState

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

Formats the value using the given formatter.

impl Default for StencilState

fn default() -> StencilState

Returns the “default value” for a type.

impl Hash for StencilState

fn hash<__H>(&self, state: &mut __H)where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq<StencilState> for StencilState

fn eq(&self, other: &StencilState) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for StencilState

impl StructuralEq for StencilState

impl StructuralPartialEq for StencilState