Enum StencilOp

#[repr(u8)]
pub enum StencilOp {
    Keep = 0,
    Zero = 1,
    Replace = 2,
    IncrementClamp = 3,
    DecrementClamp = 4,
    Invert = 5,
    IncrementWrap = 6,
    DecrementWrap = 7,
}

The operation to use for stencil masking.

Variants

Keep = 0

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

Zero = 1

Set the value in the stencil buffer to zero.

Replace = 2

Set the stencil buffer value to reference from StencilFace.

IncrementClamp = 3

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

DecrementClamp = 4

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

Invert = 5

Bitwise invert the current value in the stencil buffer.

IncrementWrap = 6

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

DecrementWrap = 7

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

Trait Implementations

impl Clone for StencilOp

fn clone(&self) -> StencilOp

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StencilOp

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

Formats the value using the given formatter.

impl Hash for StencilOp

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for StencilOp

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for StencilOp

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for StencilOp

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Copy for StencilOp

impl Eq for StencilOp

impl StructuralPartialEq for StencilOp