8 // Hack applied for MSVC when compiling in C89 mode as it isn't C99 compliant.
12 #if defined(_MSC_VER) && !defined(SN_TARGET_PS3) && !defined(__cplusplus)
13 #define bool unsigned char
21 // Used for checking API/ABI mismatches that can break libretro implementations.
22 // It is not incremented for compatible changes to the API.
23 #define RETRO_API_VERSION 1
25 // Libretro's fundamental device abstractions.
26 #define RETRO_DEVICE_MASK 0xff
27 #define RETRO_DEVICE_NONE 0
29 // The JOYPAD is called RetroPad. It is essentially a Super Nintendo controller,
30 // but with additional L2/R2/L3/R3 buttons, similar to a PS1 DualShock.
31 #define RETRO_DEVICE_JOYPAD 1
33 // The mouse is a simple mouse, similar to Super Nintendo's mouse.
34 // X and Y coordinates are reported relatively to last poll (poll callback).
35 // It is up to the libretro implementation to keep track of where the mouse pointer is supposed to be on the screen.
36 // The frontend must make sure not to interfere with its own hardware mouse pointer.
37 #define RETRO_DEVICE_MOUSE 2
39 // KEYBOARD device lets one poll for raw key pressed.
40 // It is poll based, so input callback will return with the current pressed state.
41 #define RETRO_DEVICE_KEYBOARD 3
43 // Lightgun X/Y coordinates are reported relatively to last poll, similar to mouse.
44 #define RETRO_DEVICE_LIGHTGUN 4
46 // The ANALOG device is an extension to JOYPAD (RetroPad).
47 // Similar to DualShock it adds two analog sticks.
48 // This is treated as a separate device type as it returns values in the full analog range
49 // of [-0x8000, 0x7fff]. Positive X axis is right. Positive Y axis is down.
50 // Only use ANALOG type when polling for analog values of the axes.
51 #define RETRO_DEVICE_ANALOG 5
53 // Abstracts the concept of a pointing mechanism, e.g. touch.
54 // This allows libretro to query in absolute coordinates where on the screen a mouse (or something similar) is being placed.
55 // For a touch centric device, coordinates reported are the coordinates of the press.
57 // Coordinates in X and Y are reported as:
58 // [-0x7fff, 0x7fff]: -0x7fff corresponds to the far left/top of the screen,
59 // and 0x7fff corresponds to the far right/bottom of the screen.
60 // The "screen" is here defined as area that is passed to the frontend and later displayed on the monitor.
61 // The frontend is free to scale/resize this screen as it sees fit, however,
62 // (X, Y) = (-0x7fff, -0x7fff) will correspond to the top-left pixel of the game image, etc.
64 // To check if the pointer coordinates are valid (e.g. a touch display actually being touched),
65 // PRESSED returns 1 or 0.
66 // If using a mouse, PRESSED will usually correspond to the left mouse button.
67 // PRESSED will only return 1 if the pointer is inside the game screen.
69 // For multi-touch, the index variable can be used to successively query more presses.
70 // If index = 0 returns true for _PRESSED, coordinates can be extracted
71 // with _X, _Y for index = 0. One can then query _PRESSED, _X, _Y with index = 1, and so on.
72 // Eventually _PRESSED will return false for an index. No further presses are registered at this point.
73 #define RETRO_DEVICE_POINTER 6
75 // These device types are specializations of the base types above.
76 // They should only be used in retro_set_controller_type() to inform libretro implementations
77 // about use of a very specific device type.
79 // In input state callback, however, only the base type should be used in the 'device' field.
80 #define RETRO_DEVICE_JOYPAD_MULTITAP ((1 << 8) | RETRO_DEVICE_JOYPAD)
81 #define RETRO_DEVICE_LIGHTGUN_SUPER_SCOPE ((1 << 8) | RETRO_DEVICE_LIGHTGUN)
82 #define RETRO_DEVICE_LIGHTGUN_JUSTIFIER ((2 << 8) | RETRO_DEVICE_LIGHTGUN)
83 #define RETRO_DEVICE_LIGHTGUN_JUSTIFIERS ((3 << 8) | RETRO_DEVICE_LIGHTGUN)
85 // Buttons for the RetroPad (JOYPAD).
86 // The placement of these is equivalent to placements on the Super Nintendo controller.
87 // L2/R2/L3/R3 buttons correspond to the PS1 DualShock.
88 #define RETRO_DEVICE_ID_JOYPAD_B 0
89 #define RETRO_DEVICE_ID_JOYPAD_Y 1
90 #define RETRO_DEVICE_ID_JOYPAD_SELECT 2
91 #define RETRO_DEVICE_ID_JOYPAD_START 3
92 #define RETRO_DEVICE_ID_JOYPAD_UP 4
93 #define RETRO_DEVICE_ID_JOYPAD_DOWN 5
94 #define RETRO_DEVICE_ID_JOYPAD_LEFT 6
95 #define RETRO_DEVICE_ID_JOYPAD_RIGHT 7
96 #define RETRO_DEVICE_ID_JOYPAD_A 8
97 #define RETRO_DEVICE_ID_JOYPAD_X 9
98 #define RETRO_DEVICE_ID_JOYPAD_L 10
99 #define RETRO_DEVICE_ID_JOYPAD_R 11
100 #define RETRO_DEVICE_ID_JOYPAD_L2 12
101 #define RETRO_DEVICE_ID_JOYPAD_R2 13
102 #define RETRO_DEVICE_ID_JOYPAD_L3 14
103 #define RETRO_DEVICE_ID_JOYPAD_R3 15
105 // Index / Id values for ANALOG device.
106 #define RETRO_DEVICE_INDEX_ANALOG_LEFT 0
107 #define RETRO_DEVICE_INDEX_ANALOG_RIGHT 1
108 #define RETRO_DEVICE_ID_ANALOG_X 0
109 #define RETRO_DEVICE_ID_ANALOG_Y 1
111 // Id values for MOUSE.
112 #define RETRO_DEVICE_ID_MOUSE_X 0
113 #define RETRO_DEVICE_ID_MOUSE_Y 1
114 #define RETRO_DEVICE_ID_MOUSE_LEFT 2
115 #define RETRO_DEVICE_ID_MOUSE_RIGHT 3
117 // Id values for LIGHTGUN types.
118 #define RETRO_DEVICE_ID_LIGHTGUN_X 0
119 #define RETRO_DEVICE_ID_LIGHTGUN_Y 1
120 #define RETRO_DEVICE_ID_LIGHTGUN_TRIGGER 2
121 #define RETRO_DEVICE_ID_LIGHTGUN_CURSOR 3
122 #define RETRO_DEVICE_ID_LIGHTGUN_TURBO 4
123 #define RETRO_DEVICE_ID_LIGHTGUN_PAUSE 5
124 #define RETRO_DEVICE_ID_LIGHTGUN_START 6
126 // Id values for POINTER.
127 #define RETRO_DEVICE_ID_POINTER_X 0
128 #define RETRO_DEVICE_ID_POINTER_Y 1
129 #define RETRO_DEVICE_ID_POINTER_PRESSED 2
131 // Returned from retro_get_region().
132 #define RETRO_REGION_NTSC 0
133 #define RETRO_REGION_PAL 1
135 // Passed to retro_get_memory_data/size().
136 // If the memory type doesn't apply to the implementation NULL/0 can be returned.
137 #define RETRO_MEMORY_MASK 0xff
139 // Regular save ram. This ram is usually found on a game cartridge, backed up by a battery.
140 // If save game data is too complex for a single memory buffer,
141 // the SYSTEM_DIRECTORY environment callback can be used.
142 #define RETRO_MEMORY_SAVE_RAM 0
144 // Some games have a built-in clock to keep track of time.
145 // This memory is usually just a couple of bytes to keep track of time.
146 #define RETRO_MEMORY_RTC 1
148 // System ram lets a frontend peek into a game systems main RAM.
149 #define RETRO_MEMORY_SYSTEM_RAM 2
151 // Video ram lets a frontend peek into a game systems video RAM (VRAM).
152 #define RETRO_MEMORY_VIDEO_RAM 3
154 // Special memory types.
155 #define RETRO_MEMORY_SNES_BSX_RAM ((1 << 8) | RETRO_MEMORY_SAVE_RAM)
156 #define RETRO_MEMORY_SNES_BSX_PRAM ((2 << 8) | RETRO_MEMORY_SAVE_RAM)
157 #define RETRO_MEMORY_SNES_SUFAMI_TURBO_A_RAM ((3 << 8) | RETRO_MEMORY_SAVE_RAM)
158 #define RETRO_MEMORY_SNES_SUFAMI_TURBO_B_RAM ((4 << 8) | RETRO_MEMORY_SAVE_RAM)
159 #define RETRO_MEMORY_SNES_GAME_BOY_RAM ((5 << 8) | RETRO_MEMORY_SAVE_RAM)
160 #define RETRO_MEMORY_SNES_GAME_BOY_RTC ((6 << 8) | RETRO_MEMORY_RTC)
162 // Special game types passed into retro_load_game_special().
163 // Only used when multiple ROMs are required.
164 #define RETRO_GAME_TYPE_BSX 0x101
165 #define RETRO_GAME_TYPE_BSX_SLOTTED 0x102
166 #define RETRO_GAME_TYPE_SUFAMI_TURBO 0x103
167 #define RETRO_GAME_TYPE_SUPER_GAME_BOY 0x104
169 // Keysyms used for ID in input state callback when polling RETRO_KEYBOARD.
174 RETROK_BACKSPACE = 8,
182 RETROK_QUOTEDBL = 34,
185 RETROK_AMPERSAND = 38,
187 RETROK_LEFTPAREN = 40,
188 RETROK_RIGHTPAREN = 41,
189 RETROK_ASTERISK = 42,
206 RETROK_SEMICOLON = 59,
210 RETROK_QUESTION = 63,
212 RETROK_LEFTBRACKET = 91,
213 RETROK_BACKSLASH = 92,
214 RETROK_RIGHTBRACKET = 93,
216 RETROK_UNDERSCORE = 95,
217 RETROK_BACKQUOTE = 96,
256 RETROK_KP_PERIOD = 266,
257 RETROK_KP_DIVIDE = 267,
258 RETROK_KP_MULTIPLY = 268,
259 RETROK_KP_MINUS = 269,
260 RETROK_KP_PLUS = 270,
261 RETROK_KP_ENTER = 271,
262 RETROK_KP_EQUALS = 272,
272 RETROK_PAGEDOWN = 281,
290 RETROK_NUMLOCK = 300,
291 RETROK_CAPSLOCK = 301,
292 RETROK_SCROLLOCK = 302,
304 RETROK_COMPOSE = 314,
317 RETROK_DUMMY = INT_MAX // Ensure sizeof(enum) == sizeof(int)
322 RETROKMOD_NONE = 0x0000,
324 RETROKMOD_SHIFT = 0x01,
325 RETROKMOD_CTRL = 0x02,
326 RETROKMOD_ALT = 0x04,
327 RETROKMOD_META = 0x08,
329 RETROKMOD_NUMLOCK = 0x10,
330 RETROKMOD_CAPSLOCK = 0x20,
331 RETROKMOD_SCROLLOCK = 0x40,
333 RETROKMOD_DUMMY = INT_MAX // Ensure sizeof(enum) == sizeof(int)
337 // Environment commands.
338 #define RETRO_ENVIRONMENT_SET_ROTATION 1 // const unsigned * --
339 // Sets screen rotation of graphics.
340 // Is only implemented if rotation can be accelerated by hardware.
341 // Valid values are 0, 1, 2, 3, which rotates screen by 0, 90, 180, 270 degrees
342 // counter-clockwise respectively.
344 #define RETRO_ENVIRONMENT_GET_OVERSCAN 2 // bool * --
345 // Boolean value whether or not the implementation should use overscan, or crop away overscan.
347 #define RETRO_ENVIRONMENT_GET_CAN_DUPE 3 // bool * --
348 // Boolean value whether or not frontend supports frame duping,
349 // passing NULL to video frame callback.
351 #define RETRO_ENVIRONMENT_GET_VARIABLE 4 // struct retro_variable * --
352 // Interface to aquire user-defined information from environment
353 // that cannot feasibly be supported in a multi-system way.
354 // Mostly used for obscure,
355 // specific features that the user can tap into when neseccary.
357 #define RETRO_ENVIRONMENT_SET_VARIABLES 5 // const struct retro_variable * --
358 // Allows an implementation to signal the environment
359 // which variables it might want to check for later using GET_VARIABLE.
360 // 'data' points to an array of retro_variable structs terminated by a { NULL, NULL } element.
361 // retro_variable::value should contain a human readable description of the key.
363 #define RETRO_ENVIRONMENT_SET_MESSAGE 6 // const struct retro_message * --
364 // Sets a message to be displayed in implementation-specific manner for a certain amount of 'frames'.
365 // Should not be used for trivial messages, which should simply be logged to stderr.
366 #define RETRO_ENVIRONMENT_SHUTDOWN 7 // N/A (NULL) --
367 // Requests the frontend to shutdown.
368 // Should only be used if game has a specific
369 // way to shutdown the game from a menu item or similar.
371 #define RETRO_ENVIRONMENT_SET_PERFORMANCE_LEVEL 8
372 // const unsigned * --
373 // Gives a hint to the frontend how demanding this implementation
374 // is on a system. E.g. reporting a level of 2 means
375 // this implementation should run decently on all frontends
376 // of level 2 and up.
378 // It can be used by the frontend to potentially warn
379 // about too demanding implementations.
381 // The levels are "floating", but roughly defined as:
382 // 0: Low-powered embedded devices such as Raspberry Pi
383 // 1: 6th generation consoles, such as Wii/Xbox 1, and phones, tablets, etc.
384 // 2: 7th generation consoles, such as PS3/360, with sub-par CPUs.
385 // 3: Modern desktop/laptops with reasonably powerful CPUs.
386 // 4: High-end desktops with very powerful CPUs.
388 // This function can be called on a per-game basis,
389 // as certain games an implementation can play might be
390 // particularily demanding.
391 // If called, it should be called in retro_load_game().
393 #define RETRO_ENVIRONMENT_GET_SYSTEM_DIRECTORY 9
395 // Returns the "system" directory of the frontend.
396 // This directory can be used to store system specific ROMs such as BIOSes, configuration data, etc.
397 // The returned value can be NULL.
398 // If so, no such directory is defined,
399 // and it's up to the implementation to find a suitable directory.
401 #define RETRO_ENVIRONMENT_SET_PIXEL_FORMAT 10
402 // const enum retro_pixel_format * --
403 // Sets the internal pixel format used by the implementation.
404 // The default pixel format is RETRO_PIXEL_FORMAT_0RGB1555.
405 // This pixel format however, is deprecated (see enum retro_pixel_format).
406 // If the call returns false, the frontend does not support this pixel format.
407 // This function should be called inside retro_load_game() or retro_get_system_av_info().
409 #define RETRO_ENVIRONMENT_SET_INPUT_DESCRIPTORS 11
410 // const struct retro_input_descriptor * --
411 // Sets an array of retro_input_descriptors.
412 // It is up to the frontend to present this in a usable way.
413 // The array is terminated by retro_input_descriptor::description being set to NULL.
414 // This function can be called at any time, but it is recommended to call it as early as possible.
415 #define RETRO_ENVIRONMENT_SET_KEYBOARD_CALLBACK 12
416 // const struct retro_keyboard_callback * --
417 // Sets a callback function used to notify core about keyboard events.
419 #define RETRO_ENVIRONMENT_SET_DISK_CONTROL_INTERFACE 13
420 // const struct retro_disk_control_callback * --
421 // Sets an interface which frontend can use to eject and insert disk images.
422 // This is used for games which consist of multiple images and must be manually
423 // swapped out by the user (e.g. PSX).
426 // Callback type passed in RETRO_ENVIRONMENT_SET_KEYBOARD_CALLBACK. Called by the frontend in response to keyboard events.
427 // down is set if the key is being pressed, or false if it is being released.
428 // keycode is the RETROK value of the char.
429 // character is the text character of the pressed key. (UTF-32).
430 // key_modifiers is a set of RETROKMOD values or'ed together.
431 typedef void (*retro_keyboard_event_t)(bool down, unsigned keycode, uint32_t character, uint16_t key_modifiers);
433 struct retro_keyboard_callback
435 retro_keyboard_event_t callback;
438 // Callbacks for RETRO_ENVIRONMENT_SET_DISK_CONTROL_INTERFACE.
439 // Should be set for implementations which can swap out multiple disk images in runtime.
440 // If the implementation can do this automatically, it should strive to do so.
441 // However, there are cases where the user must manually do so.
443 // Overview: To swap a disk image, eject the disk image with set_eject_state(true).
444 // Set the disk index with set_image_index(index). Insert the disk again with set_eject_state(false).
446 // If ejected is true, "ejects" the virtual disk tray.
447 // When ejected, the disk image index can be set.
448 typedef bool (*retro_set_eject_state_t)(bool ejected);
449 // Gets current eject state. The initial state is 'not ejected'.
450 typedef bool (*retro_get_eject_state_t)(void);
451 // Gets current disk index. First disk is index 0.
452 // If return value is >= get_num_images(), no disk is currently inserted.
453 typedef unsigned (*retro_get_image_index_t)(void);
454 // Sets image index. Can only be called when disk is ejected.
455 // The implementation supports setting "no disk" by using an index >= get_num_images().
456 typedef bool (*retro_set_image_index_t)(unsigned index);
457 // Gets total number of images which are available to use.
458 typedef unsigned (*retro_get_num_images_t)(void);
460 // Replaces the disk image associated with index.
461 // Arguments to pass in info have same requirements as retro_load_game().
462 // Virtual disk tray must be ejected when calling this.
463 // Replacing a disk image with info = NULL will remove the disk image from the internal list.
464 // As a result, calls to get_image_index() can change.
466 // E.g. replace_image_index(1, NULL), and previous get_image_index() returned 4 before.
467 // Index 1 will be removed, and the new index is 3.
468 struct retro_game_info;
469 typedef bool (*retro_replace_image_index_t)(unsigned index, const struct retro_game_info *info);
470 // Adds a new valid index (get_num_images()) to the internal disk list.
471 // This will increment subsequent return values from get_num_images() by 1.
472 // This image index cannot be used until a disk image has been set with replace_image_index.
473 typedef bool (*retro_add_image_index_t)(void);
475 struct retro_disk_control_callback
477 retro_set_eject_state_t set_eject_state;
478 retro_get_eject_state_t get_eject_state;
480 retro_get_image_index_t get_image_index;
481 retro_set_image_index_t set_image_index;
482 retro_get_num_images_t get_num_images;
484 retro_replace_image_index_t replace_image_index;
485 retro_add_image_index_t add_image_index;
488 enum retro_pixel_format
490 // 0RGB1555, native endian. 0 bit must be set to 0.
491 // This pixel format is default for compatibility concerns only.
492 // If a 15/16-bit pixel format is desired, consider using RGB565.
493 RETRO_PIXEL_FORMAT_0RGB1555 = 0,
495 // XRGB8888, native endian. X bits are ignored.
496 RETRO_PIXEL_FORMAT_XRGB8888 = 1,
498 // RGB565, native endian. This pixel format is the recommended format to use if a 15/16-bit format is desired
499 // as it is the pixel format that is typically available on a wide range of low-power devices.
500 // It is also natively supported in APIs like OpenGL ES.
501 RETRO_PIXEL_FORMAT_RGB565 = 2,
503 // Ensure sizeof() == sizeof(int).
504 RETRO_PIXEL_FORMAT_UNKNOWN = INT_MAX
509 const char *msg; // Message to be displayed.
510 unsigned frames; // Duration in frames of message.
513 // Describes how the libretro implementation maps a libretro input bind
514 // to its internal input system through a human readable string.
515 // This string can be used to better let a user configure input.
516 struct retro_input_descriptor
518 // Associates given parameters with a description.
524 const char *description; // Human readable description for parameters.
525 // The pointer must remain valid until retro_unload_game() is called.
528 struct retro_system_info
530 // All pointers are owned by libretro implementation, and pointers must remain valid until retro_deinit() is called.
532 const char *library_name; // Descriptive name of library. Should not contain any version numbers, etc.
533 const char *library_version; // Descriptive version of core.
535 const char *valid_extensions; // A string listing probably rom extensions the core will be able to load, separated with pipe.
536 // I.e. "bin|rom|iso".
537 // Typically used for a GUI to filter out extensions.
539 bool need_fullpath; // If true, retro_load_game() is guaranteed to provide a valid pathname in retro_game_info::path.
540 // ::data and ::size are both invalid.
541 // If false, ::data and ::size are guaranteed to be valid, but ::path might not be valid.
542 // This is typically set to true for libretro implementations that must load from file.
543 // Implementations should strive for setting this to false, as it allows the frontend to perform patching, etc.
545 bool block_extract; // If true, the frontend is not allowed to extract any archives before loading the real ROM.
546 // Necessary for certain libretro implementations that load games from zipped archives.
549 struct retro_game_geometry
551 unsigned base_width; // Nominal video width of game.
552 unsigned base_height; // Nominal video height of game.
553 unsigned max_width; // Maximum possible width of game.
554 unsigned max_height; // Maximum possible height of game.
556 float aspect_ratio; // Nominal aspect ratio of game. If aspect_ratio is <= 0.0,
557 // an aspect ratio of base_width / base_height is assumed.
558 // A frontend could override this setting if desired.
561 struct retro_system_timing
563 double fps; // FPS of video content.
564 double sample_rate; // Sampling rate of audio.
567 struct retro_system_av_info
569 struct retro_game_geometry geometry;
570 struct retro_system_timing timing;
573 struct retro_variable
575 const char *key; // Variable to query in RETRO_ENVIRONMENT_GET_VARIABLE.
576 // If NULL, obtains the complete environment string if more complex parsing is necessary.
577 // The environment string is formatted as key-value pairs delimited by semicolons as so:
578 // "key1=value1;key2=value2;..."
579 const char *value; // Value to be obtained. If key does not exist, it is set to NULL.
582 struct retro_game_info
584 const char *path; // Path to game, UTF-8 encoded. Usually used as a reference.
585 // May be NULL if rom was loaded from stdin or similar.
586 // retro_system_info::need_fullpath guaranteed that this path is valid.
587 const void *data; // Memory buffer of loaded game. Will be NULL if need_fullpath was set.
588 size_t size; // Size of memory buffer.
589 const char *meta; // String of implementation specific meta-data.
594 // Environment callback. Gives implementations a way of performing uncommon tasks. Extensible.
595 typedef bool (*retro_environment_t)(unsigned cmd, void *data);
597 // Render a frame. Pixel format is 15-bit 0RGB1555 native endian unless changed (see RETRO_ENVIRONMENT_SET_PIXEL_FORMAT).
598 // Width and height specify dimensions of buffer.
599 // Pitch specifices length in bytes between two lines in buffer.
600 // For performance reasons, it is highly recommended to have a frame that is packed in memory, i.e. pitch == width * byte_per_pixel.
601 // Certain graphic APIs, such as OpenGL ES, do not like textures that are not packed in memory.
602 typedef void (*retro_video_refresh_t)(const void *data, unsigned width, unsigned height, size_t pitch);
604 // Renders a single audio frame. Should only be used if implementation generates a single sample at a time.
605 // Format is signed 16-bit native endian.
606 typedef void (*retro_audio_sample_t)(int16_t left, int16_t right);
607 // Renders multiple audio frames in one go. One frame is defined as a sample of left and right channels, interleaved.
608 // I.e. int16_t buf[4] = { l, r, l, r }; would be 2 frames.
609 // Only one of the audio callbacks must ever be used.
610 typedef size_t (*retro_audio_sample_batch_t)(const int16_t *data, size_t frames);
613 typedef void (*retro_input_poll_t)(void);
614 // Queries for input for player 'port'. device will be masked with RETRO_DEVICE_MASK.
615 // Specialization of devices such as RETRO_DEVICE_JOYPAD_MULTITAP that have been set with retro_set_controller_port_device()
616 // will still use the higher level RETRO_DEVICE_JOYPAD to request input.
617 typedef int16_t (*retro_input_state_t)(unsigned port, unsigned device, unsigned index, unsigned id);
619 // Sets callbacks. retro_set_environment() is guaranteed to be called before retro_init().
620 // The rest of the set_* functions are guaranteed to have been called before the first call to retro_run() is made.
621 void retro_set_environment(retro_environment_t);
622 void retro_set_video_refresh(retro_video_refresh_t);
623 void retro_set_audio_sample(retro_audio_sample_t);
624 void retro_set_audio_sample_batch(retro_audio_sample_batch_t);
625 void retro_set_input_poll(retro_input_poll_t);
626 void retro_set_input_state(retro_input_state_t);
628 // Library global initialization/deinitialization.
629 void retro_init(void);
630 void retro_deinit(void);
632 // Must return RETRO_API_VERSION. Used to validate ABI compatibility when the API is revised.
633 unsigned retro_api_version(void);
635 // Gets statically known system info. Pointers provided in *info must be statically allocated.
636 // Can be called at any time, even before retro_init().
637 void retro_get_system_info(struct retro_system_info *info);
639 // Gets information about system audio/video timings and geometry.
640 // Can be called only after retro_load_game() has successfully completed.
641 // NOTE: The implementation of this function might not initialize every variable if needed.
642 // E.g. geom.aspect_ratio might not be initialized if core doesn't desire a particular aspect ratio.
643 void retro_get_system_av_info(struct retro_system_av_info *info);
645 // Sets device to be used for player 'port'.
646 void retro_set_controller_port_device(unsigned port, unsigned device);
648 // Resets the current game.
649 void retro_reset(void);
651 // Runs the game for one video frame.
652 // During retro_run(), input_poll callback must be called at least once.
654 // If a frame is not rendered for reasons where a game "dropped" a frame,
655 // this still counts as a frame, and retro_run() should explicitly dupe a frame if GET_CAN_DUPE returns true.
656 // In this case, the video callback can take a NULL argument for data.
657 void retro_run(void);
659 // Returns the amount of data the implementation requires to serialize internal state (save states).
660 // 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
661 // ensure that the frontend can allocate a save state buffer once.
662 size_t retro_serialize_size(void);
664 // Serializes internal state. If failed, or size is lower than retro_serialize_size(), it should return false, true otherwise.
665 bool retro_serialize(void *data, size_t size);
666 bool retro_unserialize(const void *data, size_t size);
668 void retro_cheat_reset(void);
669 void retro_cheat_set(unsigned index, bool enabled, const char *code);
672 bool retro_load_game(const struct retro_game_info *game);
674 // Loads a "special" kind of game. Should not be used except in extreme cases.
675 bool retro_load_game_special(
677 const struct retro_game_info *info, size_t num_info
680 // Unloads a currently loaded game.
681 void retro_unload_game(void);
683 // Gets region of game.
684 unsigned retro_get_region(void);
686 // Gets region of memory.
687 void *retro_get_memory_data(unsigned id);
688 size_t retro_get_memory_size(unsigned id);