Enum CompareFunction 

pub enum CompareFunction {
    Never,
    Less,
    Equal,
    LessEqual,
    Greater,
    NotEqual,
    GreaterEqual,
    Always,
}

The comparison performed between two values, used both for depth tests and for comparison samplers.

Replaces the bare &'static str that GpuSamplerDescriptor.compare could not express: a bool there forced the renderer to hardcode a single comparison, while SamplerDescriptor::compare carries the comparison itself as Option<CompareFunction> — None for a plain filtering sampler.

Variants

Never

Never passes: the test always fails.

Less

Passes when the incoming value is strictly less than the reference.

Equal

Passes when the two values are equal.

LessEqual

Passes when the incoming value is less than or equal to the reference.

Greater

Passes when the incoming value is strictly greater than the reference.

NotEqual

Passes when the two values differ.

GreaterEqual

Passes when the incoming value is greater than or equal to the reference.

Always

Always passes: the test never fails.

Useful for an always-visible overlay drawn after the opaque pass, where the depth buffer must be bound but must not reject anything.

Trait Implementations

impl Clone for CompareFunction

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for CompareFunction

impl Debug for CompareFunction

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

Formats the value using the given formatter.

impl Default for CompareFunction

fn default() -> Self

Returns the “default value” for a type.

impl Eq for CompareFunction

impl Hash for CompareFunction

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 CompareFunction

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for CompareFunction