Enum bevy_render::render_resource::CompareFunction

#[repr(C)]
pub enum CompareFunction {
    Never = 1,
    Less = 2,
    Equal = 3,
    LessEqual = 4,
    Greater = 5,
    NotEqual = 6,
    GreaterEqual = 7,
    Always = 8,
}

Comparison function used for depth and stencil operations.

Corresponds to WebGPU GPUCompareFunction.

Variants

Never = 1

Function never passes

Less = 2

Function passes if new value less than existing value

Equal = 3

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 = 4

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

Greater = 5

Function passes if new value is greater than existing value

NotEqual = 6

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 = 7

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

Always = 8

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 From<CompareFunction> for ImageCompareFunction

fn from(value: CompareFunction) -> Self

Converts to this type from the input type.

impl From<ImageCompareFunction> for CompareFunction

fn from(value: ImageCompareFunction) -> Self

Converts to this type from the input type.

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq 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 Copy for CompareFunction

impl Eq for CompareFunction

impl StructuralPartialEq for CompareFunction