Kodi Development 22.0
for Binary and Script based Add-Ons
 
Loading...
Searching...
No Matches
game.h
1/*
2 * Copyright (C) 2014-2025 Team Kodi
3 * This file is part of Kodi - https://kodi.tv
4 *
5 * SPDX-License-Identifier: GPL-2.0-or-later
6 * See LICENSES/README.md for more information.
7 */
8
9#ifndef C_API_ADDONINSTANCE_GAME_H
10#define C_API_ADDONINSTANCE_GAME_H
11
12#include "../addon_base.h"
13
14#include <stddef.h> /* size_t */
15#include <stdint.h>
16
17#ifdef __cplusplus
18extern "C"
19{
20#endif /* __cplusplus */
21
22 //============================================================================
54 //----------------------------------------------------------------------------
55
56 //--==----==----==----==----==----==----==----==----==----==----==----==----==--
65
66 //============================================================================
71 typedef enum GAME_PCM_FORMAT
72 {
73 GAME_PCM_FORMAT_UNKNOWN,
74
78 //----------------------------------------------------------------------------
79
80 //============================================================================
150 //----------------------------------------------------------------------------
151
152 //============================================================================
158 {
159 GAME_PCM_FORMAT format;
160 const GAME_AUDIO_CHANNEL* channel_map;
161 } ATTR_PACKED game_stream_audio_properties;
162 //----------------------------------------------------------------------------
163
164 //============================================================================
170 {
172 const uint8_t* data;
173
175 size_t size;
176 } ATTR_PACKED game_stream_audio_packet;
177 //----------------------------------------------------------------------------
178
180
181 //--==----==----==----==----==----==----==----==----==----==----==----==----==--
190
191 //============================================================================
209 //----------------------------------------------------------------------------
210
211 //============================================================================
230 //----------------------------------------------------------------------------
231
232 //============================================================================
239 {
242
244 unsigned int nominal_width;
245
247 unsigned int nominal_height;
248
254
256 unsigned int max_width;
257
259 unsigned int max_height;
260 } ATTR_PACKED game_stream_video_properties;
261 //----------------------------------------------------------------------------
262
263 //============================================================================
269 {
271 unsigned int width;
272
274 unsigned int height;
275
281
284
286 const uint8_t* data;
287
289 size_t size;
290 } ATTR_PACKED game_stream_video_packet;
291 //----------------------------------------------------------------------------
292
294
295 //--==----==----==----==----==----==----==----==----==----==----==----==----==--
301
302 //============================================================================
328 //----------------------------------------------------------------------------
329
330 //==============================================================================
338 {
342
347 bool depth;
348
357
365
367 unsigned int version_major;
368
370 unsigned int version_minor;
371
384
387
388 } ATTR_PACKED game_hw_rendering_properties;
389 //------------------------------------------------------------------------------
390
391 //==============================================================================
398 {
399 char dummy; // Occupier for empty struct
401 //----------------------------------------------------------------------------
402
403 //============================================================================
407 {
409 uintptr_t framebuffer;
411 //----------------------------------------------------------------------------
412
413 //============================================================================
417 {
419 uintptr_t framebuffer;
421 //----------------------------------------------------------------------------
422
423 //============================================================================
426 typedef void (*game_proc_address_t)(void);
427 //----------------------------------------------------------------------------
428
430
431 //--==----==----==----==----==----==----==----==----==----==----==----==----==--
437
438 //============================================================================
444 //----------------------------------------------------------------------------
445
446 //============================================================================
450 {
451 GAME_PIXEL_FORMAT format;
452 uint8_t* data;
453 size_t size;
455 //----------------------------------------------------------------------------
456
457 //============================================================================
463 //----------------------------------------------------------------------------
464
466
467 //--==----==----==----==----==----==----==----==----==----==----==----==----==--
473
474 //============================================================================
494 //----------------------------------------------------------------------------
495
496 //============================================================================
503 {
506
507 union
508 {
511
514
517
520 };
521 } ATTR_PACKED game_stream_properties;
522 //----------------------------------------------------------------------------
523
524 //============================================================================
527 typedef struct game_stream_buffer
528 {
531
532 union
533 {
536
539 };
540 } ATTR_PACKED game_stream_buffer;
541 //----------------------------------------------------------------------------
542
543 //============================================================================
550 typedef struct game_stream_packet
551 {
554
555 union
556 {
559
562
565
568 };
569 } ATTR_PACKED game_stream_packet;
570 //----------------------------------------------------------------------------
571
573
574 //--==----==----==----==----==----==----==----==----==----==----==----==----==--
580
581 //============================================================================
596 //----------------------------------------------------------------------------
597
598 //============================================================================
617 //----------------------------------------------------------------------------
618
619 //============================================================================
664 //----------------------------------------------------------------------------
665
666 //============================================================================
668 typedef enum GAME_SIMD
669 {
671 GAME_SIMD_SSE = (1 << 0),
672
674 GAME_SIMD_SSE2 = (1 << 1),
675
677 GAME_SIMD_VMX = (1 << 2),
678
681
683 GAME_SIMD_AVX = (1 << 4),
684
686 GAME_SIMD_NEON = (1 << 5),
687
689 GAME_SIMD_SSE3 = (1 << 6),
690
692 GAME_SIMD_SSSE3 = (1 << 7),
693
695 GAME_SIMD_MMX = (1 << 8),
696
699
701 GAME_SIMD_SSE4 = (1 << 10),
702
704 GAME_SIMD_SSE42 = (1 << 11),
705
707 GAME_SIMD_AVX2 = (1 << 12),
708
710 GAME_SIMD_VFPU = (1 << 13),
711 } GAME_SIMD;
712 //----------------------------------------------------------------------------
713
715
716 //--==----==----==----==----==----==----==----==----==----==----==----==----==--
743
744 //==============================================================================
746#define ROOT_PORT_ADDRESS "/"
747 //------------------------------------------------------------------------------
748
749 //==============================================================================
751#define DEFAULT_PORT_ID "1"
752 //------------------------------------------------------------------------------
753
754 //==============================================================================
756#define KEYBOARD_PORT_ID "keyboard"
757 //------------------------------------------------------------------------------
758
759 //==============================================================================
761#define MOUSE_PORT_ID "mouse"
762 //------------------------------------------------------------------------------
763
764 //==============================================================================
766#define DEFAULT_PORT_ADDRESS "/1"
767 //------------------------------------------------------------------------------
768
769 //==============================================================================
771#define KEYBOARD_PORT_ADDRESS "/keyboard"
772 //------------------------------------------------------------------------------
773
774 //==============================================================================
776#define MOUSE_PORT_ADDRESS "/mouse"
777 //------------------------------------------------------------------------------
778
779 //============================================================================
810 //----------------------------------------------------------------------------
811
812 //============================================================================
814 typedef enum GAME_KEY_MOD
815 {
818
821
824
827
830
833
836
839
842 } GAME_KEY_MOD;
843 //----------------------------------------------------------------------------
844
845 //============================================================================
861 //----------------------------------------------------------------------------
862
871 {
872 char* controller_id;
873 bool provides_input; // False for multitaps
874 char** digital_buttons;
875 unsigned int digital_button_count;
876 char** analog_buttons;
877 unsigned int analog_button_count;
878 char** analog_sticks;
879 unsigned int analog_stick_count;
880 char** accelerometers;
881 unsigned int accelerometer_count;
882 char** keys;
883 unsigned int key_count;
884 char** rel_pointers;
885 unsigned int rel_pointer_count;
886 char** abs_pointers;
887 unsigned int abs_pointer_count;
888 char** motors;
889 unsigned int motor_count;
890 } ATTR_PACKED game_controller_layout;
891
892 struct game_input_port;
893
894 //============================================================================
896 typedef struct game_input_device
897 {
899 const char* controller_id;
900
902 const char* port_address;
903
906
908 unsigned int port_count;
909 } ATTR_PACKED game_input_device;
910 //----------------------------------------------------------------------------
911
912 //============================================================================
915 typedef struct game_input_port
916 {
919
921 const char* port_id;
922
929
935
938
940 unsigned int device_count;
941 } ATTR_PACKED game_input_port;
942 //----------------------------------------------------------------------------
943
944 //============================================================================
951 typedef struct game_input_topology
952 {
955
957 unsigned int port_count;
958
961 } ATTR_PACKED game_input_topology;
962 //----------------------------------------------------------------------------
963
964 //============================================================================
967 {
970 } ATTR_PACKED game_digital_button_event;
971 //----------------------------------------------------------------------------
972
973 //============================================================================
976 {
979 } ATTR_PACKED game_analog_button_event;
980 //----------------------------------------------------------------------------
981
982 //============================================================================
984 typedef struct game_axis_event
985 {
987 float position;
988 } ATTR_PACKED game_axis_event;
989 //----------------------------------------------------------------------------
990
991 //============================================================================
998 {
1000 float x;
1001
1003 float y;
1004 } ATTR_PACKED game_analog_stick_event;
1005 //----------------------------------------------------------------------------
1006
1007 //============================================================================
1010 {
1012 float x;
1013
1015 float y;
1016
1018 float z;
1019 } ATTR_PACKED game_accelerometer_event;
1020 //----------------------------------------------------------------------------
1021
1022 //============================================================================
1024 typedef struct game_key_event
1025 {
1028
1034 uint32_t unicode;
1035
1038 } ATTR_PACKED game_key_event;
1039 //----------------------------------------------------------------------------
1040
1041 //============================================================================
1044 {
1046 int x;
1047
1049 int y;
1050 } ATTR_PACKED game_rel_pointer_event;
1051 //----------------------------------------------------------------------------
1052
1053 //============================================================================
1056 {
1059
1061 float x;
1062
1064 float y;
1065 } ATTR_PACKED game_abs_pointer_event;
1066 //----------------------------------------------------------------------------
1067
1068 //============================================================================
1070 typedef struct game_motor_event
1071 {
1074 } ATTR_PACKED game_motor_event;
1075 //----------------------------------------------------------------------------
1076
1077 //============================================================================
1079 typedef struct game_input_event
1080 {
1083
1085 const char* controller_id;
1086
1089
1091 const char* port_address;
1092
1094 const char* feature_name;
1095
1096 union
1097 {
1099 struct game_digital_button_event digital_button;
1100
1102 struct game_analog_button_event analog_button;
1103
1105 struct game_axis_event axis;
1106
1108 struct game_analog_stick_event analog_stick;
1109
1111 struct game_accelerometer_event accelerometer;
1112
1114 struct game_key_event key;
1115
1117 struct game_rel_pointer_event rel_pointer;
1118
1120 struct game_abs_pointer_event abs_pointer;
1121
1123 struct game_motor_event motor;
1124 };
1125 } ATTR_PACKED game_input_event;
1126 //----------------------------------------------------------------------------
1127
1129
1130 //--==----==----==----==----==----==----==----==----==----==----==----==----==--
1136
1137 //============================================================================
1141 {
1143 double fps;
1144
1147 };
1148 //----------------------------------------------------------------------------
1149
1151
1152 //--==----==----==----==----==----==----==----==----==----==----==----==----==--
1169
1170 //============================================================================
1184 //----------------------------------------------------------------------------
1185
1186 //============================================================================
1189 typedef struct game_rc_achievement
1190 {
1192 unsigned int id;
1193
1195 const char* title;
1196
1198 const char* description;
1199
1201 const char* badge_url;
1202
1204 const char* badge_locked_url;
1205
1207 unsigned int points;
1208
1211
1214
1216 float rarity;
1217
1220 } ATTR_PACKED game_rc_achievement;
1221 //----------------------------------------------------------------------------
1222
1223 //============================================================================
1229 typedef struct game_rc_game_loaded
1230 {
1232 unsigned int game_id;
1233
1235 const char* title;
1236
1238 const char* icon_url;
1239
1242
1244 unsigned int achievement_count;
1245 } ATTR_PACKED game_rc_game_loaded;
1246 //----------------------------------------------------------------------------
1247
1248 //============================================================================
1252 {
1254 unsigned int id;
1255
1257 const char* title;
1258
1260 const char* description;
1261
1263 const char* badge_url;
1264
1266 unsigned int points;
1267
1270 } ATTR_PACKED game_rc_achievement_triggered;
1271 //----------------------------------------------------------------------------
1272
1273 //============================================================================
1277 {
1280
1282 const char* username;
1283
1285 const char* display_name;
1286
1288 const char* icon_url;
1289
1291 unsigned int points;
1292
1294 const char* error_message;
1295
1304 } ATTR_PACKED game_rc_login_result;
1305 //----------------------------------------------------------------------------
1306
1307 //============================================================================
1318 {
1320 unsigned int id;
1321
1324
1327 } ATTR_PACKED game_rc_achievement_progress;
1328 //----------------------------------------------------------------------------
1329
1331
1332 //--==----==----==----==----==----==----==----==----==----==----==----==----==--
1333
1339 typedef struct AddonProps_Game
1340 {
1345
1349 const char** proxy_dll_paths;
1350
1354 unsigned int proxy_dll_count;
1355
1363
1368
1376
1381
1385 const char** extensions;
1386
1390 unsigned int extension_count;
1392
1393 typedef void* KODI_GAME_STREAM_HANDLE;
1394
1398 struct AddonInstance_Game;
1399
1406 {
1407 KODI_HANDLE kodiInstance;
1408
1409 bool (*EnableHardwareRendering)(void*, const game_hw_rendering_properties*);
1410 void (*CloseGame)(KODI_HANDLE kodiInstance);
1411 double (*GetPlaybackSpeed)(KODI_HANDLE kodiInstance);
1412 void (*SetGameTiming)(KODI_HANDLE kodiInstance, const struct game_system_timing* timing_info);
1413 KODI_GAME_STREAM_HANDLE (*OpenStream)(KODI_HANDLE, const struct game_stream_properties*);
1414 bool (*GetStreamBuffer)(KODI_HANDLE,
1415 KODI_GAME_STREAM_HANDLE,
1416 unsigned int,
1417 unsigned int,
1418 struct game_stream_buffer*);
1419 void (*AddStreamData)(KODI_HANDLE, KODI_GAME_STREAM_HANDLE, const struct game_stream_packet*);
1420 void (*ReleaseStreamBuffer)(KODI_HANDLE, KODI_GAME_STREAM_HANDLE, struct game_stream_buffer*);
1421 void (*CloseStream)(KODI_HANDLE, KODI_GAME_STREAM_HANDLE);
1422 game_proc_address_t (*HwGetProcAddress)(KODI_HANDLE kodiInstance, const char* symbol);
1423 bool (*InputEvent)(KODI_HANDLE kodiInstance, const struct game_input_event* event);
1424 void (*RCOnGameLoaded)(KODI_HANDLE kodiInstance, const struct game_rc_game_loaded* data);
1425 void (*RCOnAchievementTriggered)(KODI_HANDLE kodiInstance,
1426 const struct game_rc_achievement_triggered* data);
1427 void (*RCOnGameCompleted)(KODI_HANDLE kodiInstance, const char* title, bool hardcore);
1428 void (*RCOnRichPresenceUpdated)(KODI_HANDLE kodiInstance, const char* evaluation);
1429 void (*RCOnLoginResult)(KODI_HANDLE kodiInstance, const struct game_rc_login_result* data);
1430
1431 void (*RCOnAchievementProgress)(KODI_HANDLE kodiInstance,
1432 const struct game_rc_achievement_progress* progress,
1433 unsigned int count);
1434 void (*RCOnServerError)(KODI_HANDLE kodiInstance, const char* message, const char* api);
1435 void (*RCOnConnectionChanged)(KODI_HANDLE kodiInstance, bool connected);
1437
1444 {
1445 KODI_HANDLE addonInstance;
1446
1447 GAME_ERROR(__cdecl* LoadGame)(const struct AddonInstance_Game*, const char*);
1448 GAME_ERROR(__cdecl* LoadGameSpecial)
1449 (const struct AddonInstance_Game*, enum SPECIAL_GAME_TYPE, const char**, size_t);
1450 GAME_ERROR(__cdecl* LoadStandalone)(const struct AddonInstance_Game*);
1451 GAME_ERROR(__cdecl* UnloadGame)(const struct AddonInstance_Game*);
1452 GAME_ERROR(__cdecl* GetGameTiming)
1453 (const struct AddonInstance_Game*, struct game_system_timing*);
1454 GAME_REGION(__cdecl* GetRegion)(const struct AddonInstance_Game*);
1455 bool(__cdecl* RequiresGameLoop)(const struct AddonInstance_Game*);
1456 GAME_ERROR(__cdecl* RunFrame)(const struct AddonInstance_Game*);
1457 GAME_ERROR(__cdecl* Reset)(const struct AddonInstance_Game*);
1458 GAME_ERROR(__cdecl* HwContextReset)(const struct AddonInstance_Game*);
1459 GAME_ERROR(__cdecl* HwContextDestroy)(const struct AddonInstance_Game*);
1460 GAME_ERROR(__cdecl* AudioAvailable)(const AddonInstance_Game*);
1461 bool(__cdecl* HasFeature)(const struct AddonInstance_Game*, const char*, const char*);
1462 game_input_topology*(__cdecl* GetTopology)(const struct AddonInstance_Game*);
1463 void(__cdecl* FreeTopology)(const struct AddonInstance_Game*, struct game_input_topology*);
1464 void(__cdecl* SetControllerLayouts)(const struct AddonInstance_Game*,
1465 const struct game_controller_layout*,
1466 unsigned int);
1467 bool(__cdecl* EnableKeyboard)(const struct AddonInstance_Game*, bool, const char*);
1468 bool(__cdecl* EnableMouse)(const struct AddonInstance_Game*, bool, const char*);
1469 bool(__cdecl* ConnectController)(const struct AddonInstance_Game*,
1470 bool,
1471 const char*,
1472 const char*);
1473 bool(__cdecl* InputEvent)(const struct AddonInstance_Game*, const struct game_input_event*);
1474 size_t(__cdecl* SerializeSize)(const struct AddonInstance_Game*);
1475 GAME_ERROR(__cdecl* Serialize)(const struct AddonInstance_Game*, uint8_t*, size_t);
1476 GAME_ERROR(__cdecl* Deserialize)(const struct AddonInstance_Game*, const uint8_t*, size_t);
1477 GAME_ERROR(__cdecl* CheatReset)(const struct AddonInstance_Game*);
1478 GAME_ERROR(__cdecl* GetMemory)
1479 (const struct AddonInstance_Game*, enum GAME_MEMORY, uint8_t**, size_t*);
1480 GAME_ERROR(__cdecl* SetCheat)
1481 (const struct AddonInstance_Game*, unsigned int, bool, const char*);
1482 bool(__cdecl* GetEjectState)(const AddonInstance_Game*);
1483 GAME_ERROR(__cdecl* SetEjectState)(const AddonInstance_Game*, bool);
1484 unsigned int(__cdecl* GetImageIndex)(const AddonInstance_Game*);
1485 GAME_ERROR(__cdecl* SetImageIndex)(const AddonInstance_Game*, unsigned int);
1486 unsigned int(__cdecl* GetImageCount)(const AddonInstance_Game*);
1487 GAME_ERROR(__cdecl* AddImageIndex)(const AddonInstance_Game*);
1488 GAME_ERROR(__cdecl* ReplaceImageIndex)(const AddonInstance_Game*, unsigned int, const char*);
1489 GAME_ERROR(__cdecl* RemoveImageIndex)(const AddonInstance_Game*, unsigned int);
1490 GAME_ERROR(__cdecl* SetInitialImage)(const AddonInstance_Game*, unsigned int, const char*);
1491 char*(__cdecl* GetImagePath)(const AddonInstance_Game*, unsigned int);
1492 char*(__cdecl* GetImageLabel)(const AddonInstance_Game*, unsigned int);
1493 GAME_ERROR(__cdecl* SetRetroAchievementsCredentials)
1494 (const AddonInstance_Game*, const char*, const char*);
1495 GAME_ERROR(__cdecl* ActivateAchievement)(const AddonInstance_Game*, unsigned int, const char*);
1496 GAME_ERROR(__cdecl* GetCheevoUrlId)
1497 (const AddonInstance_Game*,
1498 void(__cdecl*)(const void*, const char*, unsigned int),
1499 const void*);
1500 size_t(__cdecl* AchievementStateSize)(const struct AddonInstance_Game*);
1501 GAME_ERROR(__cdecl* SerializeAchievements)
1502 (const struct AddonInstance_Game*, uint8_t*, size_t);
1503 GAME_ERROR(__cdecl* DeserializeAchievements)
1504 (const struct AddonInstance_Game*, const uint8_t*, size_t);
1505 void(__cdecl* FreeString)(const AddonInstance_Game*, char*);
1507
1513 typedef struct AddonInstance_Game
1514 {
1515 struct AddonProps_Game* props;
1516 struct AddonToKodiFuncTable_Game* toKodi;
1517 struct KodiToAddonFuncTable_Game* toAddon;
1519
1520#ifdef __cplusplus
1521}
1522#endif /* __cplusplus */
1523
1524#endif /* !C_API_ADDONINSTANCE_GAME_H */
const uint8_t * data
Pointer to the audio stream data given to Kodi.
Definition game.h:172
size_t size
Size of the data array.
Definition game.h:175
GAME_AUDIO_CHANNEL
Audio channel
Definition game.h:86
GAME_PCM_FORMAT
Stream Format
Definition game.h:72
@ GAME_CH_TFC
Channel top front center.
Definition game.h:130
@ GAME_CH_FL
Channel front left.
Definition game.h:91
@ GAME_CH_BL
Channel back left.
Definition game.h:103
@ GAME_CH_TBR
Channel top back right.
Definition game.h:139
@ GAME_CH_FC
Channel front center.
Definition game.h:97
@ GAME_CH_BLOC
Channel back left over center.
Definition game.h:145
@ GAME_CH_TFL
Channel top front left.
Definition game.h:124
@ GAME_CH_NULL
Channel list terminator.
Definition game.h:88
@ GAME_CH_TBC
Channel top back center.
Definition game.h:142
@ GAME_CH_SR
Channel surround/side right.
Definition game.h:121
@ GAME_CH_TFR
Channel top front right.
Definition game.h:127
@ GAME_CH_FR
Channel front right.
Definition game.h:94
@ GAME_CH_BC
Channel back center.
Definition game.h:115
@ GAME_CH_SL
Channel surround/side left.
Definition game.h:118
@ GAME_CH_LFE
Channel low frequency effects / subwoofer.
Definition game.h:100
@ GAME_CH_BROC
Channel back right over center.
Definition game.h:148
@ GAME_CH_TC
Channel top center.
Definition game.h:133
@ GAME_CH_FLOC
Channel front left over center.
Definition game.h:109
@ GAME_CH_FROC
Channel front right over center.
Definition game.h:112
@ GAME_CH_TBL
Channel top back left.
Definition game.h:136
@ GAME_CH_BR
Channel back right.
Definition game.h:106
@ GAME_PCM_FORMAT_S16NE
S16NE sample format.
Definition game.h:76
Audio stream packet
Definition game.h:170
Game audio stream properties
Definition game.h:158
double sample_rate
Sampling rate of audio.
Definition game.h:1146
double fps
FPS of video content.
Definition game.h:1143
Game system timing.
Definition game.h:1141
GAME_SIMD
ID values for SIMD CPU features
Definition game.h:669
GAME_REGION
Game region definition
Definition game.h:586
SPECIAL_GAME_TYPE
Special game types passed into game_load_game_special().
Definition game.h:604
GAME_MEMORY
Game Memory
Definition game.h:623
@ GAME_SIMD_VFPU
SIMD CPU VFPU.
Definition game.h:710
@ GAME_SIMD_VMX128
SIMD CPU VMX128.
Definition game.h:680
@ GAME_SIMD_SSE
SIMD CPU SSE.
Definition game.h:671
@ GAME_SIMD_SSE4
SIMD CPU SSE4.
Definition game.h:701
@ GAME_SIMD_NEON
SIMD CPU NEON.
Definition game.h:686
@ GAME_SIMD_AVX2
SIMD CPU AVX2.
Definition game.h:707
@ GAME_SIMD_SSE42
SIMD CPU SSE42.
Definition game.h:704
@ GAME_SIMD_SSSE3
SIMD CPU SSSE3.
Definition game.h:692
@ GAME_SIMD_SSE2
SIMD CPU SSE2.
Definition game.h:674
@ GAME_SIMD_SSE3
SIMD CPU SSE3.
Definition game.h:689
@ GAME_SIMD_AVX
SIMD CPU AVX.
Definition game.h:683
@ GAME_SIMD_MMXEXT
SIMD CPU MMXEXT.
Definition game.h:698
@ GAME_SIMD_MMX
SIMD CPU MMX.
Definition game.h:695
@ GAME_SIMD_VMX
SIMD CPU VMX.
Definition game.h:677
@ GAME_REGION_NTSC
Game region NTSC.
Definition game.h:591
@ GAME_REGION_PAL
Game region PAL.
Definition game.h:594
@ GAME_REGION_UNKNOWN
Game region unknown.
Definition game.h:588
@ SPECIAL_GAME_TYPE_SUPER_GAME_BOY
Game Type super game boy.
Definition game.h:615
@ SPECIAL_GAME_TYPE_BSX
Game Type BSX.
Definition game.h:606
@ SPECIAL_GAME_TYPE_BSX_SLOTTED
Game Type BSX slotted.
Definition game.h:609
@ SPECIAL_GAME_TYPE_SUFAMI_TURBO
Game Type sufami turbo.
Definition game.h:612
@ GAME_MEMORY_SNES_SUFAMI_TURBO_A_RAM
Special memory type.
Definition game.h:653
@ GAME_MEMORY_VIDEO_RAM
Video ram lets a frontend peek into a game systems video RAM (VRAM)
Definition game.h:644
@ GAME_MEMORY_SNES_SUFAMI_TURBO_B_RAM
Special memory type.
Definition game.h:656
@ GAME_MEMORY_SNES_GAME_BOY_RTC
Special memory type.
Definition game.h:662
@ GAME_MEMORY_SNES_BSX_PRAM
Special memory type.
Definition game.h:650
@ GAME_MEMORY_MASK
Passed to game_get_memory_data/size(). If the memory type doesn't apply to the implementation NULL/0 ...
Definition game.h:626
@ GAME_MEMORY_SAVE_RAM
Regular save ram.
Definition game.h:633
@ GAME_MEMORY_SYSTEM_RAM
System ram lets a frontend peek into a game systems main RAM.
Definition game.h:641
@ GAME_MEMORY_SNES_BSX_RAM
Special memory type.
Definition game.h:647
@ GAME_MEMORY_RTC
Some games have a built-in clock to keep track of time.
Definition game.h:638
@ GAME_MEMORY_SNES_GAME_BOY_RAM
Special memory type.
Definition game.h:659
bool cache_context
If true, the frontend will go to great lengths to avoid resetting the context in scenarios like toggl...
Definition game.h:383
unsigned int version_minor
Minor version number for the core GL context or GLES 3.1+.
Definition game.h:370
bool depth
Set to true if render buffers should have a depth component attached.
Definition game.h:347
unsigned int version_major
Major version number for the core GL context or GLES 3.1+.
Definition game.h:367
bool bottom_left_origin
Use the conventional bottom-left origin.
Definition game.h:364
GAME_HW_CONTEXT_TYPE context_type
The API to use.
Definition game.h:341
bool debug_context
Creates a debug context.
Definition game.h:386
bool stencil
Set to true if stencil buffers should be attached.
Definition game.h:356
void(* game_proc_address_t)(void)
Hardware framebuffer process function address
Definition game.h:426
GAME_HW_CONTEXT_TYPE
Hardware framebuffer type
Definition game.h:306
@ GAME_HW_CONTEXT_OPENGLES2
OpenGL ES 2.0.
Definition game.h:314
@ GAME_HW_CONTEXT_OPENGL_CORE
Modern desktop core GL context. Use the major and minor fields to set the GL version.
Definition game.h:317
@ GAME_HW_CONTEXT_VULKAN
Vulkan.
Definition game.h:326
@ GAME_HW_CONTEXT_OPENGLES_VERSION
OpenGL ES 3.1+. Set major/minor fields.
Definition game.h:323
@ GAME_HW_CONTEXT_OPENGLES3
OpenGL ES 3.0.
Definition game.h:320
@ GAME_HW_CONTEXT_NONE
No context.
Definition game.h:308
@ GAME_HW_CONTEXT_OPENGL
OpenGL 2.x. The driver can choose to use the latest compatibility context.
Definition game.h:311
Hardware rendering properties
Definition game.h:338
Hardware framebuffer buffer
Definition game.h:407
Hardware framebuffer packet
Definition game.h:417
Hardware framebuffer properties
Definition game.h:398
int y
The relative Y position of the pointer.
Definition game.h:1049
bool pressed
True if the button is pressed, false if it is released.
Definition game.h:969
const char * feature_name
The name of the feature that generated the event.
Definition game.h:1094
GAME_INPUT_EVENT_SOURCE type
The type of input event.
Definition game.h:1082
unsigned int port_count
The number of ports in the available ports list.
Definition game.h:908
game_input_port * ports
The list of ports on the virtual game console.
Definition game.h:954
bool force_connected
Flag to prevent a port from being disconnected.
Definition game.h:928
unsigned int device_count
The number of devices in the accepted devices list.
Definition game.h:940
int x
The relative X position of the pointer.
Definition game.h:1046
GAME_PORT_TYPE type
The type of port.
Definition game.h:918
float position
The position of the axis, from -1.0 to 1.0.
Definition game.h:987
struct game_input_port * available_ports
The list of ports that the device can be connected to.
Definition game.h:905
float magnitude
The magnitude of the button press, from 0.0 to 1.0.
Definition game.h:978
const char * controller_id
ID used in the Kodi controller API, e.g. game.controller.default
Definition game.h:899
bool autoconnect
Flag to auto-connect this port when a game session begins.
Definition game.h:934
float y
The position of the stick along the Y axis, from -1.0 to 1.0.
Definition game.h:1003
const char * port_address
The address of the port that the device is connected to.
Definition game.h:902
uint32_t unicode
If the keypress generates a printing character.
Definition game.h:1034
GAME_KEY_MOD modifiers
Modifier keys pressed with the event key.
Definition game.h:1037
GAME_PORT_TYPE port_type
The type of port that the controller is connected to.
Definition game.h:1088
float x
The position of the stick along the X axis, from -1.0 to 1.0.
Definition game.h:1000
int player_limit
A limit on the number of input-providing devices, or -1 for no limit.
Definition game.h:960
const char * port_id
Required for GAME_PORT_CONTROLLER type.
Definition game.h:921
game_input_device * accepted_devices
The list of devices that can be connected to the port.
Definition game.h:937
float z
The accelerometer Z axis, from -1.0 to 1.0.
Definition game.h:1018
GAME_INPUT_EVENT_SOURCE
Type of input event.
Definition game.h:782
GAME_KEY_MOD
A modifier key pressed to give another key a special meaning.
Definition game.h:815
GAME_PORT_TYPE
Type of port on the virtual game console.
Definition game.h:848
@ GAME_INPUT_EVENT_DIGITAL_BUTTON
Digital button press or release.
Definition game.h:784
@ GAME_INPUT_EVENT_ANALOG_STICK
Analog stick motion.
Definition game.h:793
@ GAME_INPUT_EVENT_ABSOLUTE_POINTER
Absolute pointer motion.
Definition game.h:805
@ GAME_INPUT_EVENT_RELATIVE_POINTER
Relative pointer motion.
Definition game.h:802
@ GAME_INPUT_EVENT_MOTOR
Motor vibration.
Definition game.h:808
@ GAME_INPUT_EVENT_ACCELEROMETER
Accelerometer motion.
Definition game.h:796
@ GAME_INPUT_EVENT_KEY
Key press or release.
Definition game.h:799
@ GAME_INPUT_EVENT_AXIS
Axis motion.
Definition game.h:790
@ GAME_INPUT_EVENT_ANALOG_BUTTON
Analog button motion.
Definition game.h:787
@ GAME_KEY_MOD_ALT
Alt key.
Definition game.h:826
@ GAME_KEY_MOD_CAPSLOCK
Caps Lock key.
Definition game.h:838
@ GAME_KEY_MOD_CTRL
Control key.
Definition game.h:823
@ GAME_KEY_MOD_META
Meta key.
Definition game.h:829
@ GAME_KEY_MOD_SCROLLOCK
Scroll Lock key.
Definition game.h:841
@ GAME_KEY_MOD_NUMLOCK
Num Lock key.
Definition game.h:835
@ GAME_KEY_MOD_SUPER
Windows key.
Definition game.h:832
@ GAME_KEY_MOD_NONE
No modifier key.
Definition game.h:817
@ GAME_KEY_MOD_SHIFT
Shift key.
Definition game.h:820
@ GAME_PORT_MOUSE
Game port mouse.
Definition game.h:856
@ GAME_PORT_CONTROLLER
Game port controller.
Definition game.h:859
@ GAME_PORT_KEYBOARD
Game port Keyboard.
Definition game.h:853
@ GAME_PORT_UNKNOWN
Game port unknown.
Definition game.h:850
An absolute pointer event, such as a touchscreen or tablet motion.
Definition game.h:1056
An accelerometer event.
Definition game.h:1010
An analog button event, such as a trigger press or release.
Definition game.h:976
An analog stick event, such as a joystick's motion.
Definition game.h:998
An axis event, such as a joystick or accelerometer.
Definition game.h:985
"C" Game add-on controller layout.
Definition game.h:871
A digital button event, such as a button press or release.
Definition game.h:967
Device that can provide input.
Definition game.h:897
An input event.
Definition game.h:1080
Port that can provide input.
Definition game.h:916
The input topology is the possible ways to connect input devices.
Definition game.h:952
A key event, such as a key press or release.
Definition game.h:1025
A motor vibration event.
Definition game.h:1071
A relative pointer event, such as a mouse motion.
Definition game.h:1044
const game_rc_achievement * achievements
Achievements of the game, or NULL if achievement_count is 0.
Definition game.h:1241
bool hardcore
True if the achievement was earned in hardcore mode.
Definition game.h:1269
const char * icon_url
URL of the game's icon, or NULL
Definition game.h:1238
const char * display_name
Display name of the player, or NULL
Definition game.h:1285
float rarity
Percentage of players who earned this achievement, 0.0 if unknown.
Definition game.h:1216
float measured_percent
Progress towards the achievement, from 0.0 to 100.0.
Definition game.h:1323
const char * badge_locked_url
URL of the locked (greyscale) badge, or NULL
Definition game.h:1204
const char * description
Description of how the achievement is earned, or NULL
Definition game.h:1198
unsigned int points
Point value of the achievement.
Definition game.h:1207
bool success
True if the player was logged in.
Definition game.h:1279
const char * title
Title of the achievement, or NULL if unknown.
Definition game.h:1195
unsigned int id
Unique RetroAchievements ID of the achievement.
Definition game.h:1192
const char * username
Account name of the player, or NULL
Definition game.h:1282
int64_t unlock_time
Unix time the achievement was earned, or 0 if it was not.
Definition game.h:1213
GAME_RC_UNLOCK_STATE unlock_state
Whether and how the player has earned this achievement.
Definition game.h:1210
unsigned int achievement_count
Number of elements in achievements.
Definition game.h:1244
unsigned int game_id
Unique RetroAchievements ID of the game.
Definition game.h:1232
bool credentials_rejected
True if the account or token was rejected, rather than the attempt failing for some other reason.
Definition game.h:1303
const char * badge_url
URL of the unlocked (full colour) badge, or NULL
Definition game.h:1201
const char * measured_progress
Human-readable progress such as "45/100", or NULL
Definition game.h:1326
const char * error_message
Reason the login failed, or NULL if it succeeded.
Definition game.h:1294
float rarity_hardcore
Percentage of players who earned this in hardcore, 0.0 if unknown.
Definition game.h:1219
GAME_RC_UNLOCK_STATE
Unlock state of an achievement
Definition game.h:1174
@ GAME_RC_UNLOCK_STATE_SOFTCORE
The achievement was earned outside of hardcore mode.
Definition game.h:1179
@ GAME_RC_UNLOCK_STATE_HARDCORE
The achievement was earned in hardcore mode.
Definition game.h:1182
@ GAME_RC_UNLOCK_STATE_LOCKED
The achievement has not been earned by this player.
Definition game.h:1176
A single achievement belonging to the loaded game
Definition game.h:1190
Progress towards a single measured achievement
Definition game.h:1318
**Payload of AddonToKodiFuncTable_Game::RCOnAchievementTriggered**
Definition game.h:1252
**Payload of AddonToKodiFuncTable_Game::RCOnGameLoaded**
Definition game.h:1230
**Payload of AddonToKodiFuncTable_Game::RCOnLoginResult**
Definition game.h:1277
game_stream_video_packet game_stream_sw_framebuffer_packet
Software framebuffer packet
Definition game.h:462
game_stream_video_properties game_stream_sw_framebuffer_properties
Game software framebuffer stream properties
Definition game.h:443
Software framebuffer type
Definition game.h:450
GAME_STREAM_TYPE type
The stream type.
Definition game.h:505
GAME_STREAM_TYPE
Game stream types
Definition game.h:478
@ GAME_STREAM_VIDEO
Video stream.
Definition game.h:486
@ GAME_STREAM_AUDIO
Audio stream.
Definition game.h:483
@ GAME_STREAM_HW_FRAMEBUFFER
Hardware framebuffer.
Definition game.h:489
@ GAME_STREAM_UNKNOWN
Unknown.
Definition game.h:480
@ GAME_STREAM_SW_FRAMEBUFFER
Software framebuffer.
Definition game.h:492
Stream buffers for hardware rendering and zero-copy support
Definition game.h:528
Stream packet and ephemeral metadata
Definition game.h:551
Immutable stream metadata
Definition game.h:503
float display_aspect_ratio
Display aspect ratio (DAR) to use when showing the video frame.
Definition game.h:280
const uint8_t * data
Pointer to the video stream data given to Kodi.
Definition game.h:286
size_t size
Size of the data array.
Definition game.h:289
unsigned int nominal_width
The nominal width, in pixels.
Definition game.h:244
unsigned int max_height
The maximum height, in pixels.
Definition game.h:259
GAME_VIDEO_ROTATION rotation
Video rotation angle defined by GAME_VIDEO_ROTATION.
Definition game.h:283
unsigned int height
Video height, in pixels.
Definition game.h:274
unsigned int max_width
The maximum width, in pixels.
Definition game.h:256
unsigned int width
Video width, in pixels.
Definition game.h:271
float nominal_display_aspect_ratio
The nominal display aspect ratio (DAR) used to show the video frame.
Definition game.h:253
GAME_PIXEL_FORMAT format
The stream's pixel format.
Definition game.h:241
unsigned int nominal_height
The nominal height, in pixels.
Definition game.h:247
GAME_PIXEL_FORMAT
Pixel format
Definition game.h:197
GAME_VIDEO_ROTATION
Video rotation orientation
Definition game.h:217
@ GAME_PIXEL_FORMAT_RGB565
RGB565 Format.
Definition game.h:204
@ GAME_PIXEL_FORMAT_0RGB1555
0RGB1555 Format
Definition game.h:207
@ GAME_PIXEL_FORMAT_0RGB8888
0RGB8888 Format
Definition game.h:201
@ GAME_VIDEO_ROTATION_180_CCW
Rotate 180° counterclockwise.
Definition game.h:225
@ GAME_VIDEO_ROTATION_0
0° without rotation
Definition game.h:219
@ GAME_VIDEO_ROTATION_90_CCW
Rotate 90° counterclockwise.
Definition game.h:222
@ GAME_VIDEO_ROTATION_270_CCW
Rotate 270° counterclockwise.
Definition game.h:228
Video stream packet
Definition game.h:269
Game video stream properties
Definition game.h:239
GAME_ERROR
Game add-on error codes
Definition game.h:29
@ GAME_ERROR_FAILED
The command failed.
Definition game.h:46
@ GAME_ERROR_REJECTED
The command was rejected by the game client.
Definition game.h:40
@ GAME_ERROR_INVALID_PARAMETERS
The parameters of the called method are invalid for this operation.
Definition game.h:43
@ GAME_ERROR_UNKNOWN
An unknown error occurred.
Definition game.h:34
@ GAME_ERROR_NO_ERROR
No error occurred.
Definition game.h:31
@ GAME_ERROR_RESTRICTED
Game requires restricted resources.
Definition game.h:52
@ GAME_ERROR_NOT_LOADED
No game is loaded.
Definition game.h:49
@ GAME_ERROR_NOT_IMPLEMENTED
The method called by the frontend is not implemented.
Definition game.h:37
Game instance.
Definition game.h:1514
Game properties.
Definition game.h:1340
const char ** resource_directories
The "system" directories of the frontend.
Definition game.h:1362
unsigned int proxy_dll_count
Number of proxy DLL paths provided.
Definition game.h:1354
const char * profile_directory
The writable directory of the frontend.
Definition game.h:1375
const char * game_client_dll_path
The path of the game client being loaded.
Definition game.h:1344
unsigned int extension_count
Number of extensions provided.
Definition game.h:1390
bool supports_vfs
The value of the <supports_vfs> property from addon.xml.
Definition game.h:1380
const char ** proxy_dll_paths
Paths to proxy DLLs used to load the game client.
Definition game.h:1349
const char ** extensions
The extensions in the <extensions> property from addon.xml.
Definition game.h:1385
unsigned int resource_directory_count
Number of resource directories provided.
Definition game.h:1367
Game callbacks.
Definition game.h:1406
Game function hooks.
Definition game.h:1444