Struct StencilMode 

pub struct StencilMode {
    pub fail_op: StencilOp,
    pub pass_op: StencilOp,
    pub depth_fail_op: StencilOp,
    pub compare_op: CompareOp,
    pub compare_mask: u32,
    pub write_mask: u32,
    pub reference: u32,
}

Specifies stencil mode during rasterization.

See stencil test.

Fields

fail_op: StencilOp

The action performed on samples that fail the stencil test.

pass_op: StencilOp

The action performed on samples that pass both the depth and stencil tests.

depth_fail_op: StencilOp

The action performed on samples that pass the stencil test and fail the depth test.

compare_op: CompareOp

The comparison operator used in the stencil test.

compare_mask: u32

The bits of the unsigned integer stencil values participating in the stencil test.

write_mask: u32

The bits of the unsigned integer stencil values updated by the stencil test in the stencil framebuffer attachment.

reference: u32

An unsigned integer stencil reference value that is used in the unsigned stencil comparison.

Implementations

impl StencilMode

pub const IGNORE: Self

Specifes a stencil mode which is has no effect.

Trait Implementations

impl Clone for StencilMode

fn clone(&self) -> StencilMode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StencilMode

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

Formats the value using the given formatter.

impl Default for StencilMode

fn default() -> Self

Returns the “default value” for a type.

impl From<StencilMode> for StencilOpState

fn from(mode: StencilMode) -> Self

Converts to this type from the input type.

impl Hash for StencilMode

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 StencilMode

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

fn eq(&self, other: &StencilMode) -> 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 StencilMode

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

impl Eq for StencilMode

impl StructuralPartialEq for StencilMode