Struct Nes 

pub struct Nes { /* private fields */ }

Representation of the NES system

Implementations

impl Nes

pub fn new() -> Self

Instantiate a NES emulator instance

let nes = Nes::new();

pub fn entry(self, entry_addr: u16) -> Self

Directly set the CPU entry point

let nes = Nes::default().entry(0xC000);

pub fn with_cart(self, cart: Cartridge) -> Self

Builder function to allow inserting the cartridge

pub fn debug_mode(self, debug: bool) -> Self

Builder function to set debug mode

let nes = Nes::default().debug_mode(true);

pub fn emulate_frame(&mut self) -> ([u8; 184320], Vec<Sample>)

Run the emulator for a single frame

let mut nes = Nes::from(cart);
let (videobuffer, audiobuffer) = nes.emulate_frame();

• videobuffer - A RGB8 frame buffer
• audiobuffer - Raw APU output (This must be down sampled to host playback rate)

pub fn run_audio(&mut self, buffer_size: usize) -> Vec<f32>

Run the NES emulator until it fills an audio buffer to the specified size

let samplebuffer = nes.run_audio(4096);

pub fn input(&mut self, btn: Button, pressed: bool)

Apply a button input into the emulator

nes.input(Button::A, true);

pub fn controller_input( &mut self, controller: Controller, btn: Button, pressed: bool, )

Apply a button input to the emulator from the specified controller

// Send an `A` button press to input 1
nes.controller_input(Controller::Input1, Button::A, true);
// Send an `A` button press to input 2
nes.controller_input(Controller::Input2, Button::A, true);

pub fn run_until(&mut self, addr: u16)

Run until the CPU’s PC is at address addr

pub fn is_holding(&self) -> bool

Check if the CPU is in an infinite loop state

pub fn insert(&mut self, cart: Cartridge)

Load a cartridge

pub fn eject(self) -> Vec<u8>

Eject the cartridge, returning the save state

let nes = Nes::default();
// This consumes the nes instance
let battery_ram = nes.eject();

pub fn get_program_counter(&self) -> u16

Get the CPU’s program counter

pub fn read_cpu_ram(&self, addr: u16) -> u8

Read the byte, at the specified address, from CPU’s internal RAM

pub fn read_ppu_memory(&self, addr: u16) -> u8

Read directly from VRAM

pub fn read_tile(&self, nametable: u16, x: usize, y: usize) -> u8

Read a tile from the current nametable

Trait Implementations

impl Default for Nes

fn default() -> Nes

Returns the “default value” for a type.

impl From<Cartridge> for Nes

fn from(cart: Cartridge) -> Self

Converts to this type from the input type.