Struct Gba

#[non_exhaustive]
pub struct Gba {
    pub graphics: GraphicsDist,
    pub mixer: MixerController,
    pub save: SaveManager,
    pub timers: TimerController,
}

Controls access to the Game Boy Advance’s hardware.

This struct exists to make it the borrow checker’s responsibility to ensure no clashes of global resources. It will be created for you via the #[agb::entry] attribute.

Examples

#![no_std]
#![no_main]

use agb::Gba;

#[agb::entry]
fn main(mut gba: Gba) -> ! {
    // Do whatever you need to do with gba

    loop {
        agb::halt();
    }
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

graphics: GraphicsDist

Manages access to the Game Boy Advance’s display hardware

mixer: MixerController

Manages access to the Game Boy Advance’s direct sound mixer for playing raw wav files.

save: SaveManager

Manages access to the Game Boy Advance cartridge’s save chip.

timers: TimerController

Manages access to the Game Boy Advance’s 4 timers.