Enum tetra::graphics::StencilTest

source · [−]

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

Expand description

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

Variants (Non-exhaustive)

This enum is marked as 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. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

impl Debug for StencilTest

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

Formats the value using the given formatter. Read more

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 ==. Read more

1.0.0 · source

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

This method tests for !=.

impl Copy for StencilTest

impl Eq for StencilTest

impl StructuralEq for StencilTest

impl StructuralPartialEq for StencilTest

Auto Trait Implementations

impl RefUnwindSafe for StencilTest

impl Send for StencilTest

impl Sync for StencilTest

impl Unpin for StencilTest

impl UnwindSafe for StencilTest

Blanket Implementations

impl<T> Any for T where
T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Pointable for T

const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.