Skip to main content
← PSoXide SDK guides and examples · SDK f2fec1c301f1 · All Cargo features enabled; check feature gates before use.

VramRect

Struct VramRect 

Source
pub struct VramRect {
    pub x: u16,
    pub y: u16,
    pub w: u16,
    pub h: u16,
}
Expand description

An (x, y, w, h) rectangle in VRAM coordinates.

Construction asserts the rect fits in VRAM. Subsequent code can pass VramRect around without re-checking – it’s by-construction safe.

Fields§

§x: u16

Top-left X in VRAM pixels (0..VRAM_WIDTH).

§y: u16

Top-left Y in VRAM pixels (0..VRAM_HEIGHT).

§w: u16

Width in pixels. x + w <= VRAM_WIDTH.

§h: u16

Height in pixels. y + h <= VRAM_HEIGHT.

Implementations§

Source§

impl VramRect

Source

pub const fn new(x: u16, y: u16, w: u16, h: u16) -> Self

Build a rect, asserting it fits in VRAM.

Source

pub const fn pixel_count(self) -> u32

Total pixel count. w * h.

Source

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

Do these two rectangles share a pixel?

Const so a game can prove its fixed VRAM layout at compile time. See first_vram_overlap.

Trait Implementations§

Source§

impl Clone for VramRect

Source§

fn clone(&self) -> VramRect

Returns a duplicate of the value. Read more
1.0.0§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for VramRect

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for VramRect

Source§

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

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

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

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

impl Copy for VramRect

Source§

impl Eq for VramRect

Source§

impl StructuralPartialEq for VramRect

Auto Trait Implementations§

§

impl Freeze for VramRect

§

impl RefUnwindSafe for VramRect

§

impl Send for VramRect

§

impl Sync for VramRect

§

impl Unpin for VramRect

§

impl UnsafeUnpin for VramRect

§

impl UnwindSafe for VramRect

Blanket Implementations§

§

impl<T> Any for T
where T: 'static + ?Sized,

§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<T> Borrow<T> for T
where T: ?Sized,

§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
§

impl<T> BorrowMut<T> for T
where T: ?Sized,

§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> CloneToUninit for T
where T: Clone,

§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
§

impl<T> From<T> for T

§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T, U> Into<U> for T
where U: From<T>,

§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of [From]<T> for U chooses to do.

§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

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

The type returned in the event of a conversion error.
§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.