Module olympia_engine::gameboy

Emulation core for a Gameboy.

This crate implements all instructions and their effects on the gameboy, and provides methods to query the internal state of the gameboy for the frontend.

To instantiate a new gameboy, first decide what cartridge is inserted in the gameboy, and which model of gameboy is being emulated. Then you can use GameBoy::new(cartridge, model) to instantiate an emulated gameboy.

Note that at this early stage, the emulator focuses primarily on DMG emulation, and does not support CGB or SGB exclusive features. As such, these systems currently only run in the DMG-compatible mode.

Structs

GBPixel
GameBoy	Primary struct for an emulated gameboy.

Enums

GameBoyModel	Represents a hardware type running a gameboy game.
MemoryError	Represents a failure to read from memory.
Palette
StepError	Represents an error that occurred while performing an emulated instruction.

Constants

CYCLE_FREQ

Type Definitions

MemoryResult
StepResult