Skip to main content

Rectangle

Struct Rectangle 

Source
#[repr(C)]
pub struct Rectangle { pub x: f32, pub y: f32, pub width: f32, pub height: f32, }
Expand description

An axis-aligned rectangle defined by its top-left corner and dimensions.

Rectangle is a #[repr(C)] struct with four f32 fields: x and y for the top-left corner position, and width / height for the extents. It maps directly to raylib’s Rectangle type in C.

Collision and containment helpers are available as methods: check_collision_recs, check_collision_point_rec, get_collision_rec, check_collision_circle_rec.

§Examples

use raylib_sys::Rectangle;

let r1 = Rectangle::new(0.0, 0.0, 10.0, 10.0);
let r2 = Rectangle::new(5.0, 5.0, 10.0, 10.0);
let r3 = Rectangle::new(20.0, 20.0, 10.0, 10.0);

assert!(r1.check_collision_recs(r2));   // overlapping
assert!(!r1.check_collision_recs(r3));  // non-overlapping

Fields§

§x: f32§y: f32§width: f32§height: f32

Implementations§

Source§

impl Rectangle

Source

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

Source

pub fn check_collision_recs(&self, other: Rectangle) -> bool

Check collision between two rectangles

Source

pub fn check_collision_circle_rec( &self, center: impl Into<Vector2>, radius: f32, ) -> bool

Checks collision between circle and rectangle.

Source

pub fn get_collision_rec(&self, other: Rectangle) -> Option<Rectangle>

Gets the overlap between two colliding rectangles.

use raylib_sys::Rectangle;

let r1 = Rectangle::new(0.0, 0.0, 10.0, 10.0);
let r2 = Rectangle::new(20.0, 20.0, 10.0, 10.0);
assert_eq!(None, r1.get_collision_rec(r2));
assert_eq!(Some(r1), r1.get_collision_rec(r1));
Source

pub fn check_collision_point_rec(&self, point: impl Into<Vector2>) -> bool

Checks if point is inside rectangle.

Trait Implementations§

Source§

impl Clone for Rectangle

Source§

fn clone(&self) -> Rectangle

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for Rectangle

Source§

impl Debug for Rectangle

Source§

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

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

impl Default for Rectangle

Source§

fn default() -> Rectangle

Returns the “default value” for a type. Read more
Source§

impl PartialEq for Rectangle

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · 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 StructuralPartialEq for Rectangle

Auto Trait Implementations§

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, 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.