Struct rust_chip8_opengl::processor::Processor

pub struct Processor { /* private fields */ }

The actual CHIP-8 processor. Decodes and runs any opcodes, stores memory, stores screen. Needs to be paired with an interface to allow the user to actually interact with the program.

Implementations

impl Processor

pub fn new() -> Processor

pub fn load_program(&mut self, program: &[u8])

Load a program into memory

pub fn load_program_u16(&mut self, program: &[u16])

Load a program as u16s instead of u8s. Mostly just a convenience function.

pub fn step(&mut self)

Perform the next step in whatever program has been loaded into memory. Equivalent to just calling execute and incrementing PC by 2

pub fn on_tick(&mut self)

Function that decrements both timer registers. Should be called at a rate of 60Hz.

pub fn update_inputs(&mut self, inputs: [bool; 16])

Update the current input states to the inputs given.

pub fn execute(&mut self, inst: u16)

Executes a single given instruction. Does not increment PC or affect DT or ST.

pub fn dump_state(&self)

Print the state of the machine (all registers, stack, PC, etc) in the console.

pub fn get_register_value(&self, register: u8) -> u8

Get the value of an R register

pub fn get_program_counter(&self) -> usize

Get the value of the program counter

pub fn get_i(&self) -> u16

Get the value of the I register

pub fn get_mem_at(&self, addr: usize) -> u8

Get a single byte of memory at the address given

pub fn get_pixel_at(&self, x: u8, y: u8) -> bool

Get a pixel at the given x, y position on the screen. Accounts for screen wrapping.

pub fn get_input_state(&self, i: usize) -> bool

Return whether the processor has the i key currently being pressed. This should be set by calls to update_inputs.

pub fn get_dt(&self) -> u8

Get the D timer register.

pub fn get_st(&self) -> u8

Get the S (sound) time register.

pub fn on_key_release(&mut self, kp: u8)

Method that should be called by an interface whenever a key (0-F) is released.