Struct buffer_graphics_lib::clipping::Clip

pub struct Clip { /* private fields */ }

Clip has four modes:

• Nothing - All pixels are valid
• Simple - Only pixels in the shape (rect or circle) are valid
• Custom - User provides a list of which pixels are valid
• Complex - A series of shapes adding and removing clip area

Complex starts with all pixels being valid

• use add_* to decrease the valid area
• use remove_* to increase the valid area The last shape to touch a pixel determines it’s validity

With complex mode a list of valid pixels is stored internally and each time the complex clip is updated the valid list is updated as well, if you’re making a bulk edit call set_auto_build_map(false) first

Implementations

impl Clip

pub fn new(width: usize, height: usize) -> Self

impl Clip

pub fn is_nothing(&self) -> bool

pub fn is_simple(&self) -> bool

pub fn is_complex(&self) -> bool

pub fn is_custom(&self) -> bool

pub fn set_auto_build_map(&mut self, auto_build_map: bool)

impl Clip

pub fn is_valid(&self, xy: (isize, isize)) -> bool

impl Clip

pub fn set_all_valid(&mut self)

Clears the clip so all pixels can be drawn to

pub fn set_valid_rect(&mut self, rect: Rect)

Set the valid pixels to rect

pub fn set_valid_circle(&mut self, circle: Circle)

Set the valid pixels to circle

pub fn custom(&mut self, pixel_map: Vec<bool>)

Set the valid pixels to pixel_map

pub fn get_pixel_map(&mut self) -> Vec<bool>

impl Clip

pub fn add_rect(&mut self, rect: Rect)

Set the mode to complex (clearing any other mode) Set any pixels in rect to valid

pub fn remove_rect(&mut self, rect: Rect)

Set the mode to complex (clearing any other mode) Set any pixels in rect to invalid

pub fn add_circle(&mut self, circle: Circle)

Set the mode to complex (clearing any other mode) Set any pixels in circle to valid

pub fn remove_circle(&mut self, circle: Circle)

Set the mode to complex (clearing any other mode) Set any pixels in circle to invalid

impl Clip

pub fn update_pixel_map(&mut self)

Trait Implementations

impl Clone for Clip

fn clone(&self) -> Clip

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Clip

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Clip

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Clip

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

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

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

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

impl Serialize for Clip

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Clip

impl StructuralEq for Clip

impl StructuralPartialEq for Clip