Struct wgpu::DepthStencilState

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

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.

clamp_depth: bool

If enabled polygon depth is clamped to 0-1 range instead of being clipped.

Requires Features::DEPTH_CLAMPING enabled.

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

pub fn clone(&self) -> DepthStencilState

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DepthStencilState

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DepthStencilState

pub fn deserialize<__D>(
    __deserializer: __D
) -> Result<DepthStencilState, <__D as Deserializer<'de>>::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl PartialEq<DepthStencilState> for DepthStencilState

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

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

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

This method tests for !=.

impl Serialize for DepthStencilState

pub fn serialize<__S>(
    &self,
    __serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for DepthStencilState