Struct Rect

pub struct Rect {
    pub x: i32,
    pub y: i32,
    pub w: u32,
    pub h: u32,
}

Represents a rectangle with a position (Rect::x, Rect::y) and dimensions (Rect::w, Rect::h).

Demonstration

(x/y)
  x-------. ^
  |       | |
  |       | | h
  |       | |
  '-------' v
  <------->
      w

Fields

x: i32

X-Coordinate, can be negative

y: i32

Y-Coordinate, can be negative

w: u32

Width, can not be negative

h: u32

Height, can not be negative

Implementations

impl Rect

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

Shorthand method to create a new Rect with the provided x, y, w, and h.

pub fn surface_area(&self) -> u32

Calculate the surface area of the Rect

pub fn center(&self) -> (i32, i32)

Get the coordinate at the center of the Rect.

The center coordinate is rounded to the nearest integer and might not be at the exact center position.

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

Check whether a point is contained in a Rect.

The boundary counts as part of the Rect.

pub fn top_left_corner(&self) -> (i32, i32)

Get the top left corner point of the Rect.

O---------+
|         |
|         |
|         |
+---------+

pub fn top_right_corner(&self) -> (i32, i32)

Get the top right corner point of the Rect.

+---------O
|         |
|         |
|         |
+---------+

pub fn bottom_right_corner(&self) -> (i32, i32)

Get the bottom right corner point of the Rect.

+---------+
|         |
|         |
|         |
+---------O

pub fn bottom_left_corner(&self) -> (i32, i32)

Get the bottom left corner point of the Rect.

+---------+
|         |
|         |
|         |
O---------+

pub fn top_edge(&self) -> i32

Get the top edge of the Rect.

^
|
V
+---------+
|         |
|         |
|         |
+---------+

pub fn right_edge(&self) -> i32

Get the right edge of the Rect.

<--------->
+---------+
|         |
|         |
|         |
+---------+

pub fn bottom_edge(&self) -> i32

Get the bottom edge of the Rect.

+---------+ ^
|         | |
|         | |
|         | |
+---------+ V

pub fn left_edge(&self) -> i32

Get the left edge of the Rect.

<---> +---------+
      |         |
      |         |
      |         |
      +---------+

Trait Implementations

impl Clone for Rect

fn clone(&self) -> Rect

Returns a duplicate 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() -> Self

Returns the “default value” for a type.

impl PartialEq for Rect

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

Tests for self and other values to be equal, and is used by ==.

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

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 StructuralPartialEq for Rect