Struct mage_core::image::Rect

pub struct Rect {
    pub x: i32,
    pub y: i32,
    pub width: u32,
    pub height: u32,
}

A rectangle in 2D space.

Fields

x: i32

y: i32

width: u32

height: u32

Implementations

impl Rect

pub fn new(x: i32, y: i32, width: u32, height: u32) -> Self

Creates a new rectangle with the given position and dimensions.

pub fn from_points(p1: Point, p2: Point) -> Self

Creates a new rectangle from two points.

The points do not need to be in any particular order. The rectangle will be the smallest rectangle that contains both points. If the points are the same, the rectangle will have zero width and height. If the points are on the same vertical or horizontal line, the rectangle will have zero width or height respectively.

Arguments

• p1 - The first point.
• p2 - The second point.

Returns

A new rectangle that contains both points.

pub fn from_point_and_size(p: Point, width: u32, height: u32) -> Self

Creates a new rectangle from a point and size.

The point is the top-left corner of the rectangle.

Arguments

• p - The top-left corner of the rectangle.
• width - The width of the rectangle.
• height - The height of the rectangle.

Returns

A new rectangle with the given top-left corner and dimensions.

pub fn union(&self, other: Self) -> Self

Returns the union of this rectangle and another rectangle.

The union of two rectangles is the smallest rectangle that contains both rectangles.

Arguments

• other - The other rectangle to union with.

Returns

A new rectangle that contains both rectangles.

pub fn intersect(&self, other: Self) -> Self

Returns the intersection of this rectangle and another rectangle.

The intersection of two rectangles is the largest rectangle that is contained within both rectangles.

Arguments

• other - The other rectangle to intersect with.

Returns

A new rectangle that is contained within both rectangles.

pub fn clip_within(&self, width: u32, height: u32) -> (Self, Point)

Creates a new rectangle by clipping this rectangle to the given dimensions.

The new rectangle will be the largest rectangle that fits within the given dimensions and is contained within this rectangle.

The point returned is the offset of the top-left corner of the new rectangle within the given original rectangle. This is useful for rendering the new rectangle within the original rectangle.

Arguments

• width - The width of the rectangle to clip within.
• height - The height of the rectangle to clip within.

Returns

A new rectangle that fits within the given dimensions and is contained within this rectangle. Also returns the offset of the top-left corner of the new rectangle within the original rectangle.

Trait Implementations

impl Clone for Rect

fn clone(&self) -> Rect

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Rect

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

Formats the value using the given formatter.

impl Default for Rect

fn default() -> Rect

Returns the “default value” for a type.

impl PartialEq for Rect

fn eq(&self, other: &Rect) -> 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 Copy for Rect

impl Eq for Rect

impl StructuralEq for Rect

impl StructuralPartialEq for Rect