Skip to main content

Palette

gb::mmio

Struct Palette 

Source 
pub struct Palette(/* private fields */);
Expand description

A DMG palette (BGP / OBP0 / OBP1): one shade per color index. Object palettes ignore color index 0 (transparent).

BitFieldAccessMeaning
7-6id3R/WShade for color index 3.
5-4id2R/WShade for color index 2.
3-2id1R/WShade for color index 1.
1-0id0R/WShade for color index 0.

Implementations§

Source§

impl Palette

Source

pub const fn new() -> Self

Creates a new default initialized bitfield.

Source

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

Convert from bits.

Source

pub const fn into_bits(self) -> u8

Convert into bits.

Source

pub const fn id0(&self) -> Shade

Shade for color index 0.

Bits: 0..2

Source

pub const fn with_id0_checked(self, value: Shade) -> Result<Self, ()>

Shade for color index 0.

Bits: 0..2

Source

pub const fn with_id0(self, value: Shade) -> Self

Shade for color index 0.

Bits: 0..2

Source

pub const fn set_id0(&mut self, value: Shade)

Shade for color index 0.

Bits: 0..2

Source

pub const fn set_id0_checked(&mut self, value: Shade) -> Result<(), ()>

Shade for color index 0.

Bits: 0..2

Source

pub const fn id1(&self) -> Shade

Shade for color index 1.

Bits: 2..4

Source

pub const fn with_id1_checked(self, value: Shade) -> Result<Self, ()>

Shade for color index 1.

Bits: 2..4

Source

pub const fn with_id1(self, value: Shade) -> Self

Shade for color index 1.

Bits: 2..4

Source

pub const fn set_id1(&mut self, value: Shade)

Shade for color index 1.

Bits: 2..4

Source

pub const fn set_id1_checked(&mut self, value: Shade) -> Result<(), ()>

Shade for color index 1.

Bits: 2..4

Source

pub const fn id2(&self) -> Shade

Shade for color index 2.

Bits: 4..6

Source

pub const fn with_id2_checked(self, value: Shade) -> Result<Self, ()>

Shade for color index 2.

Bits: 4..6

Source

pub const fn with_id2(self, value: Shade) -> Self

Shade for color index 2.

Bits: 4..6

Source

pub const fn set_id2(&mut self, value: Shade)

Shade for color index 2.

Bits: 4..6

Source

pub const fn set_id2_checked(&mut self, value: Shade) -> Result<(), ()>

Shade for color index 2.

Bits: 4..6

Source

pub const fn id3(&self) -> Shade

Shade for color index 3.

Bits: 6..8

Source

pub const fn with_id3_checked(self, value: Shade) -> Result<Self, ()>

Shade for color index 3.

Bits: 6..8

Source

pub const fn with_id3(self, value: Shade) -> Self

Shade for color index 3.

Bits: 6..8

Source

pub const fn set_id3(&mut self, value: Shade)

Shade for color index 3.

Bits: 6..8

Source

pub const fn set_id3_checked(&mut self, value: Shade) -> Result<(), ()>

Shade for color index 3.

Bits: 6..8

Trait Implementations§

Source§

impl Clone for Palette

Source§

fn clone(&self) -> Palette

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for Palette

Source§

impl Debug for Palette

Source§

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

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

impl Default for Palette

Source§

fn default() -> Self

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

impl Eq for Palette

Source§

impl From<Palette> for u8

Source§

fn from(v: Palette) -> Self

Converts to this type from the input type.
Source§

impl From<u8> for Palette

Source§

fn from(v: u8) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for Palette

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Palette

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CellValue for T
where T: Copy + BankSafe,

Source§

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

Source§

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
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

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

Source§

type Error = Infallible

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

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

Performs the conversion.
Source§

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

Source§

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

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

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

Performs the conversion.