#[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

source

pub fn is_enabled(&self) -> bool

Returns true if the stencil test is enabled.

source

pub fn is_read_only(&self) -> bool

Returns true if the state doesn’t mutate the target values.

source

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

source§

fn clone(&self) -> StencilState

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for StencilState

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for StencilState

source§

fn default() -> StencilState

Returns the “default value” for a type. Read more
source§

impl<'de> Deserialize<'de> for StencilState

source§

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

Deserialize this value from the given Serde deserializer. Read more
source§

impl Hash for StencilState

source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
source§

impl PartialEq<StencilState> for StencilState

source§

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl Serialize for StencilState

source§

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

Serialize this value into the given Serde serializer. Read more
source§

impl Eq for StencilState

source§

impl StructuralEq for StencilState

source§

impl StructuralPartialEq for StencilState

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

const: unstable · source§

fn into(self) -> U

Calls U::from(self).

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

source§

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
const: unstable · source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
const: unstable · source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> DeserializeOwned for Twhere T: for<'de> Deserialize<'de>,