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

Sprite

Struct Sprite 

Source
#[repr(C, align(4))]
pub struct Sprite { pub tag: u32, pub color_cmd: u32, pub xy: u32, pub uv_clut: u32, pub wh: u32, }
Expand description

Textured sprite (variable size). 5 words (tag + 4 data).

Fields§

§tag: u32

OT linkage.

§color_cmd: u32

0x64000000 | color header (blend color applied over texture).

§xy: u32

Top-left xy.

§uv_clut: u32

uv | clut (U/V in low half, CLUT handle in high half).

§wh: u32

Size wh.

Implementations§

Source§

impl Sprite

Source

pub const WORDS: u8 = 4

Data-word count.

Source

pub const fn new( x: i16, y: i16, w: u16, h: u16, uv: (u8, u8), clut: u16, r: u8, g: u8, b: u8, ) -> Self

Build a textured sprite. clut is the CLUT register handle (y << 6 | x >> 4); uv is the 8-bit texcoord within the texture page.

Source

pub const fn with_material( x: i16, y: i16, w: u16, h: u16, uv: (u8, u8), material: TextureMaterial, ) -> Self

Build a textured sprite using a TextureMaterial.

Sprite packets do not carry a tpage word. The material’s CLUT, tint, raw-texture bit, and semi-transparent command bit are encoded in the packet; the caller must set the matching draw mode before OT submission if the sprite samples a non-current tpage.

Trait Implementations§

Source§

impl Clone for Sprite

Source§

fn clone(&self) -> Sprite

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 Sprite

Source§

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

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

impl GpuPacket for Sprite

Source§

const WORDS: u8 = Sprite::WORDS

Payload words after the tag.
Source§

impl Hash for Sprite

Source§

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

Feeds this value into the given [Hasher]. Read more
1.3.0§

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

Feeds a slice of this type into the given [Hasher]. Read more
Source§

impl PartialEq for Sprite

Source§

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

Source§

impl Eq for Sprite

Source§

impl StructuralPartialEq for Sprite

Auto Trait Implementations§

§

impl Freeze for Sprite

§

impl RefUnwindSafe for Sprite

§

impl Send for Sprite

§

impl Sync for Sprite

§

impl Unpin for Sprite

§

impl UnsafeUnpin for Sprite

§

impl UnwindSafe for Sprite

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.