Struct wgpu_types::StencilState
source · #[repr(C)]pub struct StencilState {
pub front: StencilFaceState,
pub back: StencilFaceState,
pub read_mask: u32,
pub write_mask: u32,
}
Expand description
State of the stencil operation (fixed-pipeline stage).
For use in DepthStencilState
.
Corresponds to a portion of WebGPU GPUDepthStencilState
.
Fields§
§front: StencilFaceState
Front face mode.
back: StencilFaceState
Back face mode.
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.
write_mask: u32
Stencil values are AND’d with this mask when writing to the stencil buffer. Only low 8 bits are used.
Implementations§
source§impl StencilState
impl StencilState
sourcepub fn is_enabled(&self) -> bool
pub fn is_enabled(&self) -> bool
Returns true if the stencil test is enabled.
sourcepub fn is_read_only(&self, cull_mode: Option<Face>) -> bool
pub fn is_read_only(&self, cull_mode: Option<Face>) -> bool
Returns true if the state doesn’t mutate the target values.
sourcepub fn needs_ref_value(&self) -> bool
pub fn needs_ref_value(&self) -> bool
Returns true if the stencil state uses the reference value for testing.
Trait Implementations§
source§impl Clone for StencilState
impl Clone for StencilState
source§fn clone(&self) -> StencilState
fn clone(&self) -> StencilState
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moresource§impl Debug for StencilState
impl Debug for StencilState
source§impl Default for StencilState
impl Default for StencilState
source§fn default() -> StencilState
fn default() -> StencilState
Returns the “default value” for a type. Read more
source§impl Hash for StencilState
impl Hash for StencilState
source§impl PartialEq for StencilState
impl PartialEq for StencilState
source§fn eq(&self, other: &StencilState) -> bool
fn eq(&self, other: &StencilState) -> bool
This method tests for
self
and other
values to be equal, and is used
by ==
.impl Eq for StencilState
impl StructuralPartialEq for StencilState
Auto Trait Implementations§
impl Freeze for StencilState
impl RefUnwindSafe for StencilState
impl Send for StencilState
impl Sync for StencilState
impl Unpin for StencilState
impl UnwindSafe for StencilState
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more