Struct wgpu::DepthStencilState

source ·
#[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.

Corresponds to WebGPU GPUDepthStencilState.

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§

source§

impl DepthStencilState

source

pub fn is_depth_enabled(&self) -> bool

Returns true if the depth testing is enabled.

source

pub fn is_depth_read_only(&self) -> bool

Returns true if the state doesn’t mutate the depth buffer.

source

pub fn is_stencil_read_only(&self, cull_mode: Option<Face>) -> bool

Returns true if the state doesn’t mutate the stencil.

source

pub fn is_read_only(&self, cull_mode: Option<Face>) -> bool

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

Trait Implementations§

source§

impl Clone for DepthStencilState

source§

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
source§

impl Debug for DepthStencilState

source§

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

Formats the value using the given formatter. Read more
source§

impl Hash for DepthStencilState

source§

fn hash<__H>(&self, state: &mut __H)
where __H: Hasher,

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
source§

impl PartialEq for DepthStencilState

source§

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl Eq for DepthStencilState

source§

impl StructuralEq for DepthStencilState

source§

impl StructuralPartialEq for DepthStencilState

Auto Trait Implementations§

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> Downcast<T> for T

source§

fn downcast(&self) -> &T

source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

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

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.

source§

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

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

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

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

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

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

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

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.
source§

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

Performs the conversion.
source§

impl<T> Upcast<T> for T

source§

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

source§

impl<T> WasmNotSend for T
where T: Send,

source§

impl<T> WasmNotSync for T
where T: Sync,