Struct DepthStencilState 

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

Available on crate feature unstable-wgpu-29 only.

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 format of the depth/stencil attachment in CommandEncoder::begin_render_pass.

depth_write_enabled: Option<bool>

Whether to write updated depth values to the depth attachment.

If format is a depth or depth/stencil format, then this must be Some. Otherwise, specifying None is preferred, but Some(false) is also accepted.

depth_compare: Option<CompareFunction>

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

If depth_write_enabled is Some(true) or if depth_fail_op for either stencil face is not Keep, then this must be Some. Otherwise, specifying None is preferred, but Some(CompareFunction::Always) is also accepted.

stencil: StencilState

Stencil state.

bias: DepthBiasState

Depth bias state.

Implementations

impl DepthStencilState

pub fn stencil( format: TextureFormat, stencil: StencilState, ) -> DepthStencilState

Available on crate feature wgpu-29 only.

Construct DepthStencilState for a stencil operation with no depth operation.

Panics if format does not have a stencil aspect.

pub fn is_depth_enabled(&self) -> bool

Available on crate feature wgpu-29 only.

Returns true if the depth testing is enabled.

pub fn is_depth_read_only(&self) -> bool

Available on crate feature wgpu-29 only.

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

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

Available on crate feature wgpu-29 only.

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

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

Available on crate feature wgpu-29 only.

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 duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DepthStencilState

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

Formats the value using the given formatter.

impl Hash for DepthStencilState

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

where __H: Hasher,

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 PartialEq for DepthStencilState

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

impl StructuralPartialEq for DepthStencilState