Enum tetra::graphics::StencilTest

#[non_exhaustive]
pub enum StencilTest {
    Never,
    LessThan,
    LessThanOrEqualTo,
    EqualTo,
    NotEqualTo,
    GreaterThan,
    GreaterThanOrEqualTo,
    Always,
}

The test for whether a pixel is visible when using a stencil.

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

The pixel is never visible.

LessThan

The pixel is visible if the reference value is less than the value in the stencil buffer.

LessThanOrEqualTo

The pixel is visible if the reference value is less than or equal to the value in the stencil buffer.

EqualTo

The pixel is visible if the reference value is equal to the value in the stencil buffer.

NotEqualTo

The pixel is visible if the reference value is not equal to the value in the stencil buffer.

GreaterThan

The pixel is visible if the reference value is greater than the value in the stencil buffer.

GreaterThanOrEqualTo

The pixel is visible if the reference value is greater than or equal to the value in the stencil buffer.

Always

The pixel is always visible.

Trait Implementations

impl Clone for StencilTest

fn clone(&self) -> StencilTest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StencilTest

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

Formats the value using the given formatter.

impl PartialEq<StencilTest> for StencilTest

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

impl Eq for StencilTest

impl StructuralEq for StencilTest

impl StructuralPartialEq for StencilTest