Crate rust_libretro

Re-exports

pub use const_str;

pub use rust_libretro_proc as proc;

pub use rust_libretro_sys as sys;

Modules

contexts

This module contains abstractions of the libretro environment callbacks.

core

Provides the Core and CoreOptions traits.

core_wrapper 🔒

The CoreWrapper is an internal data structure.

environment

Unsafe functions related to the libretro environment callback. For safe versions have a look at the contexts module and the context types you get in your core callbacks.

logger 🔒

log::Log implementation using the libretro logging interface.

macros 🔒

types

Rust versions of libretro data structures.

util

Utility functions

Macros

c_char_ptr

c_str

env_version

input_descriptor

input_descriptors

retro_core

This macro must be used to initialize your Core.

Functions

retro_add_image_index_callback^⚠

TODO: Documentation

retro_api_version^⚠

Tells the frontend which API version this Core implements.

retro_audio_buffer_status_callback_fn^⚠

TODO: Documentation

retro_audio_callback_fn^⚠

Notifies the Core when audio data should be written.

retro_audio_set_state_callback_fn^⚠

Notifies the Core about the state of the frontend’s audio system.

retro_camera_deinitialized_callback^⚠

TODO: Documentation

retro_camera_frame_opengl_texture_callback^⚠

TODO: Documentation

retro_camera_frame_raw_framebuffer_callback^⚠

TODO: Documentation

retro_camera_initialized_callback^⚠

TODO: Documentation

retro_cheat_reset^⚠

Notifies the Core when all cheats should be unapplied.

retro_cheat_set^⚠

Called by the frontend whenever a cheat should be applied.

retro_core_options_update_display_callback_fn^⚠

TODO: Documentation

retro_deinit^⚠

Notifies the Core when it is being closed and its resources should be freed.

retro_frame_time_callback_fn^⚠

TODO: Documentation

retro_get_eject_state_callback^⚠

TODO: Documentation

retro_get_image_index_callback^⚠

TODO: Documentation

retro_get_image_label_callback^⚠

TODO: Documentation

retro_get_image_path_callback^⚠

TODO: Documentation

retro_get_memory_data^⚠

Returns a mutable pointer to queried memory type. Return std::ptr::null() in case this doesn’t apply to your Core.

retro_get_memory_size^⚠

Returns the size (in bytes) of the queried memory type. Return 0 in case this doesn’t apply to your Core.

retro_get_num_images_callback^⚠

TODO: Documentation

retro_get_proc_address_callback^⚠

TODO: Documentation

retro_get_region^⚠

Called when the frontend needs region information from the Core.

retro_get_system_av_info^⚠

Provides audio/video timings and geometry info to the frontend.

retro_get_system_info^⚠

Provides statically known system info to the frontend.

retro_hw_context_destroyed_callback^⚠

TODO: Documentation.

retro_hw_context_reset_callback^⚠

TODO: Documentation.

retro_init^⚠

Initializes the Core.

retro_keyboard_callback_fn^⚠

If enabled by the Core, notifies it when a keyboard button has been pressed or released.

retro_load_game^⚠

Called by the frontend when a game should be loaded.

retro_load_game_special^⚠

See rust_libretro_sys::retro_load_game_special.

retro_location_lifetime_status_deinitialized_callback^⚠

TODO: Documentation

retro_location_lifetime_status_initialized_callback^⚠

TODO: Documentation

retro_replace_image_index_callback^⚠

TODO: Documentation

retro_reset^⚠

Notifies the Core when the current game should be reset.

retro_run^⚠

Runs the game for one frame.

retro_serialize^⚠

Called by the frontend when the Cores state should be serialized (“save state”). This function should return false on error.

retro_serialize_size^⚠

Called when the frontend needs to know how large a buffer to allocate for save states.

retro_set_audio_sample^⚠

Provides the audio sample callback to the Core.

retro_set_audio_sample_batch^⚠

Provides the batched audio sample callback to the Core.

retro_set_controller_port_device^⚠

Sets the device type to be used for player port.

retro_set_eject_state_callback^⚠

TODO: Documentation

retro_set_environment^⚠

Provides the environment callback to the Core.

retro_set_image_index_callback^⚠

TODO: Documentation

retro_set_initial_image_callback^⚠

TODO: Documentation

retro_set_input_poll^⚠

Provides the input polling callback to the Core.

retro_set_input_state^⚠

Provides the input state request callback to the Core.

retro_set_video_refresh^⚠

Provides the frame drawing callback to the Core.

retro_unload_game^⚠

Notifies the Core when the currently loaded game should be unloaded. Called before retro_deinit.

retro_unserialize^⚠

Called by the frontend when a “save state” should be loaded. This function should return false on error.