Struct PaletteIndex 

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

Available on crate feature cgb only.

Color palette index (BCPS / OCPS).

Bit	Field	Access	Meaning
7	auto_increment	R/W	Auto-increment the address after each data-port write.
6	—		Unused.
5-0	address	R/W	Byte offset into palette memory reached through the data port.

Implementations

impl PaletteIndex

pub const fn new() -> Self

Creates a new default initialized bitfield.

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

Convert from bits.

pub const fn into_bits(self) -> u8

Convert into bits.

pub const fn address(&self) -> u8

Byte offset into palette memory reached through the data port.

Bits: 0..6

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

Byte offset into palette memory reached through the data port.

Bits: 0..6

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

Byte offset into palette memory reached through the data port.

Bits: 0..6

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

Byte offset into palette memory reached through the data port.

Bits: 0..6

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

Byte offset into palette memory reached through the data port.

Bits: 0..6

pub const fn auto_increment(&self) -> bool

Auto-increment the address after each write to the data port.

Bits: 7..8

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

Auto-increment the address after each write to the data port.

Bits: 7..8

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

Auto-increment the address after each write to the data port.

Bits: 7..8

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

Auto-increment the address after each write to the data port.

Bits: 7..8

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

Auto-increment the address after each write to the data port.

Bits: 7..8

Trait Implementations

impl Clone for PaletteIndex

fn clone(&self) -> PaletteIndex

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for PaletteIndex

impl Debug for PaletteIndex

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

Formats the value using the given formatter.

impl Default for PaletteIndex

fn default() -> Self

Returns the “default value” for a type.

impl Eq for PaletteIndex

impl From<PaletteIndex> for u8

fn from(v: PaletteIndex) -> Self

Converts to this type from the input type.

impl From<u8> for PaletteIndex

fn from(v: u8) -> Self

Converts to this type from the input type.

impl PartialEq for PaletteIndex

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for PaletteIndex