libretro/RetroArch
1
0
Fork 0
mirror of https://github.com/libretro/RetroArch.git synced 2024-11-30 19:50:24 +00:00
Code Issues Actions 23 Packages Projects Releases Wiki Activity
fe1ac4b8b9
RetroArch/retroarch.h

355 lines
10 KiB
C
Raw Blame History

/* RetroArch - A frontend for libretro.
* Copyright (C) 2010-2014 - Hans-Kristian Arntzen
* Copyright (C) 2011-2015 - Daniel De Matteis
*
* RetroArch is free software: you can redistribute it and/or modify it under the terms
* of the GNU General Public License as published by the Free Software Found-
* ation, either version 3 of the License, or (at your option) any later version.
*
* RetroArch is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
* without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
* PURPOSE. See the GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along with RetroArch.
* If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef __RETROARCH_H
#define __RETROARCH_H
#include <boolean.h>
#ifdef __cplusplus
extern "C" {
#endif
enum basic_event
{
RARCH_CMD_NONE = 0,
/* Resets RetroArch. */
RARCH_CMD_RESET,
/* Loads content file. */
RARCH_CMD_LOAD_CONTENT,
RARCH_CMD_LOAD_CONTENT_PERSIST,
/* Loads core. */
RARCH_CMD_LOAD_CORE,
RARCH_CMD_LOAD_STATE,
RARCH_CMD_SAVE_STATE,
/* Takes screenshot. */
RARCH_CMD_TAKE_SCREENSHOT,
/* Initializes dummy core. */
RARCH_CMD_PREPARE_DUMMY,
/* Quits RetroArch. */
RARCH_CMD_QUIT,
/* Reinitialize all drivers. */
RARCH_CMD_REINIT,
/* Deinitialize rewind. */
RARCH_CMD_REWIND_DEINIT,
/* Initializes rewind. */
RARCH_CMD_REWIND_INIT,
/* Toggles rewind. */
RARCH_CMD_REWIND_TOGGLE,
/* Deinitializes autosave. */
RARCH_CMD_AUTOSAVE_DEINIT,
/* Initializes autosave. */
RARCH_CMD_AUTOSAVE_INIT,
RARCH_CMD_AUTOSAVE_STATE,
/* Stops audio. */
RARCH_CMD_AUDIO_STOP,
/* Starts audio. */
RARCH_CMD_AUDIO_START,
/* Mutes audio. */
RARCH_CMD_AUDIO_MUTE_TOGGLE,
/* Initializes overlay. */
RARCH_CMD_OVERLAY_INIT,
/* Deinitializes overlay. */
RARCH_CMD_OVERLAY_DEINIT,
/* Sets current scale factor for overlay. */
RARCH_CMD_OVERLAY_SET_SCALE_FACTOR,
/* Sets current alpha modulation for overlay. */
RARCH_CMD_OVERLAY_SET_ALPHA_MOD,
/* Cycle to next overlay. */
RARCH_CMD_OVERLAY_NEXT,
/* Deinitializes overlay. */
RARCH_CMD_DSP_FILTER_INIT,
/* Deinitializes graphics filter. */
RARCH_CMD_DSP_FILTER_DEINIT,
/* Deinitializes GPU recoring. */
RARCH_CMD_GPU_RECORD_DEINIT,
/* Initializes recording system. */
RARCH_CMD_RECORD_INIT,
/* Deinitializes recording system. */
RARCH_CMD_RECORD_DEINIT,
/* Deinitializes history playlist. */
RARCH_CMD_HISTORY_DEINIT,
/* Initializes history playlist. */
RARCH_CMD_HISTORY_INIT,
/* Deinitializes core information. */
RARCH_CMD_CORE_INFO_DEINIT,
/* Initializes core information. */
RARCH_CMD_CORE_INFO_INIT,
/* Deinitializes core. */
RARCH_CMD_CORE_DEINIT,
/* Initializes core. */
RARCH_CMD_CORE_INIT,
/* Set audio blocking state. */
RARCH_CMD_AUDIO_SET_BLOCKING_STATE,
/* Set audio nonblocking state. */
RARCH_CMD_AUDIO_SET_NONBLOCKING_STATE,
/* Apply video state changes. */
RARCH_CMD_VIDEO_APPLY_STATE_CHANGES,
/* Set video blocking state. */
RARCH_CMD_VIDEO_SET_BLOCKING_STATE,
/* Set video nonblocking state. */
RARCH_CMD_VIDEO_SET_NONBLOCKING_STATE,
/* Sets current aspect ratio index. */
RARCH_CMD_VIDEO_SET_ASPECT_RATIO,
RARCH_CMD_RESET_CONTEXT,
/* Restarts RetroArch. */
RARCH_CMD_RESTART_RETROARCH,
/* Force-quit RetroArch. */
RARCH_CMD_QUIT_RETROARCH,
/* Resume RetroArch when in menu. */
RARCH_CMD_RESUME,
/* Toggles pause. */
RARCH_CMD_PAUSE_TOGGLE,
/* Pauses RetroArch. */
RARCH_CMD_UNPAUSE,
/* Unpauses retroArch. */
RARCH_CMD_PAUSE,
RARCH_CMD_PAUSE_CHECKS,
RARCH_CMD_MENU_SAVE_CONFIG,
RARCH_CMD_MENU_PAUSE_LIBRETRO,
/* Toggles menu on/off. */
RARCH_CMD_MENU_TOGGLE,
/* Applies shader changes. */
RARCH_CMD_SHADERS_APPLY_CHANGES,
/* Initializes shader directory. */
RARCH_CMD_SHADER_DIR_INIT,
/* Deinitializes shader directory. */
RARCH_CMD_SHADER_DIR_DEINIT,
/* Initializes controllers. */
RARCH_CMD_CONTROLLERS_INIT,
RARCH_CMD_SAVEFILES,
/* Initializes savefiles. */
RARCH_CMD_SAVEFILES_INIT,
/* Deinitializes savefiles. */
RARCH_CMD_SAVEFILES_DEINIT,
/* Initializes message queue. */
RARCH_CMD_MSG_QUEUE_INIT,
/* Deinitializes message queue. */
RARCH_CMD_MSG_QUEUE_DEINIT,
/* Initializes cheats. */
RARCH_CMD_CHEATS_INIT,
/* Deinitializes cheats. */
RARCH_CMD_CHEATS_DEINIT,
/* Deinitializes network system. */
RARCH_CMD_NETWORK_DEINIT,
/* Initializes network system. */
RARCH_CMD_NETWORK_INIT,
/* Initializes netplay system. */
RARCH_CMD_NETPLAY_INIT,
/* Deinitializes netplay system. */
RARCH_CMD_NETPLAY_DEINIT,
/* Flip netplay players. */
RARCH_CMD_NETPLAY_FLIP_PLAYERS,
/* Initializes BSV movie. */
RARCH_CMD_BSV_MOVIE_INIT,
/* Deinitializes BSV movie. */
RARCH_CMD_BSV_MOVIE_DEINIT,
/* Initializes command interface. */
RARCH_CMD_COMMAND_INIT,
/* Deinitialize command interface. */
RARCH_CMD_COMMAND_DEINIT,
/* Deinitializes drivers. */
RARCH_CMD_DRIVERS_DEINIT,
/* Initializes drivers. */
RARCH_CMD_DRIVERS_INIT,
/* Reinitializes audio driver. */
RARCH_CMD_AUDIO_REINIT,
/* Resizes windowed scale. Will reinitialize video driver. */
RARCH_CMD_RESIZE_WINDOWED_SCALE,
/* Deinitializes temporary content. */
RARCH_CMD_TEMPORARY_CONTENT_DEINIT,
RARCH_CMD_SUBSYSTEM_FULLPATHS_DEINIT,
RARCH_CMD_LOG_FILE_DEINIT,
/* Toggles disk eject. */
RARCH_CMD_DISK_EJECT_TOGGLE,
/* Cycle to next disk. */
RARCH_CMD_DISK_NEXT,
/* Cycle to previous disk. */
RARCH_CMD_DISK_PREV,
/* Stops rumbling. */
RARCH_CMD_RUMBLE_STOP,
/* Toggles mouse grab. */
RARCH_CMD_GRAB_MOUSE_TOGGLE,
/* Toggles fullscreen mode. */
RARCH_CMD_FULLSCREEN_TOGGLE,
RARCH_CMD_PERFCNT_REPORT_FRONTEND_LOG,
RARCH_CMD_REMAPPING_INIT,
RARCH_CMD_REMAPPING_DEINIT,
};
enum action_state
{
RARCH_ACTION_STATE_NONE = 0,
RARCH_ACTION_STATE_LOAD_CONTENT,
RARCH_ACTION_STATE_MENU_RUNNING,
RARCH_ACTION_STATE_MENU_RUNNING_FINISHED,
RARCH_ACTION_STATE_QUIT,
RARCH_ACTION_STATE_FORCE_QUIT,
};
struct rarch_main_wrap
{
const char *content_path;
const char *sram_path;
const char *state_path;
const char *config_path;
const char *libretro_path;
bool verbose;
bool no_content;
bool touched;
};
void rarch_main_state_new(void);
void rarch_main_state_free(void);
void rarch_main_set_state(unsigned action);
/**
* rarch_main_command:
* @cmd : Command index.
*
* Performs RetroArch command with index @cmd.
*
* Returns: true (1) on success, otherwise false (0).
**/
bool rarch_main_command(unsigned action);
/**
* rarch_main_init:
* @argc : Count of (commandline) arguments.
* @argv : (Commandline) arguments.
*
* Initializes RetroArch.
*
* Returns: 0 on success, otherwise 1 if there was an error.
**/
int rarch_main_init(int argc, char *argv[]);
/**
* rarch_main_init_wrap:
* @args : Input arguments.
* @argc : Count of arguments.
* @argv : Arguments.
*
* Generates an @argc and @argv pair based on @args
* of type rarch_main_wrap.
**/
void rarch_main_init_wrap(const struct rarch_main_wrap *args,
int *argc, char **argv);
/**
* rarch_main_deinit:
*
* Deinitializes RetroArch.
**/
void rarch_main_deinit(void);
/**
* rarch_render_cached_frame:
*
* Renders the current video frame.
**/
void rarch_render_cached_frame(void);
/**
* rarch_disk_control_set_eject:
* @new_state : Eject or close the virtual drive tray.
* false (0) : Close
* true (1) : Eject
* @print_log : Show message onscreen.
*
* Ejects/closes of the virtual drive tray.
**/
void rarch_disk_control_set_eject(bool state, bool log);
/**
* rarch_disk_control_set_index:
* @index : Index of disk to set as current.
*
* Sets current disk to @index.
**/
void rarch_disk_control_set_index(unsigned index);
/**
* rarch_disk_control_append_image:
* @path : Path to disk image.
*
* Appends disk image to disk image list.
**/
void rarch_disk_control_append_image(const char *path);
/**
* rarch_replace_config:
* @path : Path to config file to replace
* current config file with.
*
* Replaces currently loaded configuration file with
* another one. Will load a dummy core to flush state
* properly.
*
* Quite intrusive and error prone.
* Likely to have lots of small bugs.
* Cleanly exit the main loop to ensure that all the tiny details
* get set properly.
*
* This should mitigate most of the smaller bugs.
*
* Returns: true (1) if successful, false (0) if @path was the
* same as the current config file.
**/
bool rarch_replace_config(const char *path);
/**
* rarch_playlist_load_content:
* @playlist : Playlist handle.
* @idx : Index in playlist.
*
* Initializes core and loads content based on playlist entry.
**/
void rarch_playlist_load_content(content_playlist_t *playlist,
unsigned index);
/**
* rarch_defer_core:
* @core_info : Core info list handle.
* @dir : Directory. Gets joined with @path.
* @path : Path. Gets joined with @dir.
* @menu_label : Label identifier of menu setting.
* @deferred_path : Deferred core path. Will be filled in
* by function.
* @sizeof_deferred_path : Size of @deferred_path.
*
* Gets deferred core.
*
* Returns: 0 if there are multiple deferred cores and a
* selection needs to be made from a list, otherwise
* returns -1 and fills in @deferred_path with path to core.
**/
int rarch_defer_core(core_info_list_t *data,
const char *dir, const char *path, const char *menu_label,
char *deferred_path, size_t sizeof_deferred_path);
bool rarch_update_system_info(struct retro_system_info *info,
bool *load_no_content);
#ifdef __cplusplus
}
#endif
#endif
Reference in New Issue View Git Blame Copy Permalink