pub struct Rect { /* private fields */ }
Expand description
A (non-empty) rectangle.
The width and height of a Rect
must always be strictly positive (never
zero). In cases where empty rects may need to represented, it is
recommended to use Option<Rect>
, with None
representing an empty
rectangle (see, for example, the output of the
intersection
method).
Implementations
sourceimpl Rect
impl Rect
sourcepub fn new(x: i32, y: i32, width: u32, height: u32) -> Rect
pub fn new(x: i32, y: i32, width: u32, height: u32) -> Rect
Creates a new rectangle from the given values.
The width and height are clamped to ensure that the right and bottom sides of the rectangle does not exceed i32::max_value() (the value 2147483647, the maximal positive size of an i32). This means that the rect size will behave oddly if you move it very far to the right or downwards on the screen.
Rect
s must always be non-empty, so a width
and/or height
argument
of 0 will be replaced with 1.
sourcepub fn from_center<P>(center: P, width: u32, height: u32) -> Rect where
P: Into<Point>,
pub fn from_center<P>(center: P, width: u32, height: u32) -> Rect where
P: Into<Point>,
Creates a new rectangle centered on the given position.
The width and height are clamped to ensure that the right and bottom sides of the rectangle does not exceed i32::max_value() (the value 2147483647, the maximal positive size of an i32). This means that the rect size will behave oddly if you move it very far to the right or downwards on the screen.
Rect
s must always be non-empty, so a width
and/or height
argument
of 0 will be replaced with 1.
sourcepub fn set_x(&mut self, x: i32)
pub fn set_x(&mut self, x: i32)
Sets the horizontal position of this rectangle to the given value, clamped to be less than or equal to i32::max_value() / 2.
sourcepub fn set_y(&mut self, y: i32)
pub fn set_y(&mut self, y: i32)
Sets the vertical position of this rectangle to the given value, clamped to be less than or equal to i32::max_value() / 2.
sourcepub fn set_width(&mut self, width: u32)
pub fn set_width(&mut self, width: u32)
Sets the width of this rectangle to the given value, clamped to be less than or equal to i32::max_value() / 2.
Rect
s must always be non-empty, so a width
argument of 0 will be
replaced with 1.
sourcepub fn set_height(&mut self, height: u32)
pub fn set_height(&mut self, height: u32)
Sets the height of this rectangle to the given value, clamped to be less than or equal to i32::max_value() / 2.
Rect
s must always be non-empty, so a height
argument of 0 will be
replaced with 1.
sourcepub fn center(&self) -> Point
pub fn center(&self) -> Point
Returns the center position of this rectangle.
Note that if the width or height is not a multiple of two, the center will be rounded down.
Example
use sdl2::rect::{Rect,Point};
let rect = Rect::new(1,0,2,3);
assert_eq!(Point::new(2,1),rect.center());
sourcepub fn top_left(&self) -> Point
pub fn top_left(&self) -> Point
Returns the top-left corner of this rectangle.
Example
use sdl2::rect::{Rect, Point};
let rect = Rect::new(1, 0, 2, 3);
assert_eq!(Point::new(1, 0), rect.top_left());
sourcepub fn top_right(&self) -> Point
pub fn top_right(&self) -> Point
Returns the top-right corner of this rectangle.
Example
use sdl2::rect::{Rect, Point};
let rect = Rect::new(1, 0, 2, 3);
assert_eq!(Point::new(3, 0), rect.top_right());
sourcepub fn bottom_left(&self) -> Point
pub fn bottom_left(&self) -> Point
Returns the bottom-left corner of this rectangle.
Example
use sdl2::rect::{Rect, Point};
let rect = Rect::new(1, 0, 2, 3);
assert_eq!(Point::new(1, 3), rect.bottom_left());
sourcepub fn bottom_right(&self) -> Point
pub fn bottom_right(&self) -> Point
Returns the bottom-right corner of this rectangle.
Example
use sdl2::rect::{Rect, Point};
let rect = Rect::new(1, 0, 2, 3);
assert_eq!(Point::new(3, 3), rect.bottom_right());
sourcepub fn set_right(&mut self, right: i32)
pub fn set_right(&mut self, right: i32)
Sets the position of the right side of this rectangle to the given value, clamped to be less than or equal to i32::max_value() / 2.
sourcepub fn set_bottom(&mut self, bottom: i32)
pub fn set_bottom(&mut self, bottom: i32)
Sets the position of the bottom side of this rectangle to the given value, clamped to be less than or equal to i32::max_value() / 2.
sourcepub fn center_on<P>(&mut self, point: P) where
P: Into<(i32, i32)>,
pub fn center_on<P>(&mut self, point: P) where
P: Into<(i32, i32)>,
Centers the rectangle on the given point.
sourcepub fn offset(&mut self, x: i32, y: i32)
pub fn offset(&mut self, x: i32, y: i32)
Move this rect and clamp the positions to prevent over/underflow. This also clamps the size to prevent overflow.
sourcepub fn reposition<P>(&mut self, point: P) where
P: Into<(i32, i32)>,
pub fn reposition<P>(&mut self, point: P) where
P: Into<(i32, i32)>,
Moves this rect to the given position after clamping the values.
sourcepub fn resize(&mut self, width: u32, height: u32)
pub fn resize(&mut self, width: u32, height: u32)
Resizes this rect to the given size after clamping the values.
sourcepub fn contains_point<P>(&self, point: P) -> bool where
P: Into<(i32, i32)>,
pub fn contains_point<P>(&self, point: P) -> bool where
P: Into<(i32, i32)>,
Checks whether this rectangle contains a given point.
Points along the right and bottom edges are not considered to be inside
the rectangle; this way, a 1-by-1 rectangle contains only a single
point. Another way to look at it is that this method returns true if
and only if the given point would be painted by a call to
Renderer::fill_rect
.
Examples
use sdl2::rect::{Rect, Point};
let rect = Rect::new(1, 2, 3, 4);
assert!(rect.contains_point(Point::new(1, 2)));
assert!(!rect.contains_point(Point::new(0, 1)));
assert!(rect.contains_point(Point::new(3, 5)));
assert!(!rect.contains_point(Point::new(4, 6)));
sourcepub fn contains_rect(&self, other: Rect) -> bool
pub fn contains_rect(&self, other: Rect) -> bool
Checks whether this rectangle completely contains another rectangle.
This method returns true if and only if every point contained by
other
is also contained by self
; in other words, if the
intersection of self
and other
is equal to other
.
Examples
use sdl2::rect::Rect;
let rect = Rect::new(1, 2, 3, 4);
assert!(rect.contains_rect(rect));
assert!(rect.contains_rect(Rect::new(3, 3, 1, 1)));
assert!(!rect.contains_rect(Rect::new(2, 1, 1, 1)));
assert!(!rect.contains_rect(Rect::new(3, 3, 2, 1)));
pub fn raw_mut(&mut self) -> *mut SDL_Rect
pub fn raw_slice(slice: &[Rect]) -> *const SDL_Rect
pub fn from_ll(raw: SDL_Rect) -> Rect
sourcepub fn from_enclose_points<R: Into<Option<Rect>>>(
points: &[Point],
clipping_rect: R
) -> Option<Rect> where
R: Into<Option<Rect>>,
pub fn from_enclose_points<R: Into<Option<Rect>>>(
points: &[Point],
clipping_rect: R
) -> Option<Rect> where
R: Into<Option<Rect>>,
Calculate a minimal rectangle enclosing a set of points. If a clipping rectangle is given, only points that are within it will be considered.
sourcepub fn has_intersection(&self, other: Rect) -> bool
pub fn has_intersection(&self, other: Rect) -> bool
Determines whether two rectangles intersect.
Rectangles that share an edge but don’t actually overlap are not considered to intersect.
Examples
use sdl2::rect::Rect;
let rect = Rect::new(0, 0, 5, 5);
assert!(rect.has_intersection(rect));
assert!(rect.has_intersection(Rect::new(2, 2, 5, 5)));
assert!(!rect.has_intersection(Rect::new(5, 0, 5, 5)));
sourcepub fn intersection(&self, other: Rect) -> Option<Rect>
pub fn intersection(&self, other: Rect) -> Option<Rect>
Calculates the intersection of two rectangles.
Returns None
if the two rectangles don’t intersect. Rectangles that
share an edge but don’t actually overlap are not considered to
intersect.
The bitwise AND operator &
can also be used.
Examples
use sdl2::rect::Rect;
let rect = Rect::new(0, 0, 5, 5);
assert_eq!(rect.intersection(rect), Some(rect));
assert_eq!(rect.intersection(Rect::new(2, 2, 5, 5)),
Some(Rect::new(2, 2, 3, 3)));
assert_eq!(rect.intersection(Rect::new(5, 0, 5, 5)), None);
sourcepub fn union(&self, other: Rect) -> Rect
pub fn union(&self, other: Rect) -> Rect
Calculates the union of two rectangles (i.e. the smallest rectangle that contains both).
The bitwise OR operator |
can also be used.
Examples
use sdl2::rect::Rect;
let rect = Rect::new(0, 0, 5, 5);
assert_eq!(rect.union(rect), rect);
assert_eq!(rect.union(Rect::new(2, 2, 5, 5)), Rect::new(0, 0, 7, 7));
assert_eq!(rect.union(Rect::new(5, 0, 5, 5)), Rect::new(0, 0, 10, 5));
Trait Implementations
impl Copy for Rect
impl Eq for Rect
Auto Trait Implementations
impl RefUnwindSafe for Rect
impl Send for Rect
impl Sync for Rect
impl Unpin for Rect
impl UnwindSafe for Rect
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcepub fn to_owned(&self) -> T
pub fn to_owned(&self) -> T
Creates owned data from borrowed data, usually by cloning. Read more
sourcepub fn clone_into(&self, target: &mut T)
pub fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more