Struct DepthStencilStateDescriptor

#[repr(C)]
pub struct DepthStencilStateDescriptor {
    pub format: TextureFormat,
    pub depth_write_enabled: bool,
    pub depth_compare: CompareFunction,
    pub stencil_front: StencilStateFaceDescriptor,
    pub stencil_back: StencilStateFaceDescriptor,
    pub stencil_read_mask: u32,
    pub stencil_write_mask: u32,
}

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_front: StencilStateFaceDescriptor

Stencil state used for front faces.

stencil_back: StencilStateFaceDescriptor

Stencil state used for back faces.

stencil_read_mask: u32

Stencil values are AND’d with this mask when reading and writing from the stencil buffer. Only low 8 bits are used.

stencil_write_mask: u32

Stencil values are AND’d with this mask when writing to the stencil buffer. Only low 8 bits are used.

Implementations

impl DepthStencilStateDescriptor

pub fn needs_stencil_reference(&self) -> bool

pub fn is_read_only(&self) -> bool

Trait Implementations

impl Clone for DepthStencilStateDescriptor

fn clone(&self) -> DepthStencilStateDescriptor

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DepthStencilStateDescriptor

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DepthStencilStateDescriptor

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for DepthStencilStateDescriptor

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 DepthStencilStateDescriptor

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

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 Eq for DepthStencilStateDescriptor

impl StructuralPartialEq for DepthStencilStateDescriptor