Struct BgAttr 

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

Available on crate feature cgb only.

Per-cell tilemap attributes, in VRAM bank 1 at the tilemap addresses.

Bit	Field	Access	Meaning
7	priority	R/W	Set draws this cell’s color indices 1-3 over objects.
6	y_flip	R/W	Mirror vertically.
5	x_flip	R/W	Mirror horizontally.
4	—	R/W	Ignored by the hardware.
3	bank	R/W	Fetch this cell’s tile from VRAM bank 1.
2-0	palette	R/W	Which of the eight background palettes.

Implementations

impl BgAttr

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 palette(&self) -> u8

Which of the eight background palettes.

Bits: 0..3

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

Which of the eight background palettes.

Bits: 0..3

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

Which of the eight background palettes.

Bits: 0..3

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

Which of the eight background palettes.

Bits: 0..3

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

Which of the eight background palettes.

Bits: 0..3

pub const fn bank(&self) -> bool

Fetch this cell’s tile from VRAM bank 1 rather than bank 0.

Bits: 3..4

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

Fetch this cell’s tile from VRAM bank 1 rather than bank 0.

Bits: 3..4

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

Fetch this cell’s tile from VRAM bank 1 rather than bank 0.

Bits: 3..4

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

Fetch this cell’s tile from VRAM bank 1 rather than bank 0.

Bits: 3..4

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

Fetch this cell’s tile from VRAM bank 1 rather than bank 0.

Bits: 3..4

pub const fn x_flip(&self) -> bool

Mirror horizontally.

Bits: 5..6

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

Mirror horizontally.

Bits: 5..6

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

Mirror horizontally.

Bits: 5..6

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

Mirror horizontally.

Bits: 5..6

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

Mirror horizontally.

Bits: 5..6

pub const fn y_flip(&self) -> bool

Mirror vertically.

Bits: 6..7

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

Mirror vertically.

Bits: 6..7

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

Mirror vertically.

Bits: 6..7

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

Mirror vertically.

Bits: 6..7

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

Mirror vertically.

Bits: 6..7

pub const fn priority(&self) -> bool

Draw this cell’s color indices 1-3 over objects.

Bits: 7..8

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

Draw this cell’s color indices 1-3 over objects.

Bits: 7..8

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

Draw this cell’s color indices 1-3 over objects.

Bits: 7..8

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

Draw this cell’s color indices 1-3 over objects.

Bits: 7..8

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

Draw this cell’s color indices 1-3 over objects.

Bits: 7..8

Trait Implementations

impl Clone for BgAttr

fn clone(&self) -> BgAttr

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for BgAttr

impl Debug for BgAttr

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

Formats the value using the given formatter.

impl Default for BgAttr

fn default() -> Self

Returns the “default value” for a type.

impl Eq for BgAttr

impl From<BgAttr> for u8

fn from(v: BgAttr) -> Self

Converts to this type from the input type.

impl From<u8> for BgAttr

fn from(v: u8) -> Self

Converts to this type from the input type.

impl PartialEq for BgAttr

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for BgAttr