Struct graphics::draw_state::DrawState

pub struct DrawState {
    pub scissor: Option<[u32; 4]>,
    pub stencil: Option<Stencil>,
    pub blend: Option<Blend>,
}

Graphics draw state used for blending, clipping and stencil rendering.

Fields

scissor: Option<[u32; 4]>

Scissor mask to use. If set, no pixel outside of this rectangle (in screen space) will be written to as a result of rendering.

stencil: Option<Stencil>

Stencil test to use. If None, no stencil testing is done.

blend: Option<Blend>

Blend function to use. If None, blending is disabled.

Implementations

impl DrawState

pub fn new_alpha() -> DrawState

Uses alpha blending.

pub fn new_clip() -> DrawState

Draws to stencil buffer with value 255. This can be used for clipping.

For nested clipping, clear the stencil buffer and use DrawState::new_increment.

pub fn new_increment() -> DrawState

Increases stencil buffer. This can be used for nested clipping.

pub fn new_inside() -> DrawState

Tests against stencil buffer with value 255. Draws inside the shape defined by stencil buffer.

pub fn new_outside() -> DrawState

Tests against stencil buffer with value 255. Draws outside the shape defined by stencil buffer.

pub fn blend(self, blend: Blend) -> DrawState

Sets blending.

pub fn scissor(self, scissor: [u32; 4]) -> DrawState

Sets scissor [x, y, w, h].

Trait Implementations

impl Clone for DrawState

fn clone(&self) -> DrawState

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for DrawState

impl Debug for DrawState

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

Formats the value using the given formatter.

impl Default for DrawState

fn default() -> Self

Returns the "default value" for a type.

impl PartialEq<DrawState> for DrawState

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

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

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

This method tests for !=.

impl PartialOrd<DrawState> for DrawState

fn partial_cmp(&self, other: &DrawState) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &DrawState) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &DrawState) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &DrawState) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &DrawState) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for DrawState