Struct Chip8 

pub struct Chip8 {
    pub keypad: [u8; 16],
    pub video: [u32; 2048],
    /* private fields */
}

General chip 8 struct

Fields

keypad: [u8; 16]

video: [u32; 2048]

Implementations

impl Chip8

pub fn new() -> Self

Create a new chip8 instance with an empty rom, ready for use

Example:

let mut chip8: Chip8 = Chip8::new();

chip.load_rom(path);

let rom: PathBuf = '...';
let speed: u64 = 30;

loop {

    chip8.Cycle();
    chip8.pretty_print_video(rom);
    thread::sleep(time::Duration::from_millis(speed);
}

Values

• registers: all zeroes
• memory/rom: all zeroes
• index_register: 0
• program_counter: 0x200
• stack: all zeroes
• stack_poionter: 0
• delay_timer: 0
• sound_timer: 0
• keypad: all zeroes
• video: all zeroes
• op_code: 0
• fontset_size: 80

pub fn last_opcode(&self) -> u16

pub fn play(&mut self, speed: u64)

Runs the CHIP8 Machine forever with the currently loaded ROM. The clock speed is determined by the passed in speed parameter.

loop {
    self.Cycle();
    self.pretty_print_video();
    thread::sleep(cycle_wait_time);
}

pub fn add_table(&mut self)

Adds the correct function pointer tables to the newly created Chip8 object

pub fn debug(&mut self)

Toggle debug mode for current chip8 instance

pub fn reset_hard(&mut self)

pub fn reset_and_load_bytes(&mut self, rom: &[u8]) -> Result<(), Chip8Error>

pub fn load_rom(&mut self, path: PathBuf) -> Result<(), Error>

Loads a given rom into memory, starting from memory address 0x200

pub fn load_rom_bytes(&mut self, rom: &[u8])

pub fn dump_rom(&self, start_address: usize, byte_number: usize) -> Vec<u8>

Returns byte_number amount of bytes after the pointer in rom

pub fn export_video(&mut self) -> &[u32; 2048]

pub fn pretty_print_video(&mut self)

pub fn key_down(&mut self, k: u8)

pub fn key_up(&mut self, k: u8)

pub fn is_key_down(&self, k: u8) -> bool

pub fn take_recent_press(&mut self) -> Option<u8>

Use this in FX0A (wait for key): returns one press if available.

pub fn OP_00E0(&mut self)

OPCODE 00E0 - Clear Screen

pub fn Cycle(&mut self)