Struct tetra::graphics::StencilState[−][src]

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
Expand description

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
Expand description

How drawing operations will affect the stencil buffer.

test: StencilTest
Expand description

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

reference_value: u8
Expand description

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

write_mask: u8
Expand description

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

read_mask: u8
Expand description

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

Implementations

impl StencilState[src]

pub fn disabled() -> Self[src]

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

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

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

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

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

Trait Implementations

impl Clone for StencilState[src]

fn clone(&self) -> StencilState[src]

Returns a copy of the value. Read more

fn clone_from(&mut self, source: &Self)1.0.0[src]

Performs copy-assignment from source. Read more

impl Debug for StencilState[src]

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

Formats the value using the given formatter. Read more

impl PartialEq<StencilState> for StencilState[src]

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

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

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

This method tests for !=.

impl Copy for StencilState[src]

impl Eq for StencilState[src]

impl StructuralEq for StencilState[src]

impl StructuralPartialEq for StencilState[src]

Auto Trait Implementations

Blanket Implementations

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

pub fn type_id(&self) -> TypeId[src]

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
    T: ?Sized, [src]

pub fn borrow(&self) -> &T[src]

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
    T: ?Sized, [src]

pub fn borrow_mut(&mut self) -> &mut T[src]

Mutably borrows from an owned value. Read more

impl<T> From<T> for T[src]

pub fn from(t: T) -> T[src]

Performs the conversion.

impl<T, U> Into<U> for T where
    U: From<T>, [src]

pub fn into(self) -> U[src]

Performs the conversion.

impl<T> ToOwned for T where
    T: Clone, [src]

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T[src]

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

pub fn clone_into(&self, target: &mut T)[src]

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

recently added

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

impl<T, U> TryFrom<U> for T where
    U: Into<T>, [src]

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, [src]

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

The type returned in the event of a conversion error.

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

Performs the conversion.