libretro.h 102 KB
Newer Older
Libretro-Admin's avatar
Libretro-Admin committed
1
/* Copyright (C) 2010-2017 The RetroArch team
Higor Eurípedes's avatar
Higor Eurípedes committed
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
 *
 * ---------------------------------------------------------------------------------------
 * The following license statement only applies to this libretro API header (libretro.h).
 * ---------------------------------------------------------------------------------------
 *
 * Permission is hereby granted, free of charge,
 * to any person obtaining a copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation the rights to
 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software,
 * and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
 * INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */

#ifndef LIBRETRO_H__
#define LIBRETRO_H__

#include <stdint.h>
#include <stddef.h>
#include <limits.h>

#ifdef __cplusplus
extern "C" {
#endif

#ifndef __cplusplus
#if defined(_MSC_VER) && !defined(SN_TARGET_PS3)
Alcaro's avatar
Alcaro committed
36
37
/* Hack applied for MSVC when compiling in C89 mode
 * as it isn't C99-compliant. */
Higor Eurípedes's avatar
Higor Eurípedes committed
38
39
40
41
42
43
44
45
#define bool unsigned char
#define true 1
#define false 0
#else
#include <stdbool.h>
#endif
#endif

Libretro-Admin's avatar
Libretro-Admin committed
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
#ifndef RETRO_CALLCONV
#  if defined(__GNUC__) && defined(__i386__) && !defined(__x86_64__)
#    define RETRO_CALLCONV __attribute__((cdecl))
#  elif defined(_MSC_VER) && defined(_M_X86) && !defined(_M_X64)
#    define RETRO_CALLCONV __cdecl
#  else
#    define RETRO_CALLCONV /* all other platforms only have one calling convention each */
#  endif
#endif

#ifndef RETRO_API
#  if defined(_WIN32) || defined(__CYGWIN__) || defined(__MINGW32__)
#    ifdef RETRO_IMPORT_SYMBOLS
#      ifdef __GNUC__
#        define RETRO_API RETRO_CALLCONV __attribute__((__dllimport__))
#      else
#        define RETRO_API RETRO_CALLCONV __declspec(dllimport)
#      endif
#    else
#      ifdef __GNUC__
#        define RETRO_API RETRO_CALLCONV __attribute__((__dllexport__))
#      else
#        define RETRO_API RETRO_CALLCONV __declspec(dllexport)
#      endif
#    endif
#  else
#      if defined(__GNUC__) && __GNUC__ >= 4 && !defined(__CELLOS_LV2__)
#        define RETRO_API RETRO_CALLCONV __attribute__((__visibility__("default")))
#      else
#        define RETRO_API RETRO_CALLCONV
#      endif
#  endif
#endif

Alcaro's avatar
Alcaro committed
80
81
82
83
/* Used for checking API/ABI mismatches that can break libretro 
 * implementations.
 * It is not incremented for compatible changes to the API.
 */
Higor Eurípedes's avatar
Higor Eurípedes committed
84
85
#define RETRO_API_VERSION         1

Alcaro's avatar
Alcaro committed
86
87
88
89
90
91
92
93
94
95
96
97
98
/*
 * Libretro's fundamental device abstractions.
 *
 * Libretro's input system consists of some standardized device types,
 * such as a joypad (with/without analog), mouse, keyboard, lightgun 
 * and a pointer.
 *
 * The functionality of these devices are fixed, and individual cores 
 * map their own concept of a controller to libretro's abstractions.
 * This makes it possible for frontends to map the abstract types to a 
 * real input device, and not having to worry about binding input 
 * correctly to arbitrary controller layouts.
 */
Higor Eurípedes's avatar
Higor Eurípedes committed
99
100
101
102
103

#define RETRO_DEVICE_TYPE_SHIFT         8
#define RETRO_DEVICE_MASK               ((1 << RETRO_DEVICE_TYPE_SHIFT) - 1)
#define RETRO_DEVICE_SUBCLASS(base, id) (((id + 1) << RETRO_DEVICE_TYPE_SHIFT) | base)

Alcaro's avatar
Alcaro committed
104
/* Input disabled. */
Higor Eurípedes's avatar
Higor Eurípedes committed
105
106
#define RETRO_DEVICE_NONE         0

Alcaro's avatar
Alcaro committed
107
108
109
/* The JOYPAD is called RetroPad. It is essentially a Super Nintendo 
 * controller, but with additional L2/R2/L3/R3 buttons, similar to a 
 * PS1 DualShock. */
Higor Eurípedes's avatar
Higor Eurípedes committed
110
111
#define RETRO_DEVICE_JOYPAD       1

Alcaro's avatar
Alcaro committed
112
113
114
115
116
117
118
/* The mouse is a simple mouse, similar to Super Nintendo's mouse.
 * X and Y coordinates are reported relatively to last poll (poll callback).
 * It is up to the libretro implementation to keep track of where the mouse 
 * pointer is supposed to be on the screen.
 * The frontend must make sure not to interfere with its own hardware 
 * mouse pointer.
 */
Higor Eurípedes's avatar
Higor Eurípedes committed
119
120
#define RETRO_DEVICE_MOUSE        2

Alcaro's avatar
Alcaro committed
121
122
123
124
125
126
/* KEYBOARD device lets one poll for raw key pressed.
 * It is poll based, so input callback will return with the current 
 * pressed state.
 * For event/text based keyboard input, see
 * RETRO_ENVIRONMENT_SET_KEYBOARD_CALLBACK.
 */
Higor Eurípedes's avatar
Higor Eurípedes committed
127
128
#define RETRO_DEVICE_KEYBOARD     3

Alcaro's avatar
Alcaro committed
129
130
/* Lightgun X/Y coordinates are reported relatively to last poll,
 * similar to mouse. */
Higor Eurípedes's avatar
Higor Eurípedes committed
131
132
#define RETRO_DEVICE_LIGHTGUN     4

Alcaro's avatar
Alcaro committed
133
134
135
136
137
138
139
/* The ANALOG device is an extension to JOYPAD (RetroPad).
 * Similar to DualShock it adds two analog sticks.
 * This is treated as a separate device type as it returns values in the 
 * full analog range of [-0x8000, 0x7fff]. Positive X axis is right.
 * Positive Y axis is down.
 * Only use ANALOG type when polling for analog values of the axes.
 */
Higor Eurípedes's avatar
Higor Eurípedes committed
140
141
#define RETRO_DEVICE_ANALOG       5

Alcaro's avatar
Alcaro committed
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
/* Abstracts the concept of a pointing mechanism, e.g. touch.
 * This allows libretro to query in absolute coordinates where on the 
 * screen a mouse (or something similar) is being placed.
 * For a touch centric device, coordinates reported are the coordinates
 * of the press.
 *
 * Coordinates in X and Y are reported as:
 * [-0x7fff, 0x7fff]: -0x7fff corresponds to the far left/top of the screen,
 * and 0x7fff corresponds to the far right/bottom of the screen.
 * The "screen" is here defined as area that is passed to the frontend and 
 * later displayed on the monitor.
 *
 * The frontend is free to scale/resize this screen as it sees fit, however,
 * (X, Y) = (-0x7fff, -0x7fff) will correspond to the top-left pixel of the 
 * game image, etc.
 *
 * To check if the pointer coordinates are valid (e.g. a touch display 
 * actually being touched), PRESSED returns 1 or 0.
 *
 * If using a mouse on a desktop, PRESSED will usually correspond to the 
 * left mouse button, but this is a frontend decision.
 * PRESSED will only return 1 if the pointer is inside the game screen.
 *
 * For multi-touch, the index variable can be used to successively query 
 * more presses.
 * If index = 0 returns true for _PRESSED, coordinates can be extracted
 * with _X, _Y for index = 0. One can then query _PRESSED, _X, _Y with 
 * index = 1, and so on.
 * Eventually _PRESSED will return false for an index. No further presses 
 * are registered at this point. */
Higor Eurípedes's avatar
Higor Eurípedes committed
172
173
#define RETRO_DEVICE_POINTER      6

Alcaro's avatar
Alcaro committed
174
175
176
177
/* Buttons for the RetroPad (JOYPAD).
 * The placement of these is equivalent to placements on the 
 * Super Nintendo controller.
 * L2/R2/L3/R3 buttons correspond to the PS1 DualShock. */
Higor Eurípedes's avatar
Higor Eurípedes committed
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
#define RETRO_DEVICE_ID_JOYPAD_B        0
#define RETRO_DEVICE_ID_JOYPAD_Y        1
#define RETRO_DEVICE_ID_JOYPAD_SELECT   2
#define RETRO_DEVICE_ID_JOYPAD_START    3
#define RETRO_DEVICE_ID_JOYPAD_UP       4
#define RETRO_DEVICE_ID_JOYPAD_DOWN     5
#define RETRO_DEVICE_ID_JOYPAD_LEFT     6
#define RETRO_DEVICE_ID_JOYPAD_RIGHT    7
#define RETRO_DEVICE_ID_JOYPAD_A        8
#define RETRO_DEVICE_ID_JOYPAD_X        9
#define RETRO_DEVICE_ID_JOYPAD_L       10
#define RETRO_DEVICE_ID_JOYPAD_R       11
#define RETRO_DEVICE_ID_JOYPAD_L2      12
#define RETRO_DEVICE_ID_JOYPAD_R2      13
#define RETRO_DEVICE_ID_JOYPAD_L3      14
#define RETRO_DEVICE_ID_JOYPAD_R3      15

Alcaro's avatar
Alcaro committed
195
/* Index / Id values for ANALOG device. */
Higor Eurípedes's avatar
Higor Eurípedes committed
196
197
198
199
200
#define RETRO_DEVICE_INDEX_ANALOG_LEFT   0
#define RETRO_DEVICE_INDEX_ANALOG_RIGHT  1
#define RETRO_DEVICE_ID_ANALOG_X         0
#define RETRO_DEVICE_ID_ANALOG_Y         1

Alcaro's avatar
Alcaro committed
201
/* Id values for MOUSE. */
Libretro-Admin's avatar
Libretro-Admin committed
202
203
204
205
206
207
208
209
210
#define RETRO_DEVICE_ID_MOUSE_X                0
#define RETRO_DEVICE_ID_MOUSE_Y                1
#define RETRO_DEVICE_ID_MOUSE_LEFT             2
#define RETRO_DEVICE_ID_MOUSE_RIGHT            3
#define RETRO_DEVICE_ID_MOUSE_WHEELUP          4
#define RETRO_DEVICE_ID_MOUSE_WHEELDOWN        5
#define RETRO_DEVICE_ID_MOUSE_MIDDLE           6
#define RETRO_DEVICE_ID_MOUSE_HORIZ_WHEELUP    7
#define RETRO_DEVICE_ID_MOUSE_HORIZ_WHEELDOWN  8
Higor Eurípedes's avatar
Higor Eurípedes committed
211

Alcaro's avatar
Alcaro committed
212
/* Id values for LIGHTGUN types. */
Higor Eurípedes's avatar
Higor Eurípedes committed
213
214
215
216
217
218
219
220
#define RETRO_DEVICE_ID_LIGHTGUN_X        0
#define RETRO_DEVICE_ID_LIGHTGUN_Y        1
#define RETRO_DEVICE_ID_LIGHTGUN_TRIGGER  2
#define RETRO_DEVICE_ID_LIGHTGUN_CURSOR   3
#define RETRO_DEVICE_ID_LIGHTGUN_TURBO    4
#define RETRO_DEVICE_ID_LIGHTGUN_PAUSE    5
#define RETRO_DEVICE_ID_LIGHTGUN_START    6

Alcaro's avatar
Alcaro committed
221
/* Id values for POINTER. */
Higor Eurípedes's avatar
Higor Eurípedes committed
222
223
224
225
#define RETRO_DEVICE_ID_POINTER_X         0
#define RETRO_DEVICE_ID_POINTER_Y         1
#define RETRO_DEVICE_ID_POINTER_PRESSED   2

Alcaro's avatar
Alcaro committed
226
/* Returned from retro_get_region(). */
Higor Eurípedes's avatar
Higor Eurípedes committed
227
228
229
#define RETRO_REGION_NTSC  0
#define RETRO_REGION_PAL   1

Alcaro's avatar
Alcaro committed
230
231
232
/* Id values for LANGUAGE */
enum retro_language
{
Libretro-Admin's avatar
Libretro-Admin committed
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
   RETRO_LANGUAGE_ENGLISH             = 0,
   RETRO_LANGUAGE_JAPANESE            = 1,
   RETRO_LANGUAGE_FRENCH              = 2,
   RETRO_LANGUAGE_SPANISH             = 3,
   RETRO_LANGUAGE_GERMAN              = 4,
   RETRO_LANGUAGE_ITALIAN             = 5,
   RETRO_LANGUAGE_DUTCH               = 6,
   RETRO_LANGUAGE_PORTUGUESE_BRAZIL   = 7,
   RETRO_LANGUAGE_PORTUGUESE_PORTUGAL = 8,
   RETRO_LANGUAGE_RUSSIAN             = 9,
   RETRO_LANGUAGE_KOREAN              = 10,
   RETRO_LANGUAGE_CHINESE_TRADITIONAL = 11,
   RETRO_LANGUAGE_CHINESE_SIMPLIFIED  = 12,
   RETRO_LANGUAGE_ESPERANTO           = 13,
   RETRO_LANGUAGE_POLISH              = 14,
   RETRO_LANGUAGE_VIETNAMESE          = 15,
Alcaro's avatar
Alcaro committed
249
250
251
252
253
254
255
256
257
258
   RETRO_LANGUAGE_LAST,

   /* Ensure sizeof(enum) == sizeof(int) */
   RETRO_LANGUAGE_DUMMY          = INT_MAX 
};

/* Passed to retro_get_memory_data/size().
 * If the memory type doesn't apply to the 
 * implementation NULL/0 can be returned.
 */
Higor Eurípedes's avatar
Higor Eurípedes committed
259
260
#define RETRO_MEMORY_MASK        0xff

Alcaro's avatar
Alcaro committed
261
262
263
264
265
/* Regular save RAM. This RAM is usually found on a game cartridge,
 * backed up by a battery.
 * If save game data is too complex for a single memory buffer,
 * the SAVE_DIRECTORY (preferably) or SYSTEM_DIRECTORY environment
 * callback can be used. */
Higor Eurípedes's avatar
Higor Eurípedes committed
266
267
#define RETRO_MEMORY_SAVE_RAM    0

Alcaro's avatar
Alcaro committed
268
269
270
/* Some games have a built-in clock to keep track of time.
 * This memory is usually just a couple of bytes to keep track of time.
 */
Higor Eurípedes's avatar
Higor Eurípedes committed
271
272
#define RETRO_MEMORY_RTC         1

Alcaro's avatar
Alcaro committed
273
/* System ram lets a frontend peek into a game systems main RAM. */
Higor Eurípedes's avatar
Higor Eurípedes committed
274
275
#define RETRO_MEMORY_SYSTEM_RAM  2

Alcaro's avatar
Alcaro committed
276
/* Video ram lets a frontend peek into a game systems video RAM (VRAM). */
Higor Eurípedes's avatar
Higor Eurípedes committed
277
278
#define RETRO_MEMORY_VIDEO_RAM   3

Alcaro's avatar
Alcaro committed
279
/* Keysyms used for ID in input state callback when polling RETRO_KEYBOARD. */
Higor Eurípedes's avatar
Higor Eurípedes committed
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
enum retro_key
{
   RETROK_UNKNOWN        = 0,
   RETROK_FIRST          = 0,
   RETROK_BACKSPACE      = 8,
   RETROK_TAB            = 9,
   RETROK_CLEAR          = 12,
   RETROK_RETURN         = 13,
   RETROK_PAUSE          = 19,
   RETROK_ESCAPE         = 27,
   RETROK_SPACE          = 32,
   RETROK_EXCLAIM        = 33,
   RETROK_QUOTEDBL       = 34,
   RETROK_HASH           = 35,
   RETROK_DOLLAR         = 36,
   RETROK_AMPERSAND      = 38,
   RETROK_QUOTE          = 39,
   RETROK_LEFTPAREN      = 40,
   RETROK_RIGHTPAREN     = 41,
   RETROK_ASTERISK       = 42,
   RETROK_PLUS           = 43,
   RETROK_COMMA          = 44,
   RETROK_MINUS          = 45,
   RETROK_PERIOD         = 46,
   RETROK_SLASH          = 47,
   RETROK_0              = 48,
   RETROK_1              = 49,
   RETROK_2              = 50,
   RETROK_3              = 51,
   RETROK_4              = 52,
   RETROK_5              = 53,
   RETROK_6              = 54,
   RETROK_7              = 55,
   RETROK_8              = 56,
   RETROK_9              = 57,
   RETROK_COLON          = 58,
   RETROK_SEMICOLON      = 59,
   RETROK_LESS           = 60,
   RETROK_EQUALS         = 61,
   RETROK_GREATER        = 62,
   RETROK_QUESTION       = 63,
   RETROK_AT             = 64,
   RETROK_LEFTBRACKET    = 91,
   RETROK_BACKSLASH      = 92,
   RETROK_RIGHTBRACKET   = 93,
   RETROK_CARET          = 94,
   RETROK_UNDERSCORE     = 95,
   RETROK_BACKQUOTE      = 96,
   RETROK_a              = 97,
   RETROK_b              = 98,
   RETROK_c              = 99,
   RETROK_d              = 100,
   RETROK_e              = 101,
   RETROK_f              = 102,
   RETROK_g              = 103,
   RETROK_h              = 104,
   RETROK_i              = 105,
   RETROK_j              = 106,
   RETROK_k              = 107,
   RETROK_l              = 108,
   RETROK_m              = 109,
   RETROK_n              = 110,
   RETROK_o              = 111,
   RETROK_p              = 112,
   RETROK_q              = 113,
   RETROK_r              = 114,
   RETROK_s              = 115,
   RETROK_t              = 116,
   RETROK_u              = 117,
   RETROK_v              = 118,
   RETROK_w              = 119,
   RETROK_x              = 120,
   RETROK_y              = 121,
   RETROK_z              = 122,
   RETROK_DELETE         = 127,

   RETROK_KP0            = 256,
   RETROK_KP1            = 257,
   RETROK_KP2            = 258,
   RETROK_KP3            = 259,
   RETROK_KP4            = 260,
   RETROK_KP5            = 261,
   RETROK_KP6            = 262,
   RETROK_KP7            = 263,
   RETROK_KP8            = 264,
   RETROK_KP9            = 265,
   RETROK_KP_PERIOD      = 266,
   RETROK_KP_DIVIDE      = 267,
   RETROK_KP_MULTIPLY    = 268,
   RETROK_KP_MINUS       = 269,
   RETROK_KP_PLUS        = 270,
   RETROK_KP_ENTER       = 271,
   RETROK_KP_EQUALS      = 272,

   RETROK_UP             = 273,
   RETROK_DOWN           = 274,
   RETROK_RIGHT          = 275,
   RETROK_LEFT           = 276,
   RETROK_INSERT         = 277,
   RETROK_HOME           = 278,
   RETROK_END            = 279,
   RETROK_PAGEUP         = 280,
   RETROK_PAGEDOWN       = 281,

   RETROK_F1             = 282,
   RETROK_F2             = 283,
   RETROK_F3             = 284,
   RETROK_F4             = 285,
   RETROK_F5             = 286,
   RETROK_F6             = 287,
   RETROK_F7             = 288,
   RETROK_F8             = 289,
   RETROK_F9             = 290,
   RETROK_F10            = 291,
   RETROK_F11            = 292,
   RETROK_F12            = 293,
   RETROK_F13            = 294,
   RETROK_F14            = 295,
   RETROK_F15            = 296,

   RETROK_NUMLOCK        = 300,
   RETROK_CAPSLOCK       = 301,
   RETROK_SCROLLOCK      = 302,
   RETROK_RSHIFT         = 303,
   RETROK_LSHIFT         = 304,
   RETROK_RCTRL          = 305,
   RETROK_LCTRL          = 306,
   RETROK_RALT           = 307,
   RETROK_LALT           = 308,
   RETROK_RMETA          = 309,
   RETROK_LMETA          = 310,
   RETROK_LSUPER         = 311,
   RETROK_RSUPER         = 312,
   RETROK_MODE           = 313,
   RETROK_COMPOSE        = 314,

   RETROK_HELP           = 315,
   RETROK_PRINT          = 316,
   RETROK_SYSREQ         = 317,
   RETROK_BREAK          = 318,
   RETROK_MENU           = 319,
   RETROK_POWER          = 320,
   RETROK_EURO           = 321,
   RETROK_UNDO           = 322,

   RETROK_LAST,

Alcaro's avatar
Alcaro committed
427
   RETROK_DUMMY          = INT_MAX /* Ensure sizeof(enum) == sizeof(int) */
Higor Eurípedes's avatar
Higor Eurípedes committed
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
};

enum retro_mod
{
   RETROKMOD_NONE       = 0x0000,

   RETROKMOD_SHIFT      = 0x01,
   RETROKMOD_CTRL       = 0x02,
   RETROKMOD_ALT        = 0x04,
   RETROKMOD_META       = 0x08,

   RETROKMOD_NUMLOCK    = 0x10,
   RETROKMOD_CAPSLOCK   = 0x20,
   RETROKMOD_SCROLLOCK  = 0x40,

Alcaro's avatar
Alcaro committed
443
   RETROKMOD_DUMMY = INT_MAX /* Ensure sizeof(enum) == sizeof(int) */
Higor Eurípedes's avatar
Higor Eurípedes committed
444
445
};

Alcaro's avatar
Alcaro committed
446
447
/* If set, this call is not part of the public libretro API yet. It can 
 * change or be removed at any time. */
Higor Eurípedes's avatar
Higor Eurípedes committed
448
#define RETRO_ENVIRONMENT_EXPERIMENTAL 0x10000
Alcaro's avatar
Alcaro committed
449
/* Environment callback to be used internally in frontend. */
Higor Eurípedes's avatar
Higor Eurípedes committed
450
451
#define RETRO_ENVIRONMENT_PRIVATE 0x20000

Alcaro's avatar
Alcaro committed
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
/* Environment commands. */
#define RETRO_ENVIRONMENT_SET_ROTATION  1  /* const unsigned * --
                                            * Sets screen rotation of graphics.
                                            * Is only implemented if rotation can be accelerated by hardware.
                                            * Valid values are 0, 1, 2, 3, which rotates screen by 0, 90, 180, 
                                            * 270 degrees counter-clockwise respectively.
                                            */
#define RETRO_ENVIRONMENT_GET_OVERSCAN  2  /* bool * --
                                            * Boolean value whether or not the implementation should use overscan, 
                                            * or crop away overscan.
                                            */
#define RETRO_ENVIRONMENT_GET_CAN_DUPE  3  /* bool * --
                                            * Boolean value whether or not frontend supports frame duping,
                                            * passing NULL to video frame callback.
                                            */

                                           /* Environ 4, 5 are no longer supported (GET_VARIABLE / SET_VARIABLES), 
                                            * and reserved to avoid possible ABI clash.
                                            */

#define RETRO_ENVIRONMENT_SET_MESSAGE   6  /* const struct retro_message * --
                                            * Sets a message to be displayed in implementation-specific manner 
                                            * for a certain amount of 'frames'.
                                            * Should not be used for trivial messages, which should simply be 
                                            * logged via RETRO_ENVIRONMENT_GET_LOG_INTERFACE (or as a 
                                            * fallback, stderr).
                                            */
#define RETRO_ENVIRONMENT_SHUTDOWN      7  /* N/A (NULL) --
                                            * Requests the frontend to shutdown.
                                            * Should only be used if game has a specific
                                            * way to shutdown the game from a menu item or similar.
                                            */
Higor Eurípedes's avatar
Higor Eurípedes committed
484
#define RETRO_ENVIRONMENT_SET_PERFORMANCE_LEVEL 8
Alcaro's avatar
Alcaro committed
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
                                           /* const unsigned * --
                                            * Gives a hint to the frontend how demanding this implementation
                                            * is on a system. E.g. reporting a level of 2 means
                                            * this implementation should run decently on all frontends
                                            * of level 2 and up.
                                            *
                                            * It can be used by the frontend to potentially warn
                                            * about too demanding implementations.
                                            *
                                            * The levels are "floating".
                                            *
                                            * This function can be called on a per-game basis,
                                            * as certain games an implementation can play might be
                                            * particularly demanding.
                                            * If called, it should be called in retro_load_game().
                                            */
Higor Eurípedes's avatar
Higor Eurípedes committed
501
#define RETRO_ENVIRONMENT_GET_SYSTEM_DIRECTORY 9
Alcaro's avatar
Alcaro committed
502
503
504
505
506
507
508
509
510
511
512
513
514
                                           /* const char ** --
                                            * Returns the "system" directory of the frontend.
                                            * This directory can be used to store system specific 
                                            * content such as BIOSes, configuration data, etc.
                                            * The returned value can be NULL.
                                            * If so, no such directory is defined,
                                            * and it's up to the implementation to find a suitable directory.
                                            *
                                            * NOTE: Some cores used this folder also for "save" data such as 
                                            * memory cards, etc, for lack of a better place to put it.
                                            * This is now discouraged, and if possible, cores should try to 
                                            * use the new GET_SAVE_DIRECTORY.
                                            */
Higor Eurípedes's avatar
Higor Eurípedes committed
515
#define RETRO_ENVIRONMENT_SET_PIXEL_FORMAT 10
Alcaro's avatar
Alcaro committed
516
517
518
519
520
521
522
523
524
525
                                           /* const enum retro_pixel_format * --
                                            * Sets the internal pixel format used by the implementation.
                                            * The default pixel format is RETRO_PIXEL_FORMAT_0RGB1555.
                                            * This pixel format however, is deprecated (see enum retro_pixel_format).
                                            * If the call returns false, the frontend does not support this pixel 
                                            * format.
                                            *
                                            * This function should be called inside retro_load_game() or 
                                            * retro_get_system_av_info().
                                            */
Higor Eurípedes's avatar
Higor Eurípedes committed
526
#define RETRO_ENVIRONMENT_SET_INPUT_DESCRIPTORS 11
Alcaro's avatar
Alcaro committed
527
528
529
530
531
532
533
534
                                           /* const struct retro_input_descriptor * --
                                            * Sets an array of retro_input_descriptors.
                                            * It is up to the frontend to present this in a usable way.
                                            * The array is terminated by retro_input_descriptor::description 
                                            * being set to NULL.
                                            * This function can be called at any time, but it is recommended 
                                            * to call it as early as possible.
                                            */
Higor Eurípedes's avatar
Higor Eurípedes committed
535
#define RETRO_ENVIRONMENT_SET_KEYBOARD_CALLBACK 12
Alcaro's avatar
Alcaro committed
536
537
538
                                           /* const struct retro_keyboard_callback * --
                                            * Sets a callback function used to notify core about keyboard events.
                                            */
Higor Eurípedes's avatar
Higor Eurípedes committed
539
#define RETRO_ENVIRONMENT_SET_DISK_CONTROL_INTERFACE 13
Alcaro's avatar
Alcaro committed
540
541
542
543
544
545
                                           /* const struct retro_disk_control_callback * --
                                            * Sets an interface which frontend can use to eject and insert 
                                            * disk images.
                                            * This is used for games which consist of multiple images and 
                                            * must be manually swapped out by the user (e.g. PSX).
                                            */
Higor Eurípedes's avatar
Higor Eurípedes committed
546
#define RETRO_ENVIRONMENT_SET_HW_RENDER 14
Alcaro's avatar
Alcaro committed
547
548
549
550
551
552
553
554
555
556
557
                                           /* struct retro_hw_render_callback * --
                                            * Sets an interface to let a libretro core render with 
                                            * hardware acceleration.
                                            * Should be called in retro_load_game().
                                            * If successful, libretro cores will be able to render to a 
                                            * frontend-provided framebuffer.
                                            * The size of this framebuffer will be at least as large as 
                                            * max_width/max_height provided in get_av_info().
                                            * If HW rendering is used, pass only RETRO_HW_FRAME_BUFFER_VALID or 
                                            * NULL to retro_video_refresh_t.
                                            */
Higor Eurípedes's avatar
Higor Eurípedes committed
558
#define RETRO_ENVIRONMENT_GET_VARIABLE 15
Alcaro's avatar
Alcaro committed
559
560
561
562
563
564
565
                                           /* struct retro_variable * --
                                            * Interface to acquire user-defined information from environment
                                            * that cannot feasibly be supported in a multi-system way.
                                            * 'key' should be set to a key which has already been set by 
                                            * SET_VARIABLES.
                                            * 'data' will be set to a value or NULL.
                                            */
Higor Eurípedes's avatar
Higor Eurípedes committed
566
#define RETRO_ENVIRONMENT_SET_VARIABLES 16
Alcaro's avatar
Alcaro committed
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
                                           /* const struct retro_variable * --
                                            * Allows an implementation to signal the environment
                                            * which variables it might want to check for later using 
                                            * GET_VARIABLE.
                                            * This allows the frontend to present these variables to 
                                            * a user dynamically.
                                            * This should be called as early as possible (ideally in 
                                            * retro_set_environment).
                                            *
                                            * 'data' points to an array of retro_variable structs 
                                            * terminated by a { NULL, NULL } element.
                                            * 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'.
                                            * retro_variable::value should contain a human readable 
                                            * description of the key as well as a '|' delimited list 
                                            * of expected values.
                                            *
                                            * The number of possible options should be very limited, 
                                            * i.e. it should be feasible to cycle through options 
                                            * without a keyboard.
                                            *
                                            * First entry should be treated as a default.
                                            *
                                            * Example entry:
                                            * { "foo_option", "Speed hack coprocessor X; false|true" }
                                            *
                                            * Text before first ';' is description. This ';' must be 
                                            * followed by a space, and followed by a list of possible 
                                            * values split up with '|'.
                                            *
                                            * Only strings are operated on. The possible values will 
                                            * generally be displayed and stored as-is by the frontend.
                                            */
Higor Eurípedes's avatar
Higor Eurípedes committed
601
#define RETRO_ENVIRONMENT_GET_VARIABLE_UPDATE 17
Alcaro's avatar
Alcaro committed
602
603
604
605
606
                                           /* bool * --
                                            * Result is set to true if some variables are updated by
                                            * frontend since last call to RETRO_ENVIRONMENT_GET_VARIABLE.
                                            * Variables should be queried with GET_VARIABLE.
                                            */
Higor Eurípedes's avatar
Higor Eurípedes committed
607
#define RETRO_ENVIRONMENT_SET_SUPPORT_NO_GAME 18
Alcaro's avatar
Alcaro committed
608
609
610
611
612
613
                                           /* const bool * --
                                            * If true, the libretro implementation supports calls to 
                                            * retro_load_game() with NULL as argument.
                                            * Used by cores which can run without particular game data.
                                            * This should be called within retro_set_environment() only.
                                            */
Higor Eurípedes's avatar
Higor Eurípedes committed
614
#define RETRO_ENVIRONMENT_GET_LIBRETRO_PATH 19
Alcaro's avatar
Alcaro committed
615
616
617
618
619
620
621
622
623
624
625
626
627
                                           /* const char ** --
                                            * Retrieves the absolute path from where this libretro 
                                            * implementation was loaded.
                                            * NULL is returned if the libretro was loaded statically 
                                            * (i.e. linked statically to frontend), or if the path cannot be 
                                            * determined.
                                            * Mostly useful in cooperation with SET_SUPPORT_NO_GAME as assets can 
                                            * be loaded without ugly hacks.
                                            */
                                           
                                           /* Environment 20 was an obsolete version of SET_AUDIO_CALLBACK. 
                                            * It was not used by any known core at the time,
                                            * and was removed from the API. */
Higor Eurípedes's avatar
Higor Eurípedes committed
628
#define RETRO_ENVIRONMENT_SET_AUDIO_CALLBACK 22
Alcaro's avatar
Alcaro committed
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
                                           /* const struct retro_audio_callback * --
                                            * Sets an interface which is used to notify a libretro core about audio 
                                            * being available for writing.
                                            * The callback can be called from any thread, so a core using this must 
                                            * have a thread safe audio implementation.
                                            * It is intended for games where audio and video are completely 
                                            * asynchronous and audio can be generated on the fly.
                                            * This interface is not recommended for use with emulators which have 
                                            * highly synchronous audio.
                                            *
                                            * The callback only notifies about writability; the libretro core still 
                                            * has to call the normal audio callbacks
                                            * to write audio. The audio callbacks must be called from within the 
                                            * notification callback.
                                            * The amount of audio data to write is up to the implementation.
                                            * Generally, the audio callback will be called continously in a loop.
                                            *
                                            * Due to thread safety guarantees and lack of sync between audio and 
                                            * video, a frontend  can selectively disallow this interface based on 
                                            * internal configuration. A core using this interface must also 
                                            * implement the "normal" audio interface.
                                            *
                                            * A libretro core using SET_AUDIO_CALLBACK should also make use of 
                                            * SET_FRAME_TIME_CALLBACK.
                                            */
Higor Eurípedes's avatar
Higor Eurípedes committed
654
#define RETRO_ENVIRONMENT_SET_FRAME_TIME_CALLBACK 21
Alcaro's avatar
Alcaro committed
655
656
657
658
659
660
661
662
                                           /* const struct retro_frame_time_callback * --
                                            * Lets the core know how much time has passed since last 
                                            * invocation of retro_run().
                                            * The frontend can tamper with the timing to fake fast-forward, 
                                            * slow-motion, frame stepping, etc.
                                            * In this case the delta time will use the reference value 
                                            * in frame_time_callback..
                                            */
Higor Eurípedes's avatar
Higor Eurípedes committed
663
#define RETRO_ENVIRONMENT_GET_RUMBLE_INTERFACE 23
Alcaro's avatar
Alcaro committed
664
665
666
667
668
669
                                           /* struct retro_rumble_interface * --
                                            * Gets an interface which is used by a libretro core to set 
                                            * state of rumble motors in controllers.
                                            * A strong and weak motor is supported, and they can be 
                                            * controlled indepedently.
                                            */
Higor Eurípedes's avatar
Higor Eurípedes committed
670
#define RETRO_ENVIRONMENT_GET_INPUT_DEVICE_CAPABILITIES 24
Alcaro's avatar
Alcaro committed
671
672
673
674
675
676
677
678
                                           /* uint64_t * --
                                            * Gets a bitmask telling which device type are expected to be 
                                            * handled properly in a call to retro_input_state_t.
                                            * Devices which are not handled or recognized always return 
                                            * 0 in retro_input_state_t.
                                            * Example bitmask: caps = (1 << RETRO_DEVICE_JOYPAD) | (1 << RETRO_DEVICE_ANALOG).
                                            * Should only be called in retro_run().
                                            */
Higor Eurípedes's avatar
Higor Eurípedes committed
679
#define RETRO_ENVIRONMENT_GET_SENSOR_INTERFACE (25 | RETRO_ENVIRONMENT_EXPERIMENTAL)
Alcaro's avatar
Alcaro committed
680
681
682
683
684
685
686
687
                                           /* struct retro_sensor_interface * --
                                            * Gets access to the sensor interface.
                                            * The purpose of this interface is to allow
                                            * setting state related to sensors such as polling rate, 
                                            * enabling/disable it entirely, etc.
                                            * Reading sensor state is done via the normal 
                                            * input_state_callback API.
                                            */
Higor Eurípedes's avatar
Higor Eurípedes committed
688
#define RETRO_ENVIRONMENT_GET_CAMERA_INTERFACE (26 | RETRO_ENVIRONMENT_EXPERIMENTAL)
Alcaro's avatar
Alcaro committed
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
                                           /* struct retro_camera_callback * --
                                            * Gets an interface to a video camera driver.
                                            * A libretro core can use this interface to get access to a 
                                            * video camera.
                                            * New video frames are delivered in a callback in same 
                                            * thread as retro_run().
                                            *
                                            * GET_CAMERA_INTERFACE should be called in retro_load_game().
                                            *
                                            * Depending on the camera implementation used, camera frames 
                                            * will be delivered as a raw framebuffer,
                                            * or as an OpenGL texture directly.
                                            *
                                            * The core has to tell the frontend here which types of 
                                            * buffers can be handled properly.
                                            * An OpenGL texture can only be handled when using a 
                                            * libretro GL core (SET_HW_RENDER).
                                            * It is recommended to use a libretro GL core when 
                                            * using camera interface.
                                            *
                                            * The camera is not started automatically. The retrieved start/stop 
                                            * functions must be used to explicitly
                                            * start and stop the camera driver.
                                            */
Higor Eurípedes's avatar
Higor Eurípedes committed
713
#define RETRO_ENVIRONMENT_GET_LOG_INTERFACE 27
Alcaro's avatar
Alcaro committed
714
715
716
717
718
719
720
721
722
                                           /* struct retro_log_callback * --
                                            * Gets an interface for logging. This is useful for 
                                            * logging in a cross-platform way
                                            * as certain platforms cannot use use stderr for logging. 
                                            * It also allows the frontend to
                                            * show logging information in a more suitable way.
                                            * If this interface is not used, libretro cores should 
                                            * log to stderr as desired.
                                            */
Higor Eurípedes's avatar
Higor Eurípedes committed
723
#define RETRO_ENVIRONMENT_GET_PERF_INTERFACE 28
Alcaro's avatar
Alcaro committed
724
725
726
727
728
                                           /* struct retro_perf_callback * --
                                            * Gets an interface for performance counters. This is useful 
                                            * for performance logging in a cross-platform way and for detecting 
                                            * architecture-specific features, such as SIMD support.
                                            */
Higor Eurípedes's avatar
Higor Eurípedes committed
729
#define RETRO_ENVIRONMENT_GET_LOCATION_INTERFACE 29
Alcaro's avatar
Alcaro committed
730
731
732
733
734
735
                                           /* struct retro_location_callback * --
                                            * Gets access to the location interface.
                                            * The purpose of this interface is to be able to retrieve 
                                            * location-based information from the host device,
                                            * such as current latitude / longitude.
                                            */
Libretro-Admin's avatar
Libretro-Admin committed
736
737
#define RETRO_ENVIRONMENT_GET_CONTENT_DIRECTORY 30 /* Old name, kept for compatibility. */
#define RETRO_ENVIRONMENT_GET_CORE_ASSETS_DIRECTORY 30
Alcaro's avatar
Alcaro committed
738
                                           /* const char ** --
Libretro-Admin's avatar
Libretro-Admin committed
739
                                            * Returns the "core assets" directory of the frontend.
Alcaro's avatar
Alcaro committed
740
741
742
743
744
745
746
                                            * This directory can be used to store specific assets that the 
                                            * core relies upon, such as art assets,
                                            * input data, etc etc.
                                            * The returned value can be NULL.
                                            * If so, no such directory is defined,
                                            * and it's up to the implementation to find a suitable directory.
                                            */
Higor Eurípedes's avatar
Higor Eurípedes committed
747
#define RETRO_ENVIRONMENT_GET_SAVE_DIRECTORY 31
Alcaro's avatar
Alcaro committed
748
749
750
751
752
753
754
755
756
757
758
759
760
                                           /* const char ** --
                                            * Returns the "save" directory of the frontend.
                                            * This directory can be used to store SRAM, memory cards, 
                                            * high scores, etc, if the libretro core
                                            * cannot use the regular memory interface (retro_get_memory_data()).
                                            *
                                            * NOTE: libretro cores used to check GET_SYSTEM_DIRECTORY for 
                                            * similar things before.
                                            * They should still check GET_SYSTEM_DIRECTORY if they want to 
                                            * be backwards compatible.
                                            * The path here can be NULL. It should only be non-NULL if the 
                                            * frontend user has set a specific save path.
                                            */
Higor Eurípedes's avatar
Higor Eurípedes committed
761
#define RETRO_ENVIRONMENT_SET_SYSTEM_AV_INFO 32
Alcaro's avatar
Alcaro committed
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
                                           /* const struct retro_system_av_info * --
                                            * Sets a new av_info structure. This can only be called from 
                                            * within retro_run().
                                            * This should *only* be used if the core is completely altering the 
                                            * internal resolutions, aspect ratios, timings, sampling rate, etc.
                                            * Calling this can require a full reinitialization of video/audio 
                                            * drivers in the frontend,
                                            *
                                            * so it is important to call it very sparingly, and usually only with 
                                            * the users explicit consent.
                                            * An eventual driver reinitialize will happen so that video and 
                                            * audio callbacks
                                            * happening after this call within the same retro_run() call will 
                                            * target the newly initialized driver.
                                            *
                                            * This callback makes it possible to support configurable resolutions 
                                            * in games, which can be useful to
                                            * avoid setting the "worst case" in max_width/max_height.
                                            *
                                            * ***HIGHLY RECOMMENDED*** Do not call this callback every time 
                                            * resolution changes in an emulator core if it's
                                            * expected to be a temporary change, for the reasons of possible 
                                            * driver reinitialization.
                                            * This call is not a free pass for not trying to provide 
                                            * correct values in retro_get_system_av_info(). If you need to change 
                                            * things like aspect ratio or nominal width/height, 
                                            * use RETRO_ENVIRONMENT_SET_GEOMETRY, which is a softer variant 
                                            * of SET_SYSTEM_AV_INFO.
                                            *
                                            * If this returns false, the frontend does not acknowledge a 
                                            * changed av_info struct.
                                            */
Higor Eurípedes's avatar
Higor Eurípedes committed
794
#define RETRO_ENVIRONMENT_SET_PROC_ADDRESS_CALLBACK 33
Alcaro's avatar
Alcaro committed
795
796
797
798
799
800
801
802
803
804
                                           /* const struct retro_get_proc_address_interface * --
                                            * Allows a libretro core to announce support for the 
                                            * get_proc_address() interface.
                                            * This interface allows for a standard way to extend libretro where 
                                            * use of environment calls are too indirect,
                                            * e.g. for cases where the frontend wants to call directly into the core.
                                            *
                                            * If a core wants to expose this interface, SET_PROC_ADDRESS_CALLBACK 
                                            * **MUST** be called from within retro_set_environment().
                                            */
Higor Eurípedes's avatar
Higor Eurípedes committed
805
#define RETRO_ENVIRONMENT_SET_SUBSYSTEM_INFO 34
Alcaro's avatar
Alcaro committed
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
                                           /* const struct retro_subsystem_info * --
                                            * This environment call introduces the concept of libretro "subsystems".
                                            * A subsystem is a variant of a libretro core which supports 
                                            * different kinds of games.
                                            * The purpose of this is to support e.g. emulators which might 
                                            * have special needs, e.g. Super Nintendo's Super GameBoy, Sufami Turbo.
                                            * It can also be used to pick among subsystems in an explicit way 
                                            * if the libretro implementation is a multi-system emulator itself.
                                            *
                                            * Loading a game via a subsystem is done with retro_load_game_special(),
                                            * and this environment call allows a libretro core to expose which 
                                            * subsystems are supported for use with retro_load_game_special().
                                            * A core passes an array of retro_game_special_info which is terminated 
                                            * with a zeroed out retro_game_special_info struct.
                                            *
                                            * If a core wants to use this functionality, SET_SUBSYSTEM_INFO
                                            * **MUST** be called from within retro_set_environment().
                                            */
Higor Eurípedes's avatar
Higor Eurípedes committed
824
#define RETRO_ENVIRONMENT_SET_CONTROLLER_INFO 35
Alcaro's avatar
Alcaro committed
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
                                           /* const struct retro_controller_info * --
                                            * This environment call lets a libretro core tell the frontend 
                                            * which controller types are recognized in calls to 
                                            * retro_set_controller_port_device().
                                            *
                                            * Some emulators such as Super Nintendo
                                            * support multiple lightgun types which must be specifically 
                                            * selected from.
                                            * It is therefore sometimes necessary for a frontend to be able 
                                            * to tell the core about a special kind of input device which is 
                                            * not covered by the libretro input API.
                                            *
                                            * In order for a frontend to understand the workings of an input device,
                                            * it must be a specialized type
                                            * of the generic device types already defined in the libretro API.
                                            *
                                            * Which devices are supported can vary per input port.
                                            * The core must pass an array of const struct retro_controller_info which 
                                            * is terminated with a blanked out struct. Each element of the struct 
                                            * corresponds to an ascending port index to 
                                            * retro_set_controller_port_device().
                                            * Even if special device types are set in the libretro core, 
                                            * libretro should only poll input based on the base input device types.
                                            */
Higor Eurípedes's avatar
Higor Eurípedes committed
849
#define RETRO_ENVIRONMENT_SET_MEMORY_MAPS (36 | RETRO_ENVIRONMENT_EXPERIMENTAL)
Alcaro's avatar
Alcaro committed
850
851
852
853
854
855
856
857
858
859
860
861
                                           /* const struct retro_memory_map * --
                                            * This environment call lets a libretro core tell the frontend 
                                            * about the memory maps this core emulates.
                                            * This can be used to implement, for example, cheats in a core-agnostic way.
                                            *
                                            * Should only be used by emulators; it doesn't make much sense for 
                                            * anything else.
                                            * It is recommended to expose all relevant pointers through 
                                            * retro_get_memory_* as well.
                                            *
                                            * Can be called from retro_init and retro_load_game.
                                            */
Higor Eurípedes's avatar
Higor Eurípedes committed
862
#define RETRO_ENVIRONMENT_SET_GEOMETRY 37
Alcaro's avatar
Alcaro committed
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
                                           /* const struct retro_game_geometry * --
                                            * This environment call is similar to SET_SYSTEM_AV_INFO for changing 
                                            * video parameters, but provides a guarantee that drivers will not be 
                                            * reinitialized.
                                            * This can only be called from within retro_run().
                                            *
                                            * The purpose of this call is to allow a core to alter nominal 
                                            * width/heights as well as aspect ratios on-the-fly, which can be 
                                            * useful for some emulators to change in run-time.
                                            *
                                            * max_width/max_height arguments are ignored and cannot be changed
                                            * with this call as this could potentially require a reinitialization or a 
                                            * non-constant time operation.
                                            * If max_width/max_height are to be changed, SET_SYSTEM_AV_INFO is required.
                                            *
                                            * A frontend must guarantee that this environment call completes in 
                                            * constant time.
                                            */
#define RETRO_ENVIRONMENT_GET_USERNAME 38 
                                           /* const char **
                                            * Returns the specified username of the frontend, if specified by the user.
                                            * This username can be used as a nickname for a core that has online facilities 
                                            * or any other mode where personalization of the user is desirable.
                                            * The returned value can be NULL.
                                            * If this environ callback is used by a core that requires a valid username, 
                                            * a default username should be specified by the core.
                                            */
#define RETRO_ENVIRONMENT_GET_LANGUAGE 39
                                           /* unsigned * --
                                            * Returns the specified language of the frontend, if specified by the user.
                                            * It can be used by the core for localization purposes.
                                            */
Libretro-Admin's avatar
Libretro-Admin committed
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
#define RETRO_ENVIRONMENT_GET_CURRENT_SOFTWARE_FRAMEBUFFER (40 | RETRO_ENVIRONMENT_EXPERIMENTAL)
                                           /* struct retro_framebuffer * --
                                            * Returns a preallocated framebuffer which the core can use for rendering
                                            * the frame into when not using SET_HW_RENDER.
                                            * The framebuffer returned from this call must not be used
                                            * after the current call to retro_run() returns.
                                            *
                                            * The goal of this call is to allow zero-copy behavior where a core
                                            * can render directly into video memory, avoiding extra bandwidth cost by copying
                                            * memory from core to video memory.
                                            *
                                            * If this call succeeds and the core renders into it,
                                            * the framebuffer pointer and pitch can be passed to retro_video_refresh_t.
                                            * If the buffer from GET_CURRENT_SOFTWARE_FRAMEBUFFER is to be used,
                                            * the core must pass the exact
                                            * same pointer as returned by GET_CURRENT_SOFTWARE_FRAMEBUFFER;
                                            * i.e. passing a pointer which is offset from the
                                            * buffer is undefined. The width, height and pitch parameters
                                            * must also match exactly to the values obtained from GET_CURRENT_SOFTWARE_FRAMEBUFFER.
                                            *
                                            * It is possible for a frontend to return a different pixel format
                                            * than the one used in SET_PIXEL_FORMAT. This can happen if the frontend
                                            * needs to perform conversion.
                                            *
                                            * It is still valid for a core to render to a different buffer
                                            * even if GET_CURRENT_SOFTWARE_FRAMEBUFFER succeeds.
                                            *
                                            * A frontend must make sure that the pointer obtained from this function is
                                            * writeable (and readable).
                                            */

enum retro_hw_render_interface_type
{
   RETRO_HW_RENDER_INTERFACE_VULKAN = 0,
   RETRO_HW_RENDER_INTERFACE_DUMMY = INT_MAX
};

/* Base struct. All retro_hw_render_interface_* types
 * contain at least these fields. */
struct retro_hw_render_interface
{
   enum retro_hw_render_interface_type interface_type;
   unsigned interface_version;
};
#define RETRO_ENVIRONMENT_GET_HW_RENDER_INTERFACE (41 | RETRO_ENVIRONMENT_EXPERIMENTAL)
                                           /* const struct retro_hw_render_interface ** --
                                            * Returns an API specific rendering interface for accessing API specific data.
                                            * Not all HW rendering APIs support or need this.
                                            * The contents of the returned pointer is specific to the rendering API
                                            * being used. See the various headers like libretro_vulkan.h, etc.
                                            *
                                            * GET_HW_RENDER_INTERFACE cannot be called before context_reset has been called.
                                            * Similarly, after context_destroyed callback returns,
                                            * the contents of the HW_RENDER_INTERFACE are invalidated.
                                            */

#define RETRO_ENVIRONMENT_SET_SUPPORT_ACHIEVEMENTS (42 | RETRO_ENVIRONMENT_EXPERIMENTAL)
                                           /* const bool * --
                                            * If true, the libretro implementation supports achievements
                                            * either via memory descriptors set with RETRO_ENVIRONMENT_SET_MEMORY_MAPS
                                            * or via retro_get_memory_data/retro_get_memory_size.
                                            *
                                            * This must be called before the first call to retro_run.
                                            */

enum retro_hw_render_context_negotiation_interface_type
{
   RETRO_HW_RENDER_CONTEXT_NEGOTIATION_INTERFACE_VULKAN = 0,
   RETRO_HW_RENDER_CONTEXT_NEGOTIATION_INTERFACE_DUMMY = INT_MAX
};

/* Base struct. All retro_hw_render_context_negotiation_interface_* types
 * contain at least these fields. */
struct retro_hw_render_context_negotiation_interface
{
   enum retro_hw_render_context_negotiation_interface_type interface_type;
   unsigned interface_version;
};
#define RETRO_ENVIRONMENT_SET_HW_RENDER_CONTEXT_NEGOTIATION_INTERFACE (43 | RETRO_ENVIRONMENT_EXPERIMENTAL)
                                           /* const struct retro_hw_render_context_negotiation_interface * --
                                            * Sets an interface which lets the libretro core negotiate with frontend how a context is created.
                                            * The semantics of this interface depends on which API is used in SET_HW_RENDER earlier.
                                            * This interface will be used when the frontend is trying to create a HW rendering context,
                                            * so it will be used after SET_HW_RENDER, but before the context_reset callback.
                                            */

/* Serialized state is incomplete in some way. Set if serialization is
 * usable in typical end-user cases but should not be relied upon to
 * implement frame-sensitive frontend features such as netplay or
 * rerecording. */
#define RETRO_SERIALIZATION_QUIRK_INCOMPLETE (1 << 0)
/* The core must spend some time initializing before serialization is
 * supported. retro_serialize() will initially fail; retro_unserialize()
 * and retro_serialize_size() may or may not work correctly either. */
#define RETRO_SERIALIZATION_QUIRK_MUST_INITIALIZE (1 << 1)
/* Serialization size may change within a session. */
#define RETRO_SERIALIZATION_QUIRK_CORE_VARIABLE_SIZE (1 << 2)
/* Set by the frontend to acknowledge that it supports variable-sized
 * states. */
#define RETRO_SERIALIZATION_QUIRK_FRONT_VARIABLE_SIZE (1 << 3)
/* Serialized state can only be loaded during the same session. */
#define RETRO_SERIALIZATION_QUIRK_SINGLE_SESSION (1 << 4)
/* Serialized state cannot be loaded on an architecture with a different
 * endianness from the one it was saved on. */
#define RETRO_SERIALIZATION_QUIRK_ENDIAN_DEPENDENT (1 << 5)
/* Serialized state cannot be loaded on a different platform from the one it
 * was saved on for reasons other than endianness, such as word size
 * dependence */
#define RETRO_SERIALIZATION_QUIRK_PLATFORM_DEPENDENT (1 << 6)

#define RETRO_ENVIRONMENT_SET_SERIALIZATION_QUIRKS 44
                                           /* uint64_t * --
                                            * Sets quirk flags associated with serialization. The frontend will zero any flags it doesn't
                                            * recognize or support. Should be set in either retro_init or retro_load_game, but not both.
                                            */

Alcaro's avatar
Alcaro committed
1011
1012
1013
1014

#define RETRO_MEMDESC_CONST     (1 << 0)   /* The frontend will never change this memory area once retro_load_game has returned. */
#define RETRO_MEMDESC_BIGENDIAN (1 << 1)   /* The memory area contains big endian data. Default is little endian. */
#define RETRO_MEMDESC_ALIGN_2   (1 << 16)  /* All memory access in this area is aligned to their own size, or 2, whichever is smaller. */
Higor Eurípedes's avatar
Higor Eurípedes committed
1015
1016
#define RETRO_MEMDESC_ALIGN_4   (2 << 16)
#define RETRO_MEMDESC_ALIGN_8   (3 << 16)
Alcaro's avatar
Alcaro committed
1017
#define RETRO_MEMDESC_MINSIZE_2 (1 << 24)  /* All memory in this region is accessed at least 2 bytes at the time. */
Higor Eurípedes's avatar
Higor Eurípedes committed
1018
1019
1020
1021
1022
1023
#define RETRO_MEMDESC_MINSIZE_4 (2 << 24)
#define RETRO_MEMDESC_MINSIZE_8 (3 << 24)
struct retro_memory_descriptor
{
   uint64_t flags;

Alcaro's avatar
Alcaro committed
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
   /* Pointer to the start of the relevant ROM or RAM chip.
    * It's strongly recommended to use 'offset' if possible, rather than 
    * doing math on the pointer.
    *
    * If the same byte is mapped my multiple descriptors, their descriptors 
    * must have the same pointer.
    * If 'start' does not point to the first byte in the pointer, put the 
    * difference in 'offset' instead.
    *
    * May be NULL if there's nothing usable here (e.g. hardware registers and 
    * open bus). No flags should be set if the pointer is NULL.
    * It's recommended to minimize the number of descriptors if possible,
    * but not mandatory. */
Higor Eurípedes's avatar
Higor Eurípedes committed
1037
1038
1039
   void *ptr;
   size_t offset;

Alcaro's avatar
Alcaro committed
1040
1041
   /* This is the location in the emulated address space 
    * where the mapping starts. */
Higor Eurípedes's avatar
Higor Eurípedes committed
1042
1043
   size_t start;

Alcaro's avatar
Alcaro committed
1044
1045
1046
1047
1048
1049
   /* Which bits must be same as in 'start' for this mapping to apply.
    * The first memory descriptor to claim a certain byte is the one 
    * that applies.
    * A bit which is set in 'start' must also be set in this.
    * Can be zero, in which case each byte is assumed mapped exactly once. 
    * In this case, 'len' must be a power of two. */
Higor Eurípedes's avatar
Higor Eurípedes committed
1050
1051
   size_t select;

Alcaro's avatar
Alcaro committed
1052
1053
   /* If this is nonzero, the set bits are assumed not connected to the 
    * memory chip's address pins. */
Higor Eurípedes's avatar
Higor Eurípedes committed
1054
1055
   size_t disconnect;

Alcaro's avatar
Alcaro committed
1056
1057
1058
1059
1060
1061
1062
   /* This one tells the size of the current memory area.
    * If, after start+disconnect are applied, the address is higher than 
    * this, the highest bit of the address is cleared.
    *
    * If the address is still too high, the next highest bit is cleared.
    * Can be zero, in which case it's assumed to be infinite (as limited 
    * by 'select' and 'disconnect'). */
Higor Eurípedes's avatar
Higor Eurípedes committed
1063
1064
   size_t len;

Alcaro's avatar
Alcaro committed
1065
1066
   /* To go from emulated address to physical address, the following 
    * order applies:
Libretro-Admin's avatar
Libretro-Admin committed
1067
1068
1069
    * Subtract 'start', pick off 'disconnect', apply 'len', add 'offset'. */

   /* The address space name must consist of only a-zA-Z0-9_-, 
Alcaro's avatar
Alcaro committed
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
    * should be as short as feasible (maximum length is 8 plus the NUL),
    * and may not be any other address space plus one or more 0-9A-F 
    * at the end.
    * However, multiple memory descriptors for the same address space is 
    * allowed, and the address space name can be empty. NULL is treated 
    * as empty.
    *
    * Address space names are case sensitive, but avoid lowercase if possible.
    * The same pointer may exist in multiple address spaces.
    *
    * Examples:
    * blank+blank - valid (multiple things may be mapped in the same namespace)
    * 'Sp'+'Sp' - valid (multiple things may be mapped in the same namespace)
    * 'A'+'B' - valid (neither is a prefix of each other)
    * 'S'+blank - valid ('S' is not in 0-9A-F)
    * 'a'+blank - valid ('a' is not in 0-9A-F)
    * 'a'+'A' - valid (neither is a prefix of each other)
    * 'AR'+blank - valid ('R' is not in 0-9A-F)
    * 'ARB'+blank - valid (the B can't be part of the address either, because 
Libretro-Admin's avatar
Libretro-Admin committed
1089
    *                      there is no namespace 'AR')
Alcaro's avatar
Alcaro committed
1090
    * blank+'B' - not valid, because it's ambigous which address space B1234 
Libretro-Admin's avatar
Libretro-Admin committed
1091
    *             would refer to.
Alcaro's avatar
Alcaro committed
1092
1093
    * The length can't be used for that purpose; the frontend may want 
    * to append arbitrary data to an address, without a separator. */
Higor Eurípedes's avatar
Higor Eurípedes committed
1094
   const char *addrspace;
Libretro-Admin's avatar
Libretro-Admin committed
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125

   /* TODO: When finalizing this one, add a description field, which should be
    * "WRAM" or something roughly equally long. */

   /* TODO: When finalizing this one, replace 'select' with 'limit', which tells
    * which bits can vary and still refer to the same address (limit = ~select).
    * TODO: limit? range? vary? something else? */

   /* TODO: When finalizing this one, if 'len' is above what 'select' (or
    * 'limit') allows, it's bankswitched. Bankswitched data must have both 'len'
    * and 'select' != 0, and the mappings don't tell how the system switches the
    * banks. */

   /* TODO: When finalizing this one, fix the 'len' bit removal order.
    * For len=0x1800, pointer 0x1C00 should go to 0x1400, not 0x0C00.
    * Algorithm: Take bits highest to lowest, but if it goes above len, clear
    * the most recent addition and continue on the next bit.
    * TODO: Can the above be optimized? Is "remove the lowest bit set in both
    * pointer and 'len'" equivalent? */
   
   /* TODO: Some emulators (MAME?) emulate big endian systems by only accessing
    * the emulated memory in 32-bit chunks, native endian. But that's nothing
    * compared to Darek Mihocka <http://www.emulators.com/docs/nx07_vm101.htm>
    * (section Emulation 103 - Nearly Free Byte Reversal) - he flips the ENTIRE
    * RAM backwards! I'll want to represent both of those, via some flags.
    * 
    * I suspect MAME either didn't think of that idea, or don't want the #ifdef.
    * Not sure which, nor do I really care. */
   
   /* TODO: Some of those flags are unused and/or don't really make sense. Clean
    * them up. */
Higor Eurípedes's avatar
Higor Eurípedes committed
1126
};
Alcaro's avatar
Alcaro committed
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164

/* The frontend may use the largest value of 'start'+'select' in a 
 * certain namespace to infer the size of the address space.
 *
 * If the address space is larger than that, a mapping with .ptr=NULL 
 * should be at the end of the array, with .select set to all ones for 
 * as long as the address space is big.
 *
 * Sample descriptors (minus .ptr, and RETRO_MEMFLAG_ on the flags):
 * SNES WRAM:
 * .start=0x7E0000, .len=0x20000
 * (Note that this must be mapped before the ROM in most cases; some of the 
 * ROM mappers 
 * try to claim $7E0000, or at least $7E8000.)
 * SNES SPC700 RAM:
 * .addrspace="S", .len=0x10000
 * SNES WRAM mirrors:
 * .flags=MIRROR, .start=0x000000, .select=0xC0E000, .len=0x2000
 * .flags=MIRROR, .start=0x800000, .select=0xC0E000, .len=0x2000
 * SNES WRAM mirrors, alternate equivalent descriptor:
 * .flags=MIRROR, .select=0x40E000, .disconnect=~0x1FFF
 * (Various similar constructions can be created by combining parts of 
 * the above two.)
 * SNES LoROM (512KB, mirrored a couple of times):
 * .flags=CONST, .start=0x008000, .select=0x408000, .disconnect=0x8000, .len=512*1024
 * .flags=CONST, .start=0x400000, .select=0x400000, .disconnect=0x8000, .len=512*1024
 * SNES HiROM (4MB):
 * .flags=CONST,                 .start=0x400000, .select=0x400000, .len=4*1024*1024
 * .flags=CONST, .offset=0x8000, .start=0x008000, .select=0x408000, .len=4*1024*1024
 * SNES ExHiROM (8MB):
 * .flags=CONST, .offset=0,                  .start=0xC00000, .select=0xC00000, .len=4*1024*1024
 * .flags=CONST, .offset=4*1024*1024,        .start=0x400000, .select=0xC00000, .len=4*1024*1024
 * .flags=CONST, .offset=0x8000,             .start=0x808000, .select=0xC08000, .len=4*1024*1024
 * .flags=CONST, .offset=4*1024*1024+0x8000, .start=0x008000, .select=0xC08000, .len=4*1024*1024
 * Clarify the size of the address space:
 * .ptr=NULL, .select=0xFFFFFF
 * .len can be implied by .select in many of them, but was included for clarity.
 */
Higor Eurípedes's avatar
Higor Eurípedes committed
1165
1166
1167
1168
1169
1170
1171
1172
1173

struct retro_memory_map
{
   const struct retro_memory_descriptor *descriptors;
   unsigned num_descriptors;
};

struct retro_controller_description
{
Alcaro's avatar
Alcaro committed
1174
1175
1176
   /* Human-readable description of the controller. Even if using a generic 
    * input device type, this can be set to the particular device type the 
    * core uses. */
Higor Eurípedes's avatar
Higor Eurípedes committed
1177
1178
   const char *desc;

Alcaro's avatar
Alcaro committed
1179
1180
1181
1182
1183
   /* Device type passed to retro_set_controller_port_device(). If the device 
    * type is a sub-class of a generic input device type, use the 
    * RETRO_DEVICE_SUBCLASS macro to create an ID.
    *
    * E.g. RETRO_DEVICE_SUBCLASS(RETRO_DEVICE_JOYPAD, 1). */
Higor Eurípedes's avatar
Higor Eurípedes committed
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
   unsigned id;
};

struct retro_controller_info
{
   const struct retro_controller_description *types;
   unsigned num_types;
};

struct retro_subsystem_memory_info
{
Alcaro's avatar
Alcaro committed
1195
1196
1197
1198
1199
1200
1201
   /* The extension associated with a memory type, e.g. "psram". */
   const char *extension;

   /* The memory type for retro_get_memory(). This should be at 
    * least 0x100 to avoid conflict with standardized 
    * libretro memory types. */
   unsigned type;
Higor Eurípedes's avatar
Higor Eurípedes committed
1202
1203
1204
1205
};

struct retro_subsystem_rom_info
{
Alcaro's avatar
Alcaro committed
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
   /* Describes what the content is (SGB BIOS, GB ROM, etc). */
   const char *desc;

   /* Same definition as retro_get_system_info(). */
   const char *valid_extensions;

   /* Same definition as retro_get_system_info(). */
   bool need_fullpath;

   /* Same definition as retro_get_system_info(). */
   bool block_extract;
Higor Eurípedes's avatar
Higor Eurípedes committed
1217

Alcaro's avatar
Alcaro committed
1218
1219
1220
1221
1222
1223
   /* This is set if the content is required to load a game. 
    * If this is set to false, a zeroed-out retro_game_info can be passed. */
   bool required;

   /* Content can have multiple associated persistent 
    * memory types (retro_get_memory()). */
Higor Eurípedes's avatar
Higor Eurípedes committed
1224
1225
1226
1227
1228
1229
   const struct retro_subsystem_memory_info *memory;
   unsigned num_memory;
};

struct retro_subsystem_info
{
Alcaro's avatar
Alcaro committed
1230
1231
1232
1233
1234
1235
1236
1237
   /* Human-readable string of the subsystem type, e.g. "Super GameBoy" */
   const char *desc;

   /* A computer friendly short string identifier for the subsystem type.
    * This name must be [a-z].
    * E.g. if desc is "Super GameBoy", this can be "sgb".
    * This identifier can be used for command-line interfaces, etc.
    */
Higor Eurípedes's avatar
Higor Eurípedes committed
1238
1239
   const char *ident;

Alcaro's avatar
Alcaro committed
1240
1241
1242
1243
1244
1245
   /* Infos for each content file. The first entry is assumed to be the 
    * "most significant" content for frontend purposes.
    * E.g. with Super GameBoy, the first content should be the GameBoy ROM, 
    * as it is the most "significant" content to a user.
    * If a frontend creates new file paths based on the content used 
    * (e.g. savestates), it should use the path for the first ROM to do so. */
Higor Eurípedes's avatar
Higor Eurípedes committed
1246
1247
   const struct retro_subsystem_rom_info *roms;

Alcaro's avatar
Alcaro committed
1248
1249
1250
1251
1252
   /* Number of content files associated with a subsystem. */
   unsigned num_roms;
   
   /* The type passed to retro_load_game_special(). */
   unsigned id;
Higor Eurípedes's avatar
Higor Eurípedes committed
1253
1254
};

Libretro-Admin's avatar
Libretro-Admin committed
1255
typedef void (RETRO_CALLCONV *retro_proc_address_t)(void);
Alcaro's avatar
Alcaro committed
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270

/* libretro API extension functions:
 * (None here so far).
 *
 * Get a symbol from a libretro core.
 * Cores should only return symbols which are actual 
 * extensions to the libretro API.
 *
 * Frontends should not use this to obtain symbols to standard 
 * libretro entry points (static linking or dlsym).
 *
 * The symbol name must be equal to the function name, 
 * e.g. if void retro_foo(void); exists, the symbol must be called "retro_foo".
 * The returned function pointer must be cast to the corresponding type.
 */
Libretro-Admin's avatar
Libretro-Admin committed
1271
typedef retro_proc_address_t (RETRO_CALLCONV *retro_get_proc_address_t)(const char *sym);
Alcaro's avatar
Alcaro committed
1272

Higor Eurípedes's avatar
Higor Eurípedes committed
1273
1274
1275
1276
struct retro_get_proc_address_interface
{
   retro_get_proc_address_t get_proc_address;
};
Higor Eurípedes's avatar
Higor Eurípedes committed
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287

enum retro_log_level
{
   RETRO_LOG_DEBUG = 0,
   RETRO_LOG_INFO,
   RETRO_LOG_WARN,
   RETRO_LOG_ERROR,

   RETRO_LOG_DUMMY = INT_MAX
};

Alcaro's avatar
Alcaro committed
1288
/* Logging function. Takes log level argument as well. */
Libretro-Admin's avatar
Libretro-Admin committed
1289
typedef void (RETRO_CALLCONV *retro_log_printf_t)(enum retro_log_level level,
Alcaro's avatar
Alcaro committed
1290
      const char *fmt, ...);
Higor Eurípedes's avatar
Higor Eurípedes committed
1291
1292
1293
1294
1295
1296

struct retro_log_callback
{
   retro_log_printf_t log;
};

Alcaro's avatar
Alcaro committed
1297
1298
1299
/* Performance related functions */

/* ID values for SIMD CPU features */
Higor Eurípedes's avatar
Higor Eurípedes committed
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
#define RETRO_SIMD_SSE      (1 << 0)
#define RETRO_SIMD_SSE2     (1 << 1)
#define RETRO_SIMD_VMX      (1 << 2)
#define RETRO_SIMD_VMX128   (1 << 3)
#define RETRO_SIMD_AVX      (1 << 4)
#define RETRO_SIMD_NEON     (1 << 5)
#define RETRO_SIMD_SSE3     (1 << 6)
#define RETRO_SIMD_SSSE3    (1 << 7)
#define RETRO_SIMD_MMX      (1 << 8)
#define RETRO_SIMD_MMXEXT   (1 << 9)
#define RETRO_SIMD_SSE4     (1 << 10)
#define RETRO_SIMD_SSE42    (1 << 11)
#define RETRO_SIMD_AVX2     (1 << 12)
#define RETRO_SIMD_VFPU     (1 << 13)
#define RETRO_SIMD_PS       (1 << 14)
Alcaro's avatar
Alcaro committed
1315
#define RETRO_SIMD_AES      (1 << 15)
Libretro-Admin's avatar
Libretro-Admin committed
1316
1317
1318
1319
1320
1321
#define RETRO_SIMD_VFPV3    (1 << 16)
#define RETRO_SIMD_VFPV4    (1 << 17)
#define RETRO_SIMD_POPCNT   (1 << 18)
#define RETRO_SIMD_MOVBE    (1 << 19)
#define RETRO_SIMD_CMOV     (1 << 20)
#define RETRO_SIMD_ASIMD    (1 << 21)
Higor Eurípedes's avatar
Higor Eurípedes committed
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335

typedef uint64_t retro_perf_tick_t;
typedef int64_t retro_time_t;

struct retro_perf_counter
{
   const char *ident;
   retro_perf_tick_t start;
   retro_perf_tick_t total;
   retro_perf_tick_t call_cnt;

   bool registered;
};

Alcaro's avatar
Alcaro committed
1336
1337
1338
/* Returns current time in microseconds.
 * Tries to use the most accurate timer available.
 */
Libretro-Admin's avatar
Libretro-Admin committed
1339
typedef retro_time_t (RETRO_CALLCONV *retro_perf_get_time_usec_t)(void);
Alcaro's avatar
Alcaro committed
1340
1341
1342
1343
1344

/* A simple counter. Usually nanoseconds, but can also be CPU cycles.
 * Can be used directly if desired (when creating a more sophisticated 
 * performance counter system).
 * */
Libretro-Admin's avatar
Libretro-Admin committed
1345
typedef retro_perf_tick_t (RETRO_CALLCONV *retro_perf_get_counter_t)(void);
Alcaro's avatar
Alcaro committed
1346
1347

/* Returns a bit-mask of detected CPU features (RETRO_SIMD_*). */
Libretro-Admin's avatar
Libretro-Admin committed
1348
typedef uint64_t (RETRO_CALLCONV *retro_get_cpu_features_t)(void);
Alcaro's avatar
Alcaro committed
1349
1350
1351
1352

/* Asks frontend to log and/or display the state of performance counters.
 * Performance counters can always be poked into manually as well.
 */
Libretro-Admin's avatar
Libretro-Admin committed
1353
typedef void (RETRO_CALLCONV *retro_perf_log_t)(void);
Alcaro's avatar
Alcaro committed
1354
1355
1356
1357
1358
1359

/* Register a performance counter.
 * ident field must be set with a discrete value and other values in 
 * retro_perf_counter must be 0.
 * Registering can be called multiple times. To avoid calling to 
 * frontend redundantly, you can check registered field first. */
Libretro-Admin's avatar
Libretro-Admin committed
1360
typedef void (RETRO_CALLCONV *retro_perf_register_t)(struct retro_perf_counter *counter);
Alcaro's avatar
Alcaro committed
1361
1362

/* Starts a registered counter. */
Libretro-Admin's avatar
Libretro-Admin committed
1363
typedef void (RETRO_CALLCONV *retro_perf_start_t)(struct retro_perf_counter *counter);
Alcaro's avatar
Alcaro committed
1364
1365

/* Stops a registered counter. */
Libretro-Admin's avatar
Libretro-Admin committed
1366
typedef void (RETRO_CALLCONV *retro_perf_stop_t)(struct retro_perf_counter *counter);
Higor Eurípedes's avatar
Higor Eurípedes committed
1367

Alcaro's avatar
Alcaro committed
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
/* For convenience it can be useful to wrap register, start and stop in macros.
 * E.g.:
 * #ifdef LOG_PERFORMANCE
 * #define RETRO_PERFORMANCE_INIT(perf_cb, name) static struct retro_perf_counter name = {#name}; if (!name.registered) perf_cb.perf_register(&(name))
 * #define RETRO_PERFORMANCE_START(perf_cb, name) perf_cb.perf_start(&(name))
 * #define RETRO_PERFORMANCE_STOP(perf_cb, name) perf_cb.perf_stop(&(name))
 * #else
 * ... Blank macros ...
 * #endif
 *
 * These can then be used mid-functions around code snippets.
 *
 * extern struct retro_perf_callback perf_cb;  * Somewhere in the core.
 *
 * void do_some_heavy_work(void)
 * {
 *    RETRO_PERFORMANCE_INIT(cb, work_1;
 *    RETRO_PERFORMANCE_START(cb, work_1);
 *    heavy_work_1();
 *    RETRO_PERFORMANCE_STOP(cb, work_1);
 *
 *    RETRO_PERFORMANCE_INIT(cb, work_2);
 *    RETRO_PERFORMANCE_START(cb, work_2);
 *    heavy_work_2();
 *    RETRO_PERFORMANCE_STOP(cb, work_2);
 * }
 *
 * void retro_deinit(void)
 * {
 *    perf_cb.perf_log();  * Log all perf counters here for example.
 * }
 */
Higor Eurípedes's avatar
Higor Eurípedes committed
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412

struct retro_perf_callback
{
   retro_perf_get_time_usec_t    get_time_usec;
   retro_get_cpu_features_t      get_cpu_features;

   retro_perf_get_counter_t      get_perf_counter;
   retro_perf_register_t         perf_register;
   retro_perf_start_t            perf_start;
   retro_perf_stop_t             perf_stop;
   retro_perf_log_t              perf_log;
};

Alcaro's avatar
Alcaro committed
1413
1414
1415
/* FIXME: Document the sensor API and work out behavior.
 * It will be marked as experimental until then.
 */
Higor Eurípedes's avatar
Higor Eurípedes committed
1416
1417
1418
1419
1420
1421
1422
1423
enum retro_sensor_action
{
   RETRO_SENSOR_ACCELEROMETER_ENABLE = 0,
   RETRO_SENSOR_ACCELEROMETER_DISABLE,

   RETRO_SENSOR_DUMMY = INT_MAX
};

Alcaro's avatar
Alcaro committed
1424
/* Id values for SENSOR types. */
Higor Eurípedes's avatar
Higor Eurípedes committed
1425
1426
1427
1428
#define RETRO_SENSOR_ACCELEROMETER_X 0
#define RETRO_SENSOR_ACCELEROMETER_Y 1
#define RETRO_SENSOR_ACCELEROMETER_Z 2

Libretro-Admin's avatar
Libretro-Admin committed
1429
typedef bool (RETRO_CALLCONV *retro_set_sensor_state_t)(unsigned port, 
Alcaro's avatar
Alcaro committed
1430
1431
      enum retro_sensor_action action, unsigned rate);

Libretro-Admin's avatar
Libretro-Admin committed
1432
typedef float (RETRO_CALLCONV *retro_sensor_get_input_t)(unsigned port, unsigned id);
Alcaro's avatar
Alcaro committed
1433

Higor Eurípedes's avatar
Higor Eurípedes committed
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
struct retro_sensor_interface
{
   retro_set_sensor_state_t set_sensor_state;
   retro_sensor_get_input_t get_sensor_input;
};

enum retro_camera_buffer
{
   RETRO_CAMERA_BUFFER_OPENGL_TEXTURE = 0,
   RETRO_CAMERA_BUFFER_RAW_FRAMEBUFFER,

   RETRO_CAMERA_BUFFER_DUMMY = INT_MAX
};

Alcaro's avatar
Alcaro committed
1448
/* Starts the camera driver. Can only be called in retro_run(). */
Libretro-Admin's avatar
Libretro-Admin committed
1449
typedef bool (RETRO_CALLCONV *retro_camera_start_t)(void);
Alcaro's avatar
Alcaro committed
1450
1451

/* Stops the camera driver. Can only be called in retro_run(). */
Libretro-Admin's avatar
Libretro-Admin committed
1452
typedef void (RETRO_CALLCONV *retro_camera_stop_t)(void);
Alcaro's avatar
Alcaro committed
1453
1454
1455
1456
1457

/* Callback which signals when the camera driver is initialized 
 * and/or deinitialized.
 * retro_camera_start_t can be called in initialized callback.
 */
Libretro-Admin's avatar
Libretro-Admin committed
1458
typedef void (RETRO_CALLCONV *retro_camera_lifetime_status_t)(void);
Alcaro's avatar
Alcaro committed
1459
1460
1461
1462
1463

/* A callback for raw framebuffer data. buffer points to an XRGB8888 buffer.
 * Width, height and pitch are similar to retro_video_refresh_t.
 * First pixel is top-left origin.
 */
Libretro-Admin's avatar
Libretro-Admin committed
1464
typedef void (RETRO_CALLCONV *retro_camera_frame_raw_framebuffer_t)(const uint32_t *buffer, 
Alcaro's avatar
Alcaro committed
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
      unsigned width, unsigned height, size_t pitch);

/* A callback for when OpenGL textures are used.
 *
 * texture_id is a texture owned by camera driver.
 * Its state or content should be considered immutable, except for things like 
 * texture filtering and clamping.
 *
 * texture_target is the texture target for the GL texture.
 * These can include e.g. GL_TEXTURE_2D, GL_TEXTURE_RECTANGLE, and possibly 
 * more depending on extensions.
 *
 * affine points to a packed 3x3 column-major matrix used to apply an affine 
 * transform to texture coordinates. (affine_matrix * vec3(coord_x, coord_y, 1.0))
 * After transform, normalized texture coord (0, 0) should be bottom-left 
 * and (1, 1) should be top-right (or (width, height) for RECTANGLE).
 *
 * GL-specific typedefs are avoided here to avoid relying on gl.h in 
 * the API definition.
 */
Libretro-Admin's avatar
Libretro-Admin committed
1485
typedef void (RETRO_CALLCONV *retro_camera_frame_opengl_texture_t)(unsigned texture_id, 
Alcaro's avatar
Alcaro committed
1486
1487
      unsigned texture_target, const float *affine);

Higor Eurípedes's avatar
Higor Eurípedes committed
1488
1489
struct retro_camera_callback
{
Alcaro's avatar
Alcaro committed
1490
1491
1492
1493
   /* Set by libretro core. 
    * Example bitmask: caps = (1 << RETRO_CAMERA_BUFFER_OPENGL_TEXTURE) | (1 << RETRO_CAMERA_BUFFER_RAW_FRAMEBUFFER).
    */
   uint64_t caps; 
Higor Eurípedes's avatar
Higor Eurípedes committed
1494

Libretro-Admin's avatar
Libretro-Admin committed
1495
1496
   /* Desired resolution for camera. Is only used as a hint. */
   unsigned width;
Higor Eurípedes's avatar
Higor Eurípedes committed
1497
   unsigned height;
Libretro-Admin's avatar
Libretro-Admin committed
1498
1499
1500
1501

   /* Set by frontend. */
   retro_camera_start_t start;
   retro_camera_stop_t stop;
Alcaro's avatar
Alcaro committed
1502
1503
1504

   /* Set by libretro core if raw framebuffer callbacks will be used. */
   retro_camera_frame_raw_framebuffer_t frame_raw_framebuffer;
Libretro-Admin's avatar
Libretro-Admin committed
1505

Alcaro's avatar
Alcaro committed
1506
1507
1508
1509
1510
1511
1512
   /* Set by libretro core if OpenGL texture callbacks will be used. */
   retro_camera_frame_opengl_texture_t frame_opengl_texture; 

   /* Set by libretro core. Called after camera driver is initialized and 
    * ready to be started.
    * Can be NULL, in which this callback is not called.
    */
Higor Eurípedes's avatar
Higor Eurípedes committed
1513
1514
   retro_camera_lifetime_status_t initialized;

Alcaro's avatar
Alcaro committed
1515
1516
1517
1518
   /* Set by libretro core. Called right before camera driver is 
    * deinitialized.
    * Can be NULL, in which this callback is not called.
    */
Higor Eurípedes's avatar
Higor Eurípedes committed
1519
1520
1521
   retro_camera_lifetime_status_t deinitialized;
};

Alcaro's avatar
Alcaro committed
1522
1523
1524
1525
1526
1527
1528
1529
1530
/* Sets the interval of time and/or distance at which to update/poll 
 * location-based data.
 *
 * To ensure compatibility with all location-based implementations,
 * values for both interval_ms and interval_distance should be provided.
 *
 * interval_ms is the interval expressed in milliseconds.
 * interval_distance is the distance interval expressed in meters.
 */
Libretro-Admin's avatar
Libretro-Admin committed
1531
typedef void (RETRO_CALLCONV *retro_location_set_interval_t)(unsigned interval_ms,
Alcaro's avatar
Alcaro committed
1532
      unsigned interval_distance);
Higor Eurípedes's avatar
Higor Eurípedes committed
1533

Alcaro's avatar
Alcaro committed
1534
1535
1536
/* Start location services. The device will start listening for changes to the
 * current location at regular intervals (which are defined with 
 * retro_location_set_interval_t). */
Libretro-Admin's avatar
Libretro-Admin committed
1537
typedef bool (RETRO_CALLCONV *retro_location_start_t)(void);
Higor Eurípedes's avatar
Higor Eurípedes committed
1538

Alcaro's avatar
Alcaro committed
1539
1540
/* Stop location services. The device will stop listening for changes 
 * to the current location. */
Libretro-Admin's avatar
Libretro-Admin committed
1541
typedef void (RETRO_CALLCONV *retro_location_stop_t)(void);
Higor Eurípedes's avatar
Higor Eurípedes committed
1542

Alcaro's avatar
Alcaro committed
1543
1544
/* Get the position of the current location. Will set parameters to 
 * 0 if no new  location update has happened since the last time. */
Libretro-Admin's avatar
Libretro-Admin committed
1545
typedef bool (RETRO_CALLCONV *retro_location_get_position_t)(double *lat, double *lon,
Alcaro's avatar
Alcaro committed
1546
      double *horiz_accuracy, double *vert_accuracy);
Higor Eurípedes's avatar
Higor Eurípedes committed
1547

Alcaro's avatar
Alcaro committed
1548
1549
1550
1551
/* Callback which signals when the location driver is initialized 
 * and/or deinitialized.
 * retro_location_start_t can be called in initialized callback.
 */
Libretro-Admin's avatar
Libretro-Admin committed
1552
typedef void (RETRO_CALLCONV *retro_location_lifetime_status_t)(void);
Higor Eurípedes's avatar
Higor Eurípedes committed
1553
1554
1555
1556
1557
1558

struct retro_location_callback
{
   retro_location_start_t         start;
   retro_location_stop_t          stop;
   retro_location_get_position_t  get_position;
Higor Eurípedes's avatar
Higor Eurípedes committed
1559
   retro_location_set_interval_t  set_interval;
Higor Eurípedes's avatar
Higor Eurípedes committed
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572

   retro_location_lifetime_status_t initialized;
   retro_location_lifetime_status_t deinitialized;
};

enum retro_rumble_effect
{
   RETRO_RUMBLE_STRONG = 0,
   RETRO_RUMBLE_WEAK = 1,

   RETRO_RUMBLE_DUMMY = INT_MAX
};

Alcaro's avatar
Alcaro committed
1573
1574
1575
1576
1577
1578
1579
/* Sets rumble state for joypad plugged in port 'port'. 
 * Rumble effects are controlled independently,
 * and setting e.g. strong rumble does not override weak rumble.
 * Strength has a range of [0, 0xffff].
 *
 * Returns true if rumble state request was honored. 
 * Calling this before first retro_run() is likely to return false. */
Libretro-Admin's avatar
Libretro-Admin committed
1580
typedef bool (RETRO_CALLCONV *retro_set_rumble_state_t)(unsigned port, 
Alcaro's avatar
Alcaro committed
1581
1582
      enum retro_rumble_effect effect, uint16_t strength);

Higor Eurípedes's avatar
Higor Eurípedes committed
1583
1584
1585
1586
1587
struct retro_rumble_interface
{
   retro_set_rumble_state_t set_rumble_state;
};

Alcaro's avatar
Alcaro committed
1588
/* Notifies libretro that audio data should be written. */
Libretro-Admin's avatar
Libretro-Admin committed
1589
typedef void (RETRO_CALLCONV *retro_audio_callback_t)(void);
Higor Eurípedes's avatar
Higor Eurípedes committed
1590

Alcaro's avatar
Alcaro committed
1591
1592
1593
1594
1595
1596
1597
/* True: Audio driver in frontend is active, and callback is 
 * expected to be called regularily.
 * False: Audio driver in frontend is paused or inactive. 
 * Audio callback will not be called until set_state has been 
 * called with true.
 * Initial state is false (inactive).
 */
Libretro-Admin's avatar
Libretro-Admin committed
1598
typedef void (RETRO_CALLCONV *retro_audio_set_state_callback_t)(bool enabled);
Alcaro's avatar
Alcaro committed
1599

Higor Eurípedes's avatar
Higor Eurípedes committed
1600
1601
1602
1603
1604
1605
struct retro_audio_callback
{
   retro_audio_callback_t callback;
   retro_audio_set_state_callback_t set_state;
};

Alcaro's avatar
Alcaro committed
1606
1607
1608
1609
1610
1611
1612
1613
/* Notifies a libretro core of time spent since last invocation 
 * of retro_run() in microseconds.
 *
 * It will be called right before retro_run() every frame.
 * The frontend can tamper with timing to support cases like 
 * fast-forward, slow-motion and framestepping.
 *
 * In those scenarios the reference frame time value will be used. */
Higor Eurípedes's avatar
Higor Eurípedes committed
1614
typedef int64_t retro_usec_t;
Libretro-Admin's avatar
Libretro-Admin committed
1615
typedef void (RETRO_CALLCONV *retro_frame_time_callback_t)(retro_usec_t usec);
Higor Eurípedes's avatar
Higor Eurípedes committed
1616
1617
1618
struct retro_frame_time_callback
{
   retro_frame_time_callback_t callback;
Alcaro's avatar
Alcaro committed
1619
1620
1621
1622
   /* Represents the time of one frame. It is computed as 
    * 1000000 / fps, but the implementation will resolve the 
    * rounding to ensure that framestepping, etc is exact. */
   retro_usec_t reference;
Higor Eurípedes's avatar
Higor Eurípedes committed
1623
1624
};

Alcaro's avatar
Alcaro committed
1625
1626
1627
/* Pass this to retro_video_refresh_t if rendering to hardware.
 * Passing NULL to retro_video_refresh_t is still a frame dupe as normal.
 * */
Higor Eurípedes's avatar
Higor Eurípedes committed
1628
1629
#define RETRO_HW_FRAME_BUFFER_VALID ((void*)-1)

Alcaro's avatar
Alcaro committed
1630
1631
1632
1633
1634
1635
1636
1637
1638
/* Invalidates the current HW context.
 * Any GL state is lost, and must not be deinitialized explicitly.
 * If explicit deinitialization is desired by the libretro core,
 * it should implement context_destroy callback.
 * If called, all GPU resources must be reinitialized.
 * Usually called when frontend reinits video driver.
 * Also called first time video driver is initialized, 
 * allowing libretro core to initialize resources.
 */
Libretro-Admin's avatar
Libretro-Admin committed
1639
typedef void (RETRO_CALLCONV *retro_hw_context_reset_t)(void);
Alcaro's avatar
Alcaro committed
1640
1641
1642
1643

/* Gets current framebuffer which is to be rendered to.
 * Could change every frame potentially.
 */
Libretro-Admin's avatar
Libretro-Admin committed
1644
typedef uintptr_t (RETRO_CALLCONV *retro_hw_get_current_framebuffer_t)(void);
Higor Eurípedes's avatar
Higor Eurípedes committed
1645

Alcaro's avatar
Alcaro committed
1646
/* Get a symbol from HW context. */
Libretro-Admin's avatar
Libretro-Admin committed
1647
typedef retro_proc_address_t (RETRO_CALLCONV *retro_hw_get_proc_address_t)(const char *sym);
Higor Eurípedes's avatar
Higor Eurípedes committed
1648
1649
1650

enum retro_hw_context_type
{
Higor Eurípedes's avatar
Higor Eurípedes committed
1651
   RETRO_HW_CONTEXT_NONE             = 0,
Alcaro's avatar
Alcaro committed
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
   /* OpenGL 2.x. Driver can choose to use latest compatibility context. */
   RETRO_HW_CONTEXT_OPENGL           = 1, 
   /* OpenGL ES 2.0. */
   RETRO_HW_CONTEXT_OPENGLES2        = 2,
   /* Modern desktop core GL context. Use version_major/
    * version_minor fields to set GL version. */
   RETRO_HW_CONTEXT_OPENGL_CORE      = 3,
   /* OpenGL ES 3.0 */
   RETRO_HW_CONTEXT_OPENGLES3        = 4,
   /* OpenGL ES 3.1+. Set version_major/version_minor. For GLES2 and GLES3,
    * use the corresponding enums directly. */
   RETRO_HW_CONTEXT_OPENGLES_VERSION = 5,
Higor Eurípedes's avatar
Higor Eurípedes committed
1664

Libretro-Admin's avatar
Libretro-Admin committed
1665
1666
1667
   /* Vulkan, see RETRO_ENVIRONMENT_GET_HW_RENDER_INTERFACE. */
   RETRO_HW_CONTEXT_VULKAN           = 6,

Higor Eurípedes's avatar
Higor Eurípedes committed
1668
1669
1670
1671
1672
   RETRO_HW_CONTEXT_DUMMY = INT_MAX
};

struct retro_hw_render_callback
{
Alcaro's avatar
Alcaro committed
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
   /* Which API to use. Set by libretro core. */
   enum retro_hw_context_type context_type;

   /* Called when a context has been created or when it has been reset.
    * An OpenGL context is only valid after context_reset() has been called.
    *
    * When context_reset is called, OpenGL resources in the libretro 
    * implementation are guaranteed to be invalid.
    *
    * It is possible that context_reset is called multiple times during an 
    * application lifecycle.
    * If context_reset is called without any notification (context_destroy),
    * the OpenGL context was lost and resources should just be recreated
    * without any attempt to "free" old resources.
    */
Higor Eurípedes's avatar
Higor Eurípedes committed
1688
1689
   retro_hw_context_reset_t context_reset;

Libretro-Admin's avatar
Libretro-Admin committed
1690
1691
1692
   /* Set by frontend.
    * TODO: This is rather obsolete. The frontend should not
    * be providing preallocated framebuffers. */
Alcaro's avatar
Alcaro committed
1693
1694
   retro_hw_get_current_framebuffer_t get_current_framebuffer;

Libretro-Admin's avatar
Libretro-Admin committed
1695
1696
   /* Set by frontend.
    * Can return all relevant functions, including glClear on Windows. */
Alcaro's avatar
Alcaro committed
1697
1698
   retro_hw_get_proc_address_t get_proc_address;

Libretro-Admin's avatar
Libretro-Admin committed
1699
1700
   /* Set if render buffers should have depth component attached.
    * TODO: Obsolete. */
Alcaro's avatar
Alcaro committed
1701
1702
   bool depth;

Libretro-Admin's avatar
Libretro-Admin committed
1703
1704
   /* Set if stencil buffers should be attached.
    * TODO: Obsolete. */
Alcaro's avatar
Alcaro committed
1705
1706
1707
1708
1709
1710
   bool stencil;

   /* If depth and stencil are true, a packed 24/8 buffer will be added. 
    * Only attaching stencil is invalid and will be ignored. */

   /* Use conventional bottom-left origin convention. If false, 
Libretro-Admin's avatar
Libretro-Admin committed
1711
1712
    * standard libretro top-left origin semantics are used.
    * TODO: Move to GL specific interface. */
Alcaro's avatar
Alcaro committed
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
   bool bottom_left_origin;
   
   /* Major version number for core GL context or GLES 3.1+. */
   unsigned version_major;

   /* Minor version number for core GL context or GLES 3.1+. */
   unsigned version_minor;

   /* If this is true, the frontend will go very far to avoid 
    * resetting context in scenarios like toggling fullscreen, etc.
Libretro-Admin's avatar
Libretro-Admin committed
1723
    * TODO: Obsolete? Maybe frontend should just always assume this ...
Alcaro's avatar
Alcaro committed
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
    */
   bool cache_context;

   /* The reset callback might still be called in extreme situations 
    * such as if the context is lost beyond recovery.
    *
    * For optimal stability, set this to false, and allow context to be 
    * reset at any time.
    */
   
   /* A callback to be called before the context is destroyed in a 
    * controlled way by the frontend. */
   retro_hw_context_reset_t context_destroy;

   /* OpenGL resources can be deinitialized cleanly at this step.
    * context_destroy can be set to NULL, in which resources will 
    * just be destroyed without any notification.
    *
    * Even when context_destroy is non-NULL, it is possible that 
    * context_reset is called without any destroy notification.
    * This happens if context is lost by external factors (such as 
    * notified by GL_ARB_robustness).
    *
    * In this case, the context is assumed to be already dead,
    * and the libretro implementation must not try to free any OpenGL 
    * resources in the subsequent context_reset.
    */

   /* Creates a debug context. */
   bool debug_context;
Higor Eurípedes's avatar
Higor Eurípedes committed
1754
1755
};

Alcaro's avatar
Alcaro committed
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
/* Callback type passed in RETRO_ENVIRONMENT_SET_KEYBOARD_CALLBACK. 
 * Called by the frontend in response to keyboard events.
 * down is set if the key is being pressed, or false if it is being released.
 * keycode is the RETROK value of the char.
 * character is the text character of the pressed key. (UTF-32).
 * key_modifiers is a set of RETROKMOD values or'ed together.
 *
 * The pressed/keycode state can be indepedent of the character.
 * It is also possible that multiple characters are generated from a 
 * single keypress.
 * Keycode events should be treated separately from character events.
 * However, when possible, the frontend should try to synchronize these.
 * If only a character is posted, keycode should be RETROK_UNKNOWN.
 *
 * Similarily if only a keycode event is generated with no corresponding 
 * character, character should be 0.
 */
Libretro-Admin's avatar
Libretro-Admin committed
1773
typedef void (RETRO_CALLCONV *retro_keyboard_event_t)(bool down, unsigned keycode, 
Alcaro's avatar
Alcaro committed
1774
      uint32_t character, uint16_t key_modifiers);
Higor Eurípedes's avatar
Higor Eurípedes committed
1775
1776
1777
1778
1779
1780

struct retro_keyboard_callback
{
   retro_keyboard_event_t callback;
};

Alcaro's avatar
Alcaro committed
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
/* Callbacks for RETRO_ENVIRONMENT_SET_DISK_CONTROL_INTERFACE.
 * Should be set for implementations which can swap out multiple disk 
 * images in runtime.
 *
 * If the implementation can do this automatically, it should strive to do so.
 * However, there are cases where the user must manually do so.
 *
 * Overview: To swap a disk image, eject the disk image with 
 * set_eject_state(true).
 * Set the disk index with set_image_index(index). Insert the disk again 
 * with set_eject_state(false).
 */
Higor Eurípedes's avatar
Higor Eurípedes committed
1793

Alcaro's avatar
Alcaro committed
1794
1795
1796
/* If ejected is true, "ejects" the virtual disk tray.
 * When ejected, the disk image index can be set.
 */
Libretro-Admin's avatar
Libretro-Admin committed
1797
typedef bool (RETRO_CALLCONV *retro_set_eject_state_t)(bool ejected);
Alcaro's avatar
Alcaro committed
1798
1799

/* Gets current eject state. The initial state is 'not ejected'. */
Libretro-Admin's avatar
Libretro-Admin committed
1800
typedef bool (RETRO_CALLCONV *retro_get_eject_state_t)(void);
Alcaro's avatar
Alcaro committed
1801
1802
1803
1804

/* Gets current disk index. First disk is index 0.
 * If return value is >= get_num_images(), no disk is currently inserted.
 */
Libretro-Admin's avatar
Libretro-Admin committed
1805
typedef unsigned (RETRO_CALLCONV *retro_get_image_index_t)(void);
Alcaro's avatar
Alcaro committed
1806
1807
1808
1809
1810

/* Sets image index. Can only be called when disk is ejected.
 * The implementation supports setting "no disk" by using an 
 * index >= get_num_images().
 */
Libretro-Admin's avatar
Libretro-Admin committed
1811
typedef bool (RETRO_CALLCONV *retro_set_image_index_t)(unsigned index);
Alcaro's avatar
Alcaro committed
1812
1813

/* Gets total number of images which are available to use. */
Libretro-Admin's avatar
Libretro-Admin committed
1814
typedef unsigned (RETRO_CALLCONV *retro_get_num_images_t)(void);
Alcaro's avatar
Alcaro committed
1815

Higor Eurípedes's avatar
Higor Eurípedes committed
1816
struct retro_game_info;
Alcaro's avatar
Alcaro committed
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829

/* Replaces the disk image associated with index.
 * Arguments to pass in info have same requirements as retro_load_game().
 * Virtual disk tray must be ejected when calling this.
 *
 * Replacing a disk image with info = NULL will remove the disk image 
 * from the internal list.
 * As a result, calls to get_image_index() can change.
 *
 * E.g. replace_image_index(1, NULL), and previous get_image_index() 
 * returned 4 before.
 * Index 1 will be removed, and the new index is 3.
 */
Libretro-Admin's avatar
Libretro-Admin committed
1830
typedef bool (RETRO_CALLCONV *retro_replace_image_index_t)(unsigned index,
Alcaro's avatar
Alcaro committed
1831
1832
1833
1834
1835
1836
      const struct retro_game_info *info);

/* Adds a new valid index (get_num_images()) to the internal disk list.
 * This will increment subsequent return values from get_num_images() by 1.
 * This image index cannot be used until a disk image has been set 
 * with replace_image_index. */
Libretro-Admin's avatar
Libretro-Admin committed
1837
typedef bool (RETRO_CALLCONV *retro_add_image_index_t)(void);
Higor Eurípedes's avatar
Higor Eurípedes committed
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853

struct retro_disk_control_callback
{
   retro_set_eject_state_t set_eject_state;
   retro_get_eject_state_t get_eject_state;

   retro_get_image_index_t get_image_index;
   retro_set_image_index_t set_image_index;
   retro_get_num_images_t  get_num_images;

   retro_replace_image_index_t replace_image_index;
   retro_add_image_index_t add_image_index;
};

enum retro_pixel_format
{
Alcaro's avatar
Alcaro committed
1854
1855
1856
1857
   /* 0RGB1555, native endian.
    * 0 bit must be set to 0.
    * This pixel format is default for compatibility concerns only.
    * If a 15/16-bit pixel format is desired, consider using RGB565. */
Higor Eurípedes's avatar
Higor Eurípedes committed
1858
1859
   RETRO_PIXEL_FORMAT_0RGB1555 = 0,

Alcaro's avatar
Alcaro committed
1860
1861
   /* XRGB8888, native endian.
    * X bits are ignored. */
Higor Eurípedes's avatar
Higor Eurípedes committed
1862
1863
   RETRO_PIXEL_FORMAT_XRGB8888 = 1,

Alcaro's avatar
Alcaro committed
1864
1865
1866
1867
1868
1869
   /* RGB565, native endian.
    * This pixel format is the recommended format to use if a 15/16-bit
    * format is desired as it i