Enum wgpu::CompareFunction

#[repr(C)]
pub enum CompareFunction {
    Never,
    Less,
    Equal,
    LessEqual,
    Greater,
    NotEqual,
    GreaterEqual,
    Always,
}

Comparison function used for depth and stencil operations.

Corresponds to WebGPU GPUCompareFunction.

Variants

Never

Function never passes

Less

Function passes if new value less than existing value

Equal

Function passes if new value is equal to existing value. When using this compare function, make sure to mark your Vertex Shader’s @builtin(position) output as @invariant to prevent artifacting.

LessEqual

Function passes if new value is less than or equal to existing value

Greater

Function passes if new value is greater than existing value

NotEqual

Function passes if new value is not equal to existing value. When using this compare function, make sure to mark your Vertex Shader’s @builtin(position) output as @invariant to prevent artifacting.

GreaterEqual

Function passes if new value is greater than or equal to existing value

Always

Function always passes

Implementations

impl CompareFunction

pub fn needs_ref_value(self) -> bool

Returns true if the comparison depends on the reference value.

Trait Implementations

impl Clone for CompareFunction

fn clone(&self) -> CompareFunction

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CompareFunction

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CompareFunction

fn deserialize<__D>(
    __deserializer: __D
) -> Result<CompareFunction, <__D as Deserializer<'de>>::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for CompareFunction

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,

Feeds a slice of this type into the given Hasher.

impl PartialEq<CompareFunction> for CompareFunction

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

fn serialize<__S>(
    &self,
    __serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
    __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for CompareFunction

impl Eq for CompareFunction

impl StructuralEq for CompareFunction

impl StructuralPartialEq for CompareFunction