Struct Region

pub struct Region { /* private fields */ }

A union of rectangles, useful for describing an area that needs to be repainted.

Implementations

impl Region

pub const EMPTY: Region

The empty region.

pub fn rects(&self) -> &[Rect]

Returns the collection of rectangles making up this region.

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

Adds a rectangle to this region.

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

Replaces this region with a single rectangle.

pub fn clear(&mut self)

Sets this region to the empty region.

pub fn bounding_box(&self) -> Rect

Returns a rectangle containing this region.

Examples found in repository

examples/invalidate.rs (line 75)

    fn paint(&mut self, piet: &mut Piet, region: &Region) {
        // We can ask to draw something bigger than our rect, but things outside
        // the invalidation region won't draw. (So they'll draw if and only if
        // they intersect the cursor's invalidated region or the rect that we
        // invalidated.)
        piet.fill(region.bounding_box(), &self.color);
        piet.fill(self.cursor, &Color::WHITE);
        self.handle.request_anim_frame();
    }

pub fn intersects(&self, rect: Rect) -> bool

Returns true if this region has a non-empty intersection with the given rectangle.

pub fn contains(&self, point: Point) -> bool

Returns true if the given point is contained within any rectangle in the region.

pub fn is_empty(&self) -> bool

Returns true if this region is empty.

pub fn to_bez_path(&self) -> BezPath

Converts into a Bezier path. Note that this just gives the concatenation of the rectangle paths, which is not the smartest possible thing. Also, it’s not the right answer for an even/odd fill rule.

pub fn union_with(&mut self, other: &Region)

Modifies this region by including everything in the other region.

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

Modifies this region by intersecting it with the given rectangle.

Trait Implementations

impl AddAssign<Vec2> for Region

fn add_assign(&mut self, rhs: Vec2)

Performs the += operation.

impl Clone for Region

fn clone(&self) -> Region

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Region

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

Formats the value using the given formatter.

impl From<Rect> for Region

fn from(rect: Rect) -> Region

Converts to this type from the input type.

impl SubAssign<Vec2> for Region

fn sub_assign(&mut self, rhs: Vec2)

Performs the -= operation.