Struct Rect

pub struct Rect {
    pub position: Vec2,
    pub size: UVec2,
}

A 2D rectangle with integer coordinates for position and unsigned integer dimensions.

This struct represents a rectangle in a 2D space where the position is specified using Vec2 for integer coordinates, and the size (width and height) is represented using UVec2 for unsigned integer dimensions.

Fields

• position: The bottom-left corner of the rectangle as a Vec2.
• size: The width and height of the rectangle as a UVec2.

Examples

use int_math::prelude::*;

// Create a rectangle with bottom-left corner at (10, 20) and size (30, 40)
let rect = Rect {
    position: Vec2::new(10, 20),
    size: UVec2::new(30, 40),
};

assert_eq!(rect.position, Vec2::new(10, 20));
assert_eq!(rect.size, UVec2::new(30, 40));

Fields

position: Vec2

size: UVec2

Implementations

impl Rect

pub const fn new(x: i16, y: i16, width: u16, height: u16) -> Rect

Creates a new Rect instance with the specified position and size.

Arguments

• x: The x-coordinate of the bottom-left corner of the rectangle.
• y: The y-coordinate of the bottom-left corner of the rectangle.
• width: The width of the rectangle.
• height: The height of the rectangle.

Examples

use int_math::prelude::*;

let rect = Rect::new(10, 20, 30, 40);
assert_eq!(rect.position, Vec2::new(10, 20));
assert_eq!(rect.size, UVec2::new(30, 40));

pub const fn with_position_and_size(position: Vec2, size: UVec2) -> Rect

Creates a new Rect instance with the specified position and size.

Arguments

• position: The bottom-left corner of the rectangle as a Vec2.
• size: The width and height of the rectangle as a UVec2.

Examples

use int_math::prelude::*;

let position = Vec2::new(10, 20);
let size = UVec2::new(30, 40);
let rect = Rect::with_position_and_size(position, size);
assert_eq!(rect.position, position);
assert_eq!(rect.size, size);

pub const fn center(self) -> Vec2

Computes and returns the center of the rectangle.

The center is calculated as the midpoint of the rectangle’s width and height from its bottom-left corner.

Examples

use int_math::prelude::*;

let rect = Rect::new(10, 20, 30, 40);
let center = rect.center();
assert_eq!(center, Vec2::new(25, 40));

Note

This method performs integer division, which means that if the size of the rectangle is odd, the center coordinates may not be exact integers.

pub fn with_offset(self, offset: Vec2) -> Rect

Returns a new Rect instance with the specified offset applied to its position.

The new rectangle will have the same size but its position will be adjusted by the given offset.

Arguments

• offset: The Vec2 to add to the rectangle’s position.

Examples

use int_math::prelude::*;

let rect = Rect::new(10, 20, 30, 40);
let offset = Vec2::new(5, -5);
let new_rect = rect.with_offset(offset);
assert_eq!(new_rect.position, Vec2::new(15, 15));

Trait Implementations

impl Clone for Rect

fn clone(&self) -> Rect

Returns a copy 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<(), Error>

Formats the value using the given formatter.

impl From<(i16, i16, u16, u16)> for Rect

fn from(value: (i16, i16, u16, u16)) -> Rect

Converts to this type from the input type.

impl Copy for Rect