Struct tetra::graphics::StencilState

source · [−]

pub struct StencilState {
    pub enabled: bool,
    pub action: StencilAction,
    pub test: StencilTest,
    pub reference_value: u8,
    pub write_mask: u8,
    pub read_mask: u8,
}

Expand description

Represents a global stencil configuration.

Fields

enabled: bool

Whether stencil testing is enabled.

When set to true, pixels drawn will be hidden or visible depending on the stencil test and the contents of the stencil buffer.

action: StencilAction

How drawing operations will affect the stencil buffer.

test: StencilTest

How drawn pixels will be compared to the contents of the stencil buffer to determine if they’re visible.

reference_value: u8

The value used for most StencilTests and StencilAction::Replace.

write_mask: u8

A bitmask that will be ANDed with stencil values before they’re written to the buffer.

read_mask: u8

A bitmask that will be ANDed with both the reference value and the stencil value before a stencil test occurs.

Implementations

source

impl StencilState

source

pub fn disabled() -> Self

Creates a stencil configuration that will disable use of the stencil buffer.

source

pub fn write(action: StencilAction, reference_value: u8) -> Self

Creates a stencil configuration that will write pixels to the stencil buffer.

source

pub fn read(test: StencilTest, reference_value: u8) -> Self

Creates a stencil configuration that will compare drawn pixels to the contents of the stencil buffer to determine which pixels are visible.

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 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 ==. Read more

source

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

This method tests for !=.

source

impl StructuralPartialEq for StencilState

Auto Trait Implementations

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> 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.

impl<T> Pointable for T

const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

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)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

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 tetra::graphics::StencilState

Fields

Implementations

impl StencilState

pub fn disabled() -> Self

pub fn write(action: StencilAction, reference_value: u8) -> Self

pub fn read(test: StencilTest, reference_value: u8) -> Self

Trait Implementations

impl Clone for StencilState

fn clone(&self) -> StencilState

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

impl Debug for StencilState

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

impl PartialEq<StencilState> for StencilState

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

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

impl Copy for StencilState

impl Eq for StencilState

impl StructuralEq for StencilState

impl StructuralPartialEq for StencilState

Auto Trait Implementations

impl RefUnwindSafe for StencilState

impl Send for StencilState

impl Sync for StencilState

impl Unpin for StencilState

impl UnwindSafe for StencilState

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> Pointable for T

const ALIGN: usize

type Init = T

unsafe fn init(init: <T as Pointable>::Init) -> usize

unsafe fn deref<'a>(ptr: usize) -> &'a T

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

unsafe fn drop(ptr: usize)

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>

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>,