Struct DepthStencilMode

pub struct DepthStencilMode {
    pub back: StencilMode,
    pub bounds_test: bool,
    pub compare_op: CompareOp,
    pub depth_test: bool,
    pub depth_write: bool,
    pub front: StencilMode,
    pub min: OrderedFloat<f32>,
    pub max: OrderedFloat<f32>,
    pub stencil_test: bool,
}

Specifies the depth bounds tests, stencil test, and depth test pipeline state.

Fields

back: StencilMode

Control parameters of the stencil test.

bounds_test: bool

Controls whether depth bounds testing is enabled.

compare_op: CompareOp

A value specifying the comparison operator to use in the depth comparison step of the depth test.

depth_test: bool

Controls whether depth testing is enabled.

depth_write: bool

Controls whether depth writes are enabled when depth_test is true.

Depth writes are always disabled when depth_test is false.

front: StencilMode

Control parameters of the stencil test.

min: OrderedFloat<f32>

Minimum depth bound used in the depth bounds test.

max: OrderedFloat<f32>

Maximum depth bound used in the depth bounds test.

stencil_test: bool

Controls whether stencil testing is enabled.

Implementations

impl DepthStencilMode

pub const DEPTH_READ: Self

A commonly used depth/stencil mode

pub const DEPTH_WRITE: Self

A commonly used depth/stencil mode

pub const IGNORE: Self

Specifies a no-depth/no-stencil mode.

pub fn new() -> DepthStencilModeBuilder

Specifies a default depth/stencil mode which is equal to DepthStencilMode::IGNORE.

Trait Implementations

impl Clone for DepthStencilMode

fn clone(&self) -> DepthStencilMode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DepthStencilMode

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

Formats the value using the given formatter.

impl Hash for DepthStencilMode

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 DepthStencilMode

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

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

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

impl Eq for DepthStencilMode

impl StructuralPartialEq for DepthStencilMode