Enum glium::draw_parameters::StencilTest

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

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

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