Struct OamAttr 

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

Sprite attribute byte (OamEntry::attr).

Bit	Field	Access	Meaning
7	priority	R/W	Set draws the sprite behind BG colors 1-3.
6	y_flip	R/W	Mirror vertically.
5	x_flip	R/W	Mirror horizontally.
4	dmg_palette	R/W	DMG palette: clear = OBP0, set = OBP1.
3	cgb_bank	R/W	CGB tile VRAM bank.
2-0	cgb_palette	R/W	CGB object palette (0-7).

Implementations

impl OamAttr

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

CGB object palette (0-7).

Bits: 0..3

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

CGB object palette (0-7).

Bits: 0..3

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

CGB object palette (0-7).

Bits: 0..3

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

CGB object palette (0-7).

Bits: 0..3

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

CGB object palette (0-7).

Bits: 0..3

pub const fn cgb_bank(&self) -> bool

CGB tile VRAM bank.

Bits: 3..4

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

CGB tile VRAM bank.

Bits: 3..4

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

CGB tile VRAM bank.

Bits: 3..4

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

CGB tile VRAM bank.

Bits: 3..4

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

CGB tile VRAM bank.

Bits: 3..4

pub const fn dmg_palette(&self) -> bool

DMG palette: false = OBP0, true = OBP1.

Bits: 4..5

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

DMG palette: false = OBP0, true = OBP1.

Bits: 4..5

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

DMG palette: false = OBP0, true = OBP1.

Bits: 4..5

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

DMG palette: false = OBP0, true = OBP1.

Bits: 4..5

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

DMG palette: false = OBP0, true = OBP1.

Bits: 4..5

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

Priority: true draws the sprite behind BG colors 1-3.

Bits: 7..8

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

Priority: true draws the sprite behind BG colors 1-3.

Bits: 7..8

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

Priority: true draws the sprite behind BG colors 1-3.

Bits: 7..8

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

Priority: true draws the sprite behind BG colors 1-3.

Bits: 7..8

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

Priority: true draws the sprite behind BG colors 1-3.

Bits: 7..8

Trait Implementations

impl Clone for OamAttr

fn clone(&self) -> OamAttr

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for OamAttr

impl Debug for OamAttr

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

Formats the value using the given formatter.

impl Default for OamAttr

fn default() -> Self

Returns the “default value” for a type.

impl Eq for OamAttr

impl From<OamAttr> for u8

fn from(v: OamAttr) -> Self

Converts to this type from the input type.

impl From<u8> for OamAttr

fn from(v: u8) -> Self

Converts to this type from the input type.

impl PartialEq for OamAttr

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for OamAttr