Struct RectU16 

pub struct RectU16 {
    pub x0: u16,
    pub y0: u16,
    pub x1: u16,
    pub y1: u16,
}

An axis-aligned rectangle with u16 coordinates, stored as two corners (x0, y0) and (x1, y1).

(x0, y0) is the top-left (minimum) corner and (x1, y1) is the bottom-right (maximum) corner. The rectangle is considered to be empty when x0 >= x1 or y0 >= y1.

Fields

x0: u16

The minimum x coordinate (left edge).

y0: u16

The minimum y coordinate (top edge).

x1: u16

The maximum x coordinate (right edge, exclusive).

y1: u16

The maximum y coordinate (bottom edge, exclusive).

Implementations

impl RectU16

pub const ZERO: Self

A rectangle with all coordinates set to zero.

pub const INVERTED: Self

An empty, maximally inverted rectangle, useful as a starting value for incremental union operations.

Has (x0, y0) = (u16::MAX, u16::MAX) and (x1, y1) = (0, 0).

pub const fn new(x0: u16, y0: u16, x1: u16, y1: u16) -> Self

Create a new rectangle from its corner coordinates.

pub const fn width(self) -> u16

The width of the rectangle (x1 - x0), saturating at zero.

pub const fn height(self) -> u16

The height of the rectangle (y1 - y0), saturating at zero.

pub const fn is_empty(self) -> bool

Returns true if the rectangle has zero area (x0 >= x1 or y0 >= y1).

pub const fn contains(self, x: u16, y: u16) -> bool

Check if a point (x, y) is contained within this rectangle.

Returns true if x0 <= x < x1 and y0 <= y < y1.

pub const fn intersect(self, other: Self) -> Self

Compute the intersection of two rectangles.

The result may have zero area if the rectangles do not overlap, but is never inverted.

pub const fn expand(self, padding: PaddingU16) -> Self

Expand this rectangle by the given left, top, right, and bottom padding.

pub fn relative_to_origin(self, origin: (u16, u16)) -> Self

Return this rectangle relative to origin, clamping negative coordinates to zero.

pub fn shift(self, shift: (i32, i32)) -> Self

Return a shifted version of the rectangle, clamping negative coordinates to zero.

pub const fn union(&mut self, other: Self)

Expand this rectangle to also cover other (union in place).

The union of self with a Self::INVERTED returns self.

pub fn as_rect(self) -> Rect

Return the rect as a Rect.

Trait Implementations

impl Clone for RectU16

fn clone(&self) -> RectU16

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RectU16

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

Formats the value using the given formatter.

impl From<RectU16> for SizeU16

fn from(rect: RectU16) -> Self

Converts to this type from the input type.

impl Hash for RectU16

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for RectU16

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

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RectExt for RectU16

fn snap_to_tile_coordinates(self) -> Self

Snap the rect to whole tile coordinates.

impl Copy for RectU16

impl Eq for RectU16

impl StructuralPartialEq for RectU16