Struct StencilState

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

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

impl StencilState

pub fn disabled() -> Self

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

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

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

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

impl Clone for StencilState

fn clone(&self) -> StencilState

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StencilState

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

Formats the value using the given formatter.

impl PartialEq for StencilState

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for StencilState

impl Eq for StencilState

impl StructuralPartialEq for StencilState