Struct wgpu::DepthStencilState

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§

Returns true if the depth testing is enabled.

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

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

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

Trait Implementations§

Returns a copy of the value. Read more
Performs copy-assignment from source. Read more
Formats the value using the given formatter. Read more
Feeds this value into the given Hasher. Read more
Feeds a slice of this type into the given Hasher. Read more
This method tests for self and other values to be equal, and is used by ==. Read more
This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason. Read more

Auto Trait Implementations§

Blanket Implementations§

Gets the TypeId of self. Read more
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more
Compare self to key and return true if they are equal.

Returns the argument unchanged.

Calls U::from(self).

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

The resulting type after obtaining ownership.
Creates owned data from borrowed data, usually by cloning. Read more
Uses borrowed data to replace owned data, usually by cloning. Read more
The type returned in the event of a conversion error.
Performs the conversion.
The type returned in the event of a conversion error.
Performs the conversion.