rbgb 0.2.1

A basic and rough gameboy emulator
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35

#![cfg_attr(not(feature = "std"), no_std)]
//! Game Boy emulator core.
//!
//! This crate provides the core emulation loop and subsystems for a classic
//! Game Boy. The primary entry point is [`Emulator`], a struct that owns the
//! CPU, memory, graphics, and input devices and drives them per frame.
//!
//! High-level flow:
//! - Create an [`Emulator`] (starts paused).
//! - Load a ROM with [`Emulator::load_rom`], which resets memory and CPU state.
//! - Call [`Emulator::update`] once per frame to advance CPU, timers, and video.
//! - Provide input through [`Emulator::game_input`], and read pixels from
//!   [`Emulator::get_display_buffer`].
//!
//! The emulation state is shared across CPU, graphics, and joypad through a
//! single memory model owned by the emulator core.
//!
//! # Example
//! ```no_run
//! use rbgb::Emulator;
//!
//! fn main() -> Result<(), String> {
//!     let mut emu = Emulator::new();
//!     emu.load_rom("path/to/game.gb")?;
//!     loop {
//!         emu.update();
//!         let _pixels = emu.get_display_buffer();
//!         // Render pixels and handle input here.
//!     }
//! }
//! ```
pub mod emulator;
mod types;

pub use emulator::*;