Skip to main content

BannerKeyframe

ds_rom::rom::raw

Struct BannerKeyframe

pub struct BannerKeyframe(/* private fields */);

Expand description

A keyframe for BannerAnimation.

Implementations§

impl BannerKeyframe

pub const fn new() -> Self

Creates a new default initialized bitfield.

pub const fn from_bits(bits: u16) -> Self

Convert from bits.

pub const fn into_bits(self) -> u16

Convert into bits.

pub const fn frame_duration(&self) -> u8

How long to show this keyframe for, in frames.

Bits: 0..8

pub const fn with_frame_duration_checked(self, value: u8) -> Result<Self, ()>

How long to show this keyframe for, in frames.

Bits: 0..8

pub const fn with_frame_duration(self, value: u8) -> Self

How long to show this keyframe for, in frames.

Bits: 0..8

pub const fn set_frame_duration(&mut self, value: u8)

How long to show this keyframe for, in frames.

Bits: 0..8

pub const fn set_frame_duration_checked(&mut self, value: u8) -> Result<(), ()>

How long to show this keyframe for, in frames.

Bits: 0..8

pub const fn bitmap_index(&self) -> u8

Which of the 8 bitmaps to show.

Bits: 8..11

pub const fn with_bitmap_index_checked(self, value: u8) -> Result<Self, ()>

Which of the 8 bitmaps to show.

Bits: 8..11

pub const fn with_bitmap_index(self, value: u8) -> Self

Which of the 8 bitmaps to show.

Bits: 8..11

pub const fn set_bitmap_index(&mut self, value: u8)

Which of the 8 bitmaps to show.

Bits: 8..11

pub const fn set_bitmap_index_checked(&mut self, value: u8) -> Result<(), ()>

Which of the 8 bitmaps to show.

Bits: 8..11

pub const fn palette_index(&self) -> u8

Which of the 8 palettes to use.

Bits: 11..14

pub const fn with_palette_index_checked(self, value: u8) -> Result<Self, ()>

Which of the 8 palettes to use.

Bits: 11..14

pub const fn with_palette_index(self, value: u8) -> Self

Which of the 8 palettes to use.

Bits: 11..14

pub const fn set_palette_index(&mut self, value: u8)

Which of the 8 palettes to use.

Bits: 11..14

pub const fn set_palette_index_checked(&mut self, value: u8) -> Result<(), ()>

Which of the 8 palettes to use.

Bits: 11..14

pub const fn flip_horizontally(&self) -> bool

Flips the bitmap horizontally.

Bits: 14..15

pub const fn with_flip_horizontally_checked( self, value: bool, ) -> Result<Self, ()>

Flips the bitmap horizontally.

Bits: 14..15

pub const fn with_flip_horizontally(self, value: bool) -> Self

Flips the bitmap horizontally.

Bits: 14..15

pub const fn set_flip_horizontally(&mut self, value: bool)

Flips the bitmap horizontally.

Bits: 14..15

pub const fn set_flip_horizontally_checked( &mut self, value: bool, ) -> Result<(), ()>

Flips the bitmap horizontally.

Bits: 14..15

pub const fn flip_vertically(&self) -> bool

Flips the bitmap vertically.

Bits: 15..16

pub const fn with_flip_vertically_checked(self, value: bool) -> Result<Self, ()>

Flips the bitmap vertically.

Bits: 15..16

pub const fn with_flip_vertically(self, value: bool) -> Self

Flips the bitmap vertically.

Bits: 15..16

pub const fn set_flip_vertically(&mut self, value: bool)

Flips the bitmap vertically.

Bits: 15..16

pub const fn set_flip_vertically_checked( &mut self, value: bool, ) -> Result<(), ()>

Flips the bitmap vertically.

Bits: 15..16

Trait Implementations§

impl Clone for BannerKeyframe

fn clone(&self) -> BannerKeyframe

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl Debug for BannerKeyframe

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

Formats the value using the given formatter. Read more

impl Default for BannerKeyframe

fn default() -> Self

Returns the “default value” for a type. Read more

impl From<BannerKeyframe> for u16

fn from(v: BannerKeyframe) -> u16

Converts to this type from the input type.

impl From<u16> for BannerKeyframe

fn from(v: u16) -> Self

Converts to this type from the input type.

impl Zeroable for BannerKeyframe

fn zeroed() -> Self

Calls zeroed. Read more

impl Copy for BannerKeyframe

impl Pod for BannerKeyframe

Auto Trait Implementations§

impl Freeze for BannerKeyframe

impl RefUnwindSafe for BannerKeyframe

impl Send for BannerKeyframe

impl Sync for BannerKeyframe

impl Unpin for BannerKeyframe

impl UnsafeUnpin for BannerKeyframe

impl UnwindSafe for BannerKeyframe

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> CheckedBitPattern for T
where T: AnyBitPattern,

type Bits = T

Self must have the same layout as the specified Bits except for the possible invalid bit patterns being checked during is_valid_bit_pattern.

fn is_valid_bit_pattern(_bits: &T) -> bool

If this function returns true, then it must be valid to reinterpret bits as &Self.

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> Same for T

type Output = T

Should always be Self

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

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.

impl<T> AnyBitPattern for T
where T: Pod,

impl<T> NoUninit for T
where T: Pod,