Struct wgpu_types::StencilFaceState

#[repr(C)]
pub struct StencilFaceState {
    pub compare: CompareFunction,
    pub fail_op: StencilOperation,
    pub depth_fail_op: StencilOperation,
    pub pass_op: StencilOperation,
}

Describes stencil state in a render pipeline.

If you are not using stencil state, set this to StencilFaceState::IGNORE.

Corresponds to WebGPU GPUStencilFaceState.

Fields

compare: CompareFunction

Comparison function that determines if the fail_op or pass_op is used on the stencil buffer.

fail_op: StencilOperation

Operation that is preformed when stencil test fails.

depth_fail_op: StencilOperation

Operation that is performed when depth test fails but stencil test succeeds.

pass_op: StencilOperation

Operation that is performed when stencil test success.

Implementations

impl StencilFaceState

pub const IGNORE: Self = _

Ignore the stencil state for the face.

pub fn needs_ref_value(&self) -> bool

Returns true if the face state uses the reference value for testing or operation.

pub fn is_read_only(&self) -> bool

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

Trait Implementations

impl Clone for StencilFaceState

fn clone(&self) -> StencilFaceState

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StencilFaceState

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

Formats the value using the given formatter.

impl Default for StencilFaceState

fn default() -> Self

Returns the “default value” for a type.

impl Hash for StencilFaceState

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

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 for StencilFaceState

fn eq(&self, other: &StencilFaceState) -> 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 Copy for StencilFaceState

impl Eq for StencilFaceState

impl StructuralEq for StencilFaceState

impl StructuralPartialEq for StencilFaceState