Struct ggez::graphics::Rect

pub struct Rect {
    pub x: f32,
    pub y: f32,
    pub w: f32,
    pub h: f32,
}

A simple 2D rectangle.

The origin of the rectangle is at the top-left, with x increasing to the right and y increasing down.

Fields

x: f32

X coordinate of the left edge of the rect.

y: f32

Y coordinate of the top edge of the rect.

w: f32

Total width of the rect

h: f32

Total height of the rect.

Implementations

impl Rect

pub const fn new(x: f32, y: f32, w: f32, h: f32) -> Self

Create a new Rect.

pub fn fraction(x: f32, y: f32, w: f32, h: f32, reference: &Rect) -> Rect

Creates a new Rect a la Love2D’s love.graphics.newQuad, as a fraction of the reference rect’s size.

pub fn new_i32(x: i32, y: i32, w: i32, h: i32) -> Self

Create a new rect from i32 coordinates. Loses precision if the integers are too big to fit in f32’s.

pub const fn zero() -> Self

Create a new Rect with all values zero.

pub const fn one() -> Self

Creates a new Rect at [0.0, 0.0] with width and height 1.

pub const fn size(&self) -> Vector2<f32>

Gets the Rect’s width and height as a Vector2.

pub const fn point(&self) -> Point2<f32>

Gets the Rect’s x and y coordinates as a Point2.

pub fn center(&self) -> Point2<f32>

Gets the Rect’s center x and y coordinates as a Point2.

pub const fn left(&self) -> f32

Returns the left edge of the Rect

pub fn right(&self) -> f32

Returns the right edge of the Rect

pub const fn top(&self) -> f32

Returns the top edge of the Rect

pub fn bottom(&self) -> f32

Returns the bottom edge of the Rect

pub fn contains<P>(&self, point: P) -> boolwhere P: Into<Point2<f32>>,

Checks whether the Rect contains a Point

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

Checks whether the Rect overlaps another Rect

pub fn overlaps_circle( &self, point: impl Into<Point2<f32>>, radius: f32 ) -> bool

Checks whether the Rect overlaps a circle.

pub fn translate<V>(&mut self, offset: V)where V: Into<Vector2<f32>>,

Translates the Rect by an offset of (x, y)

pub fn move_to<P>(&mut self, destination: P)where P: Into<Point2<f32>>,

Moves the Rect’s origin to (x, y)

pub fn scale(&mut self, sx: f32, sy: f32)

Scales the Rect by a factor of (sx, sy), growing towards the bottom-left

pub fn rotate(&mut self, rotation: f32)

Calculated the new Rect around the rotated one.

pub fn combine_with(self, other: Rect) -> Rect

Returns a new Rect that includes all points of these two Rects.

Trait Implementations

impl AbsDiffEq<Rect> for Rect

type Epsilon = f32

Used for specifying relative comparisons.

fn default_epsilon() -> Self::Epsilon

The default tolerance to use when testing values that are close together.

fn abs_diff_eq(&self, other: &Self, epsilon: Self::Epsilon) -> bool

A test for equality that uses the absolute difference to compute the approximate equality of two numbers.

fn abs_diff_ne(&self, other: &Rhs, epsilon: Self::Epsilon) -> bool

The inverse of AbsDiffEq::abs_diff_eq.

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<'de> Deserialize<'de> for Rect

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<[f32; 4]> for Rect

fn from(val: [f32; 4]) -> Self

Converts to this type from the input type.

impl From<Rect> for [f32; 4]

fn from(val: Rect) -> Self

Converts to this type from the input type.

impl PartialEq<Rect> 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 RelativeEq<Rect> for Rect

fn default_max_relative() -> Self::Epsilon

The default relative tolerance for testing values that are far-apart.

fn relative_eq( &self, other: &Self, epsilon: Self::Epsilon, max_relative: Self::Epsilon ) -> bool

A test for equality that uses a relative comparison if the values are far apart.

fn relative_ne( &self, other: &Rhs, epsilon: Self::Epsilon, max_relative: Self::Epsilon ) -> bool

The inverse of RelativeEq::relative_eq.

impl Serialize for Rect

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

Serialize this value into the given Serde serializer.

impl Copy for Rect

impl StructuralPartialEq for Rect