Enum DepthTestFunction

#[non_exhaustive]
pub enum DepthTestFunction {
    Never,
    Less,
    Equal,
    Lequal,
    Greater,
    Notequal,
    Gequal,
    Always,
}

When using depth testing one of these functions is used to compare the depth of an incoming fragment against the depth value currently stored in the depth buffer. The function is changed using DepthState::set_test_function.

The test is only done when depth testing is explicitly enabled. (See DepthState::set_test_enabled)

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Never

Never passes.

Less

Passes if the fragment’s depth value is less than the value currently in the depth buffer.

Equal

Passes if the fragment’s depth value is equal to the value currently in the depth buffer.

Lequal

Passes if the fragment’s depth value is less or equal to the value currently in the depth buffer.

Greater

Passes if the fragment’s depth value is greater than the value currently in the depth buffer.

Notequal

Passes if the fragment’s depth value is not equal to the value currently in the depth buffer.

Gequal

Passes if the fragment’s depth value greater than or equal to the value currently in the depth buffer.

Always

Always passes.

Trait Implementations

impl Clone for DepthTestFunction

fn clone(&self) -> DepthTestFunction

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DepthTestFunction

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

Formats the value using the given formatter.

impl Display for DepthTestFunction

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

Formats the value using the given formatter.

impl<'a> FromValue<'a> for DepthTestFunction

unsafe fn from_value(value: &Value) -> Self

Safety

impl<'a> FromValueOptional<'a> for DepthTestFunction

unsafe fn from_value_optional(value: &Value) -> Option<Self>

Safety

impl Hash for DepthTestFunction

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 Ord for DepthTestFunction

fn cmp(&self, other: &DepthTestFunction) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for DepthTestFunction

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for DepthTestFunction

fn partial_cmp(&self, other: &DepthTestFunction) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl SetValue for DepthTestFunction

unsafe fn set_value(value: &mut Value, this: &Self)

Safety

impl StaticType for DepthTestFunction

fn static_type() -> Type

Returns the type identifier of Self.

impl Copy for DepthTestFunction

impl Eq for DepthTestFunction

impl StructuralPartialEq for DepthTestFunction