Struct gfx_hal::pso::StencilTest

pub struct StencilTest {
    pub faces: Sided<StencilFace>,
    pub read_masks: StencilValues,
    pub write_masks: StencilValues,
    pub reference_values: StencilValues,
}

Defines a stencil test. Stencil testing is an operation performed to cull fragments; the new fragment is tested against the value held in the stencil buffer, and if the test fails the fragment is discarded.

Fields

faces: Sided<StencilFace>

Operations for stencil faces.

read_masks: StencilValues

Masks that are ANDd with both the stencil buffer value and the reference value when they are read before doing the stencil test.

write_masks: StencilValues

Mask that are ANDd with the stencil value before writing to the stencil buffer.

reference_values: StencilValues

The reference values used for stencil tests.

Trait Implementations

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: &StencilTest) -> bool

This method tests for !=.

impl Default for StencilTest

fn default() -> Self

Returns the "default value" for a type.

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 Eq for StencilTest

impl Copy for StencilTest

impl Debug for StencilTest

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

Formats the value using the given formatter.

impl Hash for StencilTest

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, 

Feeds a slice of this type into the given [Hasher].