Struct ScreenRect 

pub struct ScreenRect {
    pub x1: i16,
    pub y1: i16,
    pub x2: i16,
    pub y2: i16,
}

integer pixel-space rectangle, used for scissor regions and screen-space bounds.

origin is top-left. x1 < x2, y1 < y2. the rect is inclusive on all edges.

usage

let screen = ScreenRect::full(window_w, window_h);
let clipped = screen.intersect(ScreenRect::new(10, 10, 200, 150));
if !clipped.is_empty() {
    // region is on screen
}

Fields

x1: i16

y1: i16

x2: i16

y2: i16

Implementations

impl ScreenRect

pub const EMPTY: Self

an empty rect that contains no pixels.

pub const fn full(width: u16, height: u16) -> Self

the full screen at the given dimensions.

pub const fn new(x1: i16, y1: i16, x2: i16, y2: i16) -> Self

pub const fn is_empty(self) -> bool

true if the rect has no area.

pub fn add_point(&mut self, x: i16, y: i16)

expand the rect to include a screen-space pixel point.

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

smallest rect containing both self and other.

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

largest rect contained within both self and other (intersection).

pub const fn width(self) -> u16

width in pixels (0 if empty).

pub const fn height(self) -> u16

height in pixels (0 if empty).

Trait Implementations

impl Clone for ScreenRect

fn clone(&self) -> ScreenRect

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ScreenRect

impl Debug for ScreenRect

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

Formats the value using the given formatter.

impl Eq for ScreenRect

impl PartialEq for ScreenRect

fn eq(&self, other: &ScreenRect) -> 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 StructuralPartialEq for ScreenRect