Struct sdl2::rect::Rect [−][src]
pub struct Rect { /* fields omitted */ }
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
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.
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.
Sets the horizontal position of this rectangle to the given value, clamped to be less than or equal to i32::max_value() / 2.
Sets the vertical position of this rectangle to the given value, clamped to be less than or equal to i32::max_value() / 2.
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.
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.
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());
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());
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());
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());
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());
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.
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.
Centers the rectangle on the given point.
Move this rect and clamp the positions to prevent over/underflow. This also clamps the size to prevent overflow.
Moves this rect to the given position after clamping the values.
Resizes this rect to the given size after clamping the values.
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)));
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)));
Calculate a minimal rectangle enclosing a set of points. If a clipping rectangle is given, only points that are within it will be considered.
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)));
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);
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
Auto Trait Implementations
impl RefUnwindSafe for Rect
impl UnwindSafe for Rect
Blanket Implementations
Mutably borrows from an owned value. Read more