1 /* Copyright (C) 2010-2020 The RetroArch team
3 * ---------------------------------------------------------------------------------------
4 * The following license statement only applies to this libretro API header (libretro.h).
5 * ---------------------------------------------------------------------------------------
7 * Permission is hereby granted, free of charge,
8 * to any person obtaining a copy of this software and associated documentation files (the "Software"),
9 * to deal in the Software without restriction, including without limitation the rights to
10 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software,
11 * and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
13 * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
16 * INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
18 * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
19 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
35 #if defined(_MSC_VER) && _MSC_VER < 1800 && !defined(SN_TARGET_PS3)
36 /* Hack applied for MSVC when compiling in C89 mode
37 * as it isn't C99-compliant. */
38 #define bool unsigned char
46 #ifndef RETRO_CALLCONV
47 # if defined(__GNUC__) && defined(__i386__) && !defined(__x86_64__)
48 # define RETRO_CALLCONV __attribute__((cdecl))
49 # elif defined(_MSC_VER) && defined(_M_X86) && !defined(_M_X64)
50 # define RETRO_CALLCONV __cdecl
52 # define RETRO_CALLCONV /* all other platforms only have one calling convention each */
57 # if defined(_WIN32) || defined(__CYGWIN__) || defined(__MINGW32__)
58 # ifdef RETRO_IMPORT_SYMBOLS
60 # define RETRO_API RETRO_CALLCONV __attribute__((__dllimport__))
62 # define RETRO_API RETRO_CALLCONV __declspec(dllimport)
66 # define RETRO_API RETRO_CALLCONV __attribute__((__dllexport__))
68 # define RETRO_API RETRO_CALLCONV __declspec(dllexport)
72 # if defined(__GNUC__) && __GNUC__ >= 4
73 # define RETRO_API RETRO_CALLCONV __attribute__((__visibility__("default")))
75 # define RETRO_API RETRO_CALLCONV
80 /* Used for checking API/ABI mismatches that can break libretro
82 * It is not incremented for compatible changes to the API.
84 #define RETRO_API_VERSION 1
87 * Libretro's fundamental device abstractions.
89 * Libretro's input system consists of some standardized device types,
90 * such as a joypad (with/without analog), mouse, keyboard, lightgun
93 * The functionality of these devices are fixed, and individual cores
94 * map their own concept of a controller to libretro's abstractions.
95 * This makes it possible for frontends to map the abstract types to a
96 * real input device, and not having to worry about binding input
97 * correctly to arbitrary controller layouts.
100 #define RETRO_DEVICE_TYPE_SHIFT 8
101 #define RETRO_DEVICE_MASK ((1 << RETRO_DEVICE_TYPE_SHIFT) - 1)
102 #define RETRO_DEVICE_SUBCLASS(base, id) (((id + 1) << RETRO_DEVICE_TYPE_SHIFT) | base)
104 /* Input disabled. */
105 #define RETRO_DEVICE_NONE 0
107 /* The JOYPAD is called RetroPad. It is essentially a Super Nintendo
108 * controller, but with additional L2/R2/L3/R3 buttons, similar to a
110 #define RETRO_DEVICE_JOYPAD 1
112 /* The mouse is a simple mouse, similar to Super Nintendo's mouse.
113 * X and Y coordinates are reported relatively to last poll (poll callback).
114 * It is up to the libretro implementation to keep track of where the mouse
115 * pointer is supposed to be on the screen.
116 * The frontend must make sure not to interfere with its own hardware
119 #define RETRO_DEVICE_MOUSE 2
121 /* KEYBOARD device lets one poll for raw key pressed.
122 * It is poll based, so input callback will return with the current
124 * For event/text based keyboard input, see
125 * RETRO_ENVIRONMENT_SET_KEYBOARD_CALLBACK.
127 #define RETRO_DEVICE_KEYBOARD 3
129 /* LIGHTGUN device is similar to Guncon-2 for PlayStation 2.
130 * It reports X/Y coordinates in screen space (similar to the pointer)
131 * in the range [-0x8000, 0x7fff] in both axes, with zero being center and
132 * -0x8000 being out of bounds.
133 * As well as reporting on/off screen state. It features a trigger,
134 * start/select buttons, auxiliary action buttons and a
135 * directional pad. A forced off-screen shot can be requested for
136 * auto-reloading function in some games.
138 #define RETRO_DEVICE_LIGHTGUN 4
140 /* The ANALOG device is an extension to JOYPAD (RetroPad).
141 * Similar to DualShock2 it adds two analog sticks and all buttons can
142 * be analog. This is treated as a separate device type as it returns
143 * axis values in the full analog range of [-0x7fff, 0x7fff],
144 * although some devices may return -0x8000.
145 * Positive X axis is right. Positive Y axis is down.
146 * Buttons are returned in the range [0, 0x7fff].
147 * Only use ANALOG type when polling for analog values.
149 #define RETRO_DEVICE_ANALOG 5
151 /* Abstracts the concept of a pointing mechanism, e.g. touch.
152 * This allows libretro to query in absolute coordinates where on the
153 * screen a mouse (or something similar) is being placed.
154 * For a touch centric device, coordinates reported are the coordinates
157 * Coordinates in X and Y are reported as:
158 * [-0x7fff, 0x7fff]: -0x7fff corresponds to the far left/top of the screen,
159 * and 0x7fff corresponds to the far right/bottom of the screen.
160 * The "screen" is here defined as area that is passed to the frontend and
161 * later displayed on the monitor.
163 * The frontend is free to scale/resize this screen as it sees fit, however,
164 * (X, Y) = (-0x7fff, -0x7fff) will correspond to the top-left pixel of the
167 * To check if the pointer coordinates are valid (e.g. a touch display
168 * actually being touched), PRESSED returns 1 or 0.
170 * If using a mouse on a desktop, PRESSED will usually correspond to the
171 * left mouse button, but this is a frontend decision.
172 * PRESSED will only return 1 if the pointer is inside the game screen.
174 * For multi-touch, the index variable can be used to successively query
176 * If index = 0 returns true for _PRESSED, coordinates can be extracted
177 * with _X, _Y for index = 0. One can then query _PRESSED, _X, _Y with
178 * index = 1, and so on.
179 * Eventually _PRESSED will return false for an index. No further presses
180 * are registered at this point. */
181 #define RETRO_DEVICE_POINTER 6
183 /* Buttons for the RetroPad (JOYPAD).
184 * The placement of these is equivalent to placements on the
185 * Super Nintendo controller.
186 * L2/R2/L3/R3 buttons correspond to the PS1 DualShock.
187 * Also used as id values for RETRO_DEVICE_INDEX_ANALOG_BUTTON */
188 #define RETRO_DEVICE_ID_JOYPAD_B 0
189 #define RETRO_DEVICE_ID_JOYPAD_Y 1
190 #define RETRO_DEVICE_ID_JOYPAD_SELECT 2
191 #define RETRO_DEVICE_ID_JOYPAD_START 3
192 #define RETRO_DEVICE_ID_JOYPAD_UP 4
193 #define RETRO_DEVICE_ID_JOYPAD_DOWN 5
194 #define RETRO_DEVICE_ID_JOYPAD_LEFT 6
195 #define RETRO_DEVICE_ID_JOYPAD_RIGHT 7
196 #define RETRO_DEVICE_ID_JOYPAD_A 8
197 #define RETRO_DEVICE_ID_JOYPAD_X 9
198 #define RETRO_DEVICE_ID_JOYPAD_L 10
199 #define RETRO_DEVICE_ID_JOYPAD_R 11
200 #define RETRO_DEVICE_ID_JOYPAD_L2 12
201 #define RETRO_DEVICE_ID_JOYPAD_R2 13
202 #define RETRO_DEVICE_ID_JOYPAD_L3 14
203 #define RETRO_DEVICE_ID_JOYPAD_R3 15
205 #define RETRO_DEVICE_ID_JOYPAD_MASK 256
207 /* Index / Id values for ANALOG device. */
208 #define RETRO_DEVICE_INDEX_ANALOG_LEFT 0
209 #define RETRO_DEVICE_INDEX_ANALOG_RIGHT 1
210 #define RETRO_DEVICE_INDEX_ANALOG_BUTTON 2
211 #define RETRO_DEVICE_ID_ANALOG_X 0
212 #define RETRO_DEVICE_ID_ANALOG_Y 1
214 /* Id values for MOUSE. */
215 #define RETRO_DEVICE_ID_MOUSE_X 0
216 #define RETRO_DEVICE_ID_MOUSE_Y 1
217 #define RETRO_DEVICE_ID_MOUSE_LEFT 2
218 #define RETRO_DEVICE_ID_MOUSE_RIGHT 3
219 #define RETRO_DEVICE_ID_MOUSE_WHEELUP 4
220 #define RETRO_DEVICE_ID_MOUSE_WHEELDOWN 5
221 #define RETRO_DEVICE_ID_MOUSE_MIDDLE 6
222 #define RETRO_DEVICE_ID_MOUSE_HORIZ_WHEELUP 7
223 #define RETRO_DEVICE_ID_MOUSE_HORIZ_WHEELDOWN 8
224 #define RETRO_DEVICE_ID_MOUSE_BUTTON_4 9
225 #define RETRO_DEVICE_ID_MOUSE_BUTTON_5 10
227 /* Id values for LIGHTGUN. */
228 #define RETRO_DEVICE_ID_LIGHTGUN_SCREEN_X 13 /*Absolute Position*/
229 #define RETRO_DEVICE_ID_LIGHTGUN_SCREEN_Y 14 /*Absolute*/
230 #define RETRO_DEVICE_ID_LIGHTGUN_IS_OFFSCREEN 15 /*Status Check*/
231 #define RETRO_DEVICE_ID_LIGHTGUN_TRIGGER 2
232 #define RETRO_DEVICE_ID_LIGHTGUN_RELOAD 16 /*Forced off-screen shot*/
233 #define RETRO_DEVICE_ID_LIGHTGUN_AUX_A 3
234 #define RETRO_DEVICE_ID_LIGHTGUN_AUX_B 4
235 #define RETRO_DEVICE_ID_LIGHTGUN_START 6
236 #define RETRO_DEVICE_ID_LIGHTGUN_SELECT 7
237 #define RETRO_DEVICE_ID_LIGHTGUN_AUX_C 8
238 #define RETRO_DEVICE_ID_LIGHTGUN_DPAD_UP 9
239 #define RETRO_DEVICE_ID_LIGHTGUN_DPAD_DOWN 10
240 #define RETRO_DEVICE_ID_LIGHTGUN_DPAD_LEFT 11
241 #define RETRO_DEVICE_ID_LIGHTGUN_DPAD_RIGHT 12
243 #define RETRO_DEVICE_ID_LIGHTGUN_X 0 /*Relative Position*/
244 #define RETRO_DEVICE_ID_LIGHTGUN_Y 1 /*Relative*/
245 #define RETRO_DEVICE_ID_LIGHTGUN_CURSOR 3 /*Use Aux:A*/
246 #define RETRO_DEVICE_ID_LIGHTGUN_TURBO 4 /*Use Aux:B*/
247 #define RETRO_DEVICE_ID_LIGHTGUN_PAUSE 5 /*Use Start*/
249 /* Id values for POINTER. */
250 #define RETRO_DEVICE_ID_POINTER_X 0
251 #define RETRO_DEVICE_ID_POINTER_Y 1
252 #define RETRO_DEVICE_ID_POINTER_PRESSED 2
253 #define RETRO_DEVICE_ID_POINTER_COUNT 3
255 /* Returned from retro_get_region(). */
256 #define RETRO_REGION_NTSC 0
257 #define RETRO_REGION_PAL 1
259 /* Id values for LANGUAGE */
262 RETRO_LANGUAGE_ENGLISH = 0,
263 RETRO_LANGUAGE_JAPANESE = 1,
264 RETRO_LANGUAGE_FRENCH = 2,
265 RETRO_LANGUAGE_SPANISH = 3,
266 RETRO_LANGUAGE_GERMAN = 4,
267 RETRO_LANGUAGE_ITALIAN = 5,
268 RETRO_LANGUAGE_DUTCH = 6,
269 RETRO_LANGUAGE_PORTUGUESE_BRAZIL = 7,
270 RETRO_LANGUAGE_PORTUGUESE_PORTUGAL = 8,
271 RETRO_LANGUAGE_RUSSIAN = 9,
272 RETRO_LANGUAGE_KOREAN = 10,
273 RETRO_LANGUAGE_CHINESE_TRADITIONAL = 11,
274 RETRO_LANGUAGE_CHINESE_SIMPLIFIED = 12,
275 RETRO_LANGUAGE_ESPERANTO = 13,
276 RETRO_LANGUAGE_POLISH = 14,
277 RETRO_LANGUAGE_VIETNAMESE = 15,
278 RETRO_LANGUAGE_ARABIC = 16,
279 RETRO_LANGUAGE_GREEK = 17,
280 RETRO_LANGUAGE_TURKISH = 18,
281 RETRO_LANGUAGE_SLOVAK = 19,
284 /* Ensure sizeof(enum) == sizeof(int) */
285 RETRO_LANGUAGE_DUMMY = INT_MAX
288 /* Passed to retro_get_memory_data/size().
289 * If the memory type doesn't apply to the
290 * implementation NULL/0 can be returned.
292 #define RETRO_MEMORY_MASK 0xff
294 /* Regular save RAM. This RAM is usually found on a game cartridge,
295 * backed up by a battery.
296 * If save game data is too complex for a single memory buffer,
297 * the SAVE_DIRECTORY (preferably) or SYSTEM_DIRECTORY environment
298 * callback can be used. */
299 #define RETRO_MEMORY_SAVE_RAM 0
301 /* Some games have a built-in clock to keep track of time.
302 * This memory is usually just a couple of bytes to keep track of time.
304 #define RETRO_MEMORY_RTC 1
306 /* System ram lets a frontend peek into a game systems main RAM. */
307 #define RETRO_MEMORY_SYSTEM_RAM 2
309 /* Video ram lets a frontend peek into a game systems video RAM (VRAM). */
310 #define RETRO_MEMORY_VIDEO_RAM 3
312 /* Keysyms used for ID in input state callback when polling RETRO_KEYBOARD. */
317 RETROK_BACKSPACE = 8,
325 RETROK_QUOTEDBL = 34,
328 RETROK_AMPERSAND = 38,
330 RETROK_LEFTPAREN = 40,
331 RETROK_RIGHTPAREN = 41,
332 RETROK_ASTERISK = 42,
349 RETROK_SEMICOLON = 59,
353 RETROK_QUESTION = 63,
355 RETROK_LEFTBRACKET = 91,
356 RETROK_BACKSLASH = 92,
357 RETROK_RIGHTBRACKET = 93,
359 RETROK_UNDERSCORE = 95,
360 RETROK_BACKQUOTE = 96,
387 RETROK_LEFTBRACE = 123,
389 RETROK_RIGHTBRACE = 125,
403 RETROK_KP_PERIOD = 266,
404 RETROK_KP_DIVIDE = 267,
405 RETROK_KP_MULTIPLY = 268,
406 RETROK_KP_MINUS = 269,
407 RETROK_KP_PLUS = 270,
408 RETROK_KP_ENTER = 271,
409 RETROK_KP_EQUALS = 272,
419 RETROK_PAGEDOWN = 281,
437 RETROK_NUMLOCK = 300,
438 RETROK_CAPSLOCK = 301,
439 RETROK_SCROLLOCK = 302,
451 RETROK_COMPOSE = 314,
461 RETROK_OEM_102 = 323,
465 RETROK_DUMMY = INT_MAX /* Ensure sizeof(enum) == sizeof(int) */
470 RETROKMOD_NONE = 0x0000,
472 RETROKMOD_SHIFT = 0x01,
473 RETROKMOD_CTRL = 0x02,
474 RETROKMOD_ALT = 0x04,
475 RETROKMOD_META = 0x08,
477 RETROKMOD_NUMLOCK = 0x10,
478 RETROKMOD_CAPSLOCK = 0x20,
479 RETROKMOD_SCROLLOCK = 0x40,
481 RETROKMOD_DUMMY = INT_MAX /* Ensure sizeof(enum) == sizeof(int) */
484 /* If set, this call is not part of the public libretro API yet. It can
485 * change or be removed at any time. */
486 #define RETRO_ENVIRONMENT_EXPERIMENTAL 0x10000
487 /* Environment callback to be used internally in frontend. */
488 #define RETRO_ENVIRONMENT_PRIVATE 0x20000
490 /* Environment commands. */
491 #define RETRO_ENVIRONMENT_SET_ROTATION 1 /* const unsigned * --
492 * Sets screen rotation of graphics.
493 * Valid values are 0, 1, 2, 3, which rotates screen by 0, 90, 180,
494 * 270 degrees counter-clockwise respectively.
496 #define RETRO_ENVIRONMENT_GET_OVERSCAN 2 /* bool * --
497 * NOTE: As of 2019 this callback is considered deprecated in favor of
498 * using core options to manage overscan in a more nuanced, core-specific way.
500 * Boolean value whether or not the implementation should use overscan,
501 * or crop away overscan.
503 #define RETRO_ENVIRONMENT_GET_CAN_DUPE 3 /* bool * --
504 * Boolean value whether or not frontend supports frame duping,
505 * passing NULL to video frame callback.
508 /* Environ 4, 5 are no longer supported (GET_VARIABLE / SET_VARIABLES),
509 * and reserved to avoid possible ABI clash.
512 #define RETRO_ENVIRONMENT_SET_MESSAGE 6 /* const struct retro_message * --
513 * Sets a message to be displayed in implementation-specific manner
514 * for a certain amount of 'frames'.
515 * Should not be used for trivial messages, which should simply be
516 * logged via RETRO_ENVIRONMENT_GET_LOG_INTERFACE (or as a
519 #define RETRO_ENVIRONMENT_SHUTDOWN 7 /* N/A (NULL) --
520 * Requests the frontend to shutdown.
521 * Should only be used if game has a specific
522 * way to shutdown the game from a menu item or similar.
524 #define RETRO_ENVIRONMENT_SET_PERFORMANCE_LEVEL 8
525 /* const unsigned * --
526 * Gives a hint to the frontend how demanding this implementation
527 * is on a system. E.g. reporting a level of 2 means
528 * this implementation should run decently on all frontends
531 * It can be used by the frontend to potentially warn
532 * about too demanding implementations.
534 * The levels are "floating".
536 * This function can be called on a per-game basis,
537 * as certain games an implementation can play might be
538 * particularly demanding.
539 * If called, it should be called in retro_load_game().
541 #define RETRO_ENVIRONMENT_GET_SYSTEM_DIRECTORY 9
543 * Returns the "system" directory of the frontend.
544 * This directory can be used to store system specific
545 * content such as BIOSes, configuration data, etc.
546 * The returned value can be NULL.
547 * If so, no such directory is defined,
548 * and it's up to the implementation to find a suitable directory.
550 * NOTE: Some cores used this folder also for "save" data such as
551 * memory cards, etc, for lack of a better place to put it.
552 * This is now discouraged, and if possible, cores should try to
553 * use the new GET_SAVE_DIRECTORY.
555 #define RETRO_ENVIRONMENT_SET_PIXEL_FORMAT 10
556 /* const enum retro_pixel_format * --
557 * Sets the internal pixel format used by the implementation.
558 * The default pixel format is RETRO_PIXEL_FORMAT_0RGB1555.
559 * This pixel format however, is deprecated (see enum retro_pixel_format).
560 * If the call returns false, the frontend does not support this pixel
563 * This function should be called inside retro_load_game() or
564 * retro_get_system_av_info().
566 #define RETRO_ENVIRONMENT_SET_INPUT_DESCRIPTORS 11
567 /* const struct retro_input_descriptor * --
568 * Sets an array of retro_input_descriptors.
569 * It is up to the frontend to present this in a usable way.
570 * The array is terminated by retro_input_descriptor::description
572 * This function can be called at any time, but it is recommended
573 * to call it as early as possible.
575 #define RETRO_ENVIRONMENT_SET_KEYBOARD_CALLBACK 12
576 /* const struct retro_keyboard_callback * --
577 * Sets a callback function used to notify core about keyboard events.
579 #define RETRO_ENVIRONMENT_SET_DISK_CONTROL_INTERFACE 13
580 /* const struct retro_disk_control_callback * --
581 * Sets an interface which frontend can use to eject and insert
583 * This is used for games which consist of multiple images and
584 * must be manually swapped out by the user (e.g. PSX).
586 #define RETRO_ENVIRONMENT_SET_HW_RENDER 14
587 /* struct retro_hw_render_callback * --
588 * Sets an interface to let a libretro core render with
589 * hardware acceleration.
590 * Should be called in retro_load_game().
591 * If successful, libretro cores will be able to render to a
592 * frontend-provided framebuffer.
593 * The size of this framebuffer will be at least as large as
594 * max_width/max_height provided in get_av_info().
595 * If HW rendering is used, pass only RETRO_HW_FRAME_BUFFER_VALID or
596 * NULL to retro_video_refresh_t.
598 #define RETRO_ENVIRONMENT_GET_VARIABLE 15
599 /* struct retro_variable * --
600 * Interface to acquire user-defined information from environment
601 * that cannot feasibly be supported in a multi-system way.
602 * 'key' should be set to a key which has already been set by
604 * 'data' will be set to a value or NULL.
606 #define RETRO_ENVIRONMENT_SET_VARIABLES 16
607 /* const struct retro_variable * --
608 * Allows an implementation to signal the environment
609 * which variables it might want to check for later using
611 * This allows the frontend to present these variables to
612 * a user dynamically.
613 * This should be called the first time as early as
614 * possible (ideally in retro_set_environment).
615 * Afterward it may be called again for the core to communicate
616 * updated options to the frontend, but the number of core
617 * options must not change from the number in the initial call.
619 * 'data' points to an array of retro_variable structs
620 * terminated by a { NULL, NULL } element.
621 * retro_variable::key should be namespaced to not collide
622 * with other implementations' keys. E.g. A core called
623 * 'foo' should use keys named as 'foo_option'.
624 * retro_variable::value should contain a human readable
625 * description of the key as well as a '|' delimited list
626 * of expected values.
628 * The number of possible options should be very limited,
629 * i.e. it should be feasible to cycle through options
630 * without a keyboard.
632 * First entry should be treated as a default.
635 * { "foo_option", "Speed hack coprocessor X; false|true" }
637 * Text before first ';' is description. This ';' must be
638 * followed by a space, and followed by a list of possible
639 * values split up with '|'.
641 * Only strings are operated on. The possible values will
642 * generally be displayed and stored as-is by the frontend.
644 #define RETRO_ENVIRONMENT_GET_VARIABLE_UPDATE 17
646 * Result is set to true if some variables are updated by
647 * frontend since last call to RETRO_ENVIRONMENT_GET_VARIABLE.
648 * Variables should be queried with GET_VARIABLE.
650 #define RETRO_ENVIRONMENT_SET_SUPPORT_NO_GAME 18
652 * If true, the libretro implementation supports calls to
653 * retro_load_game() with NULL as argument.
654 * Used by cores which can run without particular game data.
655 * This should be called within retro_set_environment() only.
657 #define RETRO_ENVIRONMENT_GET_LIBRETRO_PATH 19
659 * Retrieves the absolute path from where this libretro
660 * implementation was loaded.
661 * NULL is returned if the libretro was loaded statically
662 * (i.e. linked statically to frontend), or if the path cannot be
664 * Mostly useful in cooperation with SET_SUPPORT_NO_GAME as assets can
665 * be loaded without ugly hacks.
668 /* Environment 20 was an obsolete version of SET_AUDIO_CALLBACK.
669 * It was not used by any known core at the time,
670 * and was removed from the API. */
671 #define RETRO_ENVIRONMENT_SET_FRAME_TIME_CALLBACK 21
672 /* const struct retro_frame_time_callback * --
673 * Lets the core know how much time has passed since last
674 * invocation of retro_run().
675 * The frontend can tamper with the timing to fake fast-forward,
676 * slow-motion, frame stepping, etc.
677 * In this case the delta time will use the reference value
678 * in frame_time_callback..
680 #define RETRO_ENVIRONMENT_SET_AUDIO_CALLBACK 22
681 /* const struct retro_audio_callback * --
682 * Sets an interface which is used to notify a libretro core about audio
683 * being available for writing.
684 * The callback can be called from any thread, so a core using this must
685 * have a thread safe audio implementation.
686 * It is intended for games where audio and video are completely
687 * asynchronous and audio can be generated on the fly.
688 * This interface is not recommended for use with emulators which have
689 * highly synchronous audio.
691 * The callback only notifies about writability; the libretro core still
692 * has to call the normal audio callbacks
693 * to write audio. The audio callbacks must be called from within the
694 * notification callback.
695 * The amount of audio data to write is up to the implementation.
696 * Generally, the audio callback will be called continously in a loop.
698 * Due to thread safety guarantees and lack of sync between audio and
699 * video, a frontend can selectively disallow this interface based on
700 * internal configuration. A core using this interface must also
701 * implement the "normal" audio interface.
703 * A libretro core using SET_AUDIO_CALLBACK should also make use of
704 * SET_FRAME_TIME_CALLBACK.
706 #define RETRO_ENVIRONMENT_GET_RUMBLE_INTERFACE 23
707 /* struct retro_rumble_interface * --
708 * Gets an interface which is used by a libretro core to set
709 * state of rumble motors in controllers.
710 * A strong and weak motor is supported, and they can be
711 * controlled indepedently.
713 #define RETRO_ENVIRONMENT_GET_INPUT_DEVICE_CAPABILITIES 24
715 * Gets a bitmask telling which device type are expected to be
716 * handled properly in a call to retro_input_state_t.
717 * Devices which are not handled or recognized always return
718 * 0 in retro_input_state_t.
719 * Example bitmask: caps = (1 << RETRO_DEVICE_JOYPAD) | (1 << RETRO_DEVICE_ANALOG).
720 * Should only be called in retro_run().
722 #define RETRO_ENVIRONMENT_GET_SENSOR_INTERFACE (25 | RETRO_ENVIRONMENT_EXPERIMENTAL)
723 /* struct retro_sensor_interface * --
724 * Gets access to the sensor interface.
725 * The purpose of this interface is to allow
726 * setting state related to sensors such as polling rate,
727 * enabling/disable it entirely, etc.
728 * Reading sensor state is done via the normal
729 * input_state_callback API.
731 #define RETRO_ENVIRONMENT_GET_CAMERA_INTERFACE (26 | RETRO_ENVIRONMENT_EXPERIMENTAL)
732 /* struct retro_camera_callback * --
733 * Gets an interface to a video camera driver.
734 * A libretro core can use this interface to get access to a
736 * New video frames are delivered in a callback in same
737 * thread as retro_run().
739 * GET_CAMERA_INTERFACE should be called in retro_load_game().
741 * Depending on the camera implementation used, camera frames
742 * will be delivered as a raw framebuffer,
743 * or as an OpenGL texture directly.
745 * The core has to tell the frontend here which types of
746 * buffers can be handled properly.
747 * An OpenGL texture can only be handled when using a
748 * libretro GL core (SET_HW_RENDER).
749 * It is recommended to use a libretro GL core when
750 * using camera interface.
752 * The camera is not started automatically. The retrieved start/stop
753 * functions must be used to explicitly
754 * start and stop the camera driver.
756 #define RETRO_ENVIRONMENT_GET_LOG_INTERFACE 27
757 /* struct retro_log_callback * --
758 * Gets an interface for logging. This is useful for
759 * logging in a cross-platform way
760 * as certain platforms cannot use stderr for logging.
761 * It also allows the frontend to
762 * show logging information in a more suitable way.
763 * If this interface is not used, libretro cores should
764 * log to stderr as desired.
766 #define RETRO_ENVIRONMENT_GET_PERF_INTERFACE 28
767 /* struct retro_perf_callback * --
768 * Gets an interface for performance counters. This is useful
769 * for performance logging in a cross-platform way and for detecting
770 * architecture-specific features, such as SIMD support.
772 #define RETRO_ENVIRONMENT_GET_LOCATION_INTERFACE 29
773 /* struct retro_location_callback * --
774 * Gets access to the location interface.
775 * The purpose of this interface is to be able to retrieve
776 * location-based information from the host device,
777 * such as current latitude / longitude.
779 #define RETRO_ENVIRONMENT_GET_CONTENT_DIRECTORY 30 /* Old name, kept for compatibility. */
780 #define RETRO_ENVIRONMENT_GET_CORE_ASSETS_DIRECTORY 30
782 * Returns the "core assets" directory of the frontend.
783 * This directory can be used to store specific assets that the
784 * core relies upon, such as art assets,
785 * input data, etc etc.
786 * The returned value can be NULL.
787 * If so, no such directory is defined,
788 * and it's up to the implementation to find a suitable directory.
790 #define RETRO_ENVIRONMENT_GET_SAVE_DIRECTORY 31
792 * Returns the "save" directory of the frontend, unless there is no
793 * save directory available. The save directory should be used to
794 * store SRAM, memory cards, high scores, etc, if the libretro core
795 * cannot use the regular memory interface (retro_get_memory_data()).
797 * If the frontend cannot designate a save directory, it will return
798 * NULL to indicate that the core should attempt to operate without a
799 * save directory set.
801 * NOTE: early libretro cores used the system directory for save
802 * files. Cores that need to be backwards-compatible can still check
803 * GET_SYSTEM_DIRECTORY.
805 #define RETRO_ENVIRONMENT_SET_SYSTEM_AV_INFO 32
806 /* const struct retro_system_av_info * --
807 * Sets a new av_info structure. This can only be called from
808 * within retro_run().
809 * This should *only* be used if the core is completely altering the
810 * internal resolutions, aspect ratios, timings, sampling rate, etc.
811 * Calling this can require a full reinitialization of video/audio
812 * drivers in the frontend,
814 * so it is important to call it very sparingly, and usually only with
815 * the users explicit consent.
816 * An eventual driver reinitialize will happen so that video and
818 * happening after this call within the same retro_run() call will
819 * target the newly initialized driver.
821 * This callback makes it possible to support configurable resolutions
822 * in games, which can be useful to
823 * avoid setting the "worst case" in max_width/max_height.
825 * ***HIGHLY RECOMMENDED*** Do not call this callback every time
826 * resolution changes in an emulator core if it's
827 * expected to be a temporary change, for the reasons of possible
828 * driver reinitialization.
829 * This call is not a free pass for not trying to provide
830 * correct values in retro_get_system_av_info(). If you need to change
831 * things like aspect ratio or nominal width/height,
832 * use RETRO_ENVIRONMENT_SET_GEOMETRY, which is a softer variant
833 * of SET_SYSTEM_AV_INFO.
835 * If this returns false, the frontend does not acknowledge a
836 * changed av_info struct.
838 #define RETRO_ENVIRONMENT_SET_PROC_ADDRESS_CALLBACK 33
839 /* const struct retro_get_proc_address_interface * --
840 * Allows a libretro core to announce support for the
841 * get_proc_address() interface.
842 * This interface allows for a standard way to extend libretro where
843 * use of environment calls are too indirect,
844 * e.g. for cases where the frontend wants to call directly into the core.
846 * If a core wants to expose this interface, SET_PROC_ADDRESS_CALLBACK
847 * **MUST** be called from within retro_set_environment().
849 #define RETRO_ENVIRONMENT_SET_SUBSYSTEM_INFO 34
850 /* const struct retro_subsystem_info * --
851 * This environment call introduces the concept of libretro "subsystems".
852 * A subsystem is a variant of a libretro core which supports
853 * different kinds of games.
854 * The purpose of this is to support e.g. emulators which might
855 * have special needs, e.g. Super Nintendo's Super GameBoy, Sufami Turbo.
856 * It can also be used to pick among subsystems in an explicit way
857 * if the libretro implementation is a multi-system emulator itself.
859 * Loading a game via a subsystem is done with retro_load_game_special(),
860 * and this environment call allows a libretro core to expose which
861 * subsystems are supported for use with retro_load_game_special().
862 * A core passes an array of retro_game_special_info which is terminated
863 * with a zeroed out retro_game_special_info struct.
865 * If a core wants to use this functionality, SET_SUBSYSTEM_INFO
866 * **MUST** be called from within retro_set_environment().
868 #define RETRO_ENVIRONMENT_SET_CONTROLLER_INFO 35
869 /* const struct retro_controller_info * --
870 * This environment call lets a libretro core tell the frontend
871 * which controller subclasses are recognized in calls to
872 * retro_set_controller_port_device().
874 * Some emulators such as Super Nintendo support multiple lightgun
875 * types which must be specifically selected from. It is therefore
876 * sometimes necessary for a frontend to be able to tell the core
877 * about a special kind of input device which is not specifcally
878 * provided by the Libretro API.
880 * In order for a frontend to understand the workings of those devices,
881 * they must be defined as a specialized subclass of the generic device
882 * types already defined in the libretro API.
884 * The core must pass an array of const struct retro_controller_info which
885 * is terminated with a blanked out struct. Each element of the
886 * retro_controller_info struct corresponds to the ascending port index
887 * that is passed to retro_set_controller_port_device() when that function
888 * is called to indicate to the core that the frontend has changed the
889 * active device subclass. SEE ALSO: retro_set_controller_port_device()
891 * The ascending input port indexes provided by the core in the struct
892 * are generally presented by frontends as ascending User # or Player #,
893 * such as Player 1, Player 2, Player 3, etc. Which device subclasses are
894 * supported can vary per input port.
896 * The first inner element of each entry in the retro_controller_info array
897 * is a retro_controller_description struct that specifies the names and
898 * codes of all device subclasses that are available for the corresponding
899 * User or Player, beginning with the generic Libretro device that the
900 * subclasses are derived from. The second inner element of each entry is the
901 * total number of subclasses that are listed in the retro_controller_description.
903 * NOTE: Even if special device types are set in the libretro core,
904 * libretro should only poll input based on the base input device types.
906 #define RETRO_ENVIRONMENT_SET_MEMORY_MAPS (36 | RETRO_ENVIRONMENT_EXPERIMENTAL)
907 /* const struct retro_memory_map * --
908 * This environment call lets a libretro core tell the frontend
909 * about the memory maps this core emulates.
910 * This can be used to implement, for example, cheats in a core-agnostic way.
912 * Should only be used by emulators; it doesn't make much sense for
914 * It is recommended to expose all relevant pointers through
915 * retro_get_memory_* as well.
917 * Can be called from retro_init and retro_load_game.
919 #define RETRO_ENVIRONMENT_SET_GEOMETRY 37
920 /* const struct retro_game_geometry * --
921 * This environment call is similar to SET_SYSTEM_AV_INFO for changing
922 * video parameters, but provides a guarantee that drivers will not be
924 * This can only be called from within retro_run().
926 * The purpose of this call is to allow a core to alter nominal
927 * width/heights as well as aspect ratios on-the-fly, which can be
928 * useful for some emulators to change in run-time.
930 * max_width/max_height arguments are ignored and cannot be changed
931 * with this call as this could potentially require a reinitialization or a
932 * non-constant time operation.
933 * If max_width/max_height are to be changed, SET_SYSTEM_AV_INFO is required.
935 * A frontend must guarantee that this environment call completes in
938 #define RETRO_ENVIRONMENT_GET_USERNAME 38
940 * Returns the specified username of the frontend, if specified by the user.
941 * This username can be used as a nickname for a core that has online facilities
942 * or any other mode where personalization of the user is desirable.
943 * The returned value can be NULL.
944 * If this environ callback is used by a core that requires a valid username,
945 * a default username should be specified by the core.
947 #define RETRO_ENVIRONMENT_GET_LANGUAGE 39
949 * Returns the specified language of the frontend, if specified by the user.
950 * It can be used by the core for localization purposes.
952 #define RETRO_ENVIRONMENT_GET_CURRENT_SOFTWARE_FRAMEBUFFER (40 | RETRO_ENVIRONMENT_EXPERIMENTAL)
953 /* struct retro_framebuffer * --
954 * Returns a preallocated framebuffer which the core can use for rendering
955 * the frame into when not using SET_HW_RENDER.
956 * The framebuffer returned from this call must not be used
957 * after the current call to retro_run() returns.
959 * The goal of this call is to allow zero-copy behavior where a core
960 * can render directly into video memory, avoiding extra bandwidth cost by copying
961 * memory from core to video memory.
963 * If this call succeeds and the core renders into it,
964 * the framebuffer pointer and pitch can be passed to retro_video_refresh_t.
965 * If the buffer from GET_CURRENT_SOFTWARE_FRAMEBUFFER is to be used,
966 * the core must pass the exact
967 * same pointer as returned by GET_CURRENT_SOFTWARE_FRAMEBUFFER;
968 * i.e. passing a pointer which is offset from the
969 * buffer is undefined. The width, height and pitch parameters
970 * must also match exactly to the values obtained from GET_CURRENT_SOFTWARE_FRAMEBUFFER.
972 * It is possible for a frontend to return a different pixel format
973 * than the one used in SET_PIXEL_FORMAT. This can happen if the frontend
974 * needs to perform conversion.
976 * It is still valid for a core to render to a different buffer
977 * even if GET_CURRENT_SOFTWARE_FRAMEBUFFER succeeds.
979 * A frontend must make sure that the pointer obtained from this function is
980 * writeable (and readable).
982 #define RETRO_ENVIRONMENT_GET_HW_RENDER_INTERFACE (41 | RETRO_ENVIRONMENT_EXPERIMENTAL)
983 /* const struct retro_hw_render_interface ** --
984 * Returns an API specific rendering interface for accessing API specific data.
985 * Not all HW rendering APIs support or need this.
986 * The contents of the returned pointer is specific to the rendering API
987 * being used. See the various headers like libretro_vulkan.h, etc.
989 * GET_HW_RENDER_INTERFACE cannot be called before context_reset has been called.
990 * Similarly, after context_destroyed callback returns,
991 * the contents of the HW_RENDER_INTERFACE are invalidated.
993 #define RETRO_ENVIRONMENT_SET_SUPPORT_ACHIEVEMENTS (42 | RETRO_ENVIRONMENT_EXPERIMENTAL)
995 * If true, the libretro implementation supports achievements
996 * either via memory descriptors set with RETRO_ENVIRONMENT_SET_MEMORY_MAPS
997 * or via retro_get_memory_data/retro_get_memory_size.
999 * This must be called before the first call to retro_run.
1001 #define RETRO_ENVIRONMENT_SET_HW_RENDER_CONTEXT_NEGOTIATION_INTERFACE (43 | RETRO_ENVIRONMENT_EXPERIMENTAL)
1002 /* const struct retro_hw_render_context_negotiation_interface * --
1003 * Sets an interface which lets the libretro core negotiate with frontend how a context is created.
1004 * The semantics of this interface depends on which API is used in SET_HW_RENDER earlier.
1005 * This interface will be used when the frontend is trying to create a HW rendering context,
1006 * so it will be used after SET_HW_RENDER, but before the context_reset callback.
1008 #define RETRO_ENVIRONMENT_SET_SERIALIZATION_QUIRKS 44
1010 * Sets quirk flags associated with serialization. The frontend will zero any flags it doesn't
1011 * recognize or support. Should be set in either retro_init or retro_load_game, but not both.
1013 #define RETRO_ENVIRONMENT_SET_HW_SHARED_CONTEXT (44 | RETRO_ENVIRONMENT_EXPERIMENTAL)
1015 * The frontend will try to use a 'shared' hardware context (mostly applicable
1016 * to OpenGL) when a hardware context is being set up.
1018 * Returns true if the frontend supports shared hardware contexts and false
1019 * if the frontend does not support shared hardware contexts.
1021 * This will do nothing on its own until SET_HW_RENDER env callbacks are
1024 #define RETRO_ENVIRONMENT_GET_VFS_INTERFACE (45 | RETRO_ENVIRONMENT_EXPERIMENTAL)
1025 /* struct retro_vfs_interface_info * --
1026 * Gets access to the VFS interface.
1027 * VFS presence needs to be queried prior to load_game or any
1028 * get_system/save/other_directory being called to let front end know
1029 * core supports VFS before it starts handing out paths.
1030 * It is recomended to do so in retro_set_environment
1032 #define RETRO_ENVIRONMENT_GET_LED_INTERFACE (46 | RETRO_ENVIRONMENT_EXPERIMENTAL)
1033 /* struct retro_led_interface * --
1034 * Gets an interface which is used by a libretro core to set
1037 #define RETRO_ENVIRONMENT_GET_AUDIO_VIDEO_ENABLE (47 | RETRO_ENVIRONMENT_EXPERIMENTAL)
1039 * Tells the core if the frontend wants audio or video.
1040 * If disabled, the frontend will discard the audio or video,
1041 * so the core may decide to skip generating a frame or generating audio.
1042 * This is mainly used for increasing performance.
1043 * Bit 0 (value 1): Enable Video
1044 * Bit 1 (value 2): Enable Audio
1045 * Bit 2 (value 4): Use Fast Savestates.
1046 * Bit 3 (value 8): Hard Disable Audio
1047 * Other bits are reserved for future use and will default to zero.
1048 * If video is disabled:
1049 * * The frontend wants the core to not generate any video,
1050 * including presenting frames via hardware acceleration.
1051 * * The frontend's video frame callback will do nothing.
1052 * * After running the frame, the video output of the next frame should be
1053 * no different than if video was enabled, and saving and loading state
1054 * should have no issues.
1055 * If audio is disabled:
1056 * * The frontend wants the core to not generate any audio.
1057 * * The frontend's audio callbacks will do nothing.
1058 * * After running the frame, the audio output of the next frame should be
1059 * no different than if audio was enabled, and saving and loading state
1060 * should have no issues.
1062 * * Guaranteed to be created by the same binary that will load them.
1063 * * Will not be written to or read from the disk.
1064 * * Suggest that the core assumes loading state will succeed.
1065 * * Suggest that the core updates its memory buffers in-place if possible.
1066 * * Suggest that the core skips clearing memory.
1067 * * Suggest that the core skips resetting the system.
1068 * * Suggest that the core may skip validation steps.
1069 * Hard Disable Audio:
1070 * * Used for a secondary core when running ahead.
1071 * * Indicates that the frontend will never need audio from the core.
1072 * * Suggests that the core may stop synthesizing audio, but this should not
1073 * compromise emulation accuracy.
1074 * * Audio output for the next frame does not matter, and the frontend will
1075 * never need an accurate audio state in the future.
1076 * * State will never be saved when using Hard Disable Audio.
1078 #define RETRO_ENVIRONMENT_GET_MIDI_INTERFACE (48 | RETRO_ENVIRONMENT_EXPERIMENTAL)
1079 /* struct retro_midi_interface ** --
1080 * Returns a MIDI interface that can be used for raw data I/O.
1083 #define RETRO_ENVIRONMENT_GET_FASTFORWARDING (49 | RETRO_ENVIRONMENT_EXPERIMENTAL)
1085 * Boolean value that indicates whether or not the frontend is in
1086 * fastforwarding mode.
1089 #define RETRO_ENVIRONMENT_GET_TARGET_REFRESH_RATE (50 | RETRO_ENVIRONMENT_EXPERIMENTAL)
1091 * Float value that lets us know what target refresh rate
1092 * is curently in use by the frontend.
1094 * The core can use the returned value to set an ideal
1095 * refresh rate/framerate.
1098 #define RETRO_ENVIRONMENT_GET_INPUT_BITMASKS (51 | RETRO_ENVIRONMENT_EXPERIMENTAL)
1100 * Boolean value that indicates whether or not the frontend supports
1101 * input bitmasks being returned by retro_input_state_t. The advantage
1102 * of this is that retro_input_state_t has to be only called once to
1103 * grab all button states instead of multiple times.
1105 * If it returns true, you can pass RETRO_DEVICE_ID_JOYPAD_MASK as 'id'
1106 * to retro_input_state_t (make sure 'device' is set to RETRO_DEVICE_JOYPAD).
1107 * It will return a bitmask of all the digital buttons.
1110 #define RETRO_ENVIRONMENT_GET_CORE_OPTIONS_VERSION 52
1112 * Unsigned value is the API version number of the core options
1113 * interface supported by the frontend. If callback return false,
1114 * API version is assumed to be 0.
1116 * In legacy code, core options are set by passing an array of
1117 * retro_variable structs to RETRO_ENVIRONMENT_SET_VARIABLES.
1118 * This may be still be done regardless of the core options
1119 * interface version.
1121 * If version is >= 1 however, core options may instead be set by
1122 * passing an array of retro_core_option_definition structs to
1123 * RETRO_ENVIRONMENT_SET_CORE_OPTIONS, or a 2D array of
1124 * retro_core_option_definition structs to RETRO_ENVIRONMENT_SET_CORE_OPTIONS_INTL.
1125 * This allows the core to additionally set option sublabel information
1126 * and/or provide localisation support.
1129 #define RETRO_ENVIRONMENT_SET_CORE_OPTIONS 53
1130 /* const struct retro_core_option_definition ** --
1131 * Allows an implementation to signal the environment
1132 * which variables it might want to check for later using
1134 * This allows the frontend to present these variables to
1135 * a user dynamically.
1136 * This should only be called if RETRO_ENVIRONMENT_GET_CORE_OPTIONS_VERSION
1137 * returns an API version of >= 1.
1138 * This should be called instead of RETRO_ENVIRONMENT_SET_VARIABLES.
1139 * This should be called the first time as early as
1140 * possible (ideally in retro_set_environment).
1141 * Afterwards it may be called again for the core to communicate
1142 * updated options to the frontend, but the number of core
1143 * options must not change from the number in the initial call.
1145 * 'data' points to an array of retro_core_option_definition structs
1146 * terminated by a { NULL, NULL, NULL, {{0}}, NULL } element.
1147 * retro_core_option_definition::key should be namespaced to not collide
1148 * with other implementations' keys. e.g. A core called
1149 * 'foo' should use keys named as 'foo_option'.
1150 * retro_core_option_definition::desc should contain a human readable
1151 * description of the key.
1152 * retro_core_option_definition::info should contain any additional human
1153 * readable information text that a typical user may need to
1154 * understand the functionality of the option.
1155 * retro_core_option_definition::values is an array of retro_core_option_value
1156 * structs terminated by a { NULL, NULL } element.
1157 * > retro_core_option_definition::values[index].value is an expected option
1159 * > retro_core_option_definition::values[index].label is a human readable
1160 * label used when displaying the value on screen. If NULL,
1161 * the value itself is used.
1162 * retro_core_option_definition::default_value is the default core option
1163 * setting. It must match one of the expected option values in the
1164 * retro_core_option_definition::values array. If it does not, or the
1165 * default value is NULL, the first entry in the
1166 * retro_core_option_definition::values array is treated as the default.
1168 * The number of possible options should be very limited,
1169 * and must be less than RETRO_NUM_CORE_OPTION_VALUES_MAX.
1170 * i.e. it should be feasible to cycle through options
1171 * without a keyboard.
1176 * "Speed hack coprocessor X",
1177 * "Provides increased performance at the expense of reduced accuracy",
1179 * { "false", NULL },
1181 * { "unstable", "Turbo (Unstable)" },
1187 * Only strings are operated on. The possible values will
1188 * generally be displayed and stored as-is by the frontend.
1191 #define RETRO_ENVIRONMENT_SET_CORE_OPTIONS_INTL 54
1192 /* const struct retro_core_options_intl * --
1193 * Allows an implementation to signal the environment
1194 * which variables it might want to check for later using
1196 * This allows the frontend to present these variables to
1197 * a user dynamically.
1198 * This should only be called if RETRO_ENVIRONMENT_GET_CORE_OPTIONS_VERSION
1199 * returns an API version of >= 1.
1200 * This should be called instead of RETRO_ENVIRONMENT_SET_VARIABLES.
1201 * This should be called the first time as early as
1202 * possible (ideally in retro_set_environment).
1203 * Afterwards it may be called again for the core to communicate
1204 * updated options to the frontend, but the number of core
1205 * options must not change from the number in the initial call.
1207 * This is fundamentally the same as RETRO_ENVIRONMENT_SET_CORE_OPTIONS,
1208 * with the addition of localisation support. The description of the
1209 * RETRO_ENVIRONMENT_SET_CORE_OPTIONS callback should be consulted
1210 * for further details.
1212 * 'data' points to a retro_core_options_intl struct.
1214 * retro_core_options_intl::us is a pointer to an array of
1215 * retro_core_option_definition structs defining the US English
1216 * core options implementation. It must point to a valid array.
1218 * retro_core_options_intl::local is a pointer to an array of
1219 * retro_core_option_definition structs defining core options for
1220 * the current frontend language. It may be NULL (in which case
1221 * retro_core_options_intl::us is used by the frontend). Any items
1222 * missing from this array will be read from retro_core_options_intl::us
1225 * NOTE: Default core option values are always taken from the
1226 * retro_core_options_intl::us array. Any default values in
1227 * retro_core_options_intl::local array will be ignored.
1230 #define RETRO_ENVIRONMENT_SET_CORE_OPTIONS_DISPLAY 55
1231 /* struct retro_core_option_display * --
1233 * Allows an implementation to signal the environment to show
1234 * or hide a variable when displaying core options. This is
1235 * considered a *suggestion*. The frontend is free to ignore
1236 * this callback, and its implementation not considered mandatory.
1238 * 'data' points to a retro_core_option_display struct
1240 * retro_core_option_display::key is a variable identifier
1241 * which has already been set by SET_VARIABLES/SET_CORE_OPTIONS.
1243 * retro_core_option_display::visible is a boolean, specifying
1244 * whether variable should be displayed
1246 * Note that all core option variables will be set visible by
1247 * default when calling SET_VARIABLES/SET_CORE_OPTIONS.
1250 #define RETRO_ENVIRONMENT_GET_PREFERRED_HW_RENDER 56
1253 * Allows an implementation to ask frontend preferred hardware
1254 * context to use. Core should use this information to deal
1255 * with what specific context to request with SET_HW_RENDER.
1257 * 'data' points to an unsigned variable
1260 #define RETRO_ENVIRONMENT_GET_DISK_CONTROL_INTERFACE_VERSION 57
1262 * Unsigned value is the API version number of the disk control
1263 * interface supported by the frontend. If callback return false,
1264 * API version is assumed to be 0.
1266 * In legacy code, the disk control interface is defined by passing
1267 * a struct of type retro_disk_control_callback to
1268 * RETRO_ENVIRONMENT_SET_DISK_CONTROL_INTERFACE.
1269 * This may be still be done regardless of the disk control
1270 * interface version.
1272 * If version is >= 1 however, the disk control interface may
1273 * instead be defined by passing a struct of type
1274 * retro_disk_control_ext_callback to
1275 * RETRO_ENVIRONMENT_SET_DISK_CONTROL_EXT_INTERFACE.
1276 * This allows the core to provide additional information about
1277 * disk images to the frontend and/or enables extra
1278 * disk control functionality by the frontend.
1281 #define RETRO_ENVIRONMENT_SET_DISK_CONTROL_EXT_INTERFACE 58
1282 /* const struct retro_disk_control_ext_callback * --
1283 * Sets an interface which frontend can use to eject and insert
1284 * disk images, and also obtain information about individual
1285 * disk image files registered by the core.
1286 * This is used for games which consist of multiple images and
1287 * must be manually swapped out by the user (e.g. PSX, floppy disk
1291 #define RETRO_ENVIRONMENT_GET_MESSAGE_INTERFACE_VERSION 59
1293 * Unsigned value is the API version number of the message
1294 * interface supported by the frontend. If callback returns
1295 * false, API version is assumed to be 0.
1297 * In legacy code, messages may be displayed in an
1298 * implementation-specific manner by passing a struct
1299 * of type retro_message to RETRO_ENVIRONMENT_SET_MESSAGE.
1300 * This may be still be done regardless of the message
1301 * interface version.
1303 * If version is >= 1 however, messages may instead be
1304 * displayed by passing a struct of type retro_message_ext
1305 * to RETRO_ENVIRONMENT_SET_MESSAGE_EXT. This allows the
1306 * core to specify message logging level, priority and
1307 * destination (OSD, logging interface or both).
1310 #define RETRO_ENVIRONMENT_SET_MESSAGE_EXT 60
1311 /* const struct retro_message_ext * --
1312 * Sets a message to be displayed in an implementation-specific
1313 * manner for a certain amount of 'frames'. Additionally allows
1314 * the core to specify message logging level, priority and
1315 * destination (OSD, logging interface or both).
1316 * Should not be used for trivial messages, which should simply be
1317 * logged via RETRO_ENVIRONMENT_GET_LOG_INTERFACE (or as a
1318 * fallback, stderr).
1321 /* VFS functionality */
1324 * File paths passed as parameters when using this API shall be well formed UNIX-style,
1325 * using "/" (unquoted forward slash) as directory separator regardless of the platform's native separator.
1326 * Paths shall also include at least one forward slash ("game.bin" is an invalid path, use "./game.bin" instead).
1327 * Other than the directory separator, cores shall not make assumptions about path format:
1328 * "C:/path/game.bin", "http://example.com/game.bin", "#game/game.bin", "./game.bin" (without quotes) are all valid paths.
1329 * Cores may replace the basename or remove path components from the end, and/or add new components;
1330 * however, cores shall not append "./", "../" or multiple consecutive forward slashes ("//") to paths they request to front end.
1331 * The frontend is encouraged to make such paths work as well as it can, but is allowed to give up if the core alters paths too much.
1332 * Frontends are encouraged, but not required, to support native file system paths (modulo replacing the directory separator, if applicable).
1333 * Cores are allowed to try using them, but must remain functional if the front rejects such requests.
1334 * Cores are encouraged to use the libretro-common filestream functions for file I/O,
1335 * as they seamlessly integrate with VFS, deal with directory separator replacement as appropriate
1336 * and provide platform-specific fallbacks in cases where front ends do not support VFS. */
1338 /* Opaque file handle
1339 * Introduced in VFS API v1 */
1340 struct retro_vfs_file_handle;
1342 /* Opaque directory handle
1343 * Introduced in VFS API v3 */
1344 struct retro_vfs_dir_handle;
1347 * Introduced in VFS API v1 */
1348 #define RETRO_VFS_FILE_ACCESS_READ (1 << 0) /* Read only mode */
1349 #define RETRO_VFS_FILE_ACCESS_WRITE (1 << 1) /* Write only mode, discard contents and overwrites existing file unless RETRO_VFS_FILE_ACCESS_UPDATE is also specified */
1350 #define RETRO_VFS_FILE_ACCESS_READ_WRITE (RETRO_VFS_FILE_ACCESS_READ | RETRO_VFS_FILE_ACCESS_WRITE) /* Read-write mode, discard contents and overwrites existing file unless RETRO_VFS_FILE_ACCESS_UPDATE is also specified*/
1351 #define RETRO_VFS_FILE_ACCESS_UPDATE_EXISTING (1 << 2) /* Prevents discarding content of existing files opened for writing */
1353 /* These are only hints. The frontend may choose to ignore them. Other than RAM/CPU/etc use,
1354 and how they react to unlikely external interference (for example someone else writing to that file,
1355 or the file's server going down), behavior will not change. */
1356 #define RETRO_VFS_FILE_ACCESS_HINT_NONE (0)
1357 /* Indicate that the file will be accessed many times. The frontend should aggressively cache everything. */
1358 #define RETRO_VFS_FILE_ACCESS_HINT_FREQUENT_ACCESS (1 << 0)
1360 /* Seek positions */
1361 #define RETRO_VFS_SEEK_POSITION_START 0
1362 #define RETRO_VFS_SEEK_POSITION_CURRENT 1
1363 #define RETRO_VFS_SEEK_POSITION_END 2
1365 /* stat() result flags
1366 * Introduced in VFS API v3 */
1367 #define RETRO_VFS_STAT_IS_VALID (1 << 0)
1368 #define RETRO_VFS_STAT_IS_DIRECTORY (1 << 1)
1369 #define RETRO_VFS_STAT_IS_CHARACTER_SPECIAL (1 << 2)
1371 /* Get path from opaque handle. Returns the exact same path passed to file_open when getting the handle
1372 * Introduced in VFS API v1 */
1373 typedef const char *(RETRO_CALLCONV *retro_vfs_get_path_t)(struct retro_vfs_file_handle *stream);
1375 /* Open a file for reading or writing. If path points to a directory, this will
1376 * fail. Returns the opaque file handle, or NULL for error.
1377 * Introduced in VFS API v1 */
1378 typedef struct retro_vfs_file_handle *(RETRO_CALLCONV *retro_vfs_open_t)(const char *path, unsigned mode, unsigned hints);
1380 /* Close the file and release its resources. Must be called if open_file returns non-NULL. Returns 0 on success, -1 on failure.
1381 * Whether the call succeeds ot not, the handle passed as parameter becomes invalid and should no longer be used.
1382 * Introduced in VFS API v1 */
1383 typedef int (RETRO_CALLCONV *retro_vfs_close_t)(struct retro_vfs_file_handle *stream);
1385 /* Return the size of the file in bytes, or -1 for error.
1386 * Introduced in VFS API v1 */
1387 typedef int64_t (RETRO_CALLCONV *retro_vfs_size_t)(struct retro_vfs_file_handle *stream);
1389 /* Truncate file to specified size. Returns 0 on success or -1 on error
1390 * Introduced in VFS API v2 */
1391 typedef int64_t (RETRO_CALLCONV *retro_vfs_truncate_t)(struct retro_vfs_file_handle *stream, int64_t length);
1393 /* Get the current read / write position for the file. Returns -1 for error.
1394 * Introduced in VFS API v1 */
1395 typedef int64_t (RETRO_CALLCONV *retro_vfs_tell_t)(struct retro_vfs_file_handle *stream);
1397 /* Set the current read/write position for the file. Returns the new position, -1 for error.
1398 * Introduced in VFS API v1 */
1399 typedef int64_t (RETRO_CALLCONV *retro_vfs_seek_t)(struct retro_vfs_file_handle *stream, int64_t offset, int seek_position);
1401 /* Read data from a file. Returns the number of bytes read, or -1 for error.
1402 * Introduced in VFS API v1 */
1403 typedef int64_t (RETRO_CALLCONV *retro_vfs_read_t)(struct retro_vfs_file_handle *stream, void *s, uint64_t len);
1405 /* Write data to a file. Returns the number of bytes written, or -1 for error.
1406 * Introduced in VFS API v1 */
1407 typedef int64_t (RETRO_CALLCONV *retro_vfs_write_t)(struct retro_vfs_file_handle *stream, const void *s, uint64_t len);
1409 /* Flush pending writes to file, if using buffered IO. Returns 0 on sucess, or -1 on failure.
1410 * Introduced in VFS API v1 */
1411 typedef int (RETRO_CALLCONV *retro_vfs_flush_t)(struct retro_vfs_file_handle *stream);
1413 /* Delete the specified file. Returns 0 on success, -1 on failure
1414 * Introduced in VFS API v1 */
1415 typedef int (RETRO_CALLCONV *retro_vfs_remove_t)(const char *path);
1417 /* Rename the specified file. Returns 0 on success, -1 on failure
1418 * Introduced in VFS API v1 */
1419 typedef int (RETRO_CALLCONV *retro_vfs_rename_t)(const char *old_path, const char *new_path);
1421 /* Stat the specified file. Retruns a bitmask of RETRO_VFS_STAT_* flags, none are set if path was not valid.
1422 * Additionally stores file size in given variable, unless NULL is given.
1423 * Introduced in VFS API v3 */
1424 typedef int (RETRO_CALLCONV *retro_vfs_stat_t)(const char *path, int32_t *size);
1426 /* Create the specified directory. Returns 0 on success, -1 on unknown failure, -2 if already exists.
1427 * Introduced in VFS API v3 */
1428 typedef int (RETRO_CALLCONV *retro_vfs_mkdir_t)(const char *dir);
1430 /* Open the specified directory for listing. Returns the opaque dir handle, or NULL for error.
1431 * Support for the include_hidden argument may vary depending on the platform.
1432 * Introduced in VFS API v3 */
1433 typedef struct retro_vfs_dir_handle *(RETRO_CALLCONV *retro_vfs_opendir_t)(const char *dir, bool include_hidden);
1435 /* Read the directory entry at the current position, and move the read pointer to the next position.
1436 * Returns true on success, false if already on the last entry.
1437 * Introduced in VFS API v3 */
1438 typedef bool (RETRO_CALLCONV *retro_vfs_readdir_t)(struct retro_vfs_dir_handle *dirstream);
1440 /* Get the name of the last entry read. Returns a string on success, or NULL for error.
1441 * The returned string pointer is valid until the next call to readdir or closedir.
1442 * Introduced in VFS API v3 */
1443 typedef const char *(RETRO_CALLCONV *retro_vfs_dirent_get_name_t)(struct retro_vfs_dir_handle *dirstream);
1445 /* Check if the last entry read was a directory. Returns true if it was, false otherwise (or on error).
1446 * Introduced in VFS API v3 */
1447 typedef bool (RETRO_CALLCONV *retro_vfs_dirent_is_dir_t)(struct retro_vfs_dir_handle *dirstream);
1449 /* Close the directory and release its resources. Must be called if opendir returns non-NULL. Returns 0 on success, -1 on failure.
1450 * Whether the call succeeds ot not, the handle passed as parameter becomes invalid and should no longer be used.
1451 * Introduced in VFS API v3 */
1452 typedef int (RETRO_CALLCONV *retro_vfs_closedir_t)(struct retro_vfs_dir_handle *dirstream);
1454 struct retro_vfs_interface
1457 retro_vfs_get_path_t get_path;
1458 retro_vfs_open_t open;
1459 retro_vfs_close_t close;
1460 retro_vfs_size_t size;
1461 retro_vfs_tell_t tell;
1462 retro_vfs_seek_t seek;
1463 retro_vfs_read_t read;
1464 retro_vfs_write_t write;
1465 retro_vfs_flush_t flush;
1466 retro_vfs_remove_t remove;
1467 retro_vfs_rename_t rename;
1469 retro_vfs_truncate_t truncate;
1471 retro_vfs_stat_t stat;
1472 retro_vfs_mkdir_t mkdir;
1473 retro_vfs_opendir_t opendir;
1474 retro_vfs_readdir_t readdir;
1475 retro_vfs_dirent_get_name_t dirent_get_name;
1476 retro_vfs_dirent_is_dir_t dirent_is_dir;
1477 retro_vfs_closedir_t closedir;
1480 struct retro_vfs_interface_info
1482 /* Set by core: should this be higher than the version the front end supports,
1483 * front end will return false in the RETRO_ENVIRONMENT_GET_VFS_INTERFACE call
1484 * Introduced in VFS API v1 */
1485 uint32_t required_interface_version;
1487 /* Frontend writes interface pointer here. The frontend also sets the actual
1488 * version, must be at least required_interface_version.
1489 * Introduced in VFS API v1 */
1490 struct retro_vfs_interface *iface;
1493 enum retro_hw_render_interface_type
1495 RETRO_HW_RENDER_INTERFACE_VULKAN = 0,
1496 RETRO_HW_RENDER_INTERFACE_D3D9 = 1,
1497 RETRO_HW_RENDER_INTERFACE_D3D10 = 2,
1498 RETRO_HW_RENDER_INTERFACE_D3D11 = 3,
1499 RETRO_HW_RENDER_INTERFACE_D3D12 = 4,
1500 RETRO_HW_RENDER_INTERFACE_GSKIT_PS2 = 5,
1501 RETRO_HW_RENDER_INTERFACE_DUMMY = INT_MAX
1504 /* Base struct. All retro_hw_render_interface_* types
1505 * contain at least these fields. */
1506 struct retro_hw_render_interface
1508 enum retro_hw_render_interface_type interface_type;
1509 unsigned interface_version;
1512 typedef void (RETRO_CALLCONV *retro_set_led_state_t)(int led, int state);
1513 struct retro_led_interface
1515 retro_set_led_state_t set_led_state;
1518 /* Retrieves the current state of the MIDI input.
1519 * Returns true if it's enabled, false otherwise. */
1520 typedef bool (RETRO_CALLCONV *retro_midi_input_enabled_t)(void);
1522 /* Retrieves the current state of the MIDI output.
1523 * Returns true if it's enabled, false otherwise */
1524 typedef bool (RETRO_CALLCONV *retro_midi_output_enabled_t)(void);
1526 /* Reads next byte from the input stream.
1527 * Returns true if byte is read, false otherwise. */
1528 typedef bool (RETRO_CALLCONV *retro_midi_read_t)(uint8_t *byte);
1530 /* Writes byte to the output stream.
1531 * 'delta_time' is in microseconds and represent time elapsed since previous write.
1532 * Returns true if byte is written, false otherwise. */
1533 typedef bool (RETRO_CALLCONV *retro_midi_write_t)(uint8_t byte, uint32_t delta_time);
1535 /* Flushes previously written data.
1536 * Returns true if successful, false otherwise. */
1537 typedef bool (RETRO_CALLCONV *retro_midi_flush_t)(void);
1539 struct retro_midi_interface
1541 retro_midi_input_enabled_t input_enabled;
1542 retro_midi_output_enabled_t output_enabled;
1543 retro_midi_read_t read;
1544 retro_midi_write_t write;
1545 retro_midi_flush_t flush;
1548 enum retro_hw_render_context_negotiation_interface_type
1550 RETRO_HW_RENDER_CONTEXT_NEGOTIATION_INTERFACE_VULKAN = 0,
1551 RETRO_HW_RENDER_CONTEXT_NEGOTIATION_INTERFACE_DUMMY = INT_MAX
1554 /* Base struct. All retro_hw_render_context_negotiation_interface_* types
1555 * contain at least these fields. */
1556 struct retro_hw_render_context_negotiation_interface
1558 enum retro_hw_render_context_negotiation_interface_type interface_type;
1559 unsigned interface_version;
1562 /* Serialized state is incomplete in some way. Set if serialization is
1563 * usable in typical end-user cases but should not be relied upon to
1564 * implement frame-sensitive frontend features such as netplay or
1566 #define RETRO_SERIALIZATION_QUIRK_INCOMPLETE (1 << 0)
1567 /* The core must spend some time initializing before serialization is
1568 * supported. retro_serialize() will initially fail; retro_unserialize()
1569 * and retro_serialize_size() may or may not work correctly either. */
1570 #define RETRO_SERIALIZATION_QUIRK_MUST_INITIALIZE (1 << 1)
1571 /* Serialization size may change within a session. */
1572 #define RETRO_SERIALIZATION_QUIRK_CORE_VARIABLE_SIZE (1 << 2)
1573 /* Set by the frontend to acknowledge that it supports variable-sized
1575 #define RETRO_SERIALIZATION_QUIRK_FRONT_VARIABLE_SIZE (1 << 3)
1576 /* Serialized state can only be loaded during the same session. */
1577 #define RETRO_SERIALIZATION_QUIRK_SINGLE_SESSION (1 << 4)
1578 /* Serialized state cannot be loaded on an architecture with a different
1579 * endianness from the one it was saved on. */
1580 #define RETRO_SERIALIZATION_QUIRK_ENDIAN_DEPENDENT (1 << 5)
1581 /* Serialized state cannot be loaded on a different platform from the one it
1582 * was saved on for reasons other than endianness, such as word size
1584 #define RETRO_SERIALIZATION_QUIRK_PLATFORM_DEPENDENT (1 << 6)
1586 #define RETRO_MEMDESC_CONST (1 << 0) /* The frontend will never change this memory area once retro_load_game has returned. */
1587 #define RETRO_MEMDESC_BIGENDIAN (1 << 1) /* The memory area contains big endian data. Default is little endian. */
1588 #define RETRO_MEMDESC_SYSTEM_RAM (1 << 2) /* The memory area is system RAM. This is main RAM of the gaming system. */
1589 #define RETRO_MEMDESC_SAVE_RAM (1 << 3) /* The memory area is save RAM. This RAM is usually found on a game cartridge, backed up by a battery. */
1590 #define RETRO_MEMDESC_VIDEO_RAM (1 << 4) /* The memory area is video RAM (VRAM) */
1591 #define RETRO_MEMDESC_ALIGN_2 (1 << 16) /* All memory access in this area is aligned to their own size, or 2, whichever is smaller. */
1592 #define RETRO_MEMDESC_ALIGN_4 (2 << 16)
1593 #define RETRO_MEMDESC_ALIGN_8 (3 << 16)
1594 #define RETRO_MEMDESC_MINSIZE_2 (1 << 24) /* All memory in this region is accessed at least 2 bytes at the time. */
1595 #define RETRO_MEMDESC_MINSIZE_4 (2 << 24)
1596 #define RETRO_MEMDESC_MINSIZE_8 (3 << 24)
1597 struct retro_memory_descriptor
1601 /* Pointer to the start of the relevant ROM or RAM chip.
1602 * It's strongly recommended to use 'offset' if possible, rather than
1603 * doing math on the pointer.
1605 * If the same byte is mapped my multiple descriptors, their descriptors
1606 * must have the same pointer.
1607 * If 'start' does not point to the first byte in the pointer, put the
1608 * difference in 'offset' instead.
1610 * May be NULL if there's nothing usable here (e.g. hardware registers and
1611 * open bus). No flags should be set if the pointer is NULL.
1612 * It's recommended to minimize the number of descriptors if possible,
1613 * but not mandatory. */
1617 /* This is the location in the emulated address space
1618 * where the mapping starts. */
1621 /* Which bits must be same as in 'start' for this mapping to apply.
1622 * The first memory descriptor to claim a certain byte is the one
1624 * A bit which is set in 'start' must also be set in this.
1625 * Can be zero, in which case each byte is assumed mapped exactly once.
1626 * In this case, 'len' must be a power of two. */
1629 /* If this is nonzero, the set bits are assumed not connected to the
1630 * memory chip's address pins. */
1633 /* This one tells the size of the current memory area.
1634 * If, after start+disconnect are applied, the address is higher than
1635 * this, the highest bit of the address is cleared.
1637 * If the address is still too high, the next highest bit is cleared.
1638 * Can be zero, in which case it's assumed to be infinite (as limited
1639 * by 'select' and 'disconnect'). */
1642 /* To go from emulated address to physical address, the following
1644 * Subtract 'start', pick off 'disconnect', apply 'len', add 'offset'. */
1646 /* The address space name must consist of only a-zA-Z0-9_-,
1647 * should be as short as feasible (maximum length is 8 plus the NUL),
1648 * and may not be any other address space plus one or more 0-9A-F
1650 * However, multiple memory descriptors for the same address space is
1651 * allowed, and the address space name can be empty. NULL is treated
1654 * Address space names are case sensitive, but avoid lowercase if possible.
1655 * The same pointer may exist in multiple address spaces.
1658 * blank+blank - valid (multiple things may be mapped in the same namespace)
1659 * 'Sp'+'Sp' - valid (multiple things may be mapped in the same namespace)
1660 * 'A'+'B' - valid (neither is a prefix of each other)
1661 * 'S'+blank - valid ('S' is not in 0-9A-F)
1662 * 'a'+blank - valid ('a' is not in 0-9A-F)
1663 * 'a'+'A' - valid (neither is a prefix of each other)
1664 * 'AR'+blank - valid ('R' is not in 0-9A-F)
1665 * 'ARB'+blank - valid (the B can't be part of the address either, because
1666 * there is no namespace 'AR')
1667 * blank+'B' - not valid, because it's ambigous which address space B1234
1669 * The length can't be used for that purpose; the frontend may want
1670 * to append arbitrary data to an address, without a separator. */
1671 const char *addrspace;
1673 /* TODO: When finalizing this one, add a description field, which should be
1674 * "WRAM" or something roughly equally long. */
1676 /* TODO: When finalizing this one, replace 'select' with 'limit', which tells
1677 * which bits can vary and still refer to the same address (limit = ~select).
1678 * TODO: limit? range? vary? something else? */
1680 /* TODO: When finalizing this one, if 'len' is above what 'select' (or
1681 * 'limit') allows, it's bankswitched. Bankswitched data must have both 'len'
1682 * and 'select' != 0, and the mappings don't tell how the system switches the
1685 /* TODO: When finalizing this one, fix the 'len' bit removal order.
1686 * For len=0x1800, pointer 0x1C00 should go to 0x1400, not 0x0C00.
1687 * Algorithm: Take bits highest to lowest, but if it goes above len, clear
1688 * the most recent addition and continue on the next bit.
1689 * TODO: Can the above be optimized? Is "remove the lowest bit set in both
1690 * pointer and 'len'" equivalent? */
1692 /* TODO: Some emulators (MAME?) emulate big endian systems by only accessing
1693 * the emulated memory in 32-bit chunks, native endian. But that's nothing
1694 * compared to Darek Mihocka <http://www.emulators.com/docs/nx07_vm101.htm>
1695 * (section Emulation 103 - Nearly Free Byte Reversal) - he flips the ENTIRE
1696 * RAM backwards! I'll want to represent both of those, via some flags.
1698 * I suspect MAME either didn't think of that idea, or don't want the #ifdef.
1699 * Not sure which, nor do I really care. */
1701 /* TODO: Some of those flags are unused and/or don't really make sense. Clean
1705 /* The frontend may use the largest value of 'start'+'select' in a
1706 * certain namespace to infer the size of the address space.
1708 * If the address space is larger than that, a mapping with .ptr=NULL
1709 * should be at the end of the array, with .select set to all ones for
1710 * as long as the address space is big.
1712 * Sample descriptors (minus .ptr, and RETRO_MEMFLAG_ on the flags):
1714 * .start=0x7E0000, .len=0x20000
1715 * (Note that this must be mapped before the ROM in most cases; some of the
1717 * try to claim $7E0000, or at least $7E8000.)
1719 * .addrspace="S", .len=0x10000
1720 * SNES WRAM mirrors:
1721 * .flags=MIRROR, .start=0x000000, .select=0xC0E000, .len=0x2000
1722 * .flags=MIRROR, .start=0x800000, .select=0xC0E000, .len=0x2000
1723 * SNES WRAM mirrors, alternate equivalent descriptor:
1724 * .flags=MIRROR, .select=0x40E000, .disconnect=~0x1FFF
1725 * (Various similar constructions can be created by combining parts of
1727 * SNES LoROM (512KB, mirrored a couple of times):
1728 * .flags=CONST, .start=0x008000, .select=0x408000, .disconnect=0x8000, .len=512*1024
1729 * .flags=CONST, .start=0x400000, .select=0x400000, .disconnect=0x8000, .len=512*1024
1731 * .flags=CONST, .start=0x400000, .select=0x400000, .len=4*1024*1024
1732 * .flags=CONST, .offset=0x8000, .start=0x008000, .select=0x408000, .len=4*1024*1024
1733 * SNES ExHiROM (8MB):
1734 * .flags=CONST, .offset=0, .start=0xC00000, .select=0xC00000, .len=4*1024*1024
1735 * .flags=CONST, .offset=4*1024*1024, .start=0x400000, .select=0xC00000, .len=4*1024*1024
1736 * .flags=CONST, .offset=0x8000, .start=0x808000, .select=0xC08000, .len=4*1024*1024
1737 * .flags=CONST, .offset=4*1024*1024+0x8000, .start=0x008000, .select=0xC08000, .len=4*1024*1024
1738 * Clarify the size of the address space:
1739 * .ptr=NULL, .select=0xFFFFFF
1740 * .len can be implied by .select in many of them, but was included for clarity.
1743 struct retro_memory_map
1745 const struct retro_memory_descriptor *descriptors;
1746 unsigned num_descriptors;
1749 struct retro_controller_description
1751 /* Human-readable description of the controller. Even if using a generic
1752 * input device type, this can be set to the particular device type the
1756 /* Device type passed to retro_set_controller_port_device(). If the device
1757 * type is a sub-class of a generic input device type, use the
1758 * RETRO_DEVICE_SUBCLASS macro to create an ID.
1760 * E.g. RETRO_DEVICE_SUBCLASS(RETRO_DEVICE_JOYPAD, 1). */
1764 struct retro_controller_info
1766 const struct retro_controller_description *types;
1770 struct retro_subsystem_memory_info
1772 /* The extension associated with a memory type, e.g. "psram". */
1773 const char *extension;
1775 /* The memory type for retro_get_memory(). This should be at
1776 * least 0x100 to avoid conflict with standardized
1777 * libretro memory types. */
1781 struct retro_subsystem_rom_info
1783 /* Describes what the content is (SGB BIOS, GB ROM, etc). */
1786 /* Same definition as retro_get_system_info(). */
1787 const char *valid_extensions;
1789 /* Same definition as retro_get_system_info(). */
1792 /* Same definition as retro_get_system_info(). */
1795 /* This is set if the content is required to load a game.
1796 * If this is set to false, a zeroed-out retro_game_info can be passed. */
1799 /* Content can have multiple associated persistent
1800 * memory types (retro_get_memory()). */
1801 const struct retro_subsystem_memory_info *memory;
1802 unsigned num_memory;
1805 struct retro_subsystem_info
1807 /* Human-readable string of the subsystem type, e.g. "Super GameBoy" */
1810 /* A computer friendly short string identifier for the subsystem type.
1811 * This name must be [a-z].
1812 * E.g. if desc is "Super GameBoy", this can be "sgb".
1813 * This identifier can be used for command-line interfaces, etc.
1817 /* Infos for each content file. The first entry is assumed to be the
1818 * "most significant" content for frontend purposes.
1819 * E.g. with Super GameBoy, the first content should be the GameBoy ROM,
1820 * as it is the most "significant" content to a user.
1821 * If a frontend creates new file paths based on the content used
1822 * (e.g. savestates), it should use the path for the first ROM to do so. */
1823 const struct retro_subsystem_rom_info *roms;
1825 /* Number of content files associated with a subsystem. */
1828 /* The type passed to retro_load_game_special(). */
1832 typedef void (RETRO_CALLCONV *retro_proc_address_t)(void);
1834 /* libretro API extension functions:
1835 * (None here so far).
1837 * Get a symbol from a libretro core.
1838 * Cores should only return symbols which are actual
1839 * extensions to the libretro API.
1841 * Frontends should not use this to obtain symbols to standard
1842 * libretro entry points (static linking or dlsym).
1844 * The symbol name must be equal to the function name,
1845 * e.g. if void retro_foo(void); exists, the symbol must be called "retro_foo".
1846 * The returned function pointer must be cast to the corresponding type.
1848 typedef retro_proc_address_t (RETRO_CALLCONV *retro_get_proc_address_t)(const char *sym);
1850 struct retro_get_proc_address_interface
1852 retro_get_proc_address_t get_proc_address;
1855 enum retro_log_level
1857 RETRO_LOG_DEBUG = 0,
1862 RETRO_LOG_DUMMY = INT_MAX
1865 /* Logging function. Takes log level argument as well. */
1866 typedef void (RETRO_CALLCONV *retro_log_printf_t)(enum retro_log_level level,
1867 const char *fmt, ...);
1869 struct retro_log_callback
1871 retro_log_printf_t log;
1874 /* Performance related functions */
1876 /* ID values for SIMD CPU features */
1877 #define RETRO_SIMD_SSE (1 << 0)
1878 #define RETRO_SIMD_SSE2 (1 << 1)
1879 #define RETRO_SIMD_VMX (1 << 2)
1880 #define RETRO_SIMD_VMX128 (1 << 3)
1881 #define RETRO_SIMD_AVX (1 << 4)
1882 #define RETRO_SIMD_NEON (1 << 5)
1883 #define RETRO_SIMD_SSE3 (1 << 6)
1884 #define RETRO_SIMD_SSSE3 (1 << 7)
1885 #define RETRO_SIMD_MMX (1 << 8)
1886 #define RETRO_SIMD_MMXEXT (1 << 9)
1887 #define RETRO_SIMD_SSE4 (1 << 10)
1888 #define RETRO_SIMD_SSE42 (1 << 11)
1889 #define RETRO_SIMD_AVX2 (1 << 12)
1890 #define RETRO_SIMD_VFPU (1 << 13)
1891 #define RETRO_SIMD_PS (1 << 14)
1892 #define RETRO_SIMD_AES (1 << 15)
1893 #define RETRO_SIMD_VFPV3 (1 << 16)
1894 #define RETRO_SIMD_VFPV4 (1 << 17)
1895 #define RETRO_SIMD_POPCNT (1 << 18)
1896 #define RETRO_SIMD_MOVBE (1 << 19)
1897 #define RETRO_SIMD_CMOV (1 << 20)
1898 #define RETRO_SIMD_ASIMD (1 << 21)
1900 typedef uint64_t retro_perf_tick_t;
1901 typedef int64_t retro_time_t;
1903 struct retro_perf_counter
1906 retro_perf_tick_t start;
1907 retro_perf_tick_t total;
1908 retro_perf_tick_t call_cnt;
1913 /* Returns current time in microseconds.
1914 * Tries to use the most accurate timer available.
1916 typedef retro_time_t (RETRO_CALLCONV *retro_perf_get_time_usec_t)(void);
1918 /* A simple counter. Usually nanoseconds, but can also be CPU cycles.
1919 * Can be used directly if desired (when creating a more sophisticated
1920 * performance counter system).
1922 typedef retro_perf_tick_t (RETRO_CALLCONV *retro_perf_get_counter_t)(void);
1924 /* Returns a bit-mask of detected CPU features (RETRO_SIMD_*). */
1925 typedef uint64_t (RETRO_CALLCONV *retro_get_cpu_features_t)(void);
1927 /* Asks frontend to log and/or display the state of performance counters.
1928 * Performance counters can always be poked into manually as well.
1930 typedef void (RETRO_CALLCONV *retro_perf_log_t)(void);
1932 /* Register a performance counter.
1933 * ident field must be set with a discrete value and other values in
1934 * retro_perf_counter must be 0.
1935 * Registering can be called multiple times. To avoid calling to
1936 * frontend redundantly, you can check registered field first. */
1937 typedef void (RETRO_CALLCONV *retro_perf_register_t)(struct retro_perf_counter *counter);
1939 /* Starts a registered counter. */
1940 typedef void (RETRO_CALLCONV *retro_perf_start_t)(struct retro_perf_counter *counter);
1942 /* Stops a registered counter. */
1943 typedef void (RETRO_CALLCONV *retro_perf_stop_t)(struct retro_perf_counter *counter);
1945 /* For convenience it can be useful to wrap register, start and stop in macros.
1947 * #ifdef LOG_PERFORMANCE
1948 * #define RETRO_PERFORMANCE_INIT(perf_cb, name) static struct retro_perf_counter name = {#name}; if (!name.registered) perf_cb.perf_register(&(name))
1949 * #define RETRO_PERFORMANCE_START(perf_cb, name) perf_cb.perf_start(&(name))
1950 * #define RETRO_PERFORMANCE_STOP(perf_cb, name) perf_cb.perf_stop(&(name))
1952 * ... Blank macros ...
1955 * These can then be used mid-functions around code snippets.
1957 * extern struct retro_perf_callback perf_cb; * Somewhere in the core.
1959 * void do_some_heavy_work(void)
1961 * RETRO_PERFORMANCE_INIT(cb, work_1;
1962 * RETRO_PERFORMANCE_START(cb, work_1);
1964 * RETRO_PERFORMANCE_STOP(cb, work_1);
1966 * RETRO_PERFORMANCE_INIT(cb, work_2);
1967 * RETRO_PERFORMANCE_START(cb, work_2);
1969 * RETRO_PERFORMANCE_STOP(cb, work_2);
1972 * void retro_deinit(void)
1974 * perf_cb.perf_log(); * Log all perf counters here for example.
1978 struct retro_perf_callback
1980 retro_perf_get_time_usec_t get_time_usec;
1981 retro_get_cpu_features_t get_cpu_features;
1983 retro_perf_get_counter_t get_perf_counter;
1984 retro_perf_register_t perf_register;
1985 retro_perf_start_t perf_start;
1986 retro_perf_stop_t perf_stop;
1987 retro_perf_log_t perf_log;
1990 /* FIXME: Document the sensor API and work out behavior.
1991 * It will be marked as experimental until then.
1993 enum retro_sensor_action
1995 RETRO_SENSOR_ACCELEROMETER_ENABLE = 0,
1996 RETRO_SENSOR_ACCELEROMETER_DISABLE,
1997 RETRO_SENSOR_GYROSCOPE_ENABLE,
1998 RETRO_SENSOR_GYROSCOPE_DISABLE,
1999 RETRO_SENSOR_ILLUMINANCE_ENABLE,
2000 RETRO_SENSOR_ILLUMINANCE_DISABLE,
2002 RETRO_SENSOR_DUMMY = INT_MAX
2005 /* Id values for SENSOR types. */
2006 #define RETRO_SENSOR_ACCELEROMETER_X 0
2007 #define RETRO_SENSOR_ACCELEROMETER_Y 1
2008 #define RETRO_SENSOR_ACCELEROMETER_Z 2
2009 #define RETRO_SENSOR_GYROSCOPE_X 3
2010 #define RETRO_SENSOR_GYROSCOPE_Y 4
2011 #define RETRO_SENSOR_GYROSCOPE_Z 5
2012 #define RETRO_SENSOR_ILLUMINANCE 6
2014 typedef bool (RETRO_CALLCONV *retro_set_sensor_state_t)(unsigned port,
2015 enum retro_sensor_action action, unsigned rate);
2017 typedef float (RETRO_CALLCONV *retro_sensor_get_input_t)(unsigned port, unsigned id);
2019 struct retro_sensor_interface
2021 retro_set_sensor_state_t set_sensor_state;
2022 retro_sensor_get_input_t get_sensor_input;
2025 enum retro_camera_buffer
2027 RETRO_CAMERA_BUFFER_OPENGL_TEXTURE = 0,
2028 RETRO_CAMERA_BUFFER_RAW_FRAMEBUFFER,
2030 RETRO_CAMERA_BUFFER_DUMMY = INT_MAX
2033 /* Starts the camera driver. Can only be called in retro_run(). */
2034 typedef bool (RETRO_CALLCONV *retro_camera_start_t)(void);
2036 /* Stops the camera driver. Can only be called in retro_run(). */
2037 typedef void (RETRO_CALLCONV *retro_camera_stop_t)(void);
2039 /* Callback which signals when the camera driver is initialized
2040 * and/or deinitialized.
2041 * retro_camera_start_t can be called in initialized callback.
2043 typedef void (RETRO_CALLCONV *retro_camera_lifetime_status_t)(void);
2045 /* A callback for raw framebuffer data. buffer points to an XRGB8888 buffer.
2046 * Width, height and pitch are similar to retro_video_refresh_t.
2047 * First pixel is top-left origin.
2049 typedef void (RETRO_CALLCONV *retro_camera_frame_raw_framebuffer_t)(const uint32_t *buffer,
2050 unsigned width, unsigned height, size_t pitch);
2052 /* A callback for when OpenGL textures are used.
2054 * texture_id is a texture owned by camera driver.
2055 * Its state or content should be considered immutable, except for things like
2056 * texture filtering and clamping.
2058 * texture_target is the texture target for the GL texture.
2059 * These can include e.g. GL_TEXTURE_2D, GL_TEXTURE_RECTANGLE, and possibly
2060 * more depending on extensions.
2062 * affine points to a packed 3x3 column-major matrix used to apply an affine
2063 * transform to texture coordinates. (affine_matrix * vec3(coord_x, coord_y, 1.0))
2064 * After transform, normalized texture coord (0, 0) should be bottom-left
2065 * and (1, 1) should be top-right (or (width, height) for RECTANGLE).
2067 * GL-specific typedefs are avoided here to avoid relying on gl.h in
2068 * the API definition.
2070 typedef void (RETRO_CALLCONV *retro_camera_frame_opengl_texture_t)(unsigned texture_id,
2071 unsigned texture_target, const float *affine);
2073 struct retro_camera_callback
2075 /* Set by libretro core.
2076 * Example bitmask: caps = (1 << RETRO_CAMERA_BUFFER_OPENGL_TEXTURE) | (1 << RETRO_CAMERA_BUFFER_RAW_FRAMEBUFFER).
2080 /* Desired resolution for camera. Is only used as a hint. */
2084 /* Set by frontend. */
2085 retro_camera_start_t start;
2086 retro_camera_stop_t stop;
2088 /* Set by libretro core if raw framebuffer callbacks will be used. */
2089 retro_camera_frame_raw_framebuffer_t frame_raw_framebuffer;
2091 /* Set by libretro core if OpenGL texture callbacks will be used. */
2092 retro_camera_frame_opengl_texture_t frame_opengl_texture;
2094 /* Set by libretro core. Called after camera driver is initialized and
2095 * ready to be started.
2096 * Can be NULL, in which this callback is not called.
2098 retro_camera_lifetime_status_t initialized;
2100 /* Set by libretro core. Called right before camera driver is
2102 * Can be NULL, in which this callback is not called.
2104 retro_camera_lifetime_status_t deinitialized;
2107 /* Sets the interval of time and/or distance at which to update/poll
2108 * location-based data.
2110 * To ensure compatibility with all location-based implementations,
2111 * values for both interval_ms and interval_distance should be provided.
2113 * interval_ms is the interval expressed in milliseconds.
2114 * interval_distance is the distance interval expressed in meters.
2116 typedef void (RETRO_CALLCONV *retro_location_set_interval_t)(unsigned interval_ms,
2117 unsigned interval_distance);
2119 /* Start location services. The device will start listening for changes to the
2120 * current location at regular intervals (which are defined with
2121 * retro_location_set_interval_t). */
2122 typedef bool (RETRO_CALLCONV *retro_location_start_t)(void);
2124 /* Stop location services. The device will stop listening for changes
2125 * to the current location. */
2126 typedef void (RETRO_CALLCONV *retro_location_stop_t)(void);
2128 /* Get the position of the current location. Will set parameters to
2129 * 0 if no new location update has happened since the last time. */
2130 typedef bool (RETRO_CALLCONV *retro_location_get_position_t)(double *lat, double *lon,
2131 double *horiz_accuracy, double *vert_accuracy);
2133 /* Callback which signals when the location driver is initialized
2134 * and/or deinitialized.
2135 * retro_location_start_t can be called in initialized callback.
2137 typedef void (RETRO_CALLCONV *retro_location_lifetime_status_t)(void);
2139 struct retro_location_callback
2141 retro_location_start_t start;
2142 retro_location_stop_t stop;
2143 retro_location_get_position_t get_position;
2144 retro_location_set_interval_t set_interval;
2146 retro_location_lifetime_status_t initialized;
2147 retro_location_lifetime_status_t deinitialized;
2150 enum retro_rumble_effect
2152 RETRO_RUMBLE_STRONG = 0,
2153 RETRO_RUMBLE_WEAK = 1,
2155 RETRO_RUMBLE_DUMMY = INT_MAX
2158 /* Sets rumble state for joypad plugged in port 'port'.
2159 * Rumble effects are controlled independently,
2160 * and setting e.g. strong rumble does not override weak rumble.
2161 * Strength has a range of [0, 0xffff].
2163 * Returns true if rumble state request was honored.
2164 * Calling this before first retro_run() is likely to return false. */
2165 typedef bool (RETRO_CALLCONV *retro_set_rumble_state_t)(unsigned port,
2166 enum retro_rumble_effect effect, uint16_t strength);
2168 struct retro_rumble_interface
2170 retro_set_rumble_state_t set_rumble_state;
2173 /* Notifies libretro that audio data should be written. */
2174 typedef void (RETRO_CALLCONV *retro_audio_callback_t)(void);
2176 /* True: Audio driver in frontend is active, and callback is
2177 * expected to be called regularily.
2178 * False: Audio driver in frontend is paused or inactive.
2179 * Audio callback will not be called until set_state has been
2181 * Initial state is false (inactive).
2183 typedef void (RETRO_CALLCONV *retro_audio_set_state_callback_t)(bool enabled);
2185 struct retro_audio_callback
2187 retro_audio_callback_t callback;
2188 retro_audio_set_state_callback_t set_state;
2191 /* Notifies a libretro core of time spent since last invocation
2192 * of retro_run() in microseconds.
2194 * It will be called right before retro_run() every frame.
2195 * The frontend can tamper with timing to support cases like
2196 * fast-forward, slow-motion and framestepping.
2198 * In those scenarios the reference frame time value will be used. */
2199 typedef int64_t retro_usec_t;
2200 typedef void (RETRO_CALLCONV *retro_frame_time_callback_t)(retro_usec_t usec);
2201 struct retro_frame_time_callback
2203 retro_frame_time_callback_t callback;
2204 /* Represents the time of one frame. It is computed as
2205 * 1000000 / fps, but the implementation will resolve the
2206 * rounding to ensure that framestepping, etc is exact. */
2207 retro_usec_t reference;
2210 /* Pass this to retro_video_refresh_t if rendering to hardware.
2211 * Passing NULL to retro_video_refresh_t is still a frame dupe as normal.
2213 #define RETRO_HW_FRAME_BUFFER_VALID ((void*)-1)
2215 /* Invalidates the current HW context.
2216 * Any GL state is lost, and must not be deinitialized explicitly.
2217 * If explicit deinitialization is desired by the libretro core,
2218 * it should implement context_destroy callback.
2219 * If called, all GPU resources must be reinitialized.
2220 * Usually called when frontend reinits video driver.
2221 * Also called first time video driver is initialized,
2222 * allowing libretro core to initialize resources.
2224 typedef void (RETRO_CALLCONV *retro_hw_context_reset_t)(void);
2226 /* Gets current framebuffer which is to be rendered to.
2227 * Could change every frame potentially.
2229 typedef uintptr_t (RETRO_CALLCONV *retro_hw_get_current_framebuffer_t)(void);
2231 /* Get a symbol from HW context. */
2232 typedef retro_proc_address_t (RETRO_CALLCONV *retro_hw_get_proc_address_t)(const char *sym);
2234 enum retro_hw_context_type
2236 RETRO_HW_CONTEXT_NONE = 0,
2237 /* OpenGL 2.x. Driver can choose to use latest compatibility context. */
2238 RETRO_HW_CONTEXT_OPENGL = 1,
2239 /* OpenGL ES 2.0. */
2240 RETRO_HW_CONTEXT_OPENGLES2 = 2,
2241 /* Modern desktop core GL context. Use version_major/
2242 * version_minor fields to set GL version. */
2243 RETRO_HW_CONTEXT_OPENGL_CORE = 3,
2245 RETRO_HW_CONTEXT_OPENGLES3 = 4,
2246 /* OpenGL ES 3.1+. Set version_major/version_minor. For GLES2 and GLES3,
2247 * use the corresponding enums directly. */
2248 RETRO_HW_CONTEXT_OPENGLES_VERSION = 5,
2250 /* Vulkan, see RETRO_ENVIRONMENT_GET_HW_RENDER_INTERFACE. */
2251 RETRO_HW_CONTEXT_VULKAN = 6,
2253 /* Direct3D, set version_major to select the type of interface
2254 * returned by RETRO_ENVIRONMENT_GET_HW_RENDER_INTERFACE */
2255 RETRO_HW_CONTEXT_DIRECT3D = 7,
2257 RETRO_HW_CONTEXT_DUMMY = INT_MAX
2260 struct retro_hw_render_callback
2262 /* Which API to use. Set by libretro core. */
2263 enum retro_hw_context_type context_type;
2265 /* Called when a context has been created or when it has been reset.
2266 * An OpenGL context is only valid after context_reset() has been called.
2268 * When context_reset is called, OpenGL resources in the libretro
2269 * implementation are guaranteed to be invalid.
2271 * It is possible that context_reset is called multiple times during an
2272 * application lifecycle.
2273 * If context_reset is called without any notification (context_destroy),
2274 * the OpenGL context was lost and resources should just be recreated
2275 * without any attempt to "free" old resources.
2277 retro_hw_context_reset_t context_reset;
2280 * TODO: This is rather obsolete. The frontend should not
2281 * be providing preallocated framebuffers. */
2282 retro_hw_get_current_framebuffer_t get_current_framebuffer;
2285 * Can return all relevant functions, including glClear on Windows. */
2286 retro_hw_get_proc_address_t get_proc_address;
2288 /* Set if render buffers should have depth component attached.
2289 * TODO: Obsolete. */
2292 /* Set if stencil buffers should be attached.
2293 * TODO: Obsolete. */
2296 /* If depth and stencil are true, a packed 24/8 buffer will be added.
2297 * Only attaching stencil is invalid and will be ignored. */
2299 /* Use conventional bottom-left origin convention. If false,
2300 * standard libretro top-left origin semantics are used.
2301 * TODO: Move to GL specific interface. */
2302 bool bottom_left_origin;
2304 /* Major version number for core GL context or GLES 3.1+. */
2305 unsigned version_major;
2307 /* Minor version number for core GL context or GLES 3.1+. */
2308 unsigned version_minor;
2310 /* If this is true, the frontend will go very far to avoid
2311 * resetting context in scenarios like toggling fullscreen, etc.
2312 * TODO: Obsolete? Maybe frontend should just always assume this ...
2316 /* The reset callback might still be called in extreme situations
2317 * such as if the context is lost beyond recovery.
2319 * For optimal stability, set this to false, and allow context to be
2320 * reset at any time.
2323 /* A callback to be called before the context is destroyed in a
2324 * controlled way by the frontend. */
2325 retro_hw_context_reset_t context_destroy;
2327 /* OpenGL resources can be deinitialized cleanly at this step.
2328 * context_destroy can be set to NULL, in which resources will
2329 * just be destroyed without any notification.
2331 * Even when context_destroy is non-NULL, it is possible that
2332 * context_reset is called without any destroy notification.
2333 * This happens if context is lost by external factors (such as
2334 * notified by GL_ARB_robustness).
2336 * In this case, the context is assumed to be already dead,
2337 * and the libretro implementation must not try to free any OpenGL
2338 * resources in the subsequent context_reset.
2341 /* Creates a debug context. */
2345 /* Callback type passed in RETRO_ENVIRONMENT_SET_KEYBOARD_CALLBACK.
2346 * Called by the frontend in response to keyboard events.
2347 * down is set if the key is being pressed, or false if it is being released.
2348 * keycode is the RETROK value of the char.
2349 * character is the text character of the pressed key. (UTF-32).
2350 * key_modifiers is a set of RETROKMOD values or'ed together.
2352 * The pressed/keycode state can be indepedent of the character.
2353 * It is also possible that multiple characters are generated from a
2355 * Keycode events should be treated separately from character events.
2356 * However, when possible, the frontend should try to synchronize these.
2357 * If only a character is posted, keycode should be RETROK_UNKNOWN.
2359 * Similarily if only a keycode event is generated with no corresponding
2360 * character, character should be 0.
2362 typedef void (RETRO_CALLCONV *retro_keyboard_event_t)(bool down, unsigned keycode,
2363 uint32_t character, uint16_t key_modifiers);
2365 struct retro_keyboard_callback
2367 retro_keyboard_event_t callback;
2370 /* Callbacks for RETRO_ENVIRONMENT_SET_DISK_CONTROL_INTERFACE &
2371 * RETRO_ENVIRONMENT_SET_DISK_CONTROL_EXT_INTERFACE.
2372 * Should be set for implementations which can swap out multiple disk
2373 * images in runtime.
2375 * If the implementation can do this automatically, it should strive to do so.
2376 * However, there are cases where the user must manually do so.
2378 * Overview: To swap a disk image, eject the disk image with
2379 * set_eject_state(true).
2380 * Set the disk index with set_image_index(index). Insert the disk again
2381 * with set_eject_state(false).
2384 /* If ejected is true, "ejects" the virtual disk tray.
2385 * When ejected, the disk image index can be set.
2387 typedef bool (RETRO_CALLCONV *retro_set_eject_state_t)(bool ejected);
2389 /* Gets current eject state. The initial state is 'not ejected'. */
2390 typedef bool (RETRO_CALLCONV *retro_get_eject_state_t)(void);
2392 /* Gets current disk index. First disk is index 0.
2393 * If return value is >= get_num_images(), no disk is currently inserted.
2395 typedef unsigned (RETRO_CALLCONV *retro_get_image_index_t)(void);
2397 /* Sets image index. Can only be called when disk is ejected.
2398 * The implementation supports setting "no disk" by using an
2399 * index >= get_num_images().
2401 typedef bool (RETRO_CALLCONV *retro_set_image_index_t)(unsigned index);
2403 /* Gets total number of images which are available to use. */
2404 typedef unsigned (RETRO_CALLCONV *retro_get_num_images_t)(void);
2406 struct retro_game_info;
2408 /* Replaces the disk image associated with index.
2409 * Arguments to pass in info have same requirements as retro_load_game().
2410 * Virtual disk tray must be ejected when calling this.
2412 * Replacing a disk image with info = NULL will remove the disk image
2413 * from the internal list.
2414 * As a result, calls to get_image_index() can change.
2416 * E.g. replace_image_index(1, NULL), and previous get_image_index()
2417 * returned 4 before.
2418 * Index 1 will be removed, and the new index is 3.
2420 typedef bool (RETRO_CALLCONV *retro_replace_image_index_t)(unsigned index,
2421 const struct retro_game_info *info);
2423 /* Adds a new valid index (get_num_images()) to the internal disk list.
2424 * This will increment subsequent return values from get_num_images() by 1.
2425 * This image index cannot be used until a disk image has been set
2426 * with replace_image_index. */
2427 typedef bool (RETRO_CALLCONV *retro_add_image_index_t)(void);
2429 /* Sets initial image to insert in drive when calling
2431 * Since we cannot pass the initial index when loading
2432 * content (this would require a major API change), this
2433 * is set by the frontend *before* calling the core's
2434 * retro_load_game()/retro_load_game_special() implementation.
2435 * A core should therefore cache the index/path values and handle
2436 * them inside retro_load_game()/retro_load_game_special().
2437 * - If 'index' is invalid (index >= get_num_images()), the
2438 * core should ignore the set value and instead use 0
2439 * - 'path' is used purely for error checking - i.e. when
2440 * content is loaded, the core should verify that the
2441 * disk specified by 'index' has the specified file path.
2442 * This is to guard against auto selecting the wrong image
2443 * if (for example) the user should modify an existing M3U
2444 * playlist. We have to let the core handle this because
2445 * set_initial_image() must be called before loading content,
2446 * i.e. the frontend cannot access image paths in advance
2447 * and thus cannot perform the error check itself.
2448 * If set path and content path do not match, the core should
2449 * ignore the set 'index' value and instead use 0
2450 * Returns 'false' if index or 'path' are invalid, or core
2451 * does not support this functionality
2453 typedef bool (RETRO_CALLCONV *retro_set_initial_image_t)(unsigned index, const char *path);
2455 /* Fetches the path of the specified disk image file.
2456 * Returns 'false' if index is invalid (index >= get_num_images())
2457 * or path is otherwise unavailable.
2459 typedef bool (RETRO_CALLCONV *retro_get_image_path_t)(unsigned index, char *path, size_t len);
2461 /* Fetches a core-provided 'label' for the specified disk
2462 * image file. In the simplest case this may be a file name
2463 * (without extension), but for cores with more complex
2464 * content requirements information may be provided to
2465 * facilitate user disk swapping - for example, a core
2466 * running floppy-disk-based content may uniquely label
2467 * save disks, data disks, level disks, etc. with names
2468 * corresponding to in-game disk change prompts (so the
2469 * frontend can provide better user guidance than a 'dumb'
2470 * disk index value).
2471 * Returns 'false' if index is invalid (index >= get_num_images())
2472 * or label is otherwise unavailable.
2474 typedef bool (RETRO_CALLCONV *retro_get_image_label_t)(unsigned index, char *label, size_t len);
2476 struct retro_disk_control_callback
2478 retro_set_eject_state_t set_eject_state;
2479 retro_get_eject_state_t get_eject_state;
2481 retro_get_image_index_t get_image_index;
2482 retro_set_image_index_t set_image_index;
2483 retro_get_num_images_t get_num_images;
2485 retro_replace_image_index_t replace_image_index;
2486 retro_add_image_index_t add_image_index;
2489 struct retro_disk_control_ext_callback
2491 retro_set_eject_state_t set_eject_state;
2492 retro_get_eject_state_t get_eject_state;
2494 retro_get_image_index_t get_image_index;
2495 retro_set_image_index_t set_image_index;
2496 retro_get_num_images_t get_num_images;
2498 retro_replace_image_index_t replace_image_index;
2499 retro_add_image_index_t add_image_index;
2501 /* NOTE: Frontend will only attempt to record/restore
2502 * last used disk index if both set_initial_image()
2503 * and get_image_path() are implemented */
2504 retro_set_initial_image_t set_initial_image; /* Optional - may be NULL */
2506 retro_get_image_path_t get_image_path; /* Optional - may be NULL */
2507 retro_get_image_label_t get_image_label; /* Optional - may be NULL */
2510 enum retro_pixel_format
2512 /* 0RGB1555, native endian.
2513 * 0 bit must be set to 0.
2514 * This pixel format is default for compatibility concerns only.
2515 * If a 15/16-bit pixel format is desired, consider using RGB565. */
2516 RETRO_PIXEL_FORMAT_0RGB1555 = 0,
2518 /* XRGB8888, native endian.
2519 * X bits are ignored. */
2520 RETRO_PIXEL_FORMAT_XRGB8888 = 1,
2522 /* RGB565, native endian.
2523 * This pixel format is the recommended format to use if a 15/16-bit
2524 * format is desired as it is the pixel format that is typically
2525 * available on a wide range of low-power devices.
2527 * It is also natively supported in APIs like OpenGL ES. */
2528 RETRO_PIXEL_FORMAT_RGB565 = 2,
2530 /* Ensure sizeof() == sizeof(int). */
2531 RETRO_PIXEL_FORMAT_UNKNOWN = INT_MAX
2534 struct retro_message
2536 const char *msg; /* Message to be displayed. */
2537 unsigned frames; /* Duration in frames of message. */
2540 enum retro_message_target
2542 RETRO_MESSAGE_TARGET_ALL = 0,
2543 RETRO_MESSAGE_TARGET_OSD,
2544 RETRO_MESSAGE_TARGET_LOG
2547 enum retro_message_type
2549 RETRO_MESSAGE_TYPE_NOTIFICATION = 0,
2550 RETRO_MESSAGE_TYPE_NOTIFICATION_ALT,
2551 RETRO_MESSAGE_TYPE_STATUS,
2552 RETRO_MESSAGE_TYPE_PROGRESS
2555 struct retro_message_ext
2557 /* Message string to be displayed/logged */
2559 /* Duration (in ms) of message when targeting the OSD */
2561 /* Message priority when targeting the OSD
2562 * > When multiple concurrent messages are sent to
2563 * the frontend and the frontend does not have the
2564 * capacity to display them all, messages with the
2565 * *highest* priority value should be shown
2566 * > There is no upper limit to a message priority
2567 * value (within the bounds of the unsigned data type)
2568 * > In the reference frontend (RetroArch), the same
2569 * priority values are used for frontend-generated
2570 * notifications, which are typically assigned values
2571 * between 0 and 3 depending upon importance */
2573 /* Message logging level (info, warn, error, etc.) */
2574 enum retro_log_level level;
2575 /* Message destination: OSD, logging interface or both */
2576 enum retro_message_target target;
2577 /* Message 'type' when targeting the OSD
2578 * > RETRO_MESSAGE_TYPE_NOTIFICATION: Specifies that a
2579 * message should be handled in identical fashion to
2580 * a standard frontend-generated notification
2581 * > RETRO_MESSAGE_TYPE_NOTIFICATION_ALT: Specifies that
2582 * message is a notification that requires user attention
2583 * or action, but that it should be displayed in a manner
2584 * that differs from standard frontend-generated notifications.
2585 * This would typically correspond to messages that should be
2586 * displayed immediately (independently from any internal
2587 * frontend message queue), and/or which should be visually
2588 * distinguishable from frontend-generated notifications.
2589 * For example, a core may wish to inform the user of
2590 * information related to a disk-change event. It is
2591 * expected that the frontend itself may provide a
2592 * notification in this case; if the core sends a
2593 * message of type RETRO_MESSAGE_TYPE_NOTIFICATION, an
2594 * uncomfortable 'double-notification' may occur. A message
2595 * of RETRO_MESSAGE_TYPE_NOTIFICATION_ALT should therefore
2596 * be presented such that visual conflict with regular
2597 * notifications does not occur
2598 * > RETRO_MESSAGE_TYPE_STATUS: Indicates that message
2599 * is not a standard notification. This typically
2600 * corresponds to 'status' indicators, such as a core's
2601 * internal FPS, which are intended to be displayed
2602 * either permanently while a core is running, or in
2603 * a manner that does not suggest user attention or action
2604 * is required. 'Status' type messages should therefore be
2605 * displayed in a different on-screen location and in a manner
2606 * easily distinguishable from both standard frontend-generated
2607 * notifications and messages of type RETRO_MESSAGE_TYPE_NOTIFICATION_ALT
2608 * > RETRO_MESSAGE_TYPE_PROGRESS: Indicates that message reports
2609 * the progress of an internal core task. For example, in cases
2610 * where a core itself handles the loading of content from a file,
2611 * this may correspond to the percentage of the file that has been
2612 * read. Alternatively, an audio/video playback core may use a
2613 * message of type RETRO_MESSAGE_TYPE_PROGRESS to display the current
2614 * playback position as a percentage of the runtime. 'Progress' type
2615 * messages should therefore be displayed as a literal progress bar,
2617 * - 'retro_message_ext.msg' is the progress bar title/label
2618 * - 'retro_message_ext.progress' determines the length of
2620 * NOTE: Message type is a *hint*, and may be ignored
2621 * by the frontend. If a frontend lacks support for
2622 * displaying messages via alternate means than standard
2623 * frontend-generated notifications, it will treat *all*
2624 * messages as having the type RETRO_MESSAGE_TYPE_NOTIFICATION */
2625 enum retro_message_type type;
2626 /* Task progress when targeting the OSD and message is
2627 * of type RETRO_MESSAGE_TYPE_PROGRESS
2628 * > -1: Unmetered/indeterminate
2629 * > 0-100: Current progress percentage
2630 * NOTE: Since message type is a hint, a frontend may ignore
2631 * progress values. Where relevant, a core should therefore
2632 * include progress percentage within the message string,
2633 * such that the message intent remains clear when displayed
2634 * as a standard frontend-generated notification */
2638 /* Describes how the libretro implementation maps a libretro input bind
2639 * to its internal input system through a human readable string.
2640 * This string can be used to better let a user configure input. */
2641 struct retro_input_descriptor
2643 /* Associates given parameters with a description. */
2649 /* Human readable description for parameters.
2650 * The pointer must remain valid until
2651 * retro_unload_game() is called. */
2652 const char *description;
2655 struct retro_system_info
2657 /* All pointers are owned by libretro implementation, and pointers must
2658 * remain valid until retro_deinit() is called. */
2660 const char *library_name; /* Descriptive name of library. Should not
2661 * contain any version numbers, etc. */
2662 const char *library_version; /* Descriptive version of core. */
2664 const char *valid_extensions; /* A string listing probably content
2665 * extensions the core will be able to
2666 * load, separated with pipe.
2667 * I.e. "bin|rom|iso".
2668 * Typically used for a GUI to filter
2669 * out extensions. */
2671 /* Libretro cores that need to have direct access to their content
2672 * files, including cores which use the path of the content files to
2673 * determine the paths of other files, should set need_fullpath to true.
2675 * Cores should strive for setting need_fullpath to false,
2676 * as it allows the frontend to perform patching, etc.
2678 * If need_fullpath is true and retro_load_game() is called:
2679 * - retro_game_info::path is guaranteed to have a valid path
2680 * - retro_game_info::data and retro_game_info::size are invalid
2682 * If need_fullpath is false and retro_load_game() is called:
2683 * - retro_game_info::path may be NULL
2684 * - retro_game_info::data and retro_game_info::size are guaranteed
2688 * - RETRO_ENVIRONMENT_GET_SYSTEM_DIRECTORY
2689 * - RETRO_ENVIRONMENT_GET_SAVE_DIRECTORY
2693 /* If true, the frontend is not allowed to extract any archives before
2694 * loading the real content.
2695 * Necessary for certain libretro implementations that load games
2696 * from zipped archives. */
2700 struct retro_game_geometry
2702 unsigned base_width; /* Nominal video width of game. */
2703 unsigned base_height; /* Nominal video height of game. */
2704 unsigned max_width; /* Maximum possible width of game. */
2705 unsigned max_height; /* Maximum possible height of game. */
2707 float aspect_ratio; /* Nominal aspect ratio of game. If
2708 * aspect_ratio is <= 0.0, an aspect ratio
2709 * of base_width / base_height is assumed.
2710 * A frontend could override this setting,
2714 struct retro_system_timing
2716 double fps; /* FPS of video content. */
2717 double sample_rate; /* Sampling rate of audio. */
2720 struct retro_system_av_info
2722 struct retro_game_geometry geometry;
2723 struct retro_system_timing timing;
2726 struct retro_variable
2728 /* Variable to query in RETRO_ENVIRONMENT_GET_VARIABLE.
2729 * If NULL, obtains the complete environment string if more
2730 * complex parsing is necessary.
2731 * The environment string is formatted as key-value pairs
2732 * delimited by semicolons as so:
2733 * "key1=value1;key2=value2;..."
2737 /* Value to be obtained. If key does not exist, it is set to NULL. */
2741 struct retro_core_option_display
2743 /* Variable to configure in RETRO_ENVIRONMENT_SET_CORE_OPTIONS_DISPLAY */
2746 /* Specifies whether variable should be displayed
2747 * when presenting core options to the user */
2751 /* Maximum number of values permitted for a core option
2752 * > Note: We have to set a maximum value due the limitations
2753 * of the C language - i.e. it is not possible to create an
2754 * array of structs each containing a variable sized array,
2755 * so the retro_core_option_definition values array must
2756 * have a fixed size. The size limit of 128 is a balancing
2757 * act - it needs to be large enough to support all 'sane'
2758 * core options, but setting it too large may impact low memory
2759 * platforms. In practise, if a core option has more than
2760 * 128 values then the implementation is likely flawed.
2761 * To quote the above API reference:
2762 * "The number of possible options should be very limited
2763 * i.e. it should be feasible to cycle through options
2764 * without a keyboard."
2766 #define RETRO_NUM_CORE_OPTION_VALUES_MAX 128
2768 struct retro_core_option_value
2770 /* Expected option value */
2773 /* Human-readable value label. If NULL, value itself
2774 * will be displayed by the frontend */
2778 struct retro_core_option_definition
2780 /* Variable to query in RETRO_ENVIRONMENT_GET_VARIABLE. */
2783 /* Human-readable core option description (used as menu label) */
2786 /* Human-readable core option information (used as menu sublabel) */
2789 /* Array of retro_core_option_value structs, terminated by NULL */
2790 struct retro_core_option_value values[RETRO_NUM_CORE_OPTION_VALUES_MAX];
2792 /* Default core option value. Must match one of the values
2793 * in the retro_core_option_value array, otherwise will be
2795 const char *default_value;
2798 struct retro_core_options_intl
2800 /* Pointer to an array of retro_core_option_definition structs
2801 * - US English implementation
2802 * - Must point to a valid array */
2803 struct retro_core_option_definition *us;
2805 /* Pointer to an array of retro_core_option_definition structs
2806 * - Implementation for current frontend language
2808 struct retro_core_option_definition *local;
2811 struct retro_game_info
2813 const char *path; /* Path to game, UTF-8 encoded.
2814 * Sometimes used as a reference for building other paths.
2815 * May be NULL if game was loaded from stdin or similar,
2816 * but in this case some cores will be unable to load `data`.
2817 * So, it is preferable to fabricate something here instead
2818 * of passing NULL, which will help more cores to succeed.
2819 * retro_system_info::need_fullpath requires
2820 * that this path is valid. */
2821 const void *data; /* Memory buffer of loaded game. Will be NULL
2822 * if need_fullpath was set. */
2823 size_t size; /* Size of memory buffer. */
2824 const char *meta; /* String of implementation specific meta-data. */
2827 #define RETRO_MEMORY_ACCESS_WRITE (1 << 0)
2828 /* The core will write to the buffer provided by retro_framebuffer::data. */
2829 #define RETRO_MEMORY_ACCESS_READ (1 << 1)
2830 /* The core will read from retro_framebuffer::data. */
2831 #define RETRO_MEMORY_TYPE_CACHED (1 << 0)
2832 /* The memory in data is cached.
2833 * If not cached, random writes and/or reading from the buffer is expected to be very slow. */
2834 struct retro_framebuffer
2836 void *data; /* The framebuffer which the core can render into.
2837 Set by frontend in GET_CURRENT_SOFTWARE_FRAMEBUFFER.
2838 The initial contents of data are unspecified. */
2839 unsigned width; /* The framebuffer width used by the core. Set by core. */
2840 unsigned height; /* The framebuffer height used by the core. Set by core. */
2841 size_t pitch; /* The number of bytes between the beginning of a scanline,
2842 and beginning of the next scanline.
2843 Set by frontend in GET_CURRENT_SOFTWARE_FRAMEBUFFER. */
2844 enum retro_pixel_format format; /* The pixel format the core must use to render into data.
2845 This format could differ from the format used in
2847 Set by frontend in GET_CURRENT_SOFTWARE_FRAMEBUFFER. */
2849 unsigned access_flags; /* How the core will access the memory in the framebuffer.
2850 RETRO_MEMORY_ACCESS_* flags.
2852 unsigned memory_flags; /* Flags telling core how the memory has been mapped.
2853 RETRO_MEMORY_TYPE_* flags.
2854 Set by frontend in GET_CURRENT_SOFTWARE_FRAMEBUFFER. */
2859 /* Environment callback. Gives implementations a way of performing
2860 * uncommon tasks. Extensible. */
2861 typedef bool (RETRO_CALLCONV *retro_environment_t)(unsigned cmd, void *data);
2863 /* Render a frame. Pixel format is 15-bit 0RGB1555 native endian
2864 * unless changed (see RETRO_ENVIRONMENT_SET_PIXEL_FORMAT).
2866 * Width and height specify dimensions of buffer.
2867 * Pitch specifices length in bytes between two lines in buffer.
2869 * For performance reasons, it is highly recommended to have a frame
2870 * that is packed in memory, i.e. pitch == width * byte_per_pixel.
2871 * Certain graphic APIs, such as OpenGL ES, do not like textures
2872 * that are not packed in memory.
2874 typedef void (RETRO_CALLCONV *retro_video_refresh_t)(const void *data, unsigned width,
2875 unsigned height, size_t pitch);
2877 /* Renders a single audio frame. Should only be used if implementation
2878 * generates a single sample at a time.
2879 * Format is signed 16-bit native endian.
2881 typedef void (RETRO_CALLCONV *retro_audio_sample_t)(int16_t left, int16_t right);
2883 /* Renders multiple audio frames in one go.
2885 * One frame is defined as a sample of left and right channels, interleaved.
2886 * I.e. int16_t buf[4] = { l, r, l, r }; would be 2 frames.
2887 * Only one of the audio callbacks must ever be used.
2889 typedef size_t (RETRO_CALLCONV *retro_audio_sample_batch_t)(const int16_t *data,
2893 typedef void (RETRO_CALLCONV *retro_input_poll_t)(void);
2895 /* Queries for input for player 'port'. device will be masked with
2896 * RETRO_DEVICE_MASK.
2898 * Specialization of devices such as RETRO_DEVICE_JOYPAD_MULTITAP that
2899 * have been set with retro_set_controller_port_device()
2900 * will still use the higher level RETRO_DEVICE_JOYPAD to request input.
2902 typedef int16_t (RETRO_CALLCONV *retro_input_state_t)(unsigned port, unsigned device,
2903 unsigned index, unsigned id);
2905 /* Sets callbacks. retro_set_environment() is guaranteed to be called
2906 * before retro_init().
2908 * The rest of the set_* functions are guaranteed to have been called
2909 * before the first call to retro_run() is made. */
2910 RETRO_API void retro_set_environment(retro_environment_t);
2911 RETRO_API void retro_set_video_refresh(retro_video_refresh_t);
2912 RETRO_API void retro_set_audio_sample(retro_audio_sample_t);
2913 RETRO_API void retro_set_audio_sample_batch(retro_audio_sample_batch_t);
2914 RETRO_API void retro_set_input_poll(retro_input_poll_t);
2915 RETRO_API void retro_set_input_state(retro_input_state_t);
2917 /* Library global initialization/deinitialization. */
2918 RETRO_API void retro_init(void);
2919 RETRO_API void retro_deinit(void);
2921 /* Must return RETRO_API_VERSION. Used to validate ABI compatibility
2922 * when the API is revised. */
2923 RETRO_API unsigned retro_api_version(void);
2925 /* Gets statically known system info. Pointers provided in *info
2926 * must be statically allocated.
2927 * Can be called at any time, even before retro_init(). */
2928 RETRO_API void retro_get_system_info(struct retro_system_info *info);
2930 /* Gets information about system audio/video timings and geometry.
2931 * Can be called only after retro_load_game() has successfully completed.
2932 * NOTE: The implementation of this function might not initialize every
2933 * variable if needed.
2934 * E.g. geom.aspect_ratio might not be initialized if core doesn't
2935 * desire a particular aspect ratio. */
2936 RETRO_API void retro_get_system_av_info(struct retro_system_av_info *info);
2938 /* Sets device to be used for player 'port'.
2939 * By default, RETRO_DEVICE_JOYPAD is assumed to be plugged into all
2941 * Setting a particular device type is not a guarantee that libretro cores
2942 * will only poll input based on that particular device type. It is only a
2943 * hint to the libretro core when a core cannot automatically detect the
2944 * appropriate input device type on its own. It is also relevant when a
2945 * core can change its behavior depending on device type.
2947 * As part of the core's implementation of retro_set_controller_port_device,
2948 * the core should call RETRO_ENVIRONMENT_SET_INPUT_DESCRIPTORS to notify the
2949 * frontend if the descriptions for any controls have changed as a
2950 * result of changing the device type.
2952 RETRO_API void retro_set_controller_port_device(unsigned port, unsigned device);
2954 /* Resets the current game. */
2955 RETRO_API void retro_reset(void);
2957 /* Runs the game for one video frame.
2958 * During retro_run(), input_poll callback must be called at least once.
2960 * If a frame is not rendered for reasons where a game "dropped" a frame,
2961 * this still counts as a frame, and retro_run() should explicitly dupe
2962 * a frame if GET_CAN_DUPE returns true.
2963 * In this case, the video callback can take a NULL argument for data.
2965 RETRO_API void retro_run(void);
2967 /* Returns the amount of data the implementation requires to serialize
2968 * internal state (save states).
2969 * Between calls to retro_load_game() and retro_unload_game(), the
2970 * returned size is never allowed to be larger than a previous returned
2971 * value, to ensure that the frontend can allocate a save state buffer once.
2973 RETRO_API size_t retro_serialize_size(void);
2975 /* Serializes internal state. If failed, or size is lower than
2976 * retro_serialize_size(), it should return false, true otherwise. */
2977 RETRO_API bool retro_serialize(void *data, size_t size);
2978 RETRO_API bool retro_unserialize(const void *data, size_t size);
2980 RETRO_API void retro_cheat_reset(void);
2981 RETRO_API void retro_cheat_set(unsigned index, bool enabled, const char *code);
2984 * Return true to indicate successful loading and false to indicate load failure.
2986 RETRO_API bool retro_load_game(const struct retro_game_info *game);
2988 /* Loads a "special" kind of game. Should not be used,
2989 * except in extreme cases. */
2990 RETRO_API bool retro_load_game_special(
2992 const struct retro_game_info *info, size_t num_info
2995 /* Unloads the currently loaded game. Called before retro_deinit(void). */
2996 RETRO_API void retro_unload_game(void);
2998 /* Gets region of game. */
2999 RETRO_API unsigned retro_get_region(void);
3001 /* Gets region of memory. */
3002 RETRO_API void *retro_get_memory_data(unsigned id);
3003 RETRO_API size_t retro_get_memory_size(unsigned id);
notaz.gp2x.de / pcsx_rearmed.git / blob