Enum gfx::state::StencilOp

pub enum StencilOp {
    Keep,
    Zero,
    Replace,
    IncrementClamp,
    IncrementWrap,
    DecrementClamp,
    DecrementWrap,
    Invert,
}

Stencil mask operation.

Variants

Keep

Keep the current value in the stencil buffer (no change).

Zero

Set the value in the stencil buffer to zero.

Replace

Set the stencil buffer value to value from StencilSide

IncrementClamp

Increment the stencil buffer value, clamping to its maximum value.

IncrementWrap

Increment the stencil buffer value, wrapping around to 0 on overflow.

DecrementClamp

Decrement the stencil buffer value, clamping to its minimum value.

DecrementWrap

Decrement the stencil buffer value, wrapping around to the maximum value on overflow.

Invert

Bitwise invert the current value in the stencil buffer.

Trait Implementations

impl Clone for StencilOp

pub fn clone(&self) -> StencilOp

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for StencilOp

impl Debug for StencilOp

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

Formats the value using the given formatter.

impl Eq for StencilOp

impl Hash for StencilOp

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 StencilOp

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

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

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

#[must_use]

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

This method tests for !=.

impl PartialOrd<StencilOp> for StencilOp

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

impl StructuralPartialEq for StencilOp