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
sourceimpl DepthStencilState
impl DepthStencilState
sourcepub fn is_depth_enabled(&self) -> bool
pub fn is_depth_enabled(&self) -> bool
Returns true if the depth testing is enabled.
sourcepub fn is_depth_read_only(&self) -> bool
pub fn is_depth_read_only(&self) -> bool
Returns true if the state doesn’t mutate the depth buffer.
sourcepub fn is_stencil_read_only(&self) -> bool
pub fn is_stencil_read_only(&self) -> bool
Returns true if the state doesn’t mutate the stencil.
sourcepub fn is_read_only(&self) -> bool
pub fn is_read_only(&self) -> bool
Returns true if the state doesn’t mutate either depth or stencil of the target.
Trait Implementations
sourceimpl Clone for DepthStencilState
impl Clone for DepthStencilState
sourcefn clone(&self) -> DepthStencilState
fn clone(&self) -> DepthStencilState
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moresourceimpl Debug for DepthStencilState
impl Debug for DepthStencilState
sourceimpl<'de> Deserialize<'de> for DepthStencilState
impl<'de> Deserialize<'de> for DepthStencilState
sourcefn deserialize<__D>(
__deserializer: __D
) -> Result<DepthStencilState, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(
__deserializer: __D
) -> Result<DepthStencilState, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
sourceimpl PartialEq<DepthStencilState> for DepthStencilState
impl PartialEq<DepthStencilState> for DepthStencilState
sourcefn eq(&self, other: &DepthStencilState) -> bool
fn eq(&self, other: &DepthStencilState) -> bool
sourceimpl Serialize for DepthStencilState
impl Serialize for DepthStencilState
sourcefn serialize<__S>(
&self,
__serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
__S: Serializer,
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. Read more
impl StructuralPartialEq for DepthStencilState
Auto Trait Implementations
impl RefUnwindSafe for DepthStencilState
impl Send for DepthStencilState
impl Sync for DepthStencilState
impl Unpin for DepthStencilState
impl UnwindSafe for DepthStencilState
Blanket Implementations
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more