pub enum StencilTest {
    AlwaysPass,
    AlwaysFail,
    IfLess {
        mask: u32,
    },
    IfLessOrEqual {
        mask: u32,
    },
    IfMore {
        mask: u32,
    },
    IfMoreOrEqual {
        mask: u32,
    },
    IfEqual {
        mask: u32,
    },
    IfNotEqual {
        mask: u32,
    },
}
Expand description

Specifies which comparison the GPU will do to determine whether a sample passes the stencil test. The general equation is (ref & mask) CMP (stencil & mask), where ref is the reference value (stencil_reference_value_clockwise or stencil_reference_value_counter_clockwise), CMP is the comparison chosen, and stencil is the current value in the stencil buffer.

Variants§

§

AlwaysPass

The stencil test always passes.

§

AlwaysFail

The stencil test always fails.

§

IfLess

Fields

§mask: u32

The mask that is and’ed with the reference value and stencil buffer.

(ref & mask) < (stencil & mask)

§

IfLessOrEqual

Fields

§mask: u32

The mask that is and’ed with the reference value and stencil buffer.

(ref & mask) <= (stencil & mask)

§

IfMore

Fields

§mask: u32

The mask that is and’ed with the reference value and stencil buffer.

(ref & mask) > (stencil & mask)

§

IfMoreOrEqual

Fields

§mask: u32

The mask that is and’ed with the reference value and stencil buffer.

(ref & mask) >= (stencil & mask)

§

IfEqual

Fields

§mask: u32

The mask that is and’ed with the reference value and stencil buffer.

(ref & mask) == (stencil & mask)

§

IfNotEqual

Fields

§mask: u32

The mask that is and’ed with the reference value and stencil buffer.

(ref & mask) != (stencil & mask)

Trait Implementations§

source§

impl Clone for StencilTest

source§

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
source§

impl Debug for StencilTest

source§

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

Formats the value using the given formatter. Read more
source§

impl PartialEq<StencilTest> for StencilTest

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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.
source§

impl Copy for StencilTest

source§

impl Eq for StencilTest

source§

impl StructuralEq for StencilTest

source§

impl StructuralPartialEq for StencilTest

Auto Trait Implementations§

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> Content for Twhere T: Copy,

§

type Owned = T

A type that holds a sized version of the content.
source§

unsafe fn read<F, E>(size: usize, f: F) -> Result<T, E>where F: FnOnce(&mut T) -> Result<(), E>,

Prepares an output buffer, then turns this buffer into an Owned. User-provided closure F must only write to and not read from &mut Self.
source§

fn get_elements_size() -> usize

Returns the size of each element.
source§

fn to_void_ptr(&self) -> *const ()

Produces a pointer to the data.
source§

fn ref_from_ptr<'a>(ptr: *mut (), size: usize) -> Option<*mut T>

Builds a pointer to this type from a raw pointer.
source§

fn is_size_suitable(size: usize) -> bool

Returns true if the size is suitable to store a type like this.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

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

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.

source§

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

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

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

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

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

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

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

§

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

The type returned in the event of a conversion error.
source§

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

Performs the conversion.