Struct Emulator

pub struct Emulator { /* private fields */ }

Implementations

impl Emulator

pub fn create(core_path: &Path, rom_path: &Path) -> Emulator

Panics

If the platform is not Windows, Mac, or Linux; if the dylib fails to load successfully; if any Emulator has been created on this thread but not yet dropped.

pub fn get_library(&mut self) -> &Library

pub fn get_symbol<'a, T>(&'a self, symbol: &[u8]) -> Option<Symbol<'a, T>>

pub fn run(&mut self, inputs: [Buttons; 2])

pub fn reset(&mut self)

pub fn get_video_ram_size(&self) -> usize

pub fn get_system_ram_size(&self) -> usize

pub fn get_save_ram_size(&self) -> usize

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

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

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

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

pub fn memory_regions(&self) -> Vec<MemoryRegion>

pub fn memory_ref(&self, start: usize) -> Result<&[u8], RetroRsError>

Errors

RetroRsError::RAMCopyNotMappedIntoMemoryRegionError: Returns an error if the desired address is not mapped into memory regions

pub fn memory_ref_mut( &self, mr: &MemoryRegion, start: usize, ) -> Result<&mut [u8], RetroRsError>

Errors

RetroRsError::RAMMapOutOfRangeError: The desired address is out of mapped range RetroRsError::RAMCopySrcOutOfBoundsError: The desired range is not in the requested region

pub fn pixel_format(&self) -> retro_pixel_format

pub fn framebuffer_size(&self) -> (usize, usize)

pub fn framebuffer_pitch(&self) -> usize

pub fn peek_audio_sample<AudioPeek, AudioPeekRet>( &self, f: AudioPeek, ) -> AudioPeekRet

where AudioPeek: FnOnce(&[i16]) -> AudioPeekRet,

pub fn get_audio_sample_rate(&self) -> f64

pub fn get_video_fps(&self) -> f64

pub fn save(&self, bytes: &mut [u8]) -> bool

pub fn load(&mut self, bytes: &[u8]) -> bool

pub fn save_size(&self) -> usize

pub fn clear_cheats(&mut self)

pub fn set_cheat(&mut self, index: usize, enabled: bool, code: &str)

Panics

May panic if code can’t be converted to a CString

pub fn get_pixel( &self, x: usize, y: usize, ) -> Result<(u8, u8, u8), RetroRsError>

Panics

Panics if the pixel format used by the core is not supported for reads.

Errors

RetroRsError::NoFramebufferError: Emulator has not created a framebuffer.

pub fn for_each_pixel( &self, f: impl FnMut(usize, usize, u8, u8, u8), ) -> Result<(), RetroRsError>

Panics

Panics if the pixel format used by the core is not supported for reads.

Errors

RetroRsError::NoFramebufferError: Emulator has not created a framebuffer.

pub fn copy_framebuffer_rgb888( &self, slice: &mut [u8], ) -> Result<(), RetroRsError>

Panics

Panics if the pixel format used by the core is not supported for reads.

Errors

RetroRsError::NoFramebufferError: Emulator has not created a framebuffer.

pub fn copy_framebuffer_rgba8888( &self, slice: &mut [u8], ) -> Result<(), RetroRsError>

Panics

Panics if the pixel format used by the core is not supported for reads.

Errors

RetroRsError::NoFramebufferError: Emulator has not created a framebuffer.

pub fn copy_framebuffer_rgb332( &self, slice: &mut [u8], ) -> Result<(), RetroRsError>

Panics

Panics if the pixel format used by the core is not supported for reads.

Errors

RetroRsError::NoFramebufferError: Emulator has not created a framebuffer.

pub fn copy_framebuffer_argb32( &self, slice: &mut [u32], ) -> Result<(), RetroRsError>

Panics

Panics if the pixel format used by the core is not supported for reads.

Errors

RetroRsError::NoFramebufferError: Emulator has not created a framebuffer.

pub fn copy_framebuffer_rgba32( &self, slice: &mut [u32], ) -> Result<(), RetroRsError>

Panics

Panics if the pixel format used by the core is not supported for reads.

Errors

RetroRsError::NoFramebufferError: Emulator has not created a framebuffer.

pub fn copy_framebuffer_rgba_f32x4( &self, slice: &mut [f32], ) -> Result<(), RetroRsError>

Panics

Panics if the pixel format used by the core is not supported for reads.

Errors

RetroRsError::NoFramebufferError: Emulator has not created a framebuffer.

Trait Implementations

impl Drop for Emulator

fn drop(&mut self)

Executes the destructor for this type.

impl FramebufferToImageBuffer for Emulator

fn create_imagebuffer( &self, ) -> Result<ImageBuffer<Rgb<u8>, Vec<u8>>, RetroRsError>

Errors