Struct wgpu_types::StencilFaceState

source · [−]

#[repr(C)]pub struct StencilFaceState {
    pub compare: CompareFunction,
    pub fail_op: StencilOperation,
    pub depth_fail_op: StencilOperation,
    pub pass_op: StencilOperation,
}

Expand description

Describes stencil state in a render pipeline.

If you are not using stencil state, set this to StencilFaceState::IGNORE.

Corresponds to WebGPU GPUStencilFaceState.

Fields

compare: CompareFunction

Comparison function that determines if the fail_op or pass_op is used on the stencil buffer.

fail_op: StencilOperation

Operation that is preformed when stencil test fails.

depth_fail_op: StencilOperation

Operation that is performed when depth test fails but stencil test succeeds.

pass_op: StencilOperation

Operation that is performed when stencil test success.

Implementations

source

impl StencilFaceState

source

pub const IGNORE: Self = _

Ignore the stencil state for the face.

source

pub fn needs_ref_value(&self) -> bool

Returns true if the face state uses the reference value for testing or operation.

Trait Implementations

source

impl Clone for StencilFaceState

source

fn clone(&self) -> StencilFaceState

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 StencilFaceState

source

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

Formats the value using the given formatter. Read more

source

impl Default for StencilFaceState

source

fn default() -> Self

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

source

impl Hash for StencilFaceState

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,

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

source

impl PartialEq<StencilFaceState> for StencilFaceState

source

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

This method tests for self and other values to be equal, and is used by ==. Read more

source

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

This method tests for !=.

source

impl StructuralPartialEq for StencilFaceState

Auto Trait Implementations

impl RefUnwindSafe for StencilFaceState

impl Send for StencilFaceState

impl Sync for StencilFaceState

impl Unpin for StencilFaceState

impl UnwindSafe for StencilFaceState

Blanket Implementations

source

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

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
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 for T where
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 T where
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 for T where
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>::Error>

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

Struct wgpu_types::StencilFaceState

Fields

Implementations

impl StencilFaceState

pub const IGNORE: Self = _

pub fn needs_ref_value(&self) -> bool

Trait Implementations

impl Clone for StencilFaceState

fn clone(&self) -> StencilFaceState

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

impl Debug for StencilFaceState

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

impl Default for StencilFaceState

fn default() -> Self

impl Hash for StencilFaceState

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

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

impl PartialEq<StencilFaceState> for StencilFaceState

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

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

impl Copy for StencilFaceState

impl Eq for StencilFaceState

impl StructuralEq for StencilFaceState

impl StructuralPartialEq for StencilFaceState

Auto Trait Implementations

impl RefUnwindSafe for StencilFaceState

impl Send for StencilFaceState

impl Sync for StencilFaceState

impl Unpin for StencilFaceState

impl UnwindSafe for StencilFaceState

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

impl<T> ToOwned for T where T: Clone,

type Owned = T

fn to_owned(&self) -> T

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

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

type Error = Infallible

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

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

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

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

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

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

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

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

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

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

impl<T> ToOwned for T where
T: Clone,

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

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