Struct tetanes::nes::Nes

pub struct Nes { /* private fields */ }

Represents all the NES Emulation state.

Implementations

impl Nes

pub fn handle_mouse_click(&mut self, s: &mut PixState, btn: Mouse) -> bool

pub fn set_zapper_pos(&mut self, pos: Point<i32>)

pub fn handle_mouse_motion(&mut self, pos: Point<i32>) -> bool

impl Nes

pub fn run(&mut self) -> NesResult<()>

Begins emulation by starting the game engine loop.

Errors

If engine fails to build or run, then an error is returned.

Trait Implementations

impl Debug for Nes

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

Formats the value using the given formatter.

impl PixEngine for Nes

fn on_start(&mut self, s: &mut PixState) -> PixResult<()>

Called once upon engine start when Engine::run is called.

fn on_update(&mut self, s: &mut PixState) -> PixResult<()>

Called after PixEngine::on_start, every frame based on the target frame rate.

fn on_stop(&mut self, s: &mut PixState) -> PixResult<()>

Called when the engine detects a close/exit event such as calling PixState::quit or if an error is returned during program execution by any PixEngine methods.

fn on_key_pressed( &mut self, s: &mut PixState, event: KeyEvent ) -> PixResult<bool>

Called each time a Key is pressed with the KeyEvent indicating which key and modifiers are pressed as well as whether this is a repeat event where the key is being held down.

fn on_key_released( &mut self, s: &mut PixState, event: KeyEvent ) -> PixResult<bool>

Called each time a Key is pressed with the KeyEvent indicating which key and modifiers are released.

fn on_mouse_pressed( &mut self, s: &mut PixState, btn: Mouse, _pos: Point<i32> ) -> PixResult<bool>

Called each time a Mouse button is pressed.

fn on_mouse_motion( &mut self, _s: &mut PixState, pos: Point<i32>, _rel_pos: Point<i32> ) -> PixResult<bool>

Called each time the Mouse is moved with the (x, y) screen coordinates and relative (xrel, yrel) positions since last frame.

fn on_controller_update( &mut self, _s: &mut PixState, controller_id: ControllerId, update: ControllerUpdate ) -> PixResult<bool>

Called each time a Controller is added, removed, or remapped.

fn on_controller_pressed( &mut self, s: &mut PixState, event: ControllerEvent ) -> PixResult<bool>

Called each time a ControllerButton is pressed with the ControllerEvent indicating which button is pressed.

fn on_controller_released( &mut self, s: &mut PixState, event: ControllerEvent ) -> PixResult<bool>

Called each time a ControllerButton is pressed with the ControllerEvent indicating which key and modifiers are released.

fn on_controller_axis_motion( &mut self, s: &mut PixState, controller_id: ControllerId, axis: Axis, value: i32 ) -> PixResult<bool>

Called each time a Controller Axis is moved with the delta since last frame.

fn on_window_event( &mut self, s: &mut PixState, window_id: WindowId, event: WindowEvent ) -> PixResult<()>

Called each time a window event occurs.

fn on_key_typed(&mut self, s: &mut PixState, text: &str) -> Result<bool, Error>

Called each time text input is received.

fn on_mouse_dragged( &mut self, s: &mut PixState, pos: Point, rel_pos: Point ) -> Result<bool, Error>

Called each time the Mouse is moved while any mouse button is being held.

fn on_mouse_released( &mut self, s: &mut PixState, btn: Mouse, pos: Point ) -> Result<bool, Error>

Called each time a Mouse button is released.

fn on_mouse_clicked( &mut self, s: &mut PixState, btn: Mouse, pos: Point ) -> Result<bool, Error>

Called each time a Mouse button is clicked (a press followed by a release).

fn on_mouse_dbl_clicked( &mut self, s: &mut PixState, btn: Mouse, pos: Point ) -> Result<bool, Error>

Called each time a Mouse button is clicked twice within 500ms.

fn on_mouse_wheel( &mut self, s: &mut PixState, pos: Point ) -> Result<bool, Error>

Called each time the Mouse wheel is scrolled with the (x, y) delta since last frame.

fn on_event(&mut self, s: &mut PixState, event: &Event) -> Result<bool, Error>

Called for any system or user event. This is a catch-all for handling any events not covered by other PixEngine methods.