Struct components::platform::core::DepthStencilState

#[repr(C)]pub struct DepthStencilState {
    pub format: TextureFormat,
    pub depth_write_enabled: bool,
    pub depth_compare: CompareFunction,
    pub stencil: StencilState,
    pub bias: DepthBiasState,
}

Expand description

Describes the depth/stencil state in a render pipeline.

Fields

format: TextureFormat

Format of the depth/stencil buffer, must be special depth format. Must match the the format of the depth/stencil attachment in [CommandEncoder::begin_render_pass].

depth_write_enabled: bool

If disabled, depth will not be written to.

depth_compare: CompareFunction

Comparison function used to compare depth values in the depth test.

stencil: StencilState

Stencil state.

bias: DepthBiasState

Depth bias state.

Implementations

impl DepthStencilState

pub fn is_depth_enabled(&self) -> bool

Returns true if the depth testing is enabled.

pub fn is_read_only(&self) -> bool

Returns true if the state doesn’t mutate either depth or stencil of the target.

Trait Implementations

impl Clone for DepthStencilState

fn clone(&self) -> DepthStencilState

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

impl Debug for DepthStencilState

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

Formats the value using the given formatter. Read more

impl PartialEq<DepthStencilState> for DepthStencilState

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

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

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

This method tests for !=.

impl StructuralPartialEq for DepthStencilState

Auto Trait Implementations

impl RefUnwindSafe for DepthStencilState

impl Send for DepthStencilState

impl Sync for DepthStencilState

impl Unpin for DepthStencilState

impl UnwindSafe for DepthStencilState

Blanket Implementations

impl<T> Any for T where
T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> Downcast<T> for T

fn downcast(&self) -> &T

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

impl<Target, From> Getter<From> for Target where
From: AsRef<Target>,

fn get(from: &From) -> &Target

Typed getter

impl<'a, T, C, M> Inspect<'a, C, &'a C, M> for T

fn inspect(ctx: &'a mut C) -> &'a C

Inspect the context.

impl<'a, T, C, M> Inspect<'a, C, &'a mut C, M> for T

fn inspect(ctx: &'a mut C) -> &'a mut C

Inspect the context.

impl<'a, T, C, M> Inspect<'a, C, (), M> for T

fn inspect(&'a mut C)

Inspect the context.

impl<T, U> Into<U> for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<Fr, To> IntoColor<To> for Fr where
To: FromColor<Fr>,

fn into_color(self) -> To

Convert into color

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::()

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<T> SetParameter for T

fn set<T>(&mut self, value: T) -> <T as Parameter<Self>>::Result where
T: Parameter<Self>,

Sets value as a parameter of self.

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<T> Upcast<T> for T

fn upcast(&self) -> Option<&T>

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn vzip(self) -> V