1 /* Copyright (C) 2010-2013 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.
30 // Hack applied for MSVC when compiling in C89 mode as it isn't C99 compliant.
34 #if defined(_MSC_VER) && !defined(SN_TARGET_PS3) && !defined(__cplusplus)
35 #define bool unsigned char
43 // Used for checking API/ABI mismatches that can break libretro implementations.
44 // It is not incremented for compatible changes to the API.
45 #define RETRO_API_VERSION 1
47 // Libretro's fundamental device abstractions.
48 #define RETRO_DEVICE_MASK 0xff
49 #define RETRO_DEVICE_NONE 0
51 // The JOYPAD is called RetroPad. It is essentially a Super Nintendo controller,
52 // but with additional L2/R2/L3/R3 buttons, similar to a PS1 DualShock.
53 #define RETRO_DEVICE_JOYPAD 1
55 // The mouse is a simple mouse, similar to Super Nintendo's mouse.
56 // X and Y coordinates are reported relatively to last poll (poll callback).
57 // It is up to the libretro implementation to keep track of where the mouse pointer is supposed to be on the screen.
58 // The frontend must make sure not to interfere with its own hardware mouse pointer.
59 #define RETRO_DEVICE_MOUSE 2
61 // KEYBOARD device lets one poll for raw key pressed.
62 // It is poll based, so input callback will return with the current pressed state.
63 #define RETRO_DEVICE_KEYBOARD 3
65 // Lightgun X/Y coordinates are reported relatively to last poll, similar to mouse.
66 #define RETRO_DEVICE_LIGHTGUN 4
68 // The ANALOG device is an extension to JOYPAD (RetroPad).
69 // Similar to DualShock it adds two analog sticks.
70 // This is treated as a separate device type as it returns values in the full analog range
71 // of [-0x8000, 0x7fff]. Positive X axis is right. Positive Y axis is down.
72 // Only use ANALOG type when polling for analog values of the axes.
73 #define RETRO_DEVICE_ANALOG 5
75 // Abstracts the concept of a pointing mechanism, e.g. touch.
76 // This allows libretro to query in absolute coordinates where on the screen a mouse (or something similar) is being placed.
77 // For a touch centric device, coordinates reported are the coordinates of the press.
79 // Coordinates in X and Y are reported as:
80 // [-0x7fff, 0x7fff]: -0x7fff corresponds to the far left/top of the screen,
81 // and 0x7fff corresponds to the far right/bottom of the screen.
82 // The "screen" is here defined as area that is passed to the frontend and later displayed on the monitor.
83 // The frontend is free to scale/resize this screen as it sees fit, however,
84 // (X, Y) = (-0x7fff, -0x7fff) will correspond to the top-left pixel of the game image, etc.
86 // To check if the pointer coordinates are valid (e.g. a touch display actually being touched),
87 // PRESSED returns 1 or 0.
88 // If using a mouse, PRESSED will usually correspond to the left mouse button.
89 // PRESSED will only return 1 if the pointer is inside the game screen.
91 // For multi-touch, the index variable can be used to successively query more presses.
92 // If index = 0 returns true for _PRESSED, coordinates can be extracted
93 // with _X, _Y for index = 0. One can then query _PRESSED, _X, _Y with index = 1, and so on.
94 // Eventually _PRESSED will return false for an index. No further presses are registered at this point.
95 #define RETRO_DEVICE_POINTER 6
97 // These device types are specializations of the base types above.
98 // They should only be used in retro_set_controller_type() to inform libretro implementations
99 // about use of a very specific device type.
101 // In input state callback, however, only the base type should be used in the 'device' field.
102 #define RETRO_DEVICE_JOYPAD_MULTITAP ((1 << 8) | RETRO_DEVICE_JOYPAD)
103 #define RETRO_DEVICE_LIGHTGUN_SUPER_SCOPE ((1 << 8) | RETRO_DEVICE_LIGHTGUN)
104 #define RETRO_DEVICE_LIGHTGUN_JUSTIFIER ((2 << 8) | RETRO_DEVICE_LIGHTGUN)
105 #define RETRO_DEVICE_LIGHTGUN_JUSTIFIERS ((3 << 8) | RETRO_DEVICE_LIGHTGUN)
107 // Buttons for the RetroPad (JOYPAD).
108 // The placement of these is equivalent to placements on the Super Nintendo controller.
109 // L2/R2/L3/R3 buttons correspond to the PS1 DualShock.
110 #define RETRO_DEVICE_ID_JOYPAD_B 0
111 #define RETRO_DEVICE_ID_JOYPAD_Y 1
112 #define RETRO_DEVICE_ID_JOYPAD_SELECT 2
113 #define RETRO_DEVICE_ID_JOYPAD_START 3
114 #define RETRO_DEVICE_ID_JOYPAD_UP 4
115 #define RETRO_DEVICE_ID_JOYPAD_DOWN 5
116 #define RETRO_DEVICE_ID_JOYPAD_LEFT 6
117 #define RETRO_DEVICE_ID_JOYPAD_RIGHT 7
118 #define RETRO_DEVICE_ID_JOYPAD_A 8
119 #define RETRO_DEVICE_ID_JOYPAD_X 9
120 #define RETRO_DEVICE_ID_JOYPAD_L 10
121 #define RETRO_DEVICE_ID_JOYPAD_R 11
122 #define RETRO_DEVICE_ID_JOYPAD_L2 12
123 #define RETRO_DEVICE_ID_JOYPAD_R2 13
124 #define RETRO_DEVICE_ID_JOYPAD_L3 14
125 #define RETRO_DEVICE_ID_JOYPAD_R3 15
127 // Index / Id values for ANALOG device.
128 #define RETRO_DEVICE_INDEX_ANALOG_LEFT 0
129 #define RETRO_DEVICE_INDEX_ANALOG_RIGHT 1
130 #define RETRO_DEVICE_ID_ANALOG_X 0
131 #define RETRO_DEVICE_ID_ANALOG_Y 1
133 // Id values for MOUSE.
134 #define RETRO_DEVICE_ID_MOUSE_X 0
135 #define RETRO_DEVICE_ID_MOUSE_Y 1
136 #define RETRO_DEVICE_ID_MOUSE_LEFT 2
137 #define RETRO_DEVICE_ID_MOUSE_RIGHT 3
139 // Id values for LIGHTGUN types.
140 #define RETRO_DEVICE_ID_LIGHTGUN_X 0
141 #define RETRO_DEVICE_ID_LIGHTGUN_Y 1
142 #define RETRO_DEVICE_ID_LIGHTGUN_TRIGGER 2
143 #define RETRO_DEVICE_ID_LIGHTGUN_CURSOR 3
144 #define RETRO_DEVICE_ID_LIGHTGUN_TURBO 4
145 #define RETRO_DEVICE_ID_LIGHTGUN_PAUSE 5
146 #define RETRO_DEVICE_ID_LIGHTGUN_START 6
148 // Id values for POINTER.
149 #define RETRO_DEVICE_ID_POINTER_X 0
150 #define RETRO_DEVICE_ID_POINTER_Y 1
151 #define RETRO_DEVICE_ID_POINTER_PRESSED 2
153 // Returned from retro_get_region().
154 #define RETRO_REGION_NTSC 0
155 #define RETRO_REGION_PAL 1
157 // Passed to retro_get_memory_data/size().
158 // If the memory type doesn't apply to the implementation NULL/0 can be returned.
159 #define RETRO_MEMORY_MASK 0xff
161 // Regular save ram. This ram is usually found on a game cartridge, backed up by a battery.
162 // If save game data is too complex for a single memory buffer,
163 // the SYSTEM_DIRECTORY environment callback can be used.
164 #define RETRO_MEMORY_SAVE_RAM 0
166 // Some games have a built-in clock to keep track of time.
167 // This memory is usually just a couple of bytes to keep track of time.
168 #define RETRO_MEMORY_RTC 1
170 // System ram lets a frontend peek into a game systems main RAM.
171 #define RETRO_MEMORY_SYSTEM_RAM 2
173 // Video ram lets a frontend peek into a game systems video RAM (VRAM).
174 #define RETRO_MEMORY_VIDEO_RAM 3
176 // Special memory types.
177 #define RETRO_MEMORY_SNES_BSX_RAM ((1 << 8) | RETRO_MEMORY_SAVE_RAM)
178 #define RETRO_MEMORY_SNES_BSX_PRAM ((2 << 8) | RETRO_MEMORY_SAVE_RAM)
179 #define RETRO_MEMORY_SNES_SUFAMI_TURBO_A_RAM ((3 << 8) | RETRO_MEMORY_SAVE_RAM)
180 #define RETRO_MEMORY_SNES_SUFAMI_TURBO_B_RAM ((4 << 8) | RETRO_MEMORY_SAVE_RAM)
181 #define RETRO_MEMORY_SNES_GAME_BOY_RAM ((5 << 8) | RETRO_MEMORY_SAVE_RAM)
182 #define RETRO_MEMORY_SNES_GAME_BOY_RTC ((6 << 8) | RETRO_MEMORY_RTC)
184 // Special game types passed into retro_load_game_special().
185 // Only used when multiple ROMs are required.
186 #define RETRO_GAME_TYPE_BSX 0x101
187 #define RETRO_GAME_TYPE_BSX_SLOTTED 0x102
188 #define RETRO_GAME_TYPE_SUFAMI_TURBO 0x103
189 #define RETRO_GAME_TYPE_SUPER_GAME_BOY 0x104
191 // Keysyms used for ID in input state callback when polling RETRO_KEYBOARD.
196 RETROK_BACKSPACE = 8,
204 RETROK_QUOTEDBL = 34,
207 RETROK_AMPERSAND = 38,
209 RETROK_LEFTPAREN = 40,
210 RETROK_RIGHTPAREN = 41,
211 RETROK_ASTERISK = 42,
228 RETROK_SEMICOLON = 59,
232 RETROK_QUESTION = 63,
234 RETROK_LEFTBRACKET = 91,
235 RETROK_BACKSLASH = 92,
236 RETROK_RIGHTBRACKET = 93,
238 RETROK_UNDERSCORE = 95,
239 RETROK_BACKQUOTE = 96,
278 RETROK_KP_PERIOD = 266,
279 RETROK_KP_DIVIDE = 267,
280 RETROK_KP_MULTIPLY = 268,
281 RETROK_KP_MINUS = 269,
282 RETROK_KP_PLUS = 270,
283 RETROK_KP_ENTER = 271,
284 RETROK_KP_EQUALS = 272,
294 RETROK_PAGEDOWN = 281,
312 RETROK_NUMLOCK = 300,
313 RETROK_CAPSLOCK = 301,
314 RETROK_SCROLLOCK = 302,
326 RETROK_COMPOSE = 314,
339 RETROK_DUMMY = INT_MAX // Ensure sizeof(enum) == sizeof(int)
344 RETROKMOD_NONE = 0x0000,
346 RETROKMOD_SHIFT = 0x01,
347 RETROKMOD_CTRL = 0x02,
348 RETROKMOD_ALT = 0x04,
349 RETROKMOD_META = 0x08,
351 RETROKMOD_NUMLOCK = 0x10,
352 RETROKMOD_CAPSLOCK = 0x20,
353 RETROKMOD_SCROLLOCK = 0x40,
355 RETROKMOD_DUMMY = INT_MAX // Ensure sizeof(enum) == sizeof(int)
358 // If set, this call is not part of the public libretro API yet. It can change or be removed at any time.
359 #define RETRO_ENVIRONMENT_EXPERIMENTAL 0x10000
361 // Environment commands.
362 #define RETRO_ENVIRONMENT_SET_ROTATION 1 // const unsigned * --
363 // Sets screen rotation of graphics.
364 // Is only implemented if rotation can be accelerated by hardware.
365 // Valid values are 0, 1, 2, 3, which rotates screen by 0, 90, 180, 270 degrees
366 // counter-clockwise respectively.
368 #define RETRO_ENVIRONMENT_GET_OVERSCAN 2 // bool * --
369 // Boolean value whether or not the implementation should use overscan, or crop away overscan.
371 #define RETRO_ENVIRONMENT_GET_CAN_DUPE 3 // bool * --
372 // Boolean value whether or not frontend supports frame duping,
373 // passing NULL to video frame callback.
375 // Environ 4, 5 are no longer supported (GET_VARIABLE / SET_VARIABLES), and reserved to avoid possible ABI clash.
376 #define RETRO_ENVIRONMENT_SET_MESSAGE 6 // const struct retro_message * --
377 // Sets a message to be displayed in implementation-specific manner for a certain amount of 'frames'.
378 // Should not be used for trivial messages, which should simply be logged to stderr.
379 #define RETRO_ENVIRONMENT_SHUTDOWN 7 // N/A (NULL) --
380 // Requests the frontend to shutdown.
381 // Should only be used if game has a specific
382 // way to shutdown the game from a menu item or similar.
384 #define RETRO_ENVIRONMENT_SET_PERFORMANCE_LEVEL 8
385 // const unsigned * --
386 // Gives a hint to the frontend how demanding this implementation
387 // is on a system. E.g. reporting a level of 2 means
388 // this implementation should run decently on all frontends
389 // of level 2 and up.
391 // It can be used by the frontend to potentially warn
392 // about too demanding implementations.
394 // The levels are "floating", but roughly defined as:
395 // 0: Low-powered embedded devices such as Raspberry Pi
396 // 1: 6th generation consoles, such as Wii/Xbox 1, and phones, tablets, etc.
397 // 2: 7th generation consoles, such as PS3/360, with sub-par CPUs.
398 // 3: Modern desktop/laptops with reasonably powerful CPUs.
399 // 4: High-end desktops with very powerful CPUs.
401 // This function can be called on a per-game basis,
402 // as certain games an implementation can play might be
403 // particularily demanding.
404 // If called, it should be called in retro_load_game().
406 #define RETRO_ENVIRONMENT_GET_SYSTEM_DIRECTORY 9
408 // Returns the "system" directory of the frontend.
409 // This directory can be used to store system specific ROMs such as BIOSes, configuration data, etc.
410 // The returned value can be NULL.
411 // If so, no such directory is defined,
412 // and it's up to the implementation to find a suitable directory.
414 #define RETRO_ENVIRONMENT_SET_PIXEL_FORMAT 10
415 // const enum retro_pixel_format * --
416 // Sets the internal pixel format used by the implementation.
417 // The default pixel format is RETRO_PIXEL_FORMAT_0RGB1555.
418 // This pixel format however, is deprecated (see enum retro_pixel_format).
419 // If the call returns false, the frontend does not support this pixel format.
420 // This function should be called inside retro_load_game() or retro_get_system_av_info().
422 #define RETRO_ENVIRONMENT_SET_INPUT_DESCRIPTORS 11
423 // const struct retro_input_descriptor * --
424 // Sets an array of retro_input_descriptors.
425 // It is up to the frontend to present this in a usable way.
426 // The array is terminated by retro_input_descriptor::description being set to NULL.
427 // This function can be called at any time, but it is recommended to call it as early as possible.
428 #define RETRO_ENVIRONMENT_SET_KEYBOARD_CALLBACK 12
429 // const struct retro_keyboard_callback * --
430 // Sets a callback function used to notify core about keyboard events.
432 #define RETRO_ENVIRONMENT_SET_DISK_CONTROL_INTERFACE 13
433 // const struct retro_disk_control_callback * --
434 // Sets an interface which frontend can use to eject and insert disk images.
435 // This is used for games which consist of multiple images and must be manually
436 // swapped out by the user (e.g. PSX).
437 #define RETRO_ENVIRONMENT_SET_HW_RENDER (14 | RETRO_ENVIRONMENT_EXPERIMENTAL)
438 // struct retro_hw_render_callback * --
439 // NOTE: This call is currently very experimental, and should not be considered part of the public API.
440 // The interface could be changed or removed at any time.
441 // Sets an interface to let a libretro core render with hardware acceleration.
442 // Should be called in retro_load_game().
443 // If successful, libretro cores will be able to render to a frontend-provided framebuffer.
444 // The size of this framebuffer will be at least as large as max_width/max_height provided in get_av_info().
445 // If HW rendering is used, pass only RETRO_HW_FRAME_BUFFER_VALID or NULL to retro_video_refresh_t.
446 #define RETRO_ENVIRONMENT_GET_VARIABLE 15
447 // struct retro_variable * --
448 // Interface to aquire user-defined information from environment
449 // that cannot feasibly be supported in a multi-system way.
450 // 'key' should be set to a key which has already been set by SET_VARIABLES.
451 // 'data' will be set to a value or NULL.
453 #define RETRO_ENVIRONMENT_SET_VARIABLES 16
454 // const struct retro_variable * --
455 // Allows an implementation to signal the environment
456 // which variables it might want to check for later using GET_VARIABLE.
457 // This allows the frontend to present these variables to a user dynamically.
458 // This should be called as early as possible (ideally in retro_set_environment).
460 // 'data' points to an array of retro_variable structs terminated by a { NULL, NULL } element.
461 // retro_variable::key should be namespaced to not collide with other implementations' keys. E.g. A core called 'foo' should use keys named as 'foo_option'.
462 // retro_variable::value should contain a human readable description of the key as well as a '|' delimited list of expected values.
463 // The number of possible options should be very limited, i.e. it should be feasible to cycle through options without a keyboard.
464 // First entry should be treated as a default.
467 // { "foo_option", "Speed hack coprocessor X; false|true" }
469 // Text before first ';' is description. This ';' must be followed by a space, and followed by a list of possible values split up with '|'.
470 // Only strings are operated on. The possible values will generally be displayed and stored as-is by the frontend.
472 #define RETRO_ENVIRONMENT_GET_VARIABLE_UPDATE 17
474 // Result is set to true if some variables are updated by
475 // frontend since last call to RETRO_ENVIRONMENT_GET_VARIABLE.
476 // Variables should be queried with GET_VARIABLE.
478 #define RETRO_ENVIRONMENT_SET_SUPPORT_NO_GAME 18
480 // If true, the libretro implementation supports calls to retro_load_game() with NULL as argument.
481 // Used by cores which can run without particular game data.
482 // This should be called within retro_set_environment() only.
485 // Pass this to retro_video_refresh_t if rendering to hardware.
486 // Passing NULL to retro_video_refresh_t is still a frame dupe as normal.
487 #define RETRO_HW_FRAME_BUFFER_VALID ((void*)-1)
489 // Invalidates the current HW context.
490 // If called, all GPU resources must be reinitialized.
491 // Usually called when frontend reinits video driver.
492 // Also called first time video driver is initialized, allowing libretro core to init resources.
493 typedef void (*retro_hw_context_reset_t)(void);
494 // Gets current framebuffer which is to be rendered to. Could change every frame potentially.
495 typedef uintptr_t (*retro_hw_get_current_framebuffer_t)(void);
497 // Get a symbol from HW context.
498 typedef void (*retro_proc_address_t)(void);
499 typedef retro_proc_address_t (*retro_hw_get_proc_address_t)(const char *sym);
501 enum retro_hw_context_type
503 RETRO_HW_CONTEXT_NONE = 0,
504 RETRO_HW_CONTEXT_OPENGL, // OpenGL 2.x. Latest version available before 3.x+.
505 RETRO_HW_CONTEXT_OPENGLES2, // GLES 2.0
507 RETRO_HW_CONTEXT_DUMMY = INT_MAX
510 struct retro_hw_render_callback
512 enum retro_hw_context_type context_type; // Which API to use. Set by libretro core.
513 retro_hw_context_reset_t context_reset; // Set by libretro core.
514 retro_hw_get_current_framebuffer_t get_current_framebuffer; // Set by frontend.
515 retro_hw_get_proc_address_t get_proc_address; // Set by frontend.
516 bool depth; // Set if render buffers should have depth component attached.
519 // Callback type passed in RETRO_ENVIRONMENT_SET_KEYBOARD_CALLBACK. Called by the frontend in response to keyboard events.
520 // down is set if the key is being pressed, or false if it is being released.
521 // keycode is the RETROK value of the char.
522 // character is the text character of the pressed key. (UTF-32).
523 // key_modifiers is a set of RETROKMOD values or'ed together.
524 typedef void (*retro_keyboard_event_t)(bool down, unsigned keycode, uint32_t character, uint16_t key_modifiers);
526 struct retro_keyboard_callback
528 retro_keyboard_event_t callback;
531 // Callbacks for RETRO_ENVIRONMENT_SET_DISK_CONTROL_INTERFACE.
532 // Should be set for implementations which can swap out multiple disk images in runtime.
533 // If the implementation can do this automatically, it should strive to do so.
534 // However, there are cases where the user must manually do so.
536 // Overview: To swap a disk image, eject the disk image with set_eject_state(true).
537 // Set the disk index with set_image_index(index). Insert the disk again with set_eject_state(false).
539 // If ejected is true, "ejects" the virtual disk tray.
540 // When ejected, the disk image index can be set.
541 typedef bool (*retro_set_eject_state_t)(bool ejected);
542 // Gets current eject state. The initial state is 'not ejected'.
543 typedef bool (*retro_get_eject_state_t)(void);
544 // Gets current disk index. First disk is index 0.
545 // If return value is >= get_num_images(), no disk is currently inserted.
546 typedef unsigned (*retro_get_image_index_t)(void);
547 // Sets image index. Can only be called when disk is ejected.
548 // The implementation supports setting "no disk" by using an index >= get_num_images().
549 typedef bool (*retro_set_image_index_t)(unsigned index);
550 // Gets total number of images which are available to use.
551 typedef unsigned (*retro_get_num_images_t)(void);
553 // Replaces the disk image associated with index.
554 // Arguments to pass in info have same requirements as retro_load_game().
555 // Virtual disk tray must be ejected when calling this.
556 // Replacing a disk image with info = NULL will remove the disk image from the internal list.
557 // As a result, calls to get_image_index() can change.
559 // E.g. replace_image_index(1, NULL), and previous get_image_index() returned 4 before.
560 // Index 1 will be removed, and the new index is 3.
561 struct retro_game_info;
562 typedef bool (*retro_replace_image_index_t)(unsigned index, const struct retro_game_info *info);
563 // Adds a new valid index (get_num_images()) to the internal disk list.
564 // This will increment subsequent return values from get_num_images() by 1.
565 // This image index cannot be used until a disk image has been set with replace_image_index.
566 typedef bool (*retro_add_image_index_t)(void);
568 struct retro_disk_control_callback
570 retro_set_eject_state_t set_eject_state;
571 retro_get_eject_state_t get_eject_state;
573 retro_get_image_index_t get_image_index;
574 retro_set_image_index_t set_image_index;
575 retro_get_num_images_t get_num_images;
577 retro_replace_image_index_t replace_image_index;
578 retro_add_image_index_t add_image_index;
581 enum retro_pixel_format
583 // 0RGB1555, native endian. 0 bit must be set to 0.
584 // This pixel format is default for compatibility concerns only.
585 // If a 15/16-bit pixel format is desired, consider using RGB565.
586 RETRO_PIXEL_FORMAT_0RGB1555 = 0,
588 // XRGB8888, native endian. X bits are ignored.
589 RETRO_PIXEL_FORMAT_XRGB8888 = 1,
591 // RGB565, native endian. This pixel format is the recommended format to use if a 15/16-bit format is desired
592 // as it is the pixel format that is typically available on a wide range of low-power devices.
593 // It is also natively supported in APIs like OpenGL ES.
594 RETRO_PIXEL_FORMAT_RGB565 = 2,
596 // Ensure sizeof() == sizeof(int).
597 RETRO_PIXEL_FORMAT_UNKNOWN = INT_MAX
602 const char *msg; // Message to be displayed.
603 unsigned frames; // Duration in frames of message.
606 // Describes how the libretro implementation maps a libretro input bind
607 // to its internal input system through a human readable string.
608 // This string can be used to better let a user configure input.
609 struct retro_input_descriptor
611 // Associates given parameters with a description.
617 const char *description; // Human readable description for parameters.
618 // The pointer must remain valid until retro_unload_game() is called.
621 struct retro_system_info
623 // All pointers are owned by libretro implementation, and pointers must remain valid until retro_deinit() is called.
625 const char *library_name; // Descriptive name of library. Should not contain any version numbers, etc.
626 const char *library_version; // Descriptive version of core.
628 const char *valid_extensions; // A string listing probably rom extensions the core will be able to load, separated with pipe.
629 // I.e. "bin|rom|iso".
630 // Typically used for a GUI to filter out extensions.
632 bool need_fullpath; // If true, retro_load_game() is guaranteed to provide a valid pathname in retro_game_info::path.
633 // ::data and ::size are both invalid.
634 // If false, ::data and ::size are guaranteed to be valid, but ::path might not be valid.
635 // This is typically set to true for libretro implementations that must load from file.
636 // Implementations should strive for setting this to false, as it allows the frontend to perform patching, etc.
638 bool block_extract; // If true, the frontend is not allowed to extract any archives before loading the real ROM.
639 // Necessary for certain libretro implementations that load games from zipped archives.
642 struct retro_game_geometry
644 unsigned base_width; // Nominal video width of game.
645 unsigned base_height; // Nominal video height of game.
646 unsigned max_width; // Maximum possible width of game.
647 unsigned max_height; // Maximum possible height of game.
649 float aspect_ratio; // Nominal aspect ratio of game. If aspect_ratio is <= 0.0,
650 // an aspect ratio of base_width / base_height is assumed.
651 // A frontend could override this setting if desired.
654 struct retro_system_timing
656 double fps; // FPS of video content.
657 double sample_rate; // Sampling rate of audio.
660 struct retro_system_av_info
662 struct retro_game_geometry geometry;
663 struct retro_system_timing timing;
666 struct retro_variable
668 const char *key; // Variable to query in RETRO_ENVIRONMENT_GET_VARIABLE.
669 // If NULL, obtains the complete environment string if more complex parsing is necessary.
670 // The environment string is formatted as key-value pairs delimited by semicolons as so:
671 // "key1=value1;key2=value2;..."
672 const char *value; // Value to be obtained. If key does not exist, it is set to NULL.
675 struct retro_game_info
677 const char *path; // Path to game, UTF-8 encoded. Usually used as a reference.
678 // May be NULL if rom was loaded from stdin or similar.
679 // retro_system_info::need_fullpath guaranteed that this path is valid.
680 const void *data; // Memory buffer of loaded game. Will be NULL if need_fullpath was set.
681 size_t size; // Size of memory buffer.
682 const char *meta; // String of implementation specific meta-data.
687 // Environment callback. Gives implementations a way of performing uncommon tasks. Extensible.
688 typedef bool (*retro_environment_t)(unsigned cmd, void *data);
690 // Render a frame. Pixel format is 15-bit 0RGB1555 native endian unless changed (see RETRO_ENVIRONMENT_SET_PIXEL_FORMAT).
691 // Width and height specify dimensions of buffer.
692 // Pitch specifices length in bytes between two lines in buffer.
693 // For performance reasons, it is highly recommended to have a frame that is packed in memory, i.e. pitch == width * byte_per_pixel.
694 // Certain graphic APIs, such as OpenGL ES, do not like textures that are not packed in memory.
695 typedef void (*retro_video_refresh_t)(const void *data, unsigned width, unsigned height, size_t pitch);
697 // Renders a single audio frame. Should only be used if implementation generates a single sample at a time.
698 // Format is signed 16-bit native endian.
699 typedef void (*retro_audio_sample_t)(int16_t left, int16_t right);
700 // Renders multiple audio frames in one go. One frame is defined as a sample of left and right channels, interleaved.
701 // I.e. int16_t buf[4] = { l, r, l, r }; would be 2 frames.
702 // Only one of the audio callbacks must ever be used.
703 typedef size_t (*retro_audio_sample_batch_t)(const int16_t *data, size_t frames);
706 typedef void (*retro_input_poll_t)(void);
707 // Queries for input for player 'port'. device will be masked with RETRO_DEVICE_MASK.
708 // Specialization of devices such as RETRO_DEVICE_JOYPAD_MULTITAP that have been set with retro_set_controller_port_device()
709 // will still use the higher level RETRO_DEVICE_JOYPAD to request input.
710 typedef int16_t (*retro_input_state_t)(unsigned port, unsigned device, unsigned index, unsigned id);
712 // Sets callbacks. retro_set_environment() is guaranteed to be called before retro_init().
713 // The rest of the set_* functions are guaranteed to have been called before the first call to retro_run() is made.
714 void retro_set_environment(retro_environment_t);
715 void retro_set_video_refresh(retro_video_refresh_t);
716 void retro_set_audio_sample(retro_audio_sample_t);
717 void retro_set_audio_sample_batch(retro_audio_sample_batch_t);
718 void retro_set_input_poll(retro_input_poll_t);
719 void retro_set_input_state(retro_input_state_t);
721 // Library global initialization/deinitialization.
722 void retro_init(void);
723 void retro_deinit(void);
725 // Must return RETRO_API_VERSION. Used to validate ABI compatibility when the API is revised.
726 unsigned retro_api_version(void);
728 // Gets statically known system info. Pointers provided in *info must be statically allocated.
729 // Can be called at any time, even before retro_init().
730 void retro_get_system_info(struct retro_system_info *info);
732 // Gets information about system audio/video timings and geometry.
733 // Can be called only after retro_load_game() has successfully completed.
734 // NOTE: The implementation of this function might not initialize every variable if needed.
735 // E.g. geom.aspect_ratio might not be initialized if core doesn't desire a particular aspect ratio.
736 void retro_get_system_av_info(struct retro_system_av_info *info);
738 // Sets device to be used for player 'port'.
739 void retro_set_controller_port_device(unsigned port, unsigned device);
741 // Resets the current game.
742 void retro_reset(void);
744 // Runs the game for one video frame.
745 // During retro_run(), input_poll callback must be called at least once.
747 // If a frame is not rendered for reasons where a game "dropped" a frame,
748 // this still counts as a frame, and retro_run() should explicitly dupe a frame if GET_CAN_DUPE returns true.
749 // In this case, the video callback can take a NULL argument for data.
750 void retro_run(void);
752 // Returns the amount of data the implementation requires to serialize internal state (save states).
753 // Beetween calls to retro_load_game() and retro_unload_game(), the returned size is never allowed to be larger than a previous returned value, to
754 // ensure that the frontend can allocate a save state buffer once.
755 size_t retro_serialize_size(void);
757 // Serializes internal state. If failed, or size is lower than retro_serialize_size(), it should return false, true otherwise.
758 bool retro_serialize(void *data, size_t size);
759 bool retro_unserialize(const void *data, size_t size);
761 void retro_cheat_reset(void);
762 void retro_cheat_set(unsigned index, bool enabled, const char *code);
765 bool retro_load_game(const struct retro_game_info *game);
767 // Loads a "special" kind of game. Should not be used except in extreme cases.
768 bool retro_load_game_special(
770 const struct retro_game_info *info, size_t num_info
773 // Unloads a currently loaded game.
774 void retro_unload_game(void);
776 // Gets region of game.
777 unsigned retro_get_region(void);
779 // Gets region of memory.
780 void *retro_get_memory_data(unsigned id);
781 size_t retro_get_memory_size(unsigned id);