Struct tetanes::control_deck::ControlDeck

pub struct ControlDeck { /* private fields */ }

Represents an NES Control Deck

Implementations

impl ControlDeck

pub fn new(ram_state: RamState) -> Self

Create a NES ControlDeck.

pub fn load_rom<S: ToString, F: Read>( &mut self, name: S, rom: &mut F ) -> NesResult<()>

Loads a ROM cartridge into memory

Errors

If there is any issue loading the ROM, then an error is returned.

pub fn load_cpu(&mut self, cpu: Cpu)

pub const fn loaded_rom(&self) -> &Option<String>

pub const fn cart_battery_backed(&self) -> bool

pub fn sram(&self) -> &[u8]

pub fn load_sram(&mut self, sram: Vec<u8>)

pub fn wram(&self) -> &[u8]

pub fn frame_buffer(&mut self) -> &[u8]

Get a frame worth of pixels.

pub const fn frame_number(&self) -> u32

Get the current frame number.

pub const fn sample_rate(&self) -> f32

Audio sample rate.

pub fn audio_samples(&self) -> &[f32]

Get audio samples.

pub fn clear_audio_samples(&mut self)

Clear audio samples.

pub fn clock_rate(&mut self) -> f32

pub fn clock_instr(&mut self) -> NesResult<ControlFlow<usize, usize>>

Steps the control deck one CPU clock.

Errors

If CPU encounteres an invalid opcode, an error is returned.

pub fn clock_seconds( &mut self, seconds: f32 ) -> NesResult<ControlFlow<usize, usize>>

Steps the control deck the number of seconds.

Errors

If CPU encounteres an invalid opcode, an error is returned.

pub fn clock_seconds_inspect<F>( &mut self, seconds: f32, inspect: F ) -> NesResult<ControlFlow<usize, usize>>

where F: FnMut(&mut Cpu),

Steps the control deck the number of seconds with an inspection function, executed on every CPU clock.

Errors

This function will return an error if .

pub fn clock_frame(&mut self) -> NesResult<ControlFlow<usize, usize>>

Steps the control deck an entire frame

Errors

If CPU encounteres an invalid opcode, an error is returned.

pub fn clock_scanline(&mut self) -> NesResult<ControlFlow<usize, usize>>

Steps the control deck a single scanline.

Errors

If CPU encounteres an invalid opcode, an error is returned.

pub const fn cpu_corrupted(&self) -> bool

Returns whether the CPU is corrupted or not.

pub const fn cpu(&self) -> &Cpu

pub fn cpu_mut(&mut self) -> &mut Cpu

pub const fn ppu(&self) -> &Ppu

pub fn ppu_mut(&mut self) -> &mut Ppu

pub const fn apu(&self) -> &Apu

pub const fn mapper(&self) -> &Mapper

pub fn mapper_mut(&mut self) -> &mut Mapper

pub const fn four_player(&self) -> FourPlayer

Returns whether Four Score is enabled.

pub fn set_four_player(&mut self, four_player: FourPlayer)

Enable/Disable Four Score for 4-player controllers.

pub fn set_cycle_accurate(&mut self, enabled: bool)

Enable/Disable cycle accurate mode

pub fn joypad_mut(&mut self, slot: Slot) -> &mut Joypad

Returns a mutable reference to a joypad.

pub const fn zapper_pos(&self) -> (i32, i32)

Returns the zapper aiming position for the given controller slot.

pub fn trigger_zapper(&mut self)

Trigger Zapper gun for a given controller slot.

pub fn aim_zapper(&mut self, x: i32, y: i32)

Aim Zapper gun for a given controller slot.

pub fn set_filter(&mut self, filter: VideoFilter)

Set the image filter for video output.

pub fn connect_zapper(&mut self, enabled: bool)

Enable Zapper gun.

pub fn add_genie_code(&mut self, genie_code: String) -> NesResult<()>

Add NES Game Genie codes.

Errors

If genie code is invalid, an error is returned.

pub fn remove_genie_code(&mut self, genie_code: &str)

pub const fn channel_enabled(&self, channel: Channel) -> bool

Returns whether a given API audio channel is enabled.

pub fn toggle_channel(&mut self, channel: Channel)

Toggle one of the APU audio channels.

pub const fn is_running(&self) -> bool

Is control deck running.

Trait Implementations

impl Clock for ControlDeck

fn clock(&mut self) -> usize

Steps the control deck a single clock cycle.

fn clock_to(&mut self, _clocks: u64)

impl Clone for ControlDeck

fn clone(&self) -> ControlDeck

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ControlDeck

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ControlDeck

fn default() -> Self

Returns the “default value” for a type.

impl Regional for ControlDeck

fn region(&self) -> NesRegion

Get the NES format for the emulation.

fn set_region(&mut self, region: NesRegion)

Set the NES format for the emulation.

impl Reset for ControlDeck

fn reset(&mut self, kind: Kind)

Resets the console.