Enum PipelineAlphaFunc

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

Alpha testing happens before blending primitives with the framebuffer and gives an opportunity to discard fragments based on a comparison with the incoming alpha value and a reference alpha value. The PipelineAlphaFunc determines how the comparison is done.

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 let the fragment through.

Less

Let the fragment through if the incoming alpha value is less than the reference alpha value

Equal

Let the fragment through if the incoming alpha value equals the reference alpha value

Lequal

Let the fragment through if the incoming alpha value is less than or equal to the reference alpha value

Greater

Let the fragment through if the incoming alpha value is greater than the reference alpha value

Notequal

Let the fragment through if the incoming alpha value does not equal the reference alpha value

Gequal

Let the fragment through if the incoming alpha value is greater than or equal to the reference alpha value.

Always

Always let the fragment through.

Trait Implementations

impl Clone for PipelineAlphaFunc

fn clone(&self) -> PipelineAlphaFunc

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PipelineAlphaFunc

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

Formats the value using the given formatter.

impl Display for PipelineAlphaFunc

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

Formats the value using the given formatter.

impl Hash for PipelineAlphaFunc

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 PipelineAlphaFunc

fn cmp(&self, other: &PipelineAlphaFunc) -> 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 PipelineAlphaFunc

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

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

impl Eq for PipelineAlphaFunc

impl StructuralPartialEq for PipelineAlphaFunc