[][src]Struct tetra::graphics::Rectangle

pub struct Rectangle {
    pub x: f32,
    pub y: f32,
    pub width: f32,
    pub height: f32,
}

A rectangle of f32s.

Fields

x: f32

The X co-ordinate of the rectangle.

y: f32

The Y co-ordinate of the rectangle.

width: f32

The width of the rectangle.

height: f32

The height of the rectangle.

Methods

impl Rectangle[src]

pub const fn new(x: f32, y: f32, width: f32, height: f32) -> Rectangle[src]

Creates a new Rectangle.

pub fn row(
    x: f32,
    y: f32,
    width: f32,
    height: f32
) -> impl Iterator<Item = Rectangle>
[src]

Returns an infinite iterator of horizontally adjecent rectangles, starting at the specified point and increasing along the X axis.

This can be useful when slicing spritesheets.

Examples

let rects: Vec<Rectangle> = Rectangle::row(0.0, 0.0, 16.0, 16.0).take(3).collect();

assert_eq!(Rectangle::new(0.0, 0.0, 16.0, 16.0), rects[0]);
assert_eq!(Rectangle::new(16.0, 0.0, 16.0, 16.0), rects[1]);
assert_eq!(Rectangle::new(32.0, 0.0, 16.0, 16.0), rects[2]);

pub fn column(
    x: f32,
    y: f32,
    width: f32,
    height: f32
) -> impl Iterator<Item = Rectangle>
[src]

Returns an infinite iterator of vertically adjecent rectangles, starting at the specified point and increasing along the Y axis.

This can be useful when slicing spritesheets.

Examples

let rects: Vec<Rectangle> = Rectangle::column(0.0, 0.0, 16.0, 16.0).take(3).collect();

assert_eq!(Rectangle::new(0.0, 0.0, 16.0, 16.0), rects[0]);
assert_eq!(Rectangle::new(0.0, 16.0, 16.0, 16.0), rects[1]);
assert_eq!(Rectangle::new(0.0, 32.0, 16.0, 16.0), rects[2]);

pub fn intersects(&self, other: &Rectangle) -> bool[src]

Returns true if the other rectangle intersects with self.

pub fn contains(&self, other: &Rectangle) -> bool[src]

Returns true if the other rectangle is fully contained within self.

pub fn contains_point(&self, point: Vec2<f32>) -> bool[src]

Returns true if the provided point is within the bounds of self.

pub fn left(&self) -> f32[src]

Returns the X co-ordinate of the left side of the rectangle.

You can also obtain this via the x field - this method is provided for symmetry with the right method.

pub fn right(&self) -> f32[src]

Returns the X co-ordinate of the right side of the rectangle.

pub fn top(&self) -> f32[src]

Returns the Y co-ordinate of the top of the rectangle.

You can also obtain this via the y field - this method is provided for symmetry with the bottom method.

pub fn bottom(&self) -> f32[src]

Returns the Y co-ordinate of the bottom of the rectangle.

pub fn center(&self) -> Vec2<f32>[src]

Returns the co-ordinates of the center point of the rectangle.

pub fn top_left(&self) -> Vec2<f32>[src]

Returns the co-ordinates of the top-left point of the rectangle.

pub fn top_right(&self) -> Vec2<f32>[src]

Returns the co-ordinates of the top-right point of the rectangle.

pub fn bottom_left(&self) -> Vec2<f32>[src]

Returns the co-ordinates of the bottom-left point of the rectangle.

pub fn bottom_right(&self) -> Vec2<f32>[src]

Returns the co-ordinates of the bottom-right point of the rectangle.

Trait Implementations

impl Clone for Rectangle[src]

impl Copy for Rectangle[src]

impl Debug for Rectangle[src]

impl PartialEq<Rectangle> for Rectangle[src]

impl StructuralPartialEq for Rectangle[src]

Auto Trait Implementations

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> SetParameter for T

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

impl<V, T> VZip<V> for T where
    V: MultiLane<T>,