Struct GameBoy

pub struct GameBoy { /* private fields */ }

The GameBoy is the main interface to the emulator.

Everything regarding emulation can be controlled from here.

Implementations

impl GameBoy

pub fn builder<RomP: AsRef<Path>>(rom_file: RomP) -> GameBoyBuilder

Initiate a builder object with a cartridge file.

pub fn clock_for_frame(&mut self)

Clocks the Gameboy clock for the duration of one PPU frame.

This is good for timing emulation, you can call this function once and then render it.

pub fn game_title(&self) -> &str

Return the game title string extracted from the cartridge.

pub fn file_path(&self) -> &Path

The cartridge file path.

pub fn screen_buffer(&self) -> &[u8]

Return the pixels buffer of the PPU at the current state.

The format of the pixel buffer is RGB, i.e. 3 bytes per pixel.

pub fn audio_buffers(&mut self) -> AudioBuffers<'_>

Return the audio buffer of the APU at the current state.

We use &mut as it will also reset the buffers after using them

pub fn press_joypad(&mut self, button: JoypadButton)

Change the state of the joypad button to pressed.

pub fn release_joypad(&mut self, button: JoypadButton)

Change the state of the joypad button to released.

pub fn connect_device(&mut self, device: Rc<RefCell<dyn SerialDevice>>)

Connect a serial device to the Gameboy.

Currently the gameboy can only be master, so the other device must be implemented as slave.

pub fn disconnect_device(&mut self)

Disconnects the serial device if any is connected, else, nothing is done

pub fn save_state<W: Write>(&self, writer: W) -> Result<(), SaveError>

Saves the whole current state of the emulator.

pub fn load_state<R: Read + Seek>(&mut self, reader: R) -> Result<(), SaveError>

Loads the whole state of the emulator, if an error happened in the middle the emulator will keep functioning like normal, as it stores a backup recovery state before loading the new state.