Struct gfx_hal::pso::StencilFace

pub struct StencilFace {
    pub fun: Comparison,
    pub mask_read: State<StencilValue>,
    pub mask_write: State<StencilValue>,
    pub op_fail: StencilOp,
    pub op_depth_fail: StencilOp,
    pub op_pass: StencilOp,
    pub reference: State<StencilValue>,
}

Complete stencil state for a given side of a face.

Fields

fun: Comparison

Comparison function to use to determine if the stencil test passes.

mask_read: State<StencilValue>

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

mask_write: State<StencilValue>

A mask that is ANDd with the stencil value before writing to the stencil buffer.

op_fail: StencilOp

What operation to do if the stencil test fails.

op_depth_fail: StencilOp

What operation to do if the stencil test passes but the depth test fails.

op_pass: StencilOp

What operation to do if both the depth and stencil test pass.

reference: State<StencilValue>

The reference value used for stencil tests.

Trait Implementations

impl Ord for StencilFace

fn cmp(&self, other: &StencilFace) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl Eq for StencilFace

impl Clone for StencilFace

fn clone(&self) -> StencilFace

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialOrd<StencilFace> for StencilFace

fn partial_cmp(&self, other: &StencilFace) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &StencilFace) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &StencilFace) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &StencilFace) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &StencilFace) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl PartialEq<StencilFace> for StencilFace

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

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

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

This method tests for !=.

impl Copy for StencilFace

impl Default for StencilFace

fn default() -> StencilFace

Returns the "default value" for a type.

impl Debug for StencilFace

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

Formats the value using the given formatter.

impl Hash for StencilFace

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].