Struct gfx_hal::pso::StencilFace
source · pub struct StencilFace {
pub fun: Comparison,
pub mask_read: State<StencilValue>,
pub mask_write: State<StencilValue>,
pub op_fail: StencilOp,
pub op_depth_fail: StencilOp,
pub op_pass: StencilOp,
pub reference: State<StencilValue>,
}
Expand description
Complete stencil state for a given side of a face.
Fields
fun: Comparison
Comparison function to use to determine if the stencil test passes.
mask_read: State<StencilValue>
A mask that is ANDd with both the stencil buffer value and the reference value when they are read before doing the stencil test.
mask_write: State<StencilValue>
A mask that is ANDd with the stencil value before writing to the stencil buffer.
op_fail: StencilOp
What operation to do if the stencil test fails.
op_depth_fail: StencilOp
What operation to do if the stencil test passes but the depth test fails.
op_pass: StencilOp
What operation to do if both the depth and stencil test pass.
reference: State<StencilValue>
The reference value used for stencil tests.
Trait Implementations
sourceimpl Clone for StencilFace
impl Clone for StencilFace
sourcefn clone(&self) -> StencilFace
fn clone(&self) -> StencilFace
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 StencilFace
impl Debug for StencilFace
sourceimpl Default for StencilFace
impl Default for StencilFace
sourcefn default() -> StencilFace
fn default() -> StencilFace
Returns the “default value” for a type. Read more
sourceimpl Hash for StencilFace
impl Hash for StencilFace
sourceimpl Ord for StencilFace
impl Ord for StencilFace
sourcefn cmp(&self, other: &StencilFace) -> Ordering
fn cmp(&self, other: &StencilFace) -> Ordering
1.21.0 · sourcefn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere
Self: Sized,
Compares and returns the maximum of two values. Read more
1.21.0 · sourcefn min(self, other: Self) -> Selfwhere
Self: Sized,
fn min(self, other: Self) -> Selfwhere
Self: Sized,
Compares and returns the minimum of two values. Read more
1.50.0 · sourcefn clamp(self, min: Self, max: Self) -> Selfwhere
Self: Sized + PartialOrd<Self>,
fn clamp(self, min: Self, max: Self) -> Selfwhere
Self: Sized + PartialOrd<Self>,
Restrict a value to a certain interval. Read more
sourceimpl PartialEq<StencilFace> for StencilFace
impl PartialEq<StencilFace> for StencilFace
sourcefn eq(&self, other: &StencilFace) -> bool
fn eq(&self, other: &StencilFace) -> bool
sourceimpl PartialOrd<StencilFace> for StencilFace
impl PartialOrd<StencilFace> for StencilFace
sourcefn partial_cmp(&self, other: &StencilFace) -> Option<Ordering>
fn partial_cmp(&self, other: &StencilFace) -> Option<Ordering>
1.0.0 · sourcefn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for
self
and other
) and is used by the <=
operator. Read moreimpl Copy for StencilFace
impl Eq for StencilFace
impl StructuralEq for StencilFace
impl StructuralPartialEq for StencilFace
Auto Trait Implementations
impl RefUnwindSafe for StencilFace
impl Send for StencilFace
impl Sync for StencilFace
impl Unpin for StencilFace
impl UnwindSafe for StencilFace
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