Struct gfx::state::Stencil

pub struct Stencil {
    pub front: StencilSide,
    pub back: StencilSide,
}

Complete stencil state, specifying how to handle the front and back side of a face.

Fields

front: StencilSide

back: StencilSide

Implementations

impl Stencil

pub fn new(
    fun: Comparison,
    mask: u8,
    ops: (StencilOp, StencilOp, StencilOp)
) -> Stencil

Create a new stencil state with a given function.

Trait Implementations

impl Clone for Stencil

pub fn clone(&self) -> Stencil

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Stencil

impl Debug for Stencil

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

Formats the value using the given formatter.

impl Default for Stencil

pub fn default() -> Stencil

Returns the “default value” for a type.

impl Eq for Stencil

impl Hash for Stencil

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 Stencil

pub fn cmp(&self, other: &Stencil) -> 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<Stencil> for Stencil

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

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

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

This method tests for !=.

impl PartialOrd<Stencil> for Stencil

pub fn partial_cmp(&self, other: &Stencil) -> 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 Stencil

impl StructuralPartialEq for Stencil