Skip to main content

Rect

Struct Rect 

Source
pub struct Rect { /* private fields */ }
Expand description

A rectangle defined by left, top, right and bottom edges.

Can have zero width and/or height. But not a negative one.

§Guarantees

  • All values are finite.
  • Left edge is <= right.
  • Top edge is <= bottom.
  • Width and height are <= f32::MAX.

Implementations§

Source§

impl Rect

Source

pub fn from_ltrb(left: f32, top: f32, right: f32, bottom: f32) -> Option<Self>

Creates new Rect.

Source

pub fn from_xywh(x: f32, y: f32, w: f32, h: f32) -> Option<Self>

Creates new Rect.

Source

pub fn left(&self) -> f32

Returns the left edge.

Source

pub fn top(&self) -> f32

Returns the top edge.

Source

pub fn right(&self) -> f32

Returns the right edge.

Source

pub fn bottom(&self) -> f32

Returns the bottom edge.

Source

pub fn x(&self) -> f32

Returns rect’s X position.

Source

pub fn y(&self) -> f32

Returns rect’s Y position.

Source

pub fn width(&self) -> f32

Returns rect’s width.

Source

pub fn height(&self) -> f32

Returns rect’s height.

Source

pub fn is_empty(&self) -> bool

Returns true if the rect is empty.

Source

pub fn round(&self) -> Option<IntRect>

Converts into an IntRect by adding 0.5 and discarding the fractional portion.

Width and height are guarantee to be >= 1.

Source

pub fn round_out(&self) -> Option<IntRect>

Converts into an IntRect rounding outwards.

Width and height are guarantee to be >= 1.

Source

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

Returns an intersection of two rectangles.

Returns None otherwise.

Source

pub fn join(&self, other: &Self) -> Option<Self>

Returns the union of two rectangles.

Returns None if the width or height would overflow.

Source

pub fn from_points(points: &[Point]) -> Option<Self>

Creates a Rect from Point array.

Returns None if count is zero or if Point array contains an infinity or NaN.

Source

pub fn inset(&self, dx: f32, dy: f32) -> Option<Self>

Insets the rectangle by the specified offset.

Source

pub fn outset(&self, dx: f32, dy: f32) -> Option<Self>

Outsets the rectangle by the specified offset.

Source

pub fn transform(&self, ts: Transform) -> Option<Self>

Transforms the rect using the provided Transform.

If the transform is a skew, the result will be a bounding box around the skewed rectangle.

Source

pub fn bbox_transform(&self, bbox: NonZeroRect) -> Self

Applies a bounding box transform.

Source

pub fn to_non_zero_rect(&self) -> Option<NonZeroRect>

Converts into NonZeroRect.

Trait Implementations§

Source§

impl Clone for Rect

Source§

fn clone(&self) -> Rect

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Rect

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Hash for Rect

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for Rect

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Copy for Rect

Source§

impl Eq for Rect

Source§

impl StructuralPartialEq for Rect

Auto Trait Implementations§

§

impl Freeze for Rect

§

impl RefUnwindSafe for Rect

§

impl Send for Rect

§

impl Sync for Rect

§

impl Unpin for Rect

§

impl UnwindSafe for Rect

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.