Struct gba_hal::data::BackgroundControl

#[repr(transparent)]
pub struct BackgroundControl(_);

Allows configuration of a background layer.

Bits 0-1: BG Priority (lower number is higher priority, like an index) Bits 2-3: Character Base Block (0 through 3, 16k each) Bit 6: Mosaic mode Bit 7: is 8bpp Bit 8-12: Screen Base Block (0 through 31, 2k each) Bit 13: Display area overflow wraps (otherwise transparent, affine BG only) Bit 14-15: Screen Size (details depend on Text/Affine mode)

Methods

impl BackgroundControl

pub const fn new() -> Self

A const "zero value" constructor

impl BackgroundControl

pub const BG_PRIORITY_MASK: u16

pub const fn bg_priority(self) -> u16

pub const fn with_bg_priority(self, bg_priority: u16) -> Self

pub const CHAR_BASE_BLOCK_MASK: u16

pub const fn char_base_block(self) -> u16

pub const fn with_char_base_block(self, char_base_block: u16) -> Self

pub const MOSAIC_BIT: u16

pub const fn mosaic(self) -> bool

pub const fn with_mosaic(self, bit: bool) -> Self

pub const IS_8BPP_BIT: u16

pub const fn is_8bpp(self) -> bool

pub const fn with_is_8bpp(self, bit: bool) -> Self

pub const SCREEN_BASE_BLOCK_MASK: u16

pub const fn screen_base_block(self) -> u16

pub const fn with_screen_base_block(self, screen_base_block: u16) -> Self

pub const AFFINE_DISPLAY_OVERFLOW_WRAPPING_BIT: u16

pub const fn affine_display_overflow_wrapping(self) -> bool

pub const fn with_affine_display_overflow_wrapping(self, bit: bool) -> Self

pub const SIZE_MASK: u16

pub const fn size(self) -> u16

pub const fn with_size(self, size: u16) -> Self

Trait Implementations

impl PartialEq<BackgroundControl> for BackgroundControl

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Eq for BackgroundControl

impl Debug for BackgroundControl

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

Formats the value using the given formatter.

impl Copy for BackgroundControl

impl Clone for BackgroundControl

fn clone(&self) -> BackgroundControl

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for BackgroundControl

fn default() -> BackgroundControl

Returns the "default value" for a type.