Struct gfx_core::state::StencilSide

pub struct StencilSide {
    pub fun: Comparison,
    pub mask_read: u8,
    pub mask_write: u8,
    pub op_fail: StencilOp,
    pub op_depth_fail: StencilOp,
    pub op_pass: StencilOp,
}

[−] Expand description

Complete stencil state for a given side of a face.

Fields

fun: Comparison

[−] Expand description

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

mask_read: u8

[−] Expand description

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: u8

[−] Expand description

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

op_fail: StencilOp

[−] Expand description

What operation to do if the stencil test fails.

op_depth_fail: StencilOp

[−] Expand description

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

op_pass: StencilOp

[−] Expand description

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

Trait Implementations

impl Clone for StencilSide[+]

[+] Show hidden undocumented items

pub fn clone(&self) -> StencilSide[−]

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)[−]

Performs copy-assignment from source.

impl Copy for StencilSide

impl Debug for StencilSide[+]

[+] Show hidden undocumented items

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>[−]

Formats the value using the given formatter.

impl Default for StencilSide[+]

[+] Show hidden undocumented items

pub fn default() -> StencilSide[−]

Returns the “default value” for a type.

impl Eq for StencilSide

impl Hash for StencilSide[+]

[+] Show hidden undocumented items

pub fn hash<__H>(&self, state: &mut __H) where
    __H: Hasher, [−]

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, [−]

Feeds a slice of this type into the given Hasher.

impl Ord for StencilSide[+]

[+] Show hidden undocumented items

pub fn cmp(&self, other: &StencilSide) -> Ordering[−]

This method returns an Ordering between self and other.

#[must_use]

pub fn max(self, other: Self) -> Self[−]

Compares and returns the maximum of two values.

#[must_use]

pub fn min(self, other: Self) -> Self[−]

Compares and returns the minimum of two values.

#[must_use]

pub fn clamp(self, min: Self, max: Self) -> Self[−]

Restrict a value to a certain interval.

impl PartialEq<StencilSide> for StencilSide[+]

[+] Show hidden undocumented items

pub fn eq(&self, other: &StencilSide) -> bool[−]

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

pub fn ne(&self, other: &StencilSide) -> bool[−]

This method tests for !=.

impl PartialOrd<StencilSide> for StencilSide[+]

[+] Show hidden undocumented items

pub fn partial_cmp(&self, other: &StencilSide) -> Option<Ordering>[−]

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

#[must_use]

pub fn lt(&self, other: &Rhs) -> bool[−]

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

#[must_use]

pub fn le(&self, other: &Rhs) -> bool[−]

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

#[must_use]

pub fn gt(&self, other: &Rhs) -> bool[−]

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

#[must_use]

pub fn ge(&self, other: &Rhs) -> bool[−]

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

impl StructuralEq for StencilSide

impl StructuralPartialEq for StencilSide