Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
3204b5c3b4 | ||
|
|
cd02242a01 | ||
|
|
e35dc9e097 | ||
|
|
f4dc161831 | ||
|
|
1d6c27baca | ||
|
|
009df228d6 | ||
|
|
7746e494cf | ||
|
|
90a88983f1 | ||
|
|
22a4fe63db | ||
|
|
d77508f481 | ||
|
|
53321d33d5 | ||
|
|
5c28f6afd8 | ||
|
|
d49001143f | ||
|
|
513e5a7e3f | ||
|
|
6f75fab7ff | ||
|
|
38fc6d6ba1 | ||
|
|
02f2464a00 | ||
|
|
86b286fb0b | ||
|
|
ecef8913b1 | ||
|
|
277b202020 | ||
|
|
6ba97bc43c | ||
|
|
0fbde146a9 | ||
|
|
16e0c6f0f6 | ||
|
|
8cab07a4b2 | ||
|
|
55c8546d68 | ||
|
|
1762f18116 | ||
|
|
e4dbf1ce11 | ||
|
|
10b9d96259 | ||
|
|
b23154fd93 | ||
|
|
b0ee972178 | ||
|
|
544e1d3b21 | ||
|
|
0ca6947f99 | ||
|
|
3122c08039 | ||
|
|
7a279a6fd9 | ||
|
|
c4581bd9a6 | ||
|
|
bb47b976a7 | ||
|
|
6c419ff22e | ||
|
|
522904527f | ||
|
|
30539371c2 | ||
|
|
e2ecc315b4 | ||
|
|
eb2f186205 | ||
|
|
bbf06b3376 | ||
|
|
a1f70b0b31 | ||
|
|
2e0f5c02a4 | ||
|
|
0f7001ef5c | ||
|
|
4600da5782 | ||
|
|
a3557fadef | ||
|
|
d9a67faf47 | ||
|
|
96eaf8850e | ||
|
|
e7efd46419 | ||
|
|
346b1456cd | ||
|
|
9f5a5a735b | ||
|
|
8e4b304bed | ||
|
|
6cbb8a36cf | ||
|
|
607fbc54fc | ||
|
|
276cf0a8cb | ||
|
|
59c9af97c2 | ||
|
|
4e75d99026 | ||
|
|
8e91c16e97 | ||
|
|
186421fe85 | ||
|
|
af952870c3 | ||
|
|
4eeb0b4b20 | ||
|
|
cb2c65e9d9 | ||
|
|
f7bbde3982 | ||
|
|
c9fc3b4820 | ||
|
|
f5195dd137 | ||
|
|
5289f13891 | ||
|
|
073b35690b | ||
|
|
43d3ac102d | ||
|
|
aa96f9ceb3 | ||
|
|
104b8260fb | ||
|
|
edebc728ef | ||
|
|
08e7ce3b5b | ||
|
|
29f187b751 | ||
|
|
ac3a1ad5eb | ||
|
|
1b8d7b1541 | ||
|
|
b812d61da2 | ||
|
|
6fd64383d3 | ||
|
|
e984e7a6c8 | ||
|
|
96f90ff9c4 | ||
|
|
51aec0e012 | ||
|
|
faadd3e89f | ||
|
|
0c091256f4 | ||
|
|
7a0fb01626 | ||
|
|
c01818e2e3 | ||
|
|
e17a8a505c | ||
|
|
ab654deba7 | ||
|
|
b145d7fd0e | ||
|
|
264c9e38ad | ||
|
|
e88773da4e | ||
|
|
310f67a06c | ||
|
|
0914d5b8e2 | ||
|
|
bf1aa47854 | ||
|
|
291a4dbb25 | ||
|
|
8fe3d13935 | ||
|
|
bdc326b14e | ||
|
|
d938e38ad3 | ||
|
|
3d4772455b | ||
|
|
e1f0089627 | ||
|
|
be423b2910 | ||
|
|
3bf3bdf641 | ||
|
|
e923777eb6 | ||
|
|
cf6eb0010e | ||
|
|
5184115216 | ||
|
|
edbebbf082 | ||
|
|
242dee499d | ||
|
|
39a46e8f79 | ||
|
|
a2de1e24c5 | ||
|
|
c0cce90e60 | ||
|
|
d9712cf85e | ||
|
|
67e74b5874 | ||
|
|
9639ace28a | ||
|
|
a2616778cc | ||
|
|
0691e2d9e2 | ||
|
|
495c34dd40 | ||
|
|
f38ca9aa28 | ||
|
|
b0bf588c27 | ||
|
|
35e4f35f6e | ||
|
|
7866b769cc | ||
|
|
1af1e42dab | ||
|
|
40bd3e5e19 | ||
|
|
25dd3b4976 | ||
|
|
08864e27b2 | ||
|
|
4a3c9ccfbb | ||
|
|
cedd789a27 | ||
|
|
0fe3086a5a | ||
|
|
c9afd4a2cd | ||
|
|
7518a6f181 | ||
|
|
2bf4c44259 | ||
|
|
1c95e5f40e | ||
|
|
7c848f4be5 | ||
|
|
a4af254643 | ||
|
|
860dc37fe4 | ||
|
|
8b3d55fbc8 | ||
|
|
0540b5656a | ||
|
|
6c98440f27 | ||
|
|
3828a9f8e0 | ||
|
|
2c7c9ec32a | ||
|
|
1ccd3e37bc | ||
|
|
6ad344f65d | ||
|
|
1c289d73ca | ||
|
|
44ba69cf53 | ||
|
|
4cea0c1414 | ||
|
|
4ee468f5c6 | ||
|
|
9a58eb3010 | ||
|
|
59ff5e61bf | ||
|
|
821c061f82 | ||
|
|
8f91707164 | ||
|
|
37eba186f5 | ||
|
|
eb4d9bbdd5 | ||
|
|
c19c80d797 | ||
|
|
a2feaa7fde | ||
|
|
3cb4e86b48 | ||
|
|
ed758fc921 | ||
|
|
a191c8b71e | ||
|
|
3f2e0bd349 | ||
|
|
3bdc745bd1 | ||
|
|
f578781418 | ||
|
|
0bb63ee0af | ||
|
|
2ae9563ab3 | ||
|
|
6b429e4388 | ||
|
|
0321b0d94a | ||
|
|
ac57b7fd2d | ||
|
|
7013e63142 | ||
|
|
4e1ef7c0cd | ||
|
|
892f2253ea | ||
|
|
bebe62346f | ||
|
|
834a94e429 | ||
|
|
fcf833ff48 | ||
|
|
f2a27539d3 | ||
|
|
05d26654df | ||
|
|
cee6a27340 | ||
|
|
66e35a9d67 | ||
|
|
ad096ccd42 | ||
|
|
7a9e81828a | ||
|
|
71e7dacb56 | ||
|
|
f9c0ee865f | ||
|
|
154eaaf027 | ||
|
|
66f5f9b2a2 | ||
|
|
b27275b887 | ||
|
|
c81c2c1d8d | ||
|
|
7eb2ad1e35 | ||
|
|
f49e57a38c | ||
|
|
265f4a50ef | ||
|
|
e83e2659a7 | ||
|
|
c680dd3222 | ||
|
|
96aaaf5261 | ||
|
|
efb29e6be5 | ||
|
|
ccfab57a8c | ||
|
|
56d1343f1b | ||
|
|
b273bc3ca8 | ||
|
|
d4f58a885b | ||
|
|
04458f18f8 | ||
|
|
64152eea0d | ||
|
|
0e0a690e3c | ||
|
|
f283d3ca43 | ||
|
|
982fff959f | ||
|
|
b0e968e3c3 | ||
|
|
e5bbb14ce0 | ||
|
|
327cca2e8e | ||
|
|
e02e9a12d7 | ||
|
|
9e2fd091a8 | ||
|
|
0a04fca634 | ||
|
|
8a3f793324 | ||
|
|
e91892849c | ||
|
|
6b4e3c9d13 | ||
|
|
5f55b81fbf | ||
|
|
ca68bab002 | ||
|
|
339eb1879e | ||
|
|
1adb49c65c | ||
|
|
1d33a05a85 | ||
|
|
cfcd20d44a | ||
|
|
204607e272 | ||
|
|
b89a8ca6f9 | ||
|
|
d4aa352d59 | ||
|
|
c489841732 | ||
|
|
a6a97b4c4f | ||
|
|
fba070f82e | ||
|
|
10c117f95f | ||
|
|
bceda5beb4 | ||
|
|
c50c936b1f | ||
|
|
22a6be76b5 | ||
|
|
d3d25df3c5 | ||
|
|
2a3f9e9ee6 | ||
|
|
31f01fd5da | ||
|
|
bb9a4a0da0 | ||
|
|
3bac722562 | ||
|
|
3769ab74ac | ||
|
|
c3d6cdd272 | ||
|
|
093602fd6b | ||
|
|
a80d119c58 | ||
|
|
1cdc92a62b | ||
|
|
6b8de308b7 | ||
|
|
310e64d8be | ||
|
|
d2d3afc7f4 | ||
|
|
c26d2faee9 | ||
|
|
1c82c338a5 | ||
|
|
c81cd48552 | ||
|
|
306f7d455e | ||
|
|
dc40befa88 | ||
|
|
2222272d6f | ||
|
|
1849d5aade | ||
|
|
3878c2f72a | ||
|
|
7cf3bceaff | ||
|
|
1e394b0530 | ||
|
|
b09660204a | ||
|
|
7b4592377e | ||
|
|
45ba69a45a | ||
|
|
4d9c345202 | ||
|
|
0437952027 | ||
|
|
d188839d0b | ||
|
|
86ac11f877 | ||
|
|
0f59e0e270 | ||
|
|
cd32270ec0 | ||
|
|
f2a7f9ccaa | ||
|
|
2c2ffe36d7 | ||
|
|
951b880acb | ||
|
|
ecfa973e6b | ||
|
|
749b87b4ca | ||
|
|
7f671e4e30 | ||
|
|
ee0e4836f5 | ||
|
|
a01cd628ab | ||
|
|
4a4e668d21 | ||
|
|
03c579769c | ||
|
|
2e88b6a1dd | ||
|
|
5265b147f5 | ||
|
|
b4a37a2fa4 | ||
|
|
93eb2b336d | ||
|
|
30acdca9d3 | ||
|
|
677b34c174 | ||
|
|
b3be7bcedc | ||
|
|
19c10be76b | ||
|
|
60222f2f00 | ||
|
|
34edd0a2e3 | ||
|
|
46b485df14 | ||
|
|
8d3632caca | ||
|
|
b5ae9ba733 | ||
|
|
2a823ecd60 | ||
|
|
940327210f | ||
|
|
20a08df1e1 | ||
|
|
4cf27d40e9 | ||
|
|
d18c9a257a | ||
|
|
65dc5bb1fd | ||
|
|
e18be33c91 | ||
|
|
9ad6751719 | ||
|
|
86ab994408 | ||
|
|
21f0d603c3 | ||
|
|
971513e7d3 | ||
|
|
03929e551f | ||
|
|
db5ae247b6 | ||
|
|
d46beab34e | ||
|
|
9a794232d7 | ||
|
|
db635e5c5b | ||
|
|
8a105a9679 | ||
|
|
46b968a351 | ||
|
|
a9836307b2 | ||
|
|
b6515bb0ae | ||
|
|
b8257e9037 | ||
|
|
416a2565f9 | ||
|
|
fa75ad4cdd | ||
|
|
cedddaadfc | ||
|
|
43ec517cdd | ||
|
|
495ad5ce06 | ||
|
|
31ce643311 | ||
|
|
b5c1f21ac1 | ||
|
|
86c1b2cbef | ||
|
|
ad828b8f4b | ||
|
|
5dda681c8a | ||
|
|
92df8ffe01 | ||
|
|
2ee8dc09d1 | ||
|
|
b8f9392efd | ||
|
|
99f1166eb1 | ||
|
|
7ab8bf1bbf | ||
|
|
a994d7c050 | ||
|
|
e46d548080 | ||
|
|
3a7108ecfa | ||
|
|
bcf876a4c4 | ||
|
|
8ab15b73a9 | ||
|
|
301d73a30e | ||
|
|
2ef4e7fcba | ||
|
|
7eb118920f | ||
|
|
2f0588355e | ||
|
|
3e6830fc70 | ||
|
|
2faf859e32 | ||
|
|
8c31fd8a34 | ||
|
|
4dd6d52550 | ||
|
|
8524465767 | ||
|
|
91530c61ad | ||
|
|
89f450db27 | ||
|
|
3e212ebaad | ||
|
|
14af9eb82a | ||
|
|
ed5dbf74f4 | ||
|
|
2bf0a24ab6 | ||
|
|
88a9d6c29e | ||
|
|
335b7ba737 | ||
|
|
37cd720dd6 | ||
|
|
a085abe538 | ||
|
|
57dc099641 |
No files matched your search
+38
-29
@@ -1,14 +1,46 @@
|
|||||||
cmake_minimum_required(VERSION 3.5)
|
cmake_minimum_required(VERSION 3.5)
|
||||||
# DO NOT CHANGE THIS SRB2 STRING! Some variable names depend on this string.
|
|
||||||
# Version change is fine.
|
|
||||||
project(SRB2
|
|
||||||
VERSION 1.6
|
|
||||||
LANGUAGES C)
|
|
||||||
|
|
||||||
if(${PROJECT_SOURCE_DIR} MATCHES ${PROJECT_BINARY_DIR})
|
if(${PROJECT_SOURCE_DIR} MATCHES ${PROJECT_BINARY_DIR})
|
||||||
message(FATAL_ERROR "In-source builds will bring you a world of pain. Please make a separate directory to invoke CMake from.")
|
message(FATAL_ERROR "In-source builds will bring you a world of pain. Please make a separate directory to invoke CMake from.")
|
||||||
endif()
|
endif()
|
||||||
|
|
||||||
|
# DO NOT CHANGE THIS SRB2 STRING! Some variable names depend on this string.
|
||||||
|
# Version change is fine.
|
||||||
|
project(SRB2
|
||||||
|
VERSION 1.6
|
||||||
|
LANGUAGES C CXX)
|
||||||
|
|
||||||
|
set(CMAKE_CXX_STANDARD 17)
|
||||||
|
set(CMAKE_CXX_STANDARD_REQUIRED ON)
|
||||||
|
#set(CMAKE_CXX_EXTENSIONS OFF) # optional but recommended: disables GNU extensions, forces pure ISO C++
|
||||||
|
set(CMAKE_CXX_EXTENSIONS ON)
|
||||||
|
set(CMAKE_C_EXTENSIONS ON)
|
||||||
|
|
||||||
|
##### PACKAGE CONFIGURATION #####
|
||||||
|
|
||||||
|
set(SRB2_CPACK_GENERATOR "" CACHE STRING "Generator to use for making a package. E.g., ZIP, TGZ, DragNDrop (OSX only). Leave blank for default generator.")
|
||||||
|
|
||||||
|
if("${SRB2_CPACK_GENERATOR}" STREQUAL "")
|
||||||
|
if("${CMAKE_SYSTEM_NAME}" MATCHES "Windows")
|
||||||
|
set(SRB2_CPACK_GENERATOR "ZIP")
|
||||||
|
elseif("${CMAKE_SYSTEM_NAME}" MATCHES "Linux")
|
||||||
|
set(SRB2_CPACK_GENERATOR "TGZ")
|
||||||
|
elseif("${CMAKE_SYSTEM_NAME}" MATCHES "Darwin")
|
||||||
|
set(SRB2_CPACK_GENERATOR "TGZ")
|
||||||
|
endif()
|
||||||
|
endif()
|
||||||
|
|
||||||
|
set(CPACK_GENERATOR ${SRB2_CPACK_GENERATOR})
|
||||||
|
set(CPACK_PACKAGE_DESCRIPTION_SUMMARY "Sonic Robo Blast 2 Kart" CACHE STRING "Program name for display purposes")
|
||||||
|
set(CPACK_PACKAGE_VENDOR "Kart Krew" CACHE STRING "Vendor name for display purposes")
|
||||||
|
#set(CPACK_PACKAGE_DESCRIPTION_FILE )
|
||||||
|
set(CPACK_RESOURCE_FILE_LICENSE "${CMAKE_CURRENT_SOURCE_DIR}/LICENSE")
|
||||||
|
set(CPACK_PACKAGE_VERSION_MAJOR ${SRB2_VERSION_MAJOR})
|
||||||
|
set(CPACK_PACKAGE_VERSION_MINOR ${SRB2_VERSION_MINOR})
|
||||||
|
set(CPACK_PACKAGE_VERSION_PATCH ${SRB2_VERSION_PATCH})
|
||||||
|
set(CPACK_PACKAGE_INSTALL_DIRECTORY "CMake ${CMAKE_VERSION_MAJOR}.${CMAKE_VERSION_MINOR}")
|
||||||
|
include(CPack)
|
||||||
|
|
||||||
# Set up CMAKE path
|
# Set up CMAKE path
|
||||||
set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} "${CMAKE_SOURCE_DIR}/cmake/Modules/")
|
set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} "${CMAKE_SOURCE_DIR}/cmake/Modules/")
|
||||||
|
|
||||||
@@ -73,6 +105,7 @@ endif()
|
|||||||
# OS macros
|
# OS macros
|
||||||
if (UNIX)
|
if (UNIX)
|
||||||
add_definitions(-DUNIXCOMMON)
|
add_definitions(-DUNIXCOMMON)
|
||||||
|
add_link_options(-rdynamic) # Use -rdynamic so a backtrace log shows function names
|
||||||
endif()
|
endif()
|
||||||
|
|
||||||
if(CMAKE_COMPILER_IS_GNUCC)
|
if(CMAKE_COMPILER_IS_GNUCC)
|
||||||
@@ -95,14 +128,12 @@ set(CMAKE_PDB_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/bin")
|
|||||||
|
|
||||||
# Set EXE names so the assets CMakeLists can refer to its target
|
# Set EXE names so the assets CMakeLists can refer to its target
|
||||||
set(SRB2_SDL2_EXE_NAME srb2kart CACHE STRING "Executable binary output name")
|
set(SRB2_SDL2_EXE_NAME srb2kart CACHE STRING "Executable binary output name")
|
||||||
set(SRB2_WIN_EXE_NAME srb2kartdd CACHE STRING "Executable binary output name for DirectDraw build")
|
|
||||||
|
|
||||||
include_directories(${CMAKE_CURRENT_BINARY_DIR}/src)
|
include_directories(${CMAKE_CURRENT_BINARY_DIR}/src)
|
||||||
|
|
||||||
add_subdirectory(src)
|
add_subdirectory(src)
|
||||||
add_subdirectory(assets)
|
add_subdirectory(assets)
|
||||||
|
|
||||||
|
|
||||||
## config.h generation
|
## config.h generation
|
||||||
set(GIT_EXECUTABLE "git" CACHE FILEPATH "Path to git binary")
|
set(GIT_EXECUTABLE "git" CACHE FILEPATH "Path to git binary")
|
||||||
include(GitUtilities)
|
include(GitUtilities)
|
||||||
@@ -111,25 +142,3 @@ git_current_branch(SRB2_GIT_BRANCH "${CMAKE_SOURCE_DIR}")
|
|||||||
set(SRB2_COMP_BRANCH "${SRB2_GIT_BRANCH}")
|
set(SRB2_COMP_BRANCH "${SRB2_GIT_BRANCH}")
|
||||||
set(SRB2_COMP_REVISION "${SRB2_COMP_COMMIT}")
|
set(SRB2_COMP_REVISION "${SRB2_COMP_COMMIT}")
|
||||||
configure_file(${CMAKE_CURRENT_SOURCE_DIR}/src/config.h.in ${CMAKE_CURRENT_BINARY_DIR}/src/config.h)
|
configure_file(${CMAKE_CURRENT_SOURCE_DIR}/src/config.h.in ${CMAKE_CURRENT_BINARY_DIR}/src/config.h)
|
||||||
|
|
||||||
##### PACKAGE CONFIGURATION #####
|
|
||||||
|
|
||||||
if(${CMAKE_SYSTEM} MATCHES "Windows")
|
|
||||||
set(CPACK_GENERATOR "ZIP")
|
|
||||||
endif()
|
|
||||||
if(${CMAKE_SYSTEM} MATCHES "Linux")
|
|
||||||
set(CPACK_GENERATOR "TGZ")
|
|
||||||
endif()
|
|
||||||
if(${CMAKE_SYSTEM} MATCHES "Darwin")
|
|
||||||
set(CPACK_GENERATOR "DragNDrop")
|
|
||||||
endif()
|
|
||||||
|
|
||||||
set(CPACK_PACKAGE_DESCRIPTION_SUMMARY "Sonic Robo Blast 2 Kart" CACHE STRING "Program name for display purposes")
|
|
||||||
set(CPACK_PACKAGE_VENDOR "Kart Krew" CACHE STRING "Vendor name for display purposes")
|
|
||||||
#set(CPACK_PACKAGE_DESCRIPTION_FILE )
|
|
||||||
set(CPACK_RESOURCE_FILE_LICENSE "${CMAKE_CURRENT_SOURCE_DIR}/LICENSE")
|
|
||||||
set(CPACK_PACKAGE_VERSION_MAJOR ${SRB2_VERSION_MAJOR})
|
|
||||||
set(CPACK_PACKAGE_VERSION_MINOR ${SRB2_VERSION_MINOR})
|
|
||||||
set(CPACK_PACKAGE_VERSION_PATCH ${SRB2_VERSION_PATCH})
|
|
||||||
set(CPACK_PACKAGE_INSTALL_DIRECTORY "CMake ${CMAKE_VERSION_MAJOR}.${CMAKE_VERSION_MINOR}")
|
|
||||||
include(CPack)
|
|
||||||
+8
-1
@@ -13,10 +13,12 @@ Mainly for use in visual-only addons like secondcolor.
|
|||||||
|
|
||||||
**Not netsafe**. Returns player's current sliptide roll angle, taking sliptideroll cvar value into account.
|
**Not netsafe**. Returns player's current sliptide roll angle, taking sliptideroll cvar value into account.
|
||||||
|
|
||||||
## hud.setVoteBackground(name)
|
## hud.setVoteBackground(name[, time\_per\_frame])
|
||||||
|
|
||||||
Changes vote background texture prefix (game looks for PREFIX + "W" or "C" (depends on resolution) + FRAME\_NUMBER).
|
Changes vote background texture prefix (game looks for PREFIX + "W" or "C" (depends on resolution) + FRAME\_NUMBER).
|
||||||
|
|
||||||
|
If time\_per\_frame is set, each frame will last this amount of tics, default value is 2
|
||||||
|
|
||||||
## hud.add(fn, "vote") and hud.add(fn, "intermission")
|
## hud.add(fn, "vote") and hud.add(fn, "intermission")
|
||||||
|
|
||||||
Hud hooks for vote screen and intermission screen. They only get drawer (`v`) as argument.
|
Hud hooks for vote screen and intermission screen. They only get drawer (`v`) as argument.
|
||||||
@@ -120,6 +122,11 @@ v.interpLatch(false)
|
|||||||
```
|
```
|
||||||
When using a custom string drawer, enable this mode to avoid interpolation artifacting when the string changes.
|
When using a custom string drawer, enable this mode to avoid interpolation artifacting when the string changes.
|
||||||
|
|
||||||
|
## cameras[] global array
|
||||||
|
|
||||||
|
Local player cameras that can be accessed outside of hud hooks.
|
||||||
|
`#cameras` will return amount of available cameras. (0 on dedicated server, 1 with 1 player, 4 with 4p splitscreen, etc)
|
||||||
|
|
||||||
## mobj.spritexscale, mobj.spriteyscale, mobj.spritexoffset, mobj.spriteyoffset, mobj.rollangle, mobj.sloperoll, mobj.rollmodel fields
|
## mobj.spritexscale, mobj.spriteyscale, mobj.spritexoffset, mobj.spriteyoffset, mobj.rollangle, mobj.sloperoll, mobj.rollmodel fields
|
||||||
|
|
||||||
Same fields as in SRB2 2.2
|
Same fields as in SRB2 2.2
|
||||||
|
|||||||
@@ -22,13 +22,14 @@ We also have a Flatpak available on [Flathub](https://flathub.org/en/apps/org.sr
|
|||||||
|
|
||||||
See [SRB2 Wiki/Source code compiling](http://wiki.srb2.org/wiki/Source_code_compiling). The compiling process for SRB2Kart is largely identical to SRB2.
|
See [SRB2 Wiki/Source code compiling](http://wiki.srb2.org/wiki/Source_code_compiling). The compiling process for SRB2Kart is largely identical to SRB2.
|
||||||
|
|
||||||
Currently only the Makefile build system with GCC or Clang compiler is supported.
|
For Windows only the Makefile build system with GCC or Clang compiler is supported.
|
||||||
|
|
||||||
Visual C++ (MSVC) is unsupported.
|
Visual C++ (MSVC) is unsupported.
|
||||||
|
|
||||||
64-bit Windows builds are supported and recommended over 32-bit builds, they will build automatically when using the MSYS2 MinGW 64-bit executable (requires the mingw-w64-x86_64-gcc package), no extra flags needed!
|
64-bit Windows builds are supported and recommended over 32-bit builds, they will build automatically when using the MSYS2 MinGW 64-bit executable (requires the mingw-w64-x86_64-gcc package), no extra flags needed!
|
||||||
The specific DLLs can be found under /libs/dll-binaries/(i686 for 32bit/x86_64 for 64-bit)/ or in the Release packages
|
The specific DLLs can be found under /libs/dll-binaries/(i686 for 32bit/x86_64 for 64-bit)/ or in the Release packages
|
||||||
|
|
||||||
|
MacOS and Linux can be build with CMake, but it is recommended to use the Makefile for Linux over CMake
|
||||||
|
|
||||||
Alternatively the [srb2bld](https://github.com/Bijman/srb2bld) script by Bijman can be used aswell!
|
Alternatively the [srb2bld](https://github.com/Bijman/srb2bld) script by Bijman can be used aswell!
|
||||||
|
|
||||||
## Disclaimer
|
## Disclaimer
|
||||||
|
|||||||
@@ -1,5 +1,10 @@
|
|||||||
## Assets Target Configuration ##
|
## Assets Target Configuration ##
|
||||||
|
|
||||||
|
if(${CMAKE_SYSTEM} MATCHES Linux)
|
||||||
|
# Asset installation isn't part of the Linux target
|
||||||
|
return()
|
||||||
|
endif()
|
||||||
|
|
||||||
# For prepending the current source path, later
|
# For prepending the current source path, later
|
||||||
FUNCTION(PREPEND var prefix)
|
FUNCTION(PREPEND var prefix)
|
||||||
SET(listVar "")
|
SET(listVar "")
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
include(LibFindMacros)
|
include(LibFindMacros)
|
||||||
|
|
||||||
libfind_pkg_check_modules(GME_PKGCONF GME)
|
libfind_pkg_check_modules(GME_PKGCONF LIBGME)
|
||||||
|
|
||||||
find_path(GME_INCLUDE_DIR
|
find_path(GME_INCLUDE_DIR
|
||||||
NAMES gme.h
|
NAMES gme.h
|
||||||
@@ -8,6 +8,7 @@ find_path(GME_INCLUDE_DIR
|
|||||||
${GME_PKGCONF_INCLUDE_DIRS}
|
${GME_PKGCONF_INCLUDE_DIRS}
|
||||||
"/usr/include/gme"
|
"/usr/include/gme"
|
||||||
"/usr/local/include/gme"
|
"/usr/local/include/gme"
|
||||||
|
PATH_SUFFIXES gme
|
||||||
)
|
)
|
||||||
|
|
||||||
find_library(GME_LIBRARY
|
find_library(GME_LIBRARY
|
||||||
@@ -20,4 +21,4 @@ find_library(GME_LIBRARY
|
|||||||
|
|
||||||
set(GME_PROCESS_INCLUDES GME_INCLUDE_DIR)
|
set(GME_PROCESS_INCLUDES GME_INCLUDE_DIR)
|
||||||
set(GME_PROCESS_LIBS GME_LIBRARY)
|
set(GME_PROCESS_LIBS GME_LIBRARY)
|
||||||
libfind_process(GME)
|
libfind_process(GME)
|
||||||
@@ -1,6 +1,6 @@
|
|||||||
include(LibFindMacros)
|
include(LibFindMacros)
|
||||||
|
|
||||||
libfind_pkg_check_modules(OPENMPT_PKGCONF OPENMPT)
|
libfind_pkg_check_modules(OPENMPT_PKGCONF LIBOPENMPT)
|
||||||
|
|
||||||
find_path(OPENMPT_INCLUDE_DIR
|
find_path(OPENMPT_INCLUDE_DIR
|
||||||
NAMES libopenmpt.h
|
NAMES libopenmpt.h
|
||||||
@@ -8,6 +8,7 @@ find_path(OPENMPT_INCLUDE_DIR
|
|||||||
${OPENMPT_PKGCONF_INCLUDE_DIRS}
|
${OPENMPT_PKGCONF_INCLUDE_DIRS}
|
||||||
"/usr/include/libopenmpt"
|
"/usr/include/libopenmpt"
|
||||||
"/usr/local/include/libopenmpt"
|
"/usr/local/include/libopenmpt"
|
||||||
|
PATH_SUFFIXES libopenmpt
|
||||||
)
|
)
|
||||||
|
|
||||||
find_library(OPENMPT_LIBRARY
|
find_library(OPENMPT_LIBRARY
|
||||||
@@ -20,4 +21,4 @@ find_library(OPENMPT_LIBRARY
|
|||||||
|
|
||||||
set(OPENMPT_PROCESS_INCLUDES OPENMPT_INCLUDE_DIR)
|
set(OPENMPT_PROCESS_INCLUDES OPENMPT_INCLUDE_DIR)
|
||||||
set(OPENMPT_PROCESS_LIBS OPENMPT_LIBRARY)
|
set(OPENMPT_PROCESS_LIBS OPENMPT_LIBRARY)
|
||||||
libfind_process(OPENMPT)
|
libfind_process(OPENMPT)
|
||||||
@@ -0,0 +1,33 @@
|
|||||||
|
include(LibFindMacros)
|
||||||
|
|
||||||
|
libfind_pkg_check_modules(LIBBACKTRACE_PKGCONF LIBBACKTRACE)
|
||||||
|
|
||||||
|
find_path(LIBBACKTRACE_INCLUDE_DIR
|
||||||
|
NAMES backtrace.h
|
||||||
|
PATHS
|
||||||
|
${LIBBACKTRACE_PKGCONF_INCLUDE_DIRS}
|
||||||
|
"/usr/include"
|
||||||
|
"/usr/local/include"
|
||||||
|
)
|
||||||
|
|
||||||
|
find_library(LIBBACKTRACE_LIBRARY
|
||||||
|
NAMES backtrace
|
||||||
|
PATHS
|
||||||
|
${LIBBACKTRACE_PKGCONF_LIBRARY_DIRS}
|
||||||
|
"/usr/lib"
|
||||||
|
"/usr/local/lib"
|
||||||
|
)
|
||||||
|
|
||||||
|
set(LIBBACKTRACE_PROCESS_INCLUDES LIBBACKTRACE_INCLUDE_DIR)
|
||||||
|
set(LIBBACKTRACE_PROCESS_LIBS LIBBACKTRACE_LIBRARY)
|
||||||
|
libfind_process(LIBBACKTRACE)
|
||||||
|
|
||||||
|
if(LIBBACKTRACE_FOUND AND NOT TARGET libbacktrace)
|
||||||
|
add_library(libbacktrace UNKNOWN IMPORTED)
|
||||||
|
set_target_properties(
|
||||||
|
libbacktrace
|
||||||
|
PROPERTIES
|
||||||
|
IMPORTED_LOCATION "${LIBBACKTRACE_LIBRARY}"
|
||||||
|
INTERFACE_INCLUDE_DIRECTORIES "${LIBBACKTRACE_INCLUDE_DIR}"
|
||||||
|
)
|
||||||
|
endif()
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
# Version 2.2
|
# Version 2.4
|
||||||
# Public Domain, originally written by Lasse Kärkkäinen <tronic>
|
# Public Domain, originally written by Lasse Kärkkäinen <tronic>
|
||||||
# Maintained at https://github.com/Tronic/cmake-modules
|
# Maintained at https://github.com/Tronic/cmake-modules
|
||||||
# Please send your improvements as pull requests on Github.
|
# Please send your improvements as pull requests on Github.
|
||||||
@@ -52,6 +52,10 @@ function (libfind_pkg_detect PREFIX)
|
|||||||
if (libraryargs)
|
if (libraryargs)
|
||||||
find_library(${PREFIX}_LIBRARY NAMES ${libraryargs} HINTS ${${PREFIX}_PKGCONF_LIBRARY_DIRS})
|
find_library(${PREFIX}_LIBRARY NAMES ${libraryargs} HINTS ${${PREFIX}_PKGCONF_LIBRARY_DIRS})
|
||||||
endif()
|
endif()
|
||||||
|
# Read pkg-config version
|
||||||
|
if (${PREFIX}_PKGCONF_VERSION)
|
||||||
|
set(${PREFIX}_VERSION ${${PREFIX}_PKGCONF_VERSION} PARENT_SCOPE)
|
||||||
|
endif()
|
||||||
endfunction()
|
endfunction()
|
||||||
|
|
||||||
# Extracts a version #define from a version.h file, output stored to <PREFIX>_VERSION.
|
# Extracts a version #define from a version.h file, output stored to <PREFIX>_VERSION.
|
||||||
@@ -125,24 +129,39 @@ function (libfind_process PREFIX)
|
|||||||
|
|
||||||
# Process deps to add to
|
# Process deps to add to
|
||||||
foreach (i ${PREFIX} ${${PREFIX}_DEPENDENCIES})
|
foreach (i ${PREFIX} ${${PREFIX}_DEPENDENCIES})
|
||||||
if (DEFINED ${i}_INCLUDE_OPTS OR DEFINED ${i}_LIBRARY_OPTS)
|
if (DEFINED ${i}_INCLUDE_OPTS)
|
||||||
# The package seems to export option lists that we can use, woohoo!
|
# The package seems to export option lists that we can use, woohoo!
|
||||||
list(APPEND includeopts ${${i}_INCLUDE_OPTS})
|
list(APPEND includeopts ${${i}_INCLUDE_OPTS})
|
||||||
|
else()
|
||||||
|
if (DEFINED ${i}_INCLUDE_DIR)
|
||||||
|
# Singular forms can be used
|
||||||
|
list(APPEND includeopts ${i}_INCLUDE_DIR)
|
||||||
|
else()
|
||||||
|
if (DEFINED ${i}_INCLUDE_DIRS)
|
||||||
|
# Plural forms can be used
|
||||||
|
list(APPEND includeopts ${i}_INCLUDE_DIRS)
|
||||||
|
else()
|
||||||
|
# Oh no, we don't know the option names
|
||||||
|
message(FATAL_ERROR "We couldn't determine config variable names for ${i} includes. Aieeh!")
|
||||||
|
endif()
|
||||||
|
endif()
|
||||||
|
endif()
|
||||||
|
|
||||||
|
if (DEFINED ${i}_LIBRARY_OPTS)
|
||||||
|
# The package seems to export option lists that we can use, woohoo!
|
||||||
list(APPEND libraryopts ${${i}_LIBRARY_OPTS})
|
list(APPEND libraryopts ${${i}_LIBRARY_OPTS})
|
||||||
else()
|
else()
|
||||||
# If plural forms don't exist or they equal singular forms
|
if (DEFINED ${i}_LIBRARY)
|
||||||
if ((NOT DEFINED ${i}_INCLUDE_DIRS AND NOT DEFINED ${i}_LIBRARIES) OR
|
|
||||||
({i}_INCLUDE_DIR STREQUAL ${i}_INCLUDE_DIRS AND ${i}_LIBRARY STREQUAL ${i}_LIBRARIES))
|
|
||||||
# Singular forms can be used
|
# Singular forms can be used
|
||||||
if (DEFINED ${i}_INCLUDE_DIR)
|
list(APPEND libraryopts ${i}_LIBRARY)
|
||||||
list(APPEND includeopts ${i}_INCLUDE_DIR)
|
|
||||||
endif()
|
|
||||||
if (DEFINED ${i}_LIBRARY)
|
|
||||||
list(APPEND libraryopts ${i}_LIBRARY)
|
|
||||||
endif()
|
|
||||||
else()
|
else()
|
||||||
# Oh no, we don't know the option names
|
if (DEFINED ${i}_LIBRARIES)
|
||||||
message(FATAL_ERROR "We couldn't determine config variable names for ${i} includes and libs. Aieeh!")
|
# Plural forms can be used
|
||||||
|
list(APPEND libraryopts ${i}_LIBRARIES)
|
||||||
|
else()
|
||||||
|
# Oh no, we don't know the option names
|
||||||
|
message(FATAL_ERROR "We couldn't determine config variable names for ${i} libraries. Aieeh!")
|
||||||
|
endif()
|
||||||
endif()
|
endif()
|
||||||
endif()
|
endif()
|
||||||
endforeach()
|
endforeach()
|
||||||
@@ -209,12 +228,12 @@ function (libfind_process PREFIX)
|
|||||||
message(STATUS " ${PREFIX}_LIBRARY_OPTS=${libraryopts}")
|
message(STATUS " ${PREFIX}_LIBRARY_OPTS=${libraryopts}")
|
||||||
message(STATUS " ${PREFIX}_LIBRARIES=${libs}")
|
message(STATUS " ${PREFIX}_LIBRARIES=${libs}")
|
||||||
endif()
|
endif()
|
||||||
set (${PREFIX}_INCLUDE_OPTS ${includeopts} PARENT_SCOPE)
|
|
||||||
set (${PREFIX}_LIBRARY_OPTS ${libraryopts} PARENT_SCOPE)
|
|
||||||
set (${PREFIX}_INCLUDE_DIRS ${includes} PARENT_SCOPE)
|
|
||||||
set (${PREFIX}_LIBRARIES ${libs} PARENT_SCOPE)
|
|
||||||
set (${PREFIX}_FOUND TRUE PARENT_SCOPE)
|
|
||||||
endif()
|
endif()
|
||||||
|
set (${PREFIX}_INCLUDE_OPTS ${includeopts} PARENT_SCOPE)
|
||||||
|
set (${PREFIX}_LIBRARY_OPTS ${libraryopts} PARENT_SCOPE)
|
||||||
|
set (${PREFIX}_INCLUDE_DIRS ${includes} PARENT_SCOPE)
|
||||||
|
set (${PREFIX}_LIBRARIES ${libs} PARENT_SCOPE)
|
||||||
|
set (${PREFIX}_FOUND TRUE PARENT_SCOPE)
|
||||||
return()
|
return()
|
||||||
endif()
|
endif()
|
||||||
|
|
||||||
|
|||||||
@@ -1,18 +0,0 @@
|
|||||||
Copyright (C) 1997-2025 Sam Lantinga <slouken@libsdl.org>
|
|
||||||
|
|
||||||
This software is provided 'as-is', without any express or implied
|
|
||||||
warranty. In no event will the authors be held liable for any damages
|
|
||||||
arising from the use of this software.
|
|
||||||
|
|
||||||
Permission is granted to anyone to use this software for any purpose,
|
|
||||||
including commercial applications, and to alter it and redistribute it
|
|
||||||
freely, subject to the following restrictions:
|
|
||||||
|
|
||||||
1. The origin of this software must not be misrepresented; you must not
|
|
||||||
claim that you wrote the original software. If you use this software
|
|
||||||
in a product, an acknowledgment in the product documentation would be
|
|
||||||
appreciated but is not required.
|
|
||||||
2. Altered source versions must be plainly marked as such, and must not be
|
|
||||||
misrepresented as being the original software.
|
|
||||||
3. This notice may not be removed or altered from any source distribution.
|
|
||||||
|
|
||||||
@@ -1,28 +1,9 @@
|
|||||||
|
|
||||||
This is a list of major changes in SDL's version history.
|
This is a list of major changes in SDL's version history.
|
||||||
|
|
||||||
---------------------------------------------------------------------------
|
|
||||||
2.30.0:
|
|
||||||
---------------------------------------------------------------------------
|
|
||||||
|
|
||||||
General:
|
|
||||||
* Added support for 2 bits-per-pixel indexed surface formats
|
|
||||||
* Added the function SDL_GameControllerGetSteamHandle() to get the Steam API handle for a controller, if available
|
|
||||||
* Added the event SDL_CONTROLLERSTEAMHANDLEUPDATED which is sent when the Steam API handle for a controller changes. This could also change the name, VID, and PID of the controller.
|
|
||||||
* Added the environment variable SDL_LOGGING to control default log output
|
|
||||||
|
|
||||||
macOS:
|
|
||||||
* Added the hint SDL_HINT_JOYSTICK_IOKIT to control whether the IOKit controller driver should be used
|
|
||||||
* Added the hint SDL_HINT_JOYSTICK_MFI to control whether the GCController controller driver should be used
|
|
||||||
* Added the hint SDL_HINT_RENDER_METAL_PREFER_LOW_POWER_DEVICE to choose whether high or low power GPU should be used for rendering, in the case where there are multiple GPUs available
|
|
||||||
|
|
||||||
Xbox:
|
|
||||||
* Added the function SDL_GDKGetDefaultUser()
|
|
||||||
|
|
||||||
---------------------------------------------------------------------------
|
---------------------------------------------------------------------------
|
||||||
2.28.2:
|
2.28.2:
|
||||||
---------------------------------------------------------------------------
|
---------------------------------------------------------------------------
|
||||||
|
|
||||||
General:
|
General:
|
||||||
* Added the hint SDL_HINT_JOYSTICK_WGI to control whether to use Windows.Gaming.Input for controllers
|
* Added the hint SDL_HINT_JOYSTICK_WGI to control whether to use Windows.Gaming.Input for controllers
|
||||||
|
|
||||||
|
|||||||
@@ -1,97 +1,97 @@
|
|||||||
# Contributing to SDL
|
# Contributing to SDL
|
||||||
|
|
||||||
We appreciate your interest in contributing to SDL, this document will describe how to report bugs, contribute code or ideas or edit documentation.
|
We appreciate your interest in contributing to SDL, this document will describe how to report bugs, contribute code or ideas or edit documentation.
|
||||||
|
|
||||||
**Table Of Contents**
|
**Table Of Contents**
|
||||||
|
|
||||||
- [Filing a GitHub issue](#filing-a-github-issue)
|
- [Filing a GitHub issue](#filing-a-github-issue)
|
||||||
- [Reporting a bug](#reporting-a-bug)
|
- [Reporting a bug](#reporting-a-bug)
|
||||||
- [Suggesting enhancements](#suggesting-enhancements)
|
- [Suggesting enhancements](#suggesting-enhancements)
|
||||||
- [Contributing code](#contributing-code)
|
- [Contributing code](#contributing-code)
|
||||||
- [Forking the project](#forking-the-project)
|
- [Forking the project](#forking-the-project)
|
||||||
- [Following the style guide](#following-the-style-guide)
|
- [Following the style guide](#following-the-style-guide)
|
||||||
- [Running the tests](#running-the-tests)
|
- [Running the tests](#running-the-tests)
|
||||||
- [Opening a pull request](#opening-a-pull-request)
|
- [Opening a pull request](#opening-a-pull-request)
|
||||||
- [Contributing to the documentation](#contributing-to-the-documentation)
|
- [Contributing to the documentation](#contributing-to-the-documentation)
|
||||||
- [Editing a function documentation](#editing-a-function-documentation)
|
- [Editing a function documentation](#editing-a-function-documentation)
|
||||||
- [Editing the wiki](#editing-the-wiki)
|
- [Editing the wiki](#editing-the-wiki)
|
||||||
|
|
||||||
## Filing a GitHub issue
|
## Filing a GitHub issue
|
||||||
|
|
||||||
### Reporting a bug
|
### Reporting a bug
|
||||||
|
|
||||||
If you think you have found a bug and would like to report it, here are the steps you should take:
|
If you think you have found a bug and would like to report it, here are the steps you should take:
|
||||||
|
|
||||||
- Before opening a new issue, ensure your bug has not already been reported on the [GitHub Issues page](https://github.com/libsdl-org/SDL/issues).
|
- Before opening a new issue, ensure your bug has not already been reported on the [GitHub Issues page](https://github.com/libsdl-org/SDL/issues).
|
||||||
- On the issue tracker, click on [New Issue](https://github.com/libsdl-org/SDL/issues/new).
|
- On the issue tracker, click on [New Issue](https://github.com/libsdl-org/SDL/issues/new).
|
||||||
- Include details about your environment, such as your Operating System and SDL version.
|
- Include details about your environment, such as your Operating System and SDL version.
|
||||||
- If possible, provide a small example that reproduces your bug.
|
- If possible, provide a small example that reproduces your bug.
|
||||||
|
|
||||||
### Suggesting enhancements
|
### Suggesting enhancements
|
||||||
|
|
||||||
If you want to suggest changes for the project, here are the steps you should take:
|
If you want to suggest changes for the project, here are the steps you should take:
|
||||||
|
|
||||||
- Check if the suggestion has already been made on:
|
- Check if the suggestion has already been made on:
|
||||||
- the [issue tracker](https://github.com/libsdl-org/SDL/issues);
|
- the [issue tracker](https://github.com/libsdl-org/SDL/issues);
|
||||||
- the [discourse forum](https://discourse.libsdl.org/);
|
- the [discourse forum](https://discourse.libsdl.org/);
|
||||||
- or if a [pull request](https://github.com/libsdl-org/SDL/pulls) already exists.
|
- or if a [pull request](https://github.com/libsdl-org/SDL/pulls) already exists.
|
||||||
- On the issue tracker, click on [New Issue](https://github.com/libsdl-org/SDL/issues/new).
|
- On the issue tracker, click on [New Issue](https://github.com/libsdl-org/SDL/issues/new).
|
||||||
- Describe what change you would like to happen.
|
- Describe what change you would like to happen.
|
||||||
|
|
||||||
## Contributing code
|
## Contributing code
|
||||||
|
|
||||||
This section will cover how the process of forking the project, making a change and opening a pull request.
|
This section will cover how the process of forking the project, making a change and opening a pull request.
|
||||||
|
|
||||||
### Forking the project
|
### Forking the project
|
||||||
|
|
||||||
The first step consists in making a fork of the project, this is only necessary for the first contribution.
|
The first step consists in making a fork of the project, this is only necessary for the first contribution.
|
||||||
|
|
||||||
Head over to https://github.com/libsdl-org/SDL and click on the `Fork` button in the top right corner of your screen, you may leave the fields unchanged and click `Create Fork`.
|
Head over to https://github.com/libsdl-org/SDL and click on the `Fork` button in the top right corner of your screen, you may leave the fields unchanged and click `Create Fork`.
|
||||||
|
|
||||||
You will be redirected to your fork of the repository, click the green `Code` button and copy the git clone link.
|
You will be redirected to your fork of the repository, click the green `Code` button and copy the git clone link.
|
||||||
|
|
||||||
If you had already forked the repository, you may update it from the web page using the `Fetch upstream` button.
|
If you had already forked the repository, you may update it from the web page using the `Fetch upstream` button.
|
||||||
|
|
||||||
### Following the style guide
|
### Following the style guide
|
||||||
|
|
||||||
Code formatting is done using a custom `.clang-format` file, you can learn more about how to run it [here](https://clang.llvm.org/docs/ClangFormat.html).
|
Code formatting is done using a custom `.clang-format` file, you can learn more about how to run it [here](https://clang.llvm.org/docs/ClangFormat.html).
|
||||||
|
|
||||||
Some legacy code may not be formatted, as such avoid formatting the whole file at once and only format around your changes.
|
Some legacy code may not be formatted, as such avoid formatting the whole file at once and only format around your changes.
|
||||||
|
|
||||||
For your commit message to be properly displayed on GitHub, it should contain:
|
For your commit message to be properly displayed on GitHub, it should contain:
|
||||||
|
|
||||||
- A short description of the commit of 50 characters or less on the first line.
|
- A short description of the commit of 50 characters or less on the first line.
|
||||||
- If necessary, add a blank line followed by a long description, each line should be 72 characters or less.
|
- If necessary, add a blank line followed by a long description, each line should be 72 characters or less.
|
||||||
|
|
||||||
For example:
|
For example:
|
||||||
|
|
||||||
```
|
```
|
||||||
Fix crash in SDL_FooBar.
|
Fix crash in SDL_FooBar.
|
||||||
|
|
||||||
This addresses the issue #123456 by making sure Foo was successful
|
This addresses the issue #123456 by making sure Foo was successful
|
||||||
before calling Bar.
|
before calling Bar.
|
||||||
```
|
```
|
||||||
|
|
||||||
### Running the tests
|
### Running the tests
|
||||||
|
|
||||||
Tests allow you to verify if your changes did not break any behaviour, here are the steps to follow:
|
Tests allow you to verify if your changes did not break any behaviour, here are the steps to follow:
|
||||||
|
|
||||||
- Before pushing, run the `testautomation` suite on your machine, there should be no more failing tests after your change than before.
|
- Before pushing, run the `testautomation` suite on your machine, there should be no more failing tests after your change than before.
|
||||||
- After pushing to your fork, Continuous Integration (GitHub Actions) will ensure compilation and tests still pass on other systems.
|
- After pushing to your fork, Continuous Integration (GitHub Actions) will ensure compilation and tests still pass on other systems.
|
||||||
|
|
||||||
### Opening a pull request
|
### Opening a pull request
|
||||||
|
|
||||||
- Head over to your fork's GitHub page.
|
- Head over to your fork's GitHub page.
|
||||||
- Click on the `Contribute` button and `Open Pull Request`.
|
- Click on the `Contribute` button and `Open Pull Request`.
|
||||||
- Fill out the pull request template.
|
- Fill out the pull request template.
|
||||||
- If any changes are requested, you can add new commits to your fork and they will be automatically added to the pull request.
|
- If any changes are requested, you can add new commits to your fork and they will be automatically added to the pull request.
|
||||||
|
|
||||||
## Contributing to the documentation
|
## Contributing to the documentation
|
||||||
|
|
||||||
### Editing a function documentation
|
### Editing a function documentation
|
||||||
|
|
||||||
The wiki documentation for API functions is synchronised from the headers' doxygen comments. As such, all modifications to syntax; function parameters; return value; version; related functions should be done in the header directly.
|
The wiki documentation for API functions is synchronised from the headers' doxygen comments. As such, all modifications to syntax; function parameters; return value; version; related functions should be done in the header directly.
|
||||||
|
|
||||||
### Editing the wiki
|
### Editing the wiki
|
||||||
|
|
||||||
Other changes to the wiki should done directly from https://wiki.libsdl.org/
|
Other changes to the wiki should done directly from https://wiki.libsdl.org/
|
||||||
+483
-483
@@ -1,483 +1,483 @@
|
|||||||
Android
|
Android
|
||||||
================================================================================
|
================================================================================
|
||||||
|
|
||||||
Matt Styles wrote a tutorial on building SDL for Android with Visual Studio:
|
Matt Styles wrote a tutorial on building SDL for Android with Visual Studio:
|
||||||
http://trederia.blogspot.de/2017/03/building-sdl2-for-android-with-visual.html
|
http://trederia.blogspot.de/2017/03/building-sdl2-for-android-with-visual.html
|
||||||
|
|
||||||
The rest of this README covers the Android gradle style build process.
|
The rest of this README covers the Android gradle style build process.
|
||||||
|
|
||||||
If you are using the older ant build process, it is no longer officially
|
If you are using the older ant build process, it is no longer officially
|
||||||
supported, but you can use the "android-project-ant" directory as a template.
|
supported, but you can use the "android-project-ant" directory as a template.
|
||||||
|
|
||||||
|
|
||||||
Requirements
|
Requirements
|
||||||
================================================================================
|
================================================================================
|
||||||
|
|
||||||
Android SDK (version 34 or later)
|
Android SDK (version 34 or later)
|
||||||
https://developer.android.com/sdk/index.html
|
https://developer.android.com/sdk/index.html
|
||||||
|
|
||||||
Android NDK r15c or later
|
Android NDK r15c or later
|
||||||
https://developer.android.com/tools/sdk/ndk/index.html
|
https://developer.android.com/tools/sdk/ndk/index.html
|
||||||
|
|
||||||
Minimum API level supported by SDL: 19 (Android 4.4)
|
Minimum API level supported by SDL: 19 (Android 4.4)
|
||||||
|
|
||||||
|
|
||||||
How the port works
|
How the port works
|
||||||
================================================================================
|
================================================================================
|
||||||
|
|
||||||
- Android applications are Java-based, optionally with parts written in C
|
- Android applications are Java-based, optionally with parts written in C
|
||||||
- As SDL apps are C-based, we use a small Java shim that uses JNI to talk to
|
- As SDL apps are C-based, we use a small Java shim that uses JNI to talk to
|
||||||
the SDL library
|
the SDL library
|
||||||
- This means that your application C code must be placed inside an Android
|
- This means that your application C code must be placed inside an Android
|
||||||
Java project, along with some C support code that communicates with Java
|
Java project, along with some C support code that communicates with Java
|
||||||
- This eventually produces a standard Android .apk package
|
- This eventually produces a standard Android .apk package
|
||||||
|
|
||||||
The Android Java code implements an "Activity" and can be found in:
|
The Android Java code implements an "Activity" and can be found in:
|
||||||
android-project/app/src/main/java/org/libsdl/app/SDLActivity.java
|
android-project/app/src/main/java/org/libsdl/app/SDLActivity.java
|
||||||
|
|
||||||
The Java code loads your game code, the SDL shared library, and
|
The Java code loads your game code, the SDL shared library, and
|
||||||
dispatches to native functions implemented in the SDL library:
|
dispatches to native functions implemented in the SDL library:
|
||||||
src/core/android/SDL_android.c
|
src/core/android/SDL_android.c
|
||||||
|
|
||||||
|
|
||||||
Building an app
|
Building an app
|
||||||
================================================================================
|
================================================================================
|
||||||
|
|
||||||
For simple projects you can use the script located at build-scripts/androidbuild.sh
|
For simple projects you can use the script located at build-scripts/androidbuild.sh
|
||||||
|
|
||||||
There's two ways of using it:
|
There's two ways of using it:
|
||||||
|
|
||||||
androidbuild.sh com.yourcompany.yourapp < sources.list
|
androidbuild.sh com.yourcompany.yourapp < sources.list
|
||||||
androidbuild.sh com.yourcompany.yourapp source1.c source2.c ...sourceN.c
|
androidbuild.sh com.yourcompany.yourapp source1.c source2.c ...sourceN.c
|
||||||
|
|
||||||
sources.list should be a text file with a source file name in each line
|
sources.list should be a text file with a source file name in each line
|
||||||
Filenames should be specified relative to the current directory, for example if
|
Filenames should be specified relative to the current directory, for example if
|
||||||
you are in the build-scripts directory and want to create the testgles.c test, you'll
|
you are in the build-scripts directory and want to create the testgles.c test, you'll
|
||||||
run:
|
run:
|
||||||
|
|
||||||
./androidbuild.sh org.libsdl.testgles ../test/testgles.c
|
./androidbuild.sh org.libsdl.testgles ../test/testgles.c
|
||||||
|
|
||||||
One limitation of this script is that all sources provided will be aggregated into
|
One limitation of this script is that all sources provided will be aggregated into
|
||||||
a single directory, thus all your source files should have a unique name.
|
a single directory, thus all your source files should have a unique name.
|
||||||
|
|
||||||
Once the project is complete the script will tell you where the debug APK is located.
|
Once the project is complete the script will tell you where the debug APK is located.
|
||||||
If you want to create a signed release APK, you can use the project created by this
|
If you want to create a signed release APK, you can use the project created by this
|
||||||
utility to generate it.
|
utility to generate it.
|
||||||
|
|
||||||
Finally, a word of caution: re running androidbuild.sh wipes any changes you may have
|
Finally, a word of caution: re running androidbuild.sh wipes any changes you may have
|
||||||
done in the build directory for the app!
|
done in the build directory for the app!
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
For more complex projects, follow these instructions:
|
For more complex projects, follow these instructions:
|
||||||
|
|
||||||
1. Get the source code for SDL and copy the 'android-project' directory located at SDL/android-project to a suitable location. Also make sure to rename it to your project name (In these examples: YOURPROJECT).
|
1. Get the source code for SDL and copy the 'android-project' directory located at SDL/android-project to a suitable location. Also make sure to rename it to your project name (In these examples: YOURPROJECT).
|
||||||
|
|
||||||
(The 'android-project' directory can basically be seen as a sort of starting point for the android-port of your project. It contains the glue code between the Android Java 'frontend' and the SDL code 'backend'. It also contains some standard behaviour, like how events should be handled, which you will be able to change.)
|
(The 'android-project' directory can basically be seen as a sort of starting point for the android-port of your project. It contains the glue code between the Android Java 'frontend' and the SDL code 'backend'. It also contains some standard behaviour, like how events should be handled, which you will be able to change.)
|
||||||
|
|
||||||
2. Move or [symlink](https://en.wikipedia.org/wiki/Symbolic_link) the SDL directory into the "YOURPROJECT/app/jni" directory
|
2. Move or [symlink](https://en.wikipedia.org/wiki/Symbolic_link) the SDL directory into the "YOURPROJECT/app/jni" directory
|
||||||
|
|
||||||
(This is needed as the source of SDL has to be compiled by the Android compiler)
|
(This is needed as the source of SDL has to be compiled by the Android compiler)
|
||||||
|
|
||||||
3. Edit "YOURPROJECT/app/jni/src/Android.mk" to include your source files.
|
3. Edit "YOURPROJECT/app/jni/src/Android.mk" to include your source files.
|
||||||
|
|
||||||
(They should be separated by spaces after the "LOCAL_SRC_FILES := " declaration)
|
(They should be separated by spaces after the "LOCAL_SRC_FILES := " declaration)
|
||||||
|
|
||||||
4a. If you want to use Android Studio, simply open your 'YOURPROJECT' directory and start building.
|
4a. If you want to use Android Studio, simply open your 'YOURPROJECT' directory and start building.
|
||||||
|
|
||||||
4b. If you want to build manually, run './gradlew installDebug' in the project directory. This compiles the .java, creates an .apk with the native code embedded, and installs it on any connected Android device
|
4b. If you want to build manually, run './gradlew installDebug' in the project directory. This compiles the .java, creates an .apk with the native code embedded, and installs it on any connected Android device
|
||||||
|
|
||||||
|
|
||||||
If you already have a project that uses CMake, the instructions change somewhat:
|
If you already have a project that uses CMake, the instructions change somewhat:
|
||||||
|
|
||||||
1. Do points 1 and 2 from the instruction above.
|
1. Do points 1 and 2 from the instruction above.
|
||||||
2. Edit "YOURPROJECT/app/build.gradle" to comment out or remove sections containing ndk-build
|
2. Edit "YOURPROJECT/app/build.gradle" to comment out or remove sections containing ndk-build
|
||||||
and uncomment the cmake sections. Add arguments to the CMake invocation as needed.
|
and uncomment the cmake sections. Add arguments to the CMake invocation as needed.
|
||||||
3. Edit "YOURPROJECT/app/jni/CMakeLists.txt" to include your project (it defaults to
|
3. Edit "YOURPROJECT/app/jni/CMakeLists.txt" to include your project (it defaults to
|
||||||
adding the "src" subdirectory). Note that you'll have SDL2, SDL2main and SDL2-static
|
adding the "src" subdirectory). Note that you'll have SDL2, SDL2main and SDL2-static
|
||||||
as targets in your project, so you should have "target_link_libraries(yourgame SDL2 SDL2main)"
|
as targets in your project, so you should have "target_link_libraries(yourgame SDL2 SDL2main)"
|
||||||
in your CMakeLists.txt file. Also be aware that you should use add_library() instead of
|
in your CMakeLists.txt file. Also be aware that you should use add_library() instead of
|
||||||
add_executable() for the target containing your "main" function.
|
add_executable() for the target containing your "main" function.
|
||||||
|
|
||||||
If you wish to use Android Studio, you can skip the last step.
|
If you wish to use Android Studio, you can skip the last step.
|
||||||
|
|
||||||
4. Run './gradlew installDebug' or './gradlew installRelease' in the project directory. It will build and install your .apk on any
|
4. Run './gradlew installDebug' or './gradlew installRelease' in the project directory. It will build and install your .apk on any
|
||||||
connected Android device
|
connected Android device
|
||||||
|
|
||||||
Here's an explanation of the files in the Android project, so you can customize them:
|
Here's an explanation of the files in the Android project, so you can customize them:
|
||||||
|
|
||||||
android-project/app
|
android-project/app
|
||||||
build.gradle - build info including the application version and SDK
|
build.gradle - build info including the application version and SDK
|
||||||
src/main/AndroidManifest.xml - package manifest. Among others, it contains the class name of the main Activity and the package name of the application.
|
src/main/AndroidManifest.xml - package manifest. Among others, it contains the class name of the main Activity and the package name of the application.
|
||||||
jni/ - directory holding native code
|
jni/ - directory holding native code
|
||||||
jni/Application.mk - Application JNI settings, including target platform and STL library
|
jni/Application.mk - Application JNI settings, including target platform and STL library
|
||||||
jni/Android.mk - Android makefile that can call recursively the Android.mk files in all subdirectories
|
jni/Android.mk - Android makefile that can call recursively the Android.mk files in all subdirectories
|
||||||
jni/CMakeLists.txt - Top-level CMake project that adds SDL as a subproject
|
jni/CMakeLists.txt - Top-level CMake project that adds SDL as a subproject
|
||||||
jni/SDL/ - (symlink to) directory holding the SDL library files
|
jni/SDL/ - (symlink to) directory holding the SDL library files
|
||||||
jni/SDL/Android.mk - Android makefile for creating the SDL shared library
|
jni/SDL/Android.mk - Android makefile for creating the SDL shared library
|
||||||
jni/src/ - directory holding your C/C++ source
|
jni/src/ - directory holding your C/C++ source
|
||||||
jni/src/Android.mk - Android makefile that you should customize to include your source code and any library references
|
jni/src/Android.mk - Android makefile that you should customize to include your source code and any library references
|
||||||
jni/src/CMakeLists.txt - CMake file that you may customize to include your source code and any library references
|
jni/src/CMakeLists.txt - CMake file that you may customize to include your source code and any library references
|
||||||
src/main/assets/ - directory holding asset files for your application
|
src/main/assets/ - directory holding asset files for your application
|
||||||
src/main/res/ - directory holding resources for your application
|
src/main/res/ - directory holding resources for your application
|
||||||
src/main/res/mipmap-* - directories holding icons for different phone hardware
|
src/main/res/mipmap-* - directories holding icons for different phone hardware
|
||||||
src/main/res/values/strings.xml - strings used in your application, including the application name
|
src/main/res/values/strings.xml - strings used in your application, including the application name
|
||||||
src/main/java/org/libsdl/app/SDLActivity.java - the Java class handling the initialization and binding to SDL. Be very careful changing this, as the SDL library relies on this implementation. You should instead subclass this for your application.
|
src/main/java/org/libsdl/app/SDLActivity.java - the Java class handling the initialization and binding to SDL. Be very careful changing this, as the SDL library relies on this implementation. You should instead subclass this for your application.
|
||||||
|
|
||||||
|
|
||||||
Customizing your application name
|
Customizing your application name
|
||||||
================================================================================
|
================================================================================
|
||||||
|
|
||||||
To customize your application name, edit AndroidManifest.xml and replace
|
To customize your application name, edit AndroidManifest.xml and replace
|
||||||
"org.libsdl.app" with an identifier for your product package.
|
"org.libsdl.app" with an identifier for your product package.
|
||||||
|
|
||||||
Then create a Java class extending SDLActivity and place it in a directory
|
Then create a Java class extending SDLActivity and place it in a directory
|
||||||
under src matching your package, e.g.
|
under src matching your package, e.g.
|
||||||
|
|
||||||
src/com/gamemaker/game/MyGame.java
|
src/com/gamemaker/game/MyGame.java
|
||||||
|
|
||||||
Here's an example of a minimal class file:
|
Here's an example of a minimal class file:
|
||||||
|
|
||||||
--- MyGame.java --------------------------
|
--- MyGame.java --------------------------
|
||||||
package com.gamemaker.game;
|
package com.gamemaker.game;
|
||||||
|
|
||||||
import org.libsdl.app.SDLActivity;
|
import org.libsdl.app.SDLActivity;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* A sample wrapper class that just calls SDLActivity
|
* A sample wrapper class that just calls SDLActivity
|
||||||
*/
|
*/
|
||||||
|
|
||||||
public class MyGame extends SDLActivity { }
|
public class MyGame extends SDLActivity { }
|
||||||
|
|
||||||
------------------------------------------
|
------------------------------------------
|
||||||
|
|
||||||
Then replace "SDLActivity" in AndroidManifest.xml with the name of your
|
Then replace "SDLActivity" in AndroidManifest.xml with the name of your
|
||||||
class, .e.g. "MyGame"
|
class, .e.g. "MyGame"
|
||||||
|
|
||||||
|
|
||||||
Customizing your application icon
|
Customizing your application icon
|
||||||
================================================================================
|
================================================================================
|
||||||
|
|
||||||
Conceptually changing your icon is just replacing the "ic_launcher.png" files in
|
Conceptually changing your icon is just replacing the "ic_launcher.png" files in
|
||||||
the drawable directories under the res directory. There are several directories
|
the drawable directories under the res directory. There are several directories
|
||||||
for different screen sizes.
|
for different screen sizes.
|
||||||
|
|
||||||
|
|
||||||
Loading assets
|
Loading assets
|
||||||
================================================================================
|
================================================================================
|
||||||
|
|
||||||
Any files you put in the "app/src/main/assets" directory of your project
|
Any files you put in the "app/src/main/assets" directory of your project
|
||||||
directory will get bundled into the application package and you can load
|
directory will get bundled into the application package and you can load
|
||||||
them using the standard functions in SDL_rwops.h.
|
them using the standard functions in SDL_rwops.h.
|
||||||
|
|
||||||
There are also a few Android specific functions that allow you to get other
|
There are also a few Android specific functions that allow you to get other
|
||||||
useful paths for saving and loading data:
|
useful paths for saving and loading data:
|
||||||
* SDL_AndroidGetInternalStoragePath()
|
* SDL_AndroidGetInternalStoragePath()
|
||||||
* SDL_AndroidGetExternalStorageState()
|
* SDL_AndroidGetExternalStorageState()
|
||||||
* SDL_AndroidGetExternalStoragePath()
|
* SDL_AndroidGetExternalStoragePath()
|
||||||
|
|
||||||
See SDL_system.h for more details on these functions.
|
See SDL_system.h for more details on these functions.
|
||||||
|
|
||||||
The asset packaging system will, by default, compress certain file extensions.
|
The asset packaging system will, by default, compress certain file extensions.
|
||||||
SDL includes two asset file access mechanisms, the preferred one is the so
|
SDL includes two asset file access mechanisms, the preferred one is the so
|
||||||
called "File Descriptor" method, which is faster and doesn't involve the Dalvik
|
called "File Descriptor" method, which is faster and doesn't involve the Dalvik
|
||||||
GC, but given this method does not work on compressed assets, there is also the
|
GC, but given this method does not work on compressed assets, there is also the
|
||||||
"Input Stream" method, which is automatically used as a fall back by SDL. You
|
"Input Stream" method, which is automatically used as a fall back by SDL. You
|
||||||
may want to keep this fact in mind when building your APK, specially when large
|
may want to keep this fact in mind when building your APK, specially when large
|
||||||
files are involved.
|
files are involved.
|
||||||
For more information on which extensions get compressed by default and how to
|
For more information on which extensions get compressed by default and how to
|
||||||
disable this behaviour, see for example:
|
disable this behaviour, see for example:
|
||||||
|
|
||||||
http://ponystyle.com/blog/2010/03/26/dealing-with-asset-compression-in-android-apps/
|
http://ponystyle.com/blog/2010/03/26/dealing-with-asset-compression-in-android-apps/
|
||||||
|
|
||||||
|
|
||||||
Pause / Resume behaviour
|
Pause / Resume behaviour
|
||||||
================================================================================
|
================================================================================
|
||||||
|
|
||||||
If SDL_HINT_ANDROID_BLOCK_ON_PAUSE hint is set (the default),
|
If SDL_HINT_ANDROID_BLOCK_ON_PAUSE hint is set (the default),
|
||||||
the event loop will block itself when the app is paused (ie, when the user
|
the event loop will block itself when the app is paused (ie, when the user
|
||||||
returns to the main Android dashboard). Blocking is better in terms of battery
|
returns to the main Android dashboard). Blocking is better in terms of battery
|
||||||
use, and it allows your app to spring back to life instantaneously after resume
|
use, and it allows your app to spring back to life instantaneously after resume
|
||||||
(versus polling for a resume message).
|
(versus polling for a resume message).
|
||||||
|
|
||||||
Upon resume, SDL will attempt to restore the GL context automatically.
|
Upon resume, SDL will attempt to restore the GL context automatically.
|
||||||
In modern devices (Android 3.0 and up) this will most likely succeed and your
|
In modern devices (Android 3.0 and up) this will most likely succeed and your
|
||||||
app can continue to operate as it was.
|
app can continue to operate as it was.
|
||||||
|
|
||||||
However, there's a chance (on older hardware, or on systems under heavy load),
|
However, there's a chance (on older hardware, or on systems under heavy load),
|
||||||
where the GL context can not be restored. In that case you have to listen for
|
where the GL context can not be restored. In that case you have to listen for
|
||||||
a specific message (SDL_RENDER_DEVICE_RESET) and restore your textures
|
a specific message (SDL_RENDER_DEVICE_RESET) and restore your textures
|
||||||
manually or quit the app.
|
manually or quit the app.
|
||||||
|
|
||||||
You should not use the SDL renderer API while the app going in background:
|
You should not use the SDL renderer API while the app going in background:
|
||||||
- SDL_APP_WILLENTERBACKGROUND:
|
- SDL_APP_WILLENTERBACKGROUND:
|
||||||
after you read this message, GL context gets backed-up and you should not
|
after you read this message, GL context gets backed-up and you should not
|
||||||
use the SDL renderer API.
|
use the SDL renderer API.
|
||||||
|
|
||||||
When this event is received, you have to set the render target to NULL, if you're using it.
|
When this event is received, you have to set the render target to NULL, if you're using it.
|
||||||
(eg call SDL_SetRenderTarget(renderer, NULL))
|
(eg call SDL_SetRenderTarget(renderer, NULL))
|
||||||
|
|
||||||
- SDL_APP_DIDENTERFOREGROUND:
|
- SDL_APP_DIDENTERFOREGROUND:
|
||||||
GL context is restored, and the SDL renderer API is available (unless you
|
GL context is restored, and the SDL renderer API is available (unless you
|
||||||
receive SDL_RENDER_DEVICE_RESET).
|
receive SDL_RENDER_DEVICE_RESET).
|
||||||
|
|
||||||
Mouse / Touch events
|
Mouse / Touch events
|
||||||
================================================================================
|
================================================================================
|
||||||
|
|
||||||
In some case, SDL generates synthetic mouse (resp. touch) events for touch
|
In some case, SDL generates synthetic mouse (resp. touch) events for touch
|
||||||
(resp. mouse) devices.
|
(resp. mouse) devices.
|
||||||
To enable/disable this behavior, see SDL_hints.h:
|
To enable/disable this behavior, see SDL_hints.h:
|
||||||
- SDL_HINT_TOUCH_MOUSE_EVENTS
|
- SDL_HINT_TOUCH_MOUSE_EVENTS
|
||||||
- SDL_HINT_MOUSE_TOUCH_EVENTS
|
- SDL_HINT_MOUSE_TOUCH_EVENTS
|
||||||
|
|
||||||
Misc
|
Misc
|
||||||
================================================================================
|
================================================================================
|
||||||
|
|
||||||
For some device, it appears to works better setting explicitly GL attributes
|
For some device, it appears to works better setting explicitly GL attributes
|
||||||
before creating a window:
|
before creating a window:
|
||||||
SDL_GL_SetAttribute(SDL_GL_RED_SIZE, 5);
|
SDL_GL_SetAttribute(SDL_GL_RED_SIZE, 5);
|
||||||
SDL_GL_SetAttribute(SDL_GL_GREEN_SIZE, 6);
|
SDL_GL_SetAttribute(SDL_GL_GREEN_SIZE, 6);
|
||||||
SDL_GL_SetAttribute(SDL_GL_BLUE_SIZE, 5);
|
SDL_GL_SetAttribute(SDL_GL_BLUE_SIZE, 5);
|
||||||
|
|
||||||
Threads and the Java VM
|
Threads and the Java VM
|
||||||
================================================================================
|
================================================================================
|
||||||
|
|
||||||
For a quick tour on how Linux native threads interoperate with the Java VM, take
|
For a quick tour on how Linux native threads interoperate with the Java VM, take
|
||||||
a look here: https://developer.android.com/guide/practices/jni.html
|
a look here: https://developer.android.com/guide/practices/jni.html
|
||||||
|
|
||||||
If you want to use threads in your SDL app, it's strongly recommended that you
|
If you want to use threads in your SDL app, it's strongly recommended that you
|
||||||
do so by creating them using SDL functions. This way, the required attach/detach
|
do so by creating them using SDL functions. This way, the required attach/detach
|
||||||
handling is managed by SDL automagically. If you have threads created by other
|
handling is managed by SDL automagically. If you have threads created by other
|
||||||
means and they make calls to SDL functions, make sure that you call
|
means and they make calls to SDL functions, make sure that you call
|
||||||
Android_JNI_SetupThread() before doing anything else otherwise SDL will attach
|
Android_JNI_SetupThread() before doing anything else otherwise SDL will attach
|
||||||
your thread automatically anyway (when you make an SDL call), but it'll never
|
your thread automatically anyway (when you make an SDL call), but it'll never
|
||||||
detach it.
|
detach it.
|
||||||
|
|
||||||
|
|
||||||
If you ever want to use JNI in a native thread (created by "SDL_CreateThread()"),
|
If you ever want to use JNI in a native thread (created by "SDL_CreateThread()"),
|
||||||
it won't be able to find your java class and method because of the java class loader
|
it won't be able to find your java class and method because of the java class loader
|
||||||
which is different for native threads, than for java threads (eg your "main()").
|
which is different for native threads, than for java threads (eg your "main()").
|
||||||
|
|
||||||
the work-around is to find class/method, in you "main()" thread, and to use them
|
the work-around is to find class/method, in you "main()" thread, and to use them
|
||||||
in your native thread.
|
in your native thread.
|
||||||
|
|
||||||
see:
|
see:
|
||||||
https://developer.android.com/training/articles/perf-jni#faq:-why-didnt-findclass-find-my-class
|
https://developer.android.com/training/articles/perf-jni#faq:-why-didnt-findclass-find-my-class
|
||||||
|
|
||||||
Using STL
|
Using STL
|
||||||
================================================================================
|
================================================================================
|
||||||
|
|
||||||
You can use STL in your project by creating an Application.mk file in the jni
|
You can use STL in your project by creating an Application.mk file in the jni
|
||||||
folder and adding the following line:
|
folder and adding the following line:
|
||||||
|
|
||||||
APP_STL := c++_shared
|
APP_STL := c++_shared
|
||||||
|
|
||||||
For more information go here:
|
For more information go here:
|
||||||
https://developer.android.com/ndk/guides/cpp-support
|
https://developer.android.com/ndk/guides/cpp-support
|
||||||
|
|
||||||
|
|
||||||
Using the emulator
|
Using the emulator
|
||||||
================================================================================
|
================================================================================
|
||||||
|
|
||||||
There are some good tips and tricks for getting the most out of the
|
There are some good tips and tricks for getting the most out of the
|
||||||
emulator here: https://developer.android.com/tools/devices/emulator.html
|
emulator here: https://developer.android.com/tools/devices/emulator.html
|
||||||
|
|
||||||
Especially useful is the info on setting up OpenGL ES 2.0 emulation.
|
Especially useful is the info on setting up OpenGL ES 2.0 emulation.
|
||||||
|
|
||||||
Notice that this software emulator is incredibly slow and needs a lot of disk space.
|
Notice that this software emulator is incredibly slow and needs a lot of disk space.
|
||||||
Using a real device works better.
|
Using a real device works better.
|
||||||
|
|
||||||
|
|
||||||
Troubleshooting
|
Troubleshooting
|
||||||
================================================================================
|
================================================================================
|
||||||
|
|
||||||
You can see if adb can see any devices with the following command:
|
You can see if adb can see any devices with the following command:
|
||||||
|
|
||||||
adb devices
|
adb devices
|
||||||
|
|
||||||
You can see the output of log messages on the default device with:
|
You can see the output of log messages on the default device with:
|
||||||
|
|
||||||
adb logcat
|
adb logcat
|
||||||
|
|
||||||
You can push files to the device with:
|
You can push files to the device with:
|
||||||
|
|
||||||
adb push local_file remote_path_and_file
|
adb push local_file remote_path_and_file
|
||||||
|
|
||||||
You can push files to the SD Card at /sdcard, for example:
|
You can push files to the SD Card at /sdcard, for example:
|
||||||
|
|
||||||
adb push moose.dat /sdcard/moose.dat
|
adb push moose.dat /sdcard/moose.dat
|
||||||
|
|
||||||
You can see the files on the SD card with a shell command:
|
You can see the files on the SD card with a shell command:
|
||||||
|
|
||||||
adb shell ls /sdcard/
|
adb shell ls /sdcard/
|
||||||
|
|
||||||
You can start a command shell on the default device with:
|
You can start a command shell on the default device with:
|
||||||
|
|
||||||
adb shell
|
adb shell
|
||||||
|
|
||||||
You can remove the library files of your project (and not the SDL lib files) with:
|
You can remove the library files of your project (and not the SDL lib files) with:
|
||||||
|
|
||||||
ndk-build clean
|
ndk-build clean
|
||||||
|
|
||||||
You can do a build with the following command:
|
You can do a build with the following command:
|
||||||
|
|
||||||
ndk-build
|
ndk-build
|
||||||
|
|
||||||
You can see the complete command line that ndk-build is using by passing V=1 on the command line:
|
You can see the complete command line that ndk-build is using by passing V=1 on the command line:
|
||||||
|
|
||||||
ndk-build V=1
|
ndk-build V=1
|
||||||
|
|
||||||
If your application crashes in native code, you can use ndk-stack to get a symbolic stack trace:
|
If your application crashes in native code, you can use ndk-stack to get a symbolic stack trace:
|
||||||
https://developer.android.com/ndk/guides/ndk-stack
|
https://developer.android.com/ndk/guides/ndk-stack
|
||||||
|
|
||||||
If you want to go through the process manually, you can use addr2line to convert the
|
If you want to go through the process manually, you can use addr2line to convert the
|
||||||
addresses in the stack trace to lines in your code.
|
addresses in the stack trace to lines in your code.
|
||||||
|
|
||||||
For example, if your crash looks like this:
|
For example, if your crash looks like this:
|
||||||
|
|
||||||
I/DEBUG ( 31): signal 11 (SIGSEGV), code 2 (SEGV_ACCERR), fault addr 400085d0
|
I/DEBUG ( 31): signal 11 (SIGSEGV), code 2 (SEGV_ACCERR), fault addr 400085d0
|
||||||
I/DEBUG ( 31): r0 00000000 r1 00001000 r2 00000003 r3 400085d4
|
I/DEBUG ( 31): r0 00000000 r1 00001000 r2 00000003 r3 400085d4
|
||||||
I/DEBUG ( 31): r4 400085d0 r5 40008000 r6 afd41504 r7 436c6a7c
|
I/DEBUG ( 31): r4 400085d0 r5 40008000 r6 afd41504 r7 436c6a7c
|
||||||
I/DEBUG ( 31): r8 436c6b30 r9 435c6fb0 10 435c6f9c fp 4168d82c
|
I/DEBUG ( 31): r8 436c6b30 r9 435c6fb0 10 435c6f9c fp 4168d82c
|
||||||
I/DEBUG ( 31): ip 8346aff0 sp 436c6a60 lr afd1c8ff pc afd1c902 cpsr 60000030
|
I/DEBUG ( 31): ip 8346aff0 sp 436c6a60 lr afd1c8ff pc afd1c902 cpsr 60000030
|
||||||
I/DEBUG ( 31): #00 pc 0001c902 /system/lib/libc.so
|
I/DEBUG ( 31): #00 pc 0001c902 /system/lib/libc.so
|
||||||
I/DEBUG ( 31): #01 pc 0001ccf6 /system/lib/libc.so
|
I/DEBUG ( 31): #01 pc 0001ccf6 /system/lib/libc.so
|
||||||
I/DEBUG ( 31): #02 pc 000014bc /data/data/org.libsdl.app/lib/libmain.so
|
I/DEBUG ( 31): #02 pc 000014bc /data/data/org.libsdl.app/lib/libmain.so
|
||||||
I/DEBUG ( 31): #03 pc 00001506 /data/data/org.libsdl.app/lib/libmain.so
|
I/DEBUG ( 31): #03 pc 00001506 /data/data/org.libsdl.app/lib/libmain.so
|
||||||
|
|
||||||
You can see that there's a crash in the C library being called from the main code.
|
You can see that there's a crash in the C library being called from the main code.
|
||||||
I run addr2line with the debug version of my code:
|
I run addr2line with the debug version of my code:
|
||||||
|
|
||||||
arm-eabi-addr2line -C -f -e obj/local/armeabi/libmain.so
|
arm-eabi-addr2line -C -f -e obj/local/armeabi/libmain.so
|
||||||
|
|
||||||
and then paste in the number after "pc" in the call stack, from the line that I care about:
|
and then paste in the number after "pc" in the call stack, from the line that I care about:
|
||||||
000014bc
|
000014bc
|
||||||
|
|
||||||
I get output from addr2line showing that it's in the quit function, in testspriteminimal.c, on line 23.
|
I get output from addr2line showing that it's in the quit function, in testspriteminimal.c, on line 23.
|
||||||
|
|
||||||
You can add logging to your code to help show what's happening:
|
You can add logging to your code to help show what's happening:
|
||||||
|
|
||||||
#include <android/log.h>
|
#include <android/log.h>
|
||||||
|
|
||||||
__android_log_print(ANDROID_LOG_INFO, "foo", "Something happened! x = %d", x);
|
__android_log_print(ANDROID_LOG_INFO, "foo", "Something happened! x = %d", x);
|
||||||
|
|
||||||
If you need to build without optimization turned on, you can create a file called
|
If you need to build without optimization turned on, you can create a file called
|
||||||
"Application.mk" in the jni directory, with the following line in it:
|
"Application.mk" in the jni directory, with the following line in it:
|
||||||
|
|
||||||
APP_OPTIM := debug
|
APP_OPTIM := debug
|
||||||
|
|
||||||
|
|
||||||
Memory debugging
|
Memory debugging
|
||||||
================================================================================
|
================================================================================
|
||||||
|
|
||||||
The best (and slowest) way to debug memory issues on Android is valgrind.
|
The best (and slowest) way to debug memory issues on Android is valgrind.
|
||||||
Valgrind has support for Android out of the box, just grab code using:
|
Valgrind has support for Android out of the box, just grab code using:
|
||||||
|
|
||||||
svn co svn://svn.valgrind.org/valgrind/trunk valgrind
|
svn co svn://svn.valgrind.org/valgrind/trunk valgrind
|
||||||
|
|
||||||
... and follow the instructions in the file README.android to build it.
|
... and follow the instructions in the file README.android to build it.
|
||||||
|
|
||||||
One thing I needed to do on Mac OS X was change the path to the toolchain,
|
One thing I needed to do on Mac OS X was change the path to the toolchain,
|
||||||
and add ranlib to the environment variables:
|
and add ranlib to the environment variables:
|
||||||
export RANLIB=$NDKROOT/toolchains/arm-linux-androideabi-4.4.3/prebuilt/darwin-x86/bin/arm-linux-androideabi-ranlib
|
export RANLIB=$NDKROOT/toolchains/arm-linux-androideabi-4.4.3/prebuilt/darwin-x86/bin/arm-linux-androideabi-ranlib
|
||||||
|
|
||||||
Once valgrind is built, you can create a wrapper script to launch your
|
Once valgrind is built, you can create a wrapper script to launch your
|
||||||
application with it, changing org.libsdl.app to your package identifier:
|
application with it, changing org.libsdl.app to your package identifier:
|
||||||
|
|
||||||
--- start_valgrind_app -------------------
|
--- start_valgrind_app -------------------
|
||||||
#!/system/bin/sh
|
#!/system/bin/sh
|
||||||
export TMPDIR=/data/data/org.libsdl.app
|
export TMPDIR=/data/data/org.libsdl.app
|
||||||
exec /data/local/Inst/bin/valgrind --log-file=/sdcard/valgrind.log --error-limit=no $*
|
exec /data/local/Inst/bin/valgrind --log-file=/sdcard/valgrind.log --error-limit=no $*
|
||||||
------------------------------------------
|
------------------------------------------
|
||||||
|
|
||||||
Then push it to the device:
|
Then push it to the device:
|
||||||
|
|
||||||
adb push start_valgrind_app /data/local
|
adb push start_valgrind_app /data/local
|
||||||
|
|
||||||
and make it executable:
|
and make it executable:
|
||||||
|
|
||||||
adb shell chmod 755 /data/local/start_valgrind_app
|
adb shell chmod 755 /data/local/start_valgrind_app
|
||||||
|
|
||||||
and tell Android to use the script to launch your application:
|
and tell Android to use the script to launch your application:
|
||||||
|
|
||||||
adb shell setprop wrap.org.libsdl.app "logwrapper /data/local/start_valgrind_app"
|
adb shell setprop wrap.org.libsdl.app "logwrapper /data/local/start_valgrind_app"
|
||||||
|
|
||||||
If the setprop command says "could not set property", it's likely that
|
If the setprop command says "could not set property", it's likely that
|
||||||
your package name is too long and you should make it shorter by changing
|
your package name is too long and you should make it shorter by changing
|
||||||
AndroidManifest.xml and the path to your class file in android-project/src
|
AndroidManifest.xml and the path to your class file in android-project/src
|
||||||
|
|
||||||
You can then launch your application normally and waaaaaaaiiittt for it.
|
You can then launch your application normally and waaaaaaaiiittt for it.
|
||||||
You can monitor the startup process with the logcat command above, and
|
You can monitor the startup process with the logcat command above, and
|
||||||
when it's done (or even while it's running) you can grab the valgrind
|
when it's done (or even while it's running) you can grab the valgrind
|
||||||
output file:
|
output file:
|
||||||
|
|
||||||
adb pull /sdcard/valgrind.log
|
adb pull /sdcard/valgrind.log
|
||||||
|
|
||||||
When you're done instrumenting with valgrind, you can disable the wrapper:
|
When you're done instrumenting with valgrind, you can disable the wrapper:
|
||||||
|
|
||||||
adb shell setprop wrap.org.libsdl.app ""
|
adb shell setprop wrap.org.libsdl.app ""
|
||||||
|
|
||||||
|
|
||||||
Graphics debugging
|
Graphics debugging
|
||||||
================================================================================
|
================================================================================
|
||||||
|
|
||||||
If you are developing on a compatible Tegra-based tablet, NVidia provides
|
If you are developing on a compatible Tegra-based tablet, NVidia provides
|
||||||
Tegra Graphics Debugger at their website. Because SDL2 dynamically loads EGL
|
Tegra Graphics Debugger at their website. Because SDL2 dynamically loads EGL
|
||||||
and GLES libraries, you must follow their instructions for installing the
|
and GLES libraries, you must follow their instructions for installing the
|
||||||
interposer library on a rooted device. The non-rooted instructions are not
|
interposer library on a rooted device. The non-rooted instructions are not
|
||||||
compatible with applications that use SDL2 for video.
|
compatible with applications that use SDL2 for video.
|
||||||
|
|
||||||
The Tegra Graphics Debugger is available from NVidia here:
|
The Tegra Graphics Debugger is available from NVidia here:
|
||||||
https://developer.nvidia.com/tegra-graphics-debugger
|
https://developer.nvidia.com/tegra-graphics-debugger
|
||||||
|
|
||||||
|
|
||||||
Why is API level 19 the minimum required?
|
Why is API level 19 the minimum required?
|
||||||
================================================================================
|
================================================================================
|
||||||
|
|
||||||
The latest NDK toolchain doesn't support targeting earlier than API level 19.
|
The latest NDK toolchain doesn't support targeting earlier than API level 19.
|
||||||
As of this writing, according to https://www.composables.com/tools/distribution-chart
|
As of this writing, according to https://www.composables.com/tools/distribution-chart
|
||||||
about 99.7% of the Android devices accessing Google Play support API level 19 or
|
about 99.7% of the Android devices accessing Google Play support API level 19 or
|
||||||
higher (August 2023).
|
higher (August 2023).
|
||||||
|
|
||||||
|
|
||||||
A note regarding the use of the "dirty rectangles" rendering technique
|
A note regarding the use of the "dirty rectangles" rendering technique
|
||||||
================================================================================
|
================================================================================
|
||||||
|
|
||||||
If your app uses a variation of the "dirty rectangles" rendering technique,
|
If your app uses a variation of the "dirty rectangles" rendering technique,
|
||||||
where you only update a portion of the screen on each frame, you may notice a
|
where you only update a portion of the screen on each frame, you may notice a
|
||||||
variety of visual glitches on Android, that are not present on other platforms.
|
variety of visual glitches on Android, that are not present on other platforms.
|
||||||
This is caused by SDL's use of EGL as the support system to handle OpenGL ES/ES2
|
This is caused by SDL's use of EGL as the support system to handle OpenGL ES/ES2
|
||||||
contexts, in particular the use of the eglSwapBuffers function. As stated in the
|
contexts, in particular the use of the eglSwapBuffers function. As stated in the
|
||||||
documentation for the function "The contents of ancillary buffers are always
|
documentation for the function "The contents of ancillary buffers are always
|
||||||
undefined after calling eglSwapBuffers".
|
undefined after calling eglSwapBuffers".
|
||||||
Setting the EGL_SWAP_BEHAVIOR attribute of the surface to EGL_BUFFER_PRESERVED
|
Setting the EGL_SWAP_BEHAVIOR attribute of the surface to EGL_BUFFER_PRESERVED
|
||||||
is not possible for SDL as it requires EGL 1.4, available only on the API level
|
is not possible for SDL as it requires EGL 1.4, available only on the API level
|
||||||
17+, so the only workaround available on this platform is to redraw the entire
|
17+, so the only workaround available on this platform is to redraw the entire
|
||||||
screen each frame.
|
screen each frame.
|
||||||
|
|
||||||
Reference: http://www.khronos.org/registry/egl/specs/EGLTechNote0001.html
|
Reference: http://www.khronos.org/registry/egl/specs/EGLTechNote0001.html
|
||||||
|
|
||||||
|
|
||||||
Ending your application
|
Ending your application
|
||||||
================================================================================
|
================================================================================
|
||||||
|
|
||||||
Two legitimate ways:
|
Two legitimate ways:
|
||||||
|
|
||||||
- return from your main() function. Java side will automatically terminate the
|
- return from your main() function. Java side will automatically terminate the
|
||||||
Activity by calling Activity.finish().
|
Activity by calling Activity.finish().
|
||||||
|
|
||||||
- Android OS can decide to terminate your application by calling onDestroy()
|
- Android OS can decide to terminate your application by calling onDestroy()
|
||||||
(see Activity life cycle). Your application will receive a SDL_QUIT event you
|
(see Activity life cycle). Your application will receive a SDL_QUIT event you
|
||||||
can handle to save things and quit.
|
can handle to save things and quit.
|
||||||
|
|
||||||
Don't call exit() as it stops the activity badly.
|
Don't call exit() as it stops the activity badly.
|
||||||
|
|
||||||
NB: "Back button" can be handled as a SDL_KEYDOWN/UP events, with Keycode
|
NB: "Back button" can be handled as a SDL_KEYDOWN/UP events, with Keycode
|
||||||
SDLK_AC_BACK, for any purpose.
|
SDLK_AC_BACK, for any purpose.
|
||||||
|
|
||||||
Known issues
|
Known issues
|
||||||
================================================================================
|
================================================================================
|
||||||
|
|
||||||
- The number of buttons reported for each joystick is hardcoded to be 36, which
|
- The number of buttons reported for each joystick is hardcoded to be 36, which
|
||||||
is the current maximum number of buttons Android can report.
|
is the current maximum number of buttons Android can report.
|
||||||
|
|
||||||
+163
-163
@@ -1,163 +1,163 @@
|
|||||||
# CMake
|
# CMake
|
||||||
|
|
||||||
(www.cmake.org)
|
(www.cmake.org)
|
||||||
|
|
||||||
SDL's build system was traditionally based on autotools. Over time, this
|
SDL's build system was traditionally based on autotools. Over time, this
|
||||||
approach has suffered from several issues across the different supported
|
approach has suffered from several issues across the different supported
|
||||||
platforms.
|
platforms.
|
||||||
To solve these problems, a new build system based on CMake was introduced.
|
To solve these problems, a new build system based on CMake was introduced.
|
||||||
It is developed in parallel to the legacy autotools build system, so users
|
It is developed in parallel to the legacy autotools build system, so users
|
||||||
can experiment with it without complication.
|
can experiment with it without complication.
|
||||||
|
|
||||||
The CMake build system is supported on the following platforms:
|
The CMake build system is supported on the following platforms:
|
||||||
|
|
||||||
* FreeBSD
|
* FreeBSD
|
||||||
* Linux
|
* Linux
|
||||||
* Microsoft Visual C
|
* Microsoft Visual C
|
||||||
* MinGW and Msys
|
* MinGW and Msys
|
||||||
* macOS, iOS, and tvOS, with support for XCode
|
* macOS, iOS, and tvOS, with support for XCode
|
||||||
* Android
|
* Android
|
||||||
* Emscripten
|
* Emscripten
|
||||||
* RiscOS
|
* RiscOS
|
||||||
* Playstation Vita
|
* Playstation Vita
|
||||||
|
|
||||||
## Building SDL
|
## Building SDL
|
||||||
|
|
||||||
Assuming the source for SDL is located at `~/sdl`
|
Assuming the source for SDL is located at `~/sdl`
|
||||||
```sh
|
```sh
|
||||||
cd ~
|
cd ~
|
||||||
mkdir build
|
mkdir build
|
||||||
cd build
|
cd build
|
||||||
cmake ~/sdl
|
cmake ~/sdl
|
||||||
cmake --build .
|
cmake --build .
|
||||||
```
|
```
|
||||||
|
|
||||||
This will build the static and dynamic versions of SDL in the `~/build` directory.
|
This will build the static and dynamic versions of SDL in the `~/build` directory.
|
||||||
Installation can be done using:
|
Installation can be done using:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
cmake --install . # '--install' requires CMake 3.15, or newer
|
cmake --install . # '--install' requires CMake 3.15, or newer
|
||||||
```
|
```
|
||||||
|
|
||||||
## Including SDL in your project
|
## Including SDL in your project
|
||||||
|
|
||||||
SDL can be included in your project in 2 major ways:
|
SDL can be included in your project in 2 major ways:
|
||||||
- using a system SDL library, provided by your (*nix) distribution or a package manager
|
- using a system SDL library, provided by your (*nix) distribution or a package manager
|
||||||
- using a vendored SDL library: this is SDL copied or symlinked in a subfolder.
|
- using a vendored SDL library: this is SDL copied or symlinked in a subfolder.
|
||||||
|
|
||||||
The following CMake script supports both, depending on the value of `MYGAME_VENDORED`.
|
The following CMake script supports both, depending on the value of `MYGAME_VENDORED`.
|
||||||
|
|
||||||
```cmake
|
```cmake
|
||||||
cmake_minimum_required(VERSION 3.5)
|
cmake_minimum_required(VERSION 3.5)
|
||||||
project(mygame)
|
project(mygame)
|
||||||
|
|
||||||
# Create an option to switch between a system sdl library and a vendored sdl library
|
# Create an option to switch between a system sdl library and a vendored sdl library
|
||||||
option(MYGAME_VENDORED "Use vendored libraries" OFF)
|
option(MYGAME_VENDORED "Use vendored libraries" OFF)
|
||||||
|
|
||||||
if(MYGAME_VENDORED)
|
if(MYGAME_VENDORED)
|
||||||
add_subdirectory(vendored/sdl EXCLUDE_FROM_ALL)
|
add_subdirectory(vendored/sdl EXCLUDE_FROM_ALL)
|
||||||
else()
|
else()
|
||||||
# 1. Look for a SDL2 package, 2. look for the SDL2 component and 3. fail if none can be found
|
# 1. Look for a SDL2 package, 2. look for the SDL2 component and 3. fail if none can be found
|
||||||
find_package(SDL2 REQUIRED CONFIG REQUIRED COMPONENTS SDL2)
|
find_package(SDL2 REQUIRED CONFIG REQUIRED COMPONENTS SDL2)
|
||||||
|
|
||||||
# 1. Look for a SDL2 package, 2. Look for the SDL2maincomponent and 3. DO NOT fail when SDL2main is not available
|
# 1. Look for a SDL2 package, 2. Look for the SDL2maincomponent and 3. DO NOT fail when SDL2main is not available
|
||||||
find_package(SDL2 REQUIRED CONFIG COMPONENTS SDL2main)
|
find_package(SDL2 REQUIRED CONFIG COMPONENTS SDL2main)
|
||||||
endif()
|
endif()
|
||||||
|
|
||||||
# Create your game executable target as usual
|
# Create your game executable target as usual
|
||||||
add_executable(mygame WIN32 mygame.c)
|
add_executable(mygame WIN32 mygame.c)
|
||||||
|
|
||||||
# SDL2::SDL2main may or may not be available. It is e.g. required by Windows GUI applications
|
# SDL2::SDL2main may or may not be available. It is e.g. required by Windows GUI applications
|
||||||
if(TARGET SDL2::SDL2main)
|
if(TARGET SDL2::SDL2main)
|
||||||
# It has an implicit dependency on SDL2 functions, so it MUST be added before SDL2::SDL2 (or SDL2::SDL2-static)
|
# It has an implicit dependency on SDL2 functions, so it MUST be added before SDL2::SDL2 (or SDL2::SDL2-static)
|
||||||
target_link_libraries(mygame PRIVATE SDL2::SDL2main)
|
target_link_libraries(mygame PRIVATE SDL2::SDL2main)
|
||||||
endif()
|
endif()
|
||||||
|
|
||||||
# Link to the actual SDL2 library. SDL2::SDL2 is the shared SDL library, SDL2::SDL2-static is the static SDL libarary.
|
# Link to the actual SDL2 library. SDL2::SDL2 is the shared SDL library, SDL2::SDL2-static is the static SDL libarary.
|
||||||
target_link_libraries(mygame PRIVATE SDL2::SDL2)
|
target_link_libraries(mygame PRIVATE SDL2::SDL2)
|
||||||
```
|
```
|
||||||
|
|
||||||
### A system SDL library
|
### A system SDL library
|
||||||
|
|
||||||
For CMake to find SDL, it must be installed in [a default location CMake is looking for](https://cmake.org/cmake/help/latest/command/find_package.html#config-mode-search-procedure).
|
For CMake to find SDL, it must be installed in [a default location CMake is looking for](https://cmake.org/cmake/help/latest/command/find_package.html#config-mode-search-procedure).
|
||||||
|
|
||||||
The following components are available, to be used as an argument of `find_package`.
|
The following components are available, to be used as an argument of `find_package`.
|
||||||
|
|
||||||
| Component name | Description |
|
| Component name | Description |
|
||||||
|----------------|--------------------------------------------------------------------------------------------|
|
|----------------|--------------------------------------------------------------------------------------------|
|
||||||
| SDL2 | The SDL2 shared library, available through the `SDL2::SDL2` target [^SDL_TARGET_EXCEPTION] |
|
| SDL2 | The SDL2 shared library, available through the `SDL2::SDL2` target [^SDL_TARGET_EXCEPTION] |
|
||||||
| SDL2-static | The SDL2 static library, available through the `SDL2::SDL2-static` target |
|
| SDL2-static | The SDL2 static library, available through the `SDL2::SDL2-static` target |
|
||||||
| SDL2main | The SDL2main static library, available through the `SDL2::SDL2main` target |
|
| SDL2main | The SDL2main static library, available through the `SDL2::SDL2main` target |
|
||||||
| SDL2test | The SDL2test static library, available through the `SDL2::SDL2test` target |
|
| SDL2test | The SDL2test static library, available through the `SDL2::SDL2test` target |
|
||||||
|
|
||||||
### Using a vendored SDL
|
### Using a vendored SDL
|
||||||
|
|
||||||
This only requires a copy of SDL in a subdirectory.
|
This only requires a copy of SDL in a subdirectory.
|
||||||
|
|
||||||
## CMake configuration options for platforms
|
## CMake configuration options for platforms
|
||||||
|
|
||||||
### iOS/tvOS
|
### iOS/tvOS
|
||||||
|
|
||||||
CMake 3.14+ natively includes support for iOS and tvOS. SDL binaries may be built
|
CMake 3.14+ natively includes support for iOS and tvOS. SDL binaries may be built
|
||||||
using Xcode or Make, possibly among other build-systems.
|
using Xcode or Make, possibly among other build-systems.
|
||||||
|
|
||||||
When using a recent version of CMake (3.14+), it should be possible to:
|
When using a recent version of CMake (3.14+), it should be possible to:
|
||||||
|
|
||||||
- build SDL for iOS, both static and dynamic
|
- build SDL for iOS, both static and dynamic
|
||||||
- build SDL test apps (as iOS/tvOS .app bundles)
|
- build SDL test apps (as iOS/tvOS .app bundles)
|
||||||
- generate a working SDL_config.h for iOS (using SDL_config.h.cmake as a basis)
|
- generate a working SDL_config.h for iOS (using SDL_config.h.cmake as a basis)
|
||||||
|
|
||||||
To use, set the following CMake variables when running CMake's configuration stage:
|
To use, set the following CMake variables when running CMake's configuration stage:
|
||||||
|
|
||||||
- `CMAKE_SYSTEM_NAME=<OS>` (either `iOS` or `tvOS`)
|
- `CMAKE_SYSTEM_NAME=<OS>` (either `iOS` or `tvOS`)
|
||||||
- `CMAKE_OSX_SYSROOT=<SDK>` (examples: `iphoneos`, `iphonesimulator`, `iphoneos12.4`, `/full/path/to/iPhoneOS.sdk`,
|
- `CMAKE_OSX_SYSROOT=<SDK>` (examples: `iphoneos`, `iphonesimulator`, `iphoneos12.4`, `/full/path/to/iPhoneOS.sdk`,
|
||||||
`appletvos`, `appletvsimulator`, `appletvos12.4`, `/full/path/to/AppleTVOS.sdk`, etc.)
|
`appletvos`, `appletvsimulator`, `appletvos12.4`, `/full/path/to/AppleTVOS.sdk`, etc.)
|
||||||
- `CMAKE_OSX_ARCHITECTURES=<semicolon-separated list of CPU architectures>` (example: "arm64;armv7s;x86_64")
|
- `CMAKE_OSX_ARCHITECTURES=<semicolon-separated list of CPU architectures>` (example: "arm64;armv7s;x86_64")
|
||||||
|
|
||||||
|
|
||||||
#### Examples
|
#### Examples
|
||||||
|
|
||||||
- for iOS-Simulator, using the latest, installed SDK:
|
- for iOS-Simulator, using the latest, installed SDK:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
cmake ~/sdl -DCMAKE_SYSTEM_NAME=iOS -DCMAKE_OSX_SYSROOT=iphonesimulator -DCMAKE_OSX_ARCHITECTURES=x86_64
|
cmake ~/sdl -DCMAKE_SYSTEM_NAME=iOS -DCMAKE_OSX_SYSROOT=iphonesimulator -DCMAKE_OSX_ARCHITECTURES=x86_64
|
||||||
```
|
```
|
||||||
|
|
||||||
- for iOS-Device, using the latest, installed SDK, 64-bit only
|
- for iOS-Device, using the latest, installed SDK, 64-bit only
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
cmake ~/sdl -DCMAKE_SYSTEM_NAME=iOS -DCMAKE_OSX_SYSROOT=iphoneos -DCMAKE_OSX_ARCHITECTURES=arm64
|
cmake ~/sdl -DCMAKE_SYSTEM_NAME=iOS -DCMAKE_OSX_SYSROOT=iphoneos -DCMAKE_OSX_ARCHITECTURES=arm64
|
||||||
```
|
```
|
||||||
|
|
||||||
- for iOS-Device, using the latest, installed SDK, mixed 32/64 bit
|
- for iOS-Device, using the latest, installed SDK, mixed 32/64 bit
|
||||||
|
|
||||||
```cmake
|
```cmake
|
||||||
cmake ~/sdl -DCMAKE_SYSTEM_NAME=iOS -DCMAKE_OSX_SYSROOT=iphoneos -DCMAKE_OSX_ARCHITECTURES="arm64;armv7s"
|
cmake ~/sdl -DCMAKE_SYSTEM_NAME=iOS -DCMAKE_OSX_SYSROOT=iphoneos -DCMAKE_OSX_ARCHITECTURES="arm64;armv7s"
|
||||||
```
|
```
|
||||||
|
|
||||||
- for iOS-Device, using a specific SDK revision (iOS 12.4, in this example):
|
- for iOS-Device, using a specific SDK revision (iOS 12.4, in this example):
|
||||||
|
|
||||||
```cmake
|
```cmake
|
||||||
cmake ~/sdl -DCMAKE_SYSTEM_NAME=iOS -DCMAKE_OSX_SYSROOT=iphoneos12.4 -DCMAKE_OSX_ARCHITECTURES=arm64
|
cmake ~/sdl -DCMAKE_SYSTEM_NAME=iOS -DCMAKE_OSX_SYSROOT=iphoneos12.4 -DCMAKE_OSX_ARCHITECTURES=arm64
|
||||||
```
|
```
|
||||||
|
|
||||||
- for iOS-Simulator, using the latest, installed SDK, and building SDL test apps (as .app bundles):
|
- for iOS-Simulator, using the latest, installed SDK, and building SDL test apps (as .app bundles):
|
||||||
|
|
||||||
```cmake
|
```cmake
|
||||||
cmake ~/sdl -DSDL_TESTS=1 -DCMAKE_SYSTEM_NAME=iOS -DCMAKE_OSX_SYSROOT=iphonesimulator -DCMAKE_OSX_ARCHITECTURES=x86_64
|
cmake ~/sdl -DSDL_TESTS=1 -DCMAKE_SYSTEM_NAME=iOS -DCMAKE_OSX_SYSROOT=iphonesimulator -DCMAKE_OSX_ARCHITECTURES=x86_64
|
||||||
```
|
```
|
||||||
|
|
||||||
- for tvOS-Simulator, using the latest, installed SDK:
|
- for tvOS-Simulator, using the latest, installed SDK:
|
||||||
|
|
||||||
```cmake
|
```cmake
|
||||||
cmake ~/sdl -DCMAKE_SYSTEM_NAME=tvOS -DCMAKE_OSX_SYSROOT=appletvsimulator -DCMAKE_OSX_ARCHITECTURES=x86_64
|
cmake ~/sdl -DCMAKE_SYSTEM_NAME=tvOS -DCMAKE_OSX_SYSROOT=appletvsimulator -DCMAKE_OSX_ARCHITECTURES=x86_64
|
||||||
```
|
```
|
||||||
|
|
||||||
- for tvOS-Device, using the latest, installed SDK:
|
- for tvOS-Device, using the latest, installed SDK:
|
||||||
|
|
||||||
```cmake
|
```cmake
|
||||||
cmake ~/sdl -DCMAKE_SYSTEM_NAME=tvOS -DCMAKE_OSX_SYSROOT=appletvos -DCMAKE_OSX_ARCHITECTURES=arm64`
|
cmake ~/sdl -DCMAKE_SYSTEM_NAME=tvOS -DCMAKE_OSX_SYSROOT=appletvos -DCMAKE_OSX_ARCHITECTURES=arm64`
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
[^SDL_TARGET_EXCEPTION]: `SDL2::SDL2` can be an ALIAS to a static `SDL2::SDL2-static` target for multiple reasons.
|
[^SDL_TARGET_EXCEPTION]: `SDL2::SDL2` can be an ALIAS to a static `SDL2::SDL2-static` target for multiple reasons.
|
||||||
+123
-123
@@ -1,123 +1,123 @@
|
|||||||
DirectFB
|
DirectFB
|
||||||
========
|
========
|
||||||
|
|
||||||
Supports:
|
Supports:
|
||||||
|
|
||||||
- Hardware YUV overlays
|
- Hardware YUV overlays
|
||||||
- OpenGL - software only
|
- OpenGL - software only
|
||||||
- 2D/3D accelerations (depends on directfb driver)
|
- 2D/3D accelerations (depends on directfb driver)
|
||||||
- multiple displays
|
- multiple displays
|
||||||
- windows
|
- windows
|
||||||
|
|
||||||
What you need:
|
What you need:
|
||||||
|
|
||||||
* DirectFB 1.0.1, 1.2.x, 1.3.0
|
* DirectFB 1.0.1, 1.2.x, 1.3.0
|
||||||
* Kernel-Framebuffer support: required: vesafb, radeonfb ....
|
* Kernel-Framebuffer support: required: vesafb, radeonfb ....
|
||||||
* Mesa 7.0.x - optional for OpenGL
|
* Mesa 7.0.x - optional for OpenGL
|
||||||
|
|
||||||
The `/etc/directfbrc` file should contain the following lines to make
|
The `/etc/directfbrc` file should contain the following lines to make
|
||||||
your joystick work and avoid crashes:
|
your joystick work and avoid crashes:
|
||||||
|
|
||||||
```
|
```
|
||||||
disable-module=joystick
|
disable-module=joystick
|
||||||
disable-module=cle266
|
disable-module=cle266
|
||||||
disable-module=cyber5k
|
disable-module=cyber5k
|
||||||
no-linux-input-grab
|
no-linux-input-grab
|
||||||
```
|
```
|
||||||
|
|
||||||
To disable to use x11 backend when DISPLAY variable is found use
|
To disable to use x11 backend when DISPLAY variable is found use
|
||||||
|
|
||||||
```
|
```
|
||||||
export SDL_DIRECTFB_X11_CHECK=0
|
export SDL_DIRECTFB_X11_CHECK=0
|
||||||
```
|
```
|
||||||
|
|
||||||
To disable the use of linux input devices, i.e. multimice/multikeyboard support,
|
To disable the use of linux input devices, i.e. multimice/multikeyboard support,
|
||||||
use
|
use
|
||||||
|
|
||||||
```
|
```
|
||||||
export SDL_DIRECTFB_LINUX_INPUT=0
|
export SDL_DIRECTFB_LINUX_INPUT=0
|
||||||
```
|
```
|
||||||
|
|
||||||
To use hardware accelerated YUV-overlays for YUV-textures, use:
|
To use hardware accelerated YUV-overlays for YUV-textures, use:
|
||||||
|
|
||||||
```
|
```
|
||||||
export SDL_DIRECTFB_YUV_DIRECT=1
|
export SDL_DIRECTFB_YUV_DIRECT=1
|
||||||
```
|
```
|
||||||
|
|
||||||
This is disabled by default. It will only support one
|
This is disabled by default. It will only support one
|
||||||
YUV texture, namely the first. Every other YUV texture will be
|
YUV texture, namely the first. Every other YUV texture will be
|
||||||
rendered in software.
|
rendered in software.
|
||||||
|
|
||||||
In addition, you may use (directfb-1.2.x)
|
In addition, you may use (directfb-1.2.x)
|
||||||
|
|
||||||
```
|
```
|
||||||
export SDL_DIRECTFB_YUV_UNDERLAY=1
|
export SDL_DIRECTFB_YUV_UNDERLAY=1
|
||||||
```
|
```
|
||||||
|
|
||||||
to make the YUV texture an underlay. This will make the cursor to
|
to make the YUV texture an underlay. This will make the cursor to
|
||||||
be shown.
|
be shown.
|
||||||
|
|
||||||
Simple Window Manager
|
Simple Window Manager
|
||||||
=====================
|
=====================
|
||||||
|
|
||||||
The driver has support for a very, very basic window manager you may
|
The driver has support for a very, very basic window manager you may
|
||||||
want to use when running with `wm=default`. Use
|
want to use when running with `wm=default`. Use
|
||||||
|
|
||||||
```
|
```
|
||||||
export SDL_DIRECTFB_WM=1
|
export SDL_DIRECTFB_WM=1
|
||||||
```
|
```
|
||||||
|
|
||||||
to enable basic window borders. In order to have the window title rendered,
|
to enable basic window borders. In order to have the window title rendered,
|
||||||
you need to have the following font installed:
|
you need to have the following font installed:
|
||||||
|
|
||||||
```
|
```
|
||||||
/usr/share/fonts/truetype/freefont/FreeSans.ttf
|
/usr/share/fonts/truetype/freefont/FreeSans.ttf
|
||||||
```
|
```
|
||||||
|
|
||||||
OpenGL Support
|
OpenGL Support
|
||||||
==============
|
==============
|
||||||
|
|
||||||
The following instructions will give you *software* OpenGL. However this
|
The following instructions will give you *software* OpenGL. However this
|
||||||
works at least on all directfb supported platforms.
|
works at least on all directfb supported platforms.
|
||||||
|
|
||||||
As of this writing 20100802 you need to pull Mesa from git and do the following:
|
As of this writing 20100802 you need to pull Mesa from git and do the following:
|
||||||
|
|
||||||
```
|
```
|
||||||
git clone git://anongit.freedesktop.org/git/mesa/mesa
|
git clone git://anongit.freedesktop.org/git/mesa/mesa
|
||||||
cd mesa
|
cd mesa
|
||||||
git checkout 2c9fdaf7292423c157fc79b5ce43f0f199dd753a
|
git checkout 2c9fdaf7292423c157fc79b5ce43f0f199dd753a
|
||||||
```
|
```
|
||||||
|
|
||||||
Edit `configs/linux-directfb` so that the Directories-section looks like this:
|
Edit `configs/linux-directfb` so that the Directories-section looks like this:
|
||||||
|
|
||||||
```
|
```
|
||||||
# Directories
|
# Directories
|
||||||
SRC_DIRS = mesa glu
|
SRC_DIRS = mesa glu
|
||||||
GLU_DIRS = sgi
|
GLU_DIRS = sgi
|
||||||
DRIVER_DIRS = directfb
|
DRIVER_DIRS = directfb
|
||||||
PROGRAM_DIRS =
|
PROGRAM_DIRS =
|
||||||
```
|
```
|
||||||
|
|
||||||
Then do the following:
|
Then do the following:
|
||||||
|
|
||||||
```
|
```
|
||||||
make linux-directfb
|
make linux-directfb
|
||||||
make
|
make
|
||||||
|
|
||||||
echo Installing - please enter sudo pw.
|
echo Installing - please enter sudo pw.
|
||||||
|
|
||||||
sudo make install INSTALL_DIR=/usr/local/dfb_GL
|
sudo make install INSTALL_DIR=/usr/local/dfb_GL
|
||||||
cd src/mesa/drivers/directfb
|
cd src/mesa/drivers/directfb
|
||||||
make
|
make
|
||||||
sudo make install INSTALL_DIR=/usr/local/dfb_GL
|
sudo make install INSTALL_DIR=/usr/local/dfb_GL
|
||||||
```
|
```
|
||||||
|
|
||||||
To run the SDL - testprograms:
|
To run the SDL - testprograms:
|
||||||
|
|
||||||
```
|
```
|
||||||
export SDL_VIDEODRIVER=directfb
|
export SDL_VIDEODRIVER=directfb
|
||||||
export LD_LIBRARY_PATH=/usr/local/dfb_GL/lib
|
export LD_LIBRARY_PATH=/usr/local/dfb_GL/lib
|
||||||
export LD_PRELOAD=/usr/local/dfb_GL/libGL.so.7
|
export LD_PRELOAD=/usr/local/dfb_GL/libGL.so.7
|
||||||
|
|
||||||
./testgl
|
./testgl
|
||||||
```
|
```
|
||||||
+138
-138
@@ -1,138 +1,138 @@
|
|||||||
# Dynamic API
|
# Dynamic API
|
||||||
|
|
||||||
Originally posted on Ryan's Google+ account.
|
Originally posted on Ryan's Google+ account.
|
||||||
|
|
||||||
Background:
|
Background:
|
||||||
|
|
||||||
- The Steam Runtime has (at least in theory) a really kick-ass build of SDL2,
|
- The Steam Runtime has (at least in theory) a really kick-ass build of SDL2,
|
||||||
but developers are shipping their own SDL2 with individual Steam games.
|
but developers are shipping their own SDL2 with individual Steam games.
|
||||||
These games might stop getting updates, but a newer SDL2 might be needed later.
|
These games might stop getting updates, but a newer SDL2 might be needed later.
|
||||||
Certainly we'll always be fixing bugs in SDL, even if a new video target isn't
|
Certainly we'll always be fixing bugs in SDL, even if a new video target isn't
|
||||||
ever needed, and these fixes won't make it to a game shipping its own SDL.
|
ever needed, and these fixes won't make it to a game shipping its own SDL.
|
||||||
- Even if we replace the SDL2 in those games with a compatible one, that is to
|
- Even if we replace the SDL2 in those games with a compatible one, that is to
|
||||||
say, edit a developer's Steam depot (yuck!), there are developers that are
|
say, edit a developer's Steam depot (yuck!), there are developers that are
|
||||||
statically linking SDL2 that we can't do this for. We can't even force the
|
statically linking SDL2 that we can't do this for. We can't even force the
|
||||||
dynamic loader to ignore their SDL2 in this case, of course.
|
dynamic loader to ignore their SDL2 in this case, of course.
|
||||||
- If you don't ship an SDL2 with the game in some form, people that disabled the
|
- If you don't ship an SDL2 with the game in some form, people that disabled the
|
||||||
Steam Runtime, or just tried to run the game from the command line instead of
|
Steam Runtime, or just tried to run the game from the command line instead of
|
||||||
Steam might find themselves unable to run the game, due to a missing dependency.
|
Steam might find themselves unable to run the game, due to a missing dependency.
|
||||||
- If you want to ship on non-Steam platforms like GOG or Humble Bundle, or target
|
- If you want to ship on non-Steam platforms like GOG or Humble Bundle, or target
|
||||||
generic Linux boxes that may or may not have SDL2 installed, you have to ship
|
generic Linux boxes that may or may not have SDL2 installed, you have to ship
|
||||||
the library or risk a total failure to launch. So now, you might have to have
|
the library or risk a total failure to launch. So now, you might have to have
|
||||||
a non-Steam build plus a Steam build (that is, one with and one without SDL2
|
a non-Steam build plus a Steam build (that is, one with and one without SDL2
|
||||||
included), which is inconvenient if you could have had one universal build
|
included), which is inconvenient if you could have had one universal build
|
||||||
that works everywhere.
|
that works everywhere.
|
||||||
- We like the zlib license, but the biggest complaint from the open source
|
- We like the zlib license, but the biggest complaint from the open source
|
||||||
community about the license change is the static linking. The LGPL forced this
|
community about the license change is the static linking. The LGPL forced this
|
||||||
as a legal, not technical issue, but zlib doesn't care. Even those that aren't
|
as a legal, not technical issue, but zlib doesn't care. Even those that aren't
|
||||||
concerned about the GNU freedoms found themselves solving the same problems:
|
concerned about the GNU freedoms found themselves solving the same problems:
|
||||||
swapping in a newer SDL to an older game often times can save the day.
|
swapping in a newer SDL to an older game often times can save the day.
|
||||||
Static linking stops this dead.
|
Static linking stops this dead.
|
||||||
|
|
||||||
So here's what we did:
|
So here's what we did:
|
||||||
|
|
||||||
SDL now has, internally, a table of function pointers. So, this is what SDL_Init
|
SDL now has, internally, a table of function pointers. So, this is what SDL_Init
|
||||||
now looks like:
|
now looks like:
|
||||||
|
|
||||||
```c
|
```c
|
||||||
Uint32 SDL_Init(Uint32 flags)
|
UInt32 SDL_Init(Uint32 flags)
|
||||||
{
|
{
|
||||||
return jump_table.SDL_Init(flags);
|
return jump_table.SDL_Init(flags);
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
Except that is all done with a bunch of macro magic so we don't have to maintain
|
Except that is all done with a bunch of macro magic so we don't have to maintain
|
||||||
every one of these.
|
every one of these.
|
||||||
|
|
||||||
What is jump_table.SDL_init()? Eventually, that's a function pointer of the real
|
What is jump_table.SDL_init()? Eventually, that's a function pointer of the real
|
||||||
SDL_Init() that you've been calling all this time. But at startup, it looks more
|
SDL_Init() that you've been calling all this time. But at startup, it looks more
|
||||||
like this:
|
like this:
|
||||||
|
|
||||||
```c
|
```c
|
||||||
Uint32 SDL_Init_DEFAULT(Uint32 flags)
|
Uint32 SDL_Init_DEFAULT(Uint32 flags)
|
||||||
{
|
{
|
||||||
SDL_InitDynamicAPI();
|
SDL_InitDynamicAPI();
|
||||||
return jump_table.SDL_Init(flags);
|
return jump_table.SDL_Init(flags);
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
SDL_InitDynamicAPI() fills in jump_table with all the actual SDL function
|
SDL_InitDynamicAPI() fills in jump_table with all the actual SDL function
|
||||||
pointers, which means that this `_DEFAULT` function never gets called again.
|
pointers, which means that this `_DEFAULT` function never gets called again.
|
||||||
First call to any SDL function sets the whole thing up.
|
First call to any SDL function sets the whole thing up.
|
||||||
|
|
||||||
So you might be asking, what was the value in that? Isn't this what the operating
|
So you might be asking, what was the value in that? Isn't this what the operating
|
||||||
system's dynamic loader was supposed to do for us? Yes, but now we've got this
|
system's dynamic loader was supposed to do for us? Yes, but now we've got this
|
||||||
level of indirection, we can do things like this:
|
level of indirection, we can do things like this:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
export SDL_DYNAMIC_API=/my/actual/libSDL-2.0.so.0
|
export SDL_DYNAMIC_API=/my/actual/libSDL-2.0.so.0
|
||||||
./MyGameThatIsStaticallyLinkedToSDL2
|
./MyGameThatIsStaticallyLinkedToSDL2
|
||||||
```
|
```
|
||||||
|
|
||||||
And now, this game that is statically linked to SDL, can still be overridden
|
And now, this game that is statically linked to SDL, can still be overridden
|
||||||
with a newer, or better, SDL. The statically linked one will only be used as
|
with a newer, or better, SDL. The statically linked one will only be used as
|
||||||
far as calling into the jump table in this case. But in cases where no override
|
far as calling into the jump table in this case. But in cases where no override
|
||||||
is desired, the statically linked version will provide its own jump table,
|
is desired, the statically linked version will provide its own jump table,
|
||||||
and everyone is happy.
|
and everyone is happy.
|
||||||
|
|
||||||
So now:
|
So now:
|
||||||
- Developers can statically link SDL, and users can still replace it.
|
- Developers can statically link SDL, and users can still replace it.
|
||||||
(We'd still rather you ship a shared library, though!)
|
(We'd still rather you ship a shared library, though!)
|
||||||
- Developers can ship an SDL with their game, Valve can override it for, say,
|
- Developers can ship an SDL with their game, Valve can override it for, say,
|
||||||
new features on SteamOS, or distros can override it for their own needs,
|
new features on SteamOS, or distros can override it for their own needs,
|
||||||
but it'll also just work in the default case.
|
but it'll also just work in the default case.
|
||||||
- Developers can ship the same package to everyone (Humble Bundle, GOG, etc),
|
- Developers can ship the same package to everyone (Humble Bundle, GOG, etc),
|
||||||
and it'll do the right thing.
|
and it'll do the right thing.
|
||||||
- End users (and Valve) can update a game's SDL in almost any case,
|
- End users (and Valve) can update a game's SDL in almost any case,
|
||||||
to keep abandoned games running on newer platforms.
|
to keep abandoned games running on newer platforms.
|
||||||
- Everyone develops with SDL exactly as they have been doing all along.
|
- Everyone develops with SDL exactly as they have been doing all along.
|
||||||
Same headers, same ABI. Just get the latest version to enable this magic.
|
Same headers, same ABI. Just get the latest version to enable this magic.
|
||||||
|
|
||||||
|
|
||||||
A little more about SDL_InitDynamicAPI():
|
A little more about SDL_InitDynamicAPI():
|
||||||
|
|
||||||
Internally, InitAPI does some locking to make sure everything waits until a
|
Internally, InitAPI does some locking to make sure everything waits until a
|
||||||
single thread initializes everything (although even SDL_CreateThread() goes
|
single thread initializes everything (although even SDL_CreateThread() goes
|
||||||
through here before spinning a thread, too), and then decides if it should use
|
through here before spinning a thread, too), and then decides if it should use
|
||||||
an external SDL library. If not, it sets up the jump table using the current
|
an external SDL library. If not, it sets up the jump table using the current
|
||||||
SDL's function pointers (which might be statically linked into a program, or in
|
SDL's function pointers (which might be statically linked into a program, or in
|
||||||
a shared library of its own). If so, it loads that library and looks for and
|
a shared library of its own). If so, it loads that library and looks for and
|
||||||
calls a single function:
|
calls a single function:
|
||||||
|
|
||||||
```c
|
```c
|
||||||
Sint32 SDL_DYNAPI_entry(Uint32 version, void *table, Uint32 tablesize);
|
SInt32 SDL_DYNAPI_entry(Uint32 version, void *table, Uint32 tablesize);
|
||||||
```
|
```
|
||||||
|
|
||||||
That function takes a version number (more on that in a moment), the address of
|
That function takes a version number (more on that in a moment), the address of
|
||||||
the jump table, and the size, in bytes, of the table.
|
the jump table, and the size, in bytes, of the table.
|
||||||
Now, we've got policy here: this table's layout never changes; new stuff gets
|
Now, we've got policy here: this table's layout never changes; new stuff gets
|
||||||
added to the end. Therefore SDL_DYNAPI_entry() knows that it can provide all
|
added to the end. Therefore SDL_DYNAPI_entry() knows that it can provide all
|
||||||
the needed functions if tablesize <= sizeof its own jump table. If tablesize is
|
the needed functions if tablesize <= sizeof its own jump table. If tablesize is
|
||||||
bigger (say, SDL 2.0.4 is trying to load SDL 2.0.3), then we know to abort, but
|
bigger (say, SDL 2.0.4 is trying to load SDL 2.0.3), then we know to abort, but
|
||||||
if it's smaller, we know we can provide the entire API that the caller needs.
|
if it's smaller, we know we can provide the entire API that the caller needs.
|
||||||
|
|
||||||
The version variable is a failsafe switch.
|
The version variable is a failsafe switch.
|
||||||
Right now it's always 1. This number changes when there are major API changes
|
Right now it's always 1. This number changes when there are major API changes
|
||||||
(so we know if the tablesize might be smaller, or entries in it have changed).
|
(so we know if the tablesize might be smaller, or entries in it have changed).
|
||||||
Right now SDL_DYNAPI_entry gives up if the version doesn't match, but it's not
|
Right now SDL_DYNAPI_entry gives up if the version doesn't match, but it's not
|
||||||
inconceivable to have a small dispatch library that only supplies this one
|
inconceivable to have a small dispatch library that only supplies this one
|
||||||
function and loads different, otherwise-incompatible SDL libraries and has the
|
function and loads different, otherwise-incompatible SDL libraries and has the
|
||||||
right one initialize the jump table based on the version. For something that
|
right one initialize the jump table based on the version. For something that
|
||||||
must generically catch lots of different versions of SDL over time, like the
|
must generically catch lots of different versions of SDL over time, like the
|
||||||
Steam Client, this isn't a bad option.
|
Steam Client, this isn't a bad option.
|
||||||
|
|
||||||
Finally, I'm sure some people are reading this and thinking,
|
Finally, I'm sure some people are reading this and thinking,
|
||||||
"I don't want that overhead in my project!"
|
"I don't want that overhead in my project!"
|
||||||
|
|
||||||
To which I would point out that the extra function call through the jump table
|
To which I would point out that the extra function call through the jump table
|
||||||
probably wouldn't even show up in a profile, but lucky you: this can all be
|
probably wouldn't even show up in a profile, but lucky you: this can all be
|
||||||
disabled. You can build SDL without this if you absolutely must, but we would
|
disabled. You can build SDL without this if you absolutely must, but we would
|
||||||
encourage you not to do that. However, on heavily locked down platforms like
|
encourage you not to do that. However, on heavily locked down platforms like
|
||||||
iOS, or maybe when debugging, it makes sense to disable it. The way this is
|
iOS, or maybe when debugging, it makes sense to disable it. The way this is
|
||||||
designed in SDL, you just have to change one #define, and the entire system
|
designed in SDL, you just have to change one #define, and the entire system
|
||||||
vaporizes out, and SDL functions exactly like it always did. Most of it is
|
vaporizes out, and SDL functions exactly like it always did. Most of it is
|
||||||
macro magic, so the system is contained to one C file and a few headers.
|
macro magic, so the system is contained to one C file and a few headers.
|
||||||
However, this is on by default and you have to edit a header file to turn it
|
However, this is on by default and you have to edit a header file to turn it
|
||||||
off. Our hopes is that if we make it easy to disable, but not too easy,
|
off. Our hopes is that if we make it easy to disable, but not too easy,
|
||||||
everyone will ultimately be able to get what they want, but we've gently
|
everyone will ultimately be able to get what they want, but we've gently
|
||||||
nudged everyone towards what we think is the best solution.
|
nudged everyone towards what we think is the best solution.
|
||||||
@@ -1,374 +1,76 @@
|
|||||||
# Emscripten
|
# Emscripten
|
||||||
|
|
||||||
## The state of things
|
(This documentation is not very robust; we will update and expand this later.)
|
||||||
|
|
||||||
(As of September 2023, but things move quickly and we don't update this
|
## A quick note about audio
|
||||||
document often.)
|
|
||||||
|
Modern web browsers will not permit web pages to produce sound before the
|
||||||
In modern times, all the browsers you probably care about (Chrome, Firefox,
|
user has interacted with them; this is for several reasons, not the least
|
||||||
Edge, and Safari, on Windows, macOS, Linux, iOS and Android), support some
|
of which being that no one likes when a random browser tab suddenly starts
|
||||||
reasonable base configurations:
|
making noise and the user has to scramble to figure out which and silence
|
||||||
|
it.
|
||||||
- WebAssembly (don't bother with asm.js any more)
|
|
||||||
- WebGL (which will look like OpenGL ES 2 or 3 to your app).
|
To solve this, most browsers will refuse to let a web app use the audio
|
||||||
- Threads (see caveats, though!)
|
subsystem at all before the user has interacted with (clicked on) the page
|
||||||
- Game controllers
|
in a meaningful way. SDL-based apps also have to deal with this problem; if
|
||||||
- Autoupdating (so you can assume they have a recent version of the browser)
|
the user hasn't interacted with the page, SDL_OpenAudioDevice will fail.
|
||||||
|
|
||||||
All this to say we're at the point where you don't have to make a lot of
|
There are two reasonable ways to deal with this: if you are writing some
|
||||||
concessions to get even a fairly complex SDL-based game up and running.
|
sort of media player thing, where the user expects there to be a volume
|
||||||
|
control when you mouseover the canvas, just default that control to a muted
|
||||||
|
state; if the user clicks on the control to unmute it, on this first click,
|
||||||
## RTFM
|
open the audio device. This allows the media to play at start, the user can
|
||||||
|
reasonably opt-in to listening, and you never get access denied to the audio
|
||||||
This document is a quick rundown of some high-level details. The
|
device.
|
||||||
documentation at [emscripten.org](https://emscripten.org/) is vast
|
|
||||||
and extremely detailed for a wide variety of topics, and you should at
|
Many games do not have this sort of UI, and are more rigid about starting
|
||||||
least skim through it at some point.
|
audio along with everything else at the start of the process. For these, your
|
||||||
|
best bet is to write a little Javascript that puts up a "Click here to play!"
|
||||||
|
UI, and upon the user clicking, remove that UI and then call the Emscripten
|
||||||
## Porting your app to Emscripten
|
app's main() function. As far as the application knows, the audio device was
|
||||||
|
available to be opened as soon as the program started, and since this magic
|
||||||
Many many things just need some simple adjustments and they'll compile
|
happens in a little Javascript, you don't have to change your C/C++ code at
|
||||||
like any other C/C++ code, as long as SDL was handling the platform-specific
|
all to make it happen.
|
||||||
work for your program.
|
|
||||||
|
Please see the discussion at https://github.com/libsdl-org/SDL/issues/6385
|
||||||
First, you probably need this in at least one of your source files:
|
for some Javascript code to steal for this approach.
|
||||||
|
|
||||||
```c
|
|
||||||
#ifdef __EMSCRIPTEN__
|
## Building SDL/emscripten
|
||||||
#include <emscripten.h>
|
|
||||||
#endif
|
SDL currently requires at least Emscripten 3.1.35 to build. Newer versions
|
||||||
```
|
are likely to work, as well.
|
||||||
|
|
||||||
Second: assembly language code has to go. Replace it with C. You can even use
|
|
||||||
[x86 SIMD intrinsic functions in Emscripten](https://emscripten.org/docs/porting/simd.html)!
|
Build:
|
||||||
|
|
||||||
Third: Middleware has to go. If you have a third-party library you link
|
$ mkdir build
|
||||||
against, you either need an Emscripten port of it, or the source code to it
|
$ cd build
|
||||||
to compile yourself, or you need to remove it.
|
$ emconfigure ../configure --host=asmjs-unknown-emscripten --disable-assembly --disable-threads --disable-cpuinfo CFLAGS="-O2"
|
||||||
|
$ emmake make
|
||||||
Fourth: You still start in a function called main(), but you need to get out of
|
|
||||||
it and into a function that gets called repeatedly, and returns quickly,
|
Or with cmake:
|
||||||
called a mainloop.
|
|
||||||
|
$ mkdir build
|
||||||
Somewhere in your program, you probably have something that looks like a more
|
$ cd build
|
||||||
complicated version of this:
|
$ emcmake cmake ..
|
||||||
|
$ emmake make
|
||||||
```c
|
|
||||||
void main(void)
|
To build one of the tests:
|
||||||
{
|
|
||||||
initialize_the_game();
|
$ cd test/
|
||||||
while (game_is_still_running) {
|
$ emcc -O2 --js-opts 0 -g4 testdraw2.c -I../include ../build/.libs/libSDL2.a ../build/libSDL2_test.a -o a.html
|
||||||
check_for_new_input();
|
|
||||||
think_about_stuff();
|
Uses GLES2 renderer or software
|
||||||
draw_the_next_frame();
|
|
||||||
}
|
Some other SDL2 libraries can be easily built (assuming SDL2 is installed somewhere):
|
||||||
deinitialize_the_game();
|
|
||||||
}
|
SDL_mixer (http://www.libsdl.org/projects/SDL_mixer/):
|
||||||
```
|
|
||||||
|
$ EMCONFIGURE_JS=1 emconfigure ../configure
|
||||||
This will not work on Emscripten, because the main thread needs to be free
|
build as usual...
|
||||||
to do stuff and can't sit in this loop forever. So Emscripten lets you set up
|
|
||||||
a [mainloop](https://emscripten.org/docs/porting/emscripten-runtime-environment.html#browser-main-loop).
|
SDL_gfx (http://cms.ferzkopp.net/index.php/software/13-sdl-gfx):
|
||||||
|
|
||||||
```c
|
$ EMCONFIGURE_JS=1 emconfigure ../configure --disable-mmx
|
||||||
static void mainloop(void) /* this will run often, possibly at the monitor's refresh rate */
|
build as usual...
|
||||||
{
|
|
||||||
if (!game_is_still_running) {
|
|
||||||
deinitialize_the_game();
|
|
||||||
#ifdef __EMSCRIPTEN__
|
|
||||||
emscripten_cancel_main_loop(); /* this should "kill" the app. */
|
|
||||||
#else
|
|
||||||
exit(0);
|
|
||||||
#endif
|
|
||||||
}
|
|
||||||
|
|
||||||
check_for_new_input();
|
|
||||||
think_about_stuff();
|
|
||||||
draw_the_next_frame();
|
|
||||||
}
|
|
||||||
|
|
||||||
void main(void)
|
|
||||||
{
|
|
||||||
initialize_the_game();
|
|
||||||
#ifdef __EMSCRIPTEN__
|
|
||||||
emscripten_set_main_loop(mainloop, 0, 1);
|
|
||||||
#else
|
|
||||||
while (1) { mainloop(); }
|
|
||||||
#endif
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
Basically, `emscripten_set_main_loop(mainloop, 0, 1);` says "run
|
|
||||||
`mainloop` over and over until I end the program." The function will
|
|
||||||
run, and return, freeing the main thread for other tasks, and then
|
|
||||||
run again when it's time. The `1` parameter does some magic to make
|
|
||||||
your main() function end immediately; this is useful because you
|
|
||||||
don't want any shutdown code that might be sitting below this code
|
|
||||||
to actually run if main() were to continue on, since we're just
|
|
||||||
getting started.
|
|
||||||
|
|
||||||
There's a lot of little details that are beyond the scope of this
|
|
||||||
document, but that's the biggest intial set of hurdles to porting
|
|
||||||
your app to the web.
|
|
||||||
|
|
||||||
|
|
||||||
## Do you need threads?
|
|
||||||
|
|
||||||
If you plan to use threads, they work on all major browsers now. HOWEVER,
|
|
||||||
they bring with them a lot of careful considerations. Rendering _must_
|
|
||||||
be done on the main thread. This is a general guideline for many
|
|
||||||
platforms, but a hard requirement on the web.
|
|
||||||
|
|
||||||
Many other things also must happen on the main thread; often times SDL
|
|
||||||
and Emscripten make efforts to "proxy" work to the main thread that
|
|
||||||
must be there, but you have to be careful (and read more detailed
|
|
||||||
documentation than this for the finer points).
|
|
||||||
|
|
||||||
Even when using threads, your main thread needs to set an Emscripten
|
|
||||||
mainloop that runs quickly and returns, or things will fail to work
|
|
||||||
correctly.
|
|
||||||
|
|
||||||
You should definitely read [Emscripten's pthreads docs](https://emscripten.org/docs/porting/pthreads.html)
|
|
||||||
for all the finer points. Mostly SDL's thread API will work as expected,
|
|
||||||
but is built on pthreads, so it shares the same little incompatibilities
|
|
||||||
that are documented there, such as where you can use a mutex, and when
|
|
||||||
a thread will start running, etc.
|
|
||||||
|
|
||||||
|
|
||||||
IMPORTANT: You have to decide to either build something that uses
|
|
||||||
threads or something that doesn't; you can't have one build
|
|
||||||
that works everywhere. This is an Emscripten (or maybe WebAssembly?
|
|
||||||
Or just web browsers in general?) limitation. If you aren't using
|
|
||||||
threads, it's easier to not enable them at all, at build time.
|
|
||||||
|
|
||||||
If you use threads, you _have to_ run from a web server that has
|
|
||||||
[COOP/COEP headers set correctly](https://web.dev/why-coop-coep/)
|
|
||||||
or your program will fail to start at all.
|
|
||||||
|
|
||||||
If building with threads, `__EMSCRIPTEN_PTHREADS__` will be defined
|
|
||||||
for checking with the C preprocessor, so you can build something
|
|
||||||
different depending on what sort of build you're compiling.
|
|
||||||
|
|
||||||
|
|
||||||
## Audio
|
|
||||||
|
|
||||||
Audio works as expected at the API level, but not exactly like other
|
|
||||||
platforms.
|
|
||||||
|
|
||||||
You'll only see a single default audio device. Audio capture also works;
|
|
||||||
if the browser pops up a prompt to ask for permission to access the
|
|
||||||
microphone, the SDL_OpenAudioDevice call will succeed and start producing
|
|
||||||
silence at a regular interval. Once the user approves the request, real
|
|
||||||
audio data will flow. If the user denies it, the app is not informed and
|
|
||||||
will just continue to receive silence.
|
|
||||||
|
|
||||||
Modern web browsers will not permit web pages to produce sound before the
|
|
||||||
user has interacted with them (clicked or tapped on them, usually); this is
|
|
||||||
for several reasons, not the least of which being that no one likes when a
|
|
||||||
random browser tab suddenly starts making noise and the user has to scramble
|
|
||||||
to figure out which and silence it.
|
|
||||||
|
|
||||||
SDL will allow you to open the audio device for playback in this
|
|
||||||
circumstance, and your audio callback will fire, but SDL will throw the audio
|
|
||||||
data away until the user interacts with the page. This helps apps that depend
|
|
||||||
on the audio callback to make progress, and also keeps audio playback in sync
|
|
||||||
once the app is finally allowed to make noise.
|
|
||||||
|
|
||||||
There are two reasonable ways to deal with the silence at the app level:
|
|
||||||
if you are writing some sort of media player thing, where the user expects
|
|
||||||
there to be a volume control when you mouseover the canvas, just default
|
|
||||||
that control to a muted state; if the user clicks on the control to unmute
|
|
||||||
it, on this first click, open the audio device. This allows the media to
|
|
||||||
play at start, and the user can reasonably opt-in to listening.
|
|
||||||
|
|
||||||
Many games do not have this sort of UI, and are more rigid about starting
|
|
||||||
audio along with everything else at the start of the process. For these, your
|
|
||||||
best bet is to write a little Javascript that puts up a "Click here to play!"
|
|
||||||
UI, and upon the user clicking, remove that UI and then call the Emscripten
|
|
||||||
app's main() function. As far as the application knows, the audio device was
|
|
||||||
available to be opened as soon as the program started, and since this magic
|
|
||||||
happens in a little Javascript, you don't have to change your C/C++ code at
|
|
||||||
all to make it happen.
|
|
||||||
|
|
||||||
Please see the discussion at https://github.com/libsdl-org/SDL/issues/6385
|
|
||||||
for some Javascript code to steal for this approach.
|
|
||||||
|
|
||||||
|
|
||||||
## Rendering
|
|
||||||
|
|
||||||
If you use SDL's 2D render API, it will use GLES2 internally, which
|
|
||||||
Emscripten will turn into WebGL calls. You can also use OpenGL ES 2
|
|
||||||
directly by creating a GL context and drawing into it.
|
|
||||||
|
|
||||||
Calling SDL_RenderPresent (or SDL_GL_SwapWindow) will not actually
|
|
||||||
present anything on the screen until your return from your mainloop
|
|
||||||
function.
|
|
||||||
|
|
||||||
|
|
||||||
## Building SDL/emscripten
|
|
||||||
|
|
||||||
First: do you _really_ need to build SDL from source?
|
|
||||||
|
|
||||||
If you aren't developing SDL itself, have a desire to mess with its source
|
|
||||||
code, or need something on the bleeding edge, don't build SDL. Just use
|
|
||||||
Emscripten's packaged version!
|
|
||||||
|
|
||||||
Compile and link your app with `-sUSE_SDL=2` and it'll use a build of
|
|
||||||
SDL packaged with Emscripten. This comes from the same source code and
|
|
||||||
fixes the Emscripten project makes to SDL are generally merged into SDL's
|
|
||||||
revision control, so often this is much easier for app developers.
|
|
||||||
|
|
||||||
`-sUSE_SDL=1` will select Emscripten's JavaScript reimplementation of SDL
|
|
||||||
1.2 instead; if you need SDL 1.2, this might be fine, but we generally
|
|
||||||
recommend you don't use SDL 1.2 in modern times.
|
|
||||||
|
|
||||||
|
|
||||||
If you want to build SDL, though...
|
|
||||||
|
|
||||||
SDL currently requires at least Emscripten 3.1.35 to build. Newer versions
|
|
||||||
are likely to work, as well.
|
|
||||||
|
|
||||||
|
|
||||||
Build:
|
|
||||||
|
|
||||||
This works on Linux/Unix and macOS. Please send comments about Windows.
|
|
||||||
|
|
||||||
Make sure you've [installed emsdk](https://emscripten.org/docs/getting_started/downloads.html)
|
|
||||||
first, and run `source emsdk_env.sh` at the command line so it finds the
|
|
||||||
tools.
|
|
||||||
|
|
||||||
(These configure options might be overkill, but this has worked for me.)
|
|
||||||
|
|
||||||
```bash
|
|
||||||
cd SDL
|
|
||||||
mkdir build
|
|
||||||
cd build
|
|
||||||
emconfigure ../configure --host=wasm32-unknown-emscripten --disable-pthreads --disable-assembly --disable-cpuinfo CFLAGS="-sUSE_SDL=0 -O3"
|
|
||||||
emmake make -j4
|
|
||||||
```
|
|
||||||
|
|
||||||
If you want to build with thread support, something like this works:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
emconfigure ../configure --host=wasm32-unknown-emscripten --enable-pthreads --disable-assembly --disable-cpuinfo CFLAGS="-sUSE_SDL=0 -O3 -pthread" LDFLAGS="-pthread"
|
|
||||||
```
|
|
||||||
|
|
||||||
Or with cmake:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
mkdir build
|
|
||||||
cd build
|
|
||||||
emcmake cmake ..
|
|
||||||
emmake make -j4
|
|
||||||
```
|
|
||||||
|
|
||||||
To build one of the tests:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
cd test/
|
|
||||||
emcc -O2 --js-opts 0 -g4 testdraw2.c -I../include ../build/.libs/libSDL2.a ../build/libSDL2_test.a -o a.html
|
|
||||||
```
|
|
||||||
|
|
||||||
## Building your app
|
|
||||||
|
|
||||||
You need to compile with `emcc` instead of `gcc` or `clang` or whatever, but
|
|
||||||
mostly it uses the same command line arguments as Clang.
|
|
||||||
|
|
||||||
Link against the SDL/build/.libs/libSDL2.a file you generated by building SDL,
|
|
||||||
link with `-sUSE_SDL=2` to use Emscripten's prepackaged SDL2 build.
|
|
||||||
|
|
||||||
Usually you would produce a binary like this:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
gcc -o mygame mygame.c # or whatever
|
|
||||||
```
|
|
||||||
|
|
||||||
But for Emscripten, you want to output something else:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
emcc -o index.html mygame.c
|
|
||||||
```
|
|
||||||
|
|
||||||
This will produce several files...support Javascript and WebAssembly (.wasm)
|
|
||||||
files. The `-o index.html` will produce a simple HTML page that loads and
|
|
||||||
runs your app. You will (probably) eventually want to replace or customize
|
|
||||||
that file and do `-o index.js` instead to just build the code pieces.
|
|
||||||
|
|
||||||
If you're working on a program of any serious size, you'll likely need to
|
|
||||||
link with `-sALLOW_MEMORY_GROWTH=1 -sMAXIMUM_MEMORY=1gb` to get access
|
|
||||||
to more memory. If using pthreads, you'll need the `-sMAXIMUM_MEMORY=1gb`
|
|
||||||
or the app will fail to start on iOS browsers, but this might be a bug that
|
|
||||||
goes away in the future.
|
|
||||||
|
|
||||||
|
|
||||||
## Data files
|
|
||||||
|
|
||||||
Your game probably has data files. Here's how to access them.
|
|
||||||
|
|
||||||
Filesystem access works like a Unix filesystem; you have a single directory
|
|
||||||
tree, possibly interpolated from several mounted locations, no drive letters,
|
|
||||||
'/' for a path separator. You can access them with standard file APIs like
|
|
||||||
open() or fopen() or SDL_RWops. You can read or write from the filesystem.
|
|
||||||
|
|
||||||
By default, you probably have a "MEMFS" filesystem (all files are stored in
|
|
||||||
memory, but access to them is immediate and doesn't need to block). There are
|
|
||||||
other options, like "IDBFS" (files are stored in a local database, so they
|
|
||||||
don't need to be in RAM all the time and they can persist between runs of the
|
|
||||||
program, but access is not synchronous). You can mix and match these file
|
|
||||||
systems, mounting a MEMFS filesystem at one place and idbfs elsewhere, etc,
|
|
||||||
but that's beyond the scope of this document. Please refer to Emscripten's
|
|
||||||
[page on the topic](https://emscripten.org/docs/porting/files/file_systems_overview.html)
|
|
||||||
for more info.
|
|
||||||
|
|
||||||
The _easiest_ (but not the best) way to get at your data files is to embed
|
|
||||||
them in the app itself. Emscripten's linker has support for automating this.
|
|
||||||
|
|
||||||
```bash
|
|
||||||
emcc -o index.html loopwave.c --embed-file=../test/sample.wav@/sounds/sample.wav
|
|
||||||
```
|
|
||||||
|
|
||||||
This will pack ../test/sample.wav in your app, and make it available at
|
|
||||||
"/sounds/sample.wav" at runtime. Emscripten makes sure this data is available
|
|
||||||
before your main() function runs, and since it's in MEMFS, you can just
|
|
||||||
read it like you do on other platforms. `--embed-file` can also accept a
|
|
||||||
directory to pack an entire tree, and you can specify the argument multiple
|
|
||||||
times to pack unrelated things into the final installation.
|
|
||||||
|
|
||||||
Note that this is absolutely the best approach if you have a few small
|
|
||||||
files to include and shouldn't worry about the issue further. However, if you
|
|
||||||
have hundreds of megabytes and/or thousands of files, this is not so great,
|
|
||||||
since the user will download it all every time they load your page, and it
|
|
||||||
all has to live in memory at runtime.
|
|
||||||
|
|
||||||
[Emscripten's documentation on the matter](https://emscripten.org/docs/porting/files/packaging_files.html)
|
|
||||||
gives other options and details, and is worth a read.
|
|
||||||
|
|
||||||
|
|
||||||
## Debugging
|
|
||||||
|
|
||||||
Debugging web apps is a mixed bag. You should compile and link with
|
|
||||||
`-gsource-map`, which embeds a ton of source-level debugging information into
|
|
||||||
the build, and make sure _the app source code is available on the web server_,
|
|
||||||
which is often a scary proposition for various reasons.
|
|
||||||
|
|
||||||
When you debug from the browser's tools and hit a breakpoint, you can step
|
|
||||||
through the actual C/C++ source code, though, which can be nice.
|
|
||||||
|
|
||||||
If you try debugging in Firefox and it doesn't work well for no apparent
|
|
||||||
reason, try Chrome, and vice-versa. These tools are still relatively new,
|
|
||||||
and improving all the time.
|
|
||||||
|
|
||||||
SDL_Log() (or even plain old printf) will write to the Javascript console,
|
|
||||||
and honestly I find printf-style debugging to be easier than setting up a build
|
|
||||||
for proper debugging, so use whatever tools work best for you.
|
|
||||||
|
|
||||||
|
|
||||||
## Questions?
|
|
||||||
|
|
||||||
Please give us feedback on this document at [the SDL bug tracker](https://github.com/libsdl-org/SDL/issues).
|
|
||||||
If something is wrong or unclear, we want to know!
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
+155
-176
@@ -1,176 +1,155 @@
|
|||||||
GDK
|
GDK
|
||||||
=====
|
=====
|
||||||
|
|
||||||
This port allows SDL applications to run via Microsoft's Game Development Kit (GDK).
|
This port allows SDL applications to run via Microsoft's Game Development Kit (GDK).
|
||||||
|
|
||||||
Windows (GDK) and Xbox One/Xbox Series (GDKX) are both supported and all the required code is included in this public SDL release. However, only licensed Xbox developers have access to the GDKX libraries which will allow you to build the Xbox targets.
|
Windows (GDK) and Xbox One/Xbox Series (GDKX) are supported. Although most of the Xbox code is included in the public SDL source code, NDA access is required for a small number of source files. If you have access to GDKX, these required Xbox files are posted on the GDK forums [here](https://forums.xboxlive.com/questions/130003/).
|
||||||
|
|
||||||
|
|
||||||
Requirements
|
Requirements
|
||||||
------------
|
------------
|
||||||
|
|
||||||
* Microsoft Visual Studio 2022 (in theory, it should also work in 2017 or 2019, but this has not been tested)
|
* Microsoft Visual Studio 2022 (in theory, it should also work in 2017 or 2019, but this has not been tested)
|
||||||
* Microsoft GDK June 2022 or newer (public release [here](https://github.com/microsoft/GDK/releases/tag/June_2022))
|
* Microsoft GDK June 2022 or newer (public release [here](https://github.com/microsoft/GDK/releases/tag/June_2022))
|
||||||
* For Xbox, you will need the corresponding GDKX version (licensed developers only)
|
* To publish a package or successfully authenticate a user, you will need to create an app id/configure services in Partner Center. However, for local testing purposes (without authenticating on Xbox Live), the identifiers used by the GDK test programs in the included solution will work.
|
||||||
* To publish a package or successfully authenticate a user, you will need to create an app id/configure services in Partner Center. However, for local testing purposes (without authenticating on Xbox Live), the identifiers used by the GDK test programs in the included solution will work.
|
|
||||||
|
|
||||||
|
Windows GDK Status
|
||||||
Windows GDK Status
|
------
|
||||||
------
|
|
||||||
|
The Windows GDK port supports the full set of Win32 APIs, renderers, controllers, input devices, etc., as the normal Windows x64 build of SDL.
|
||||||
The Windows GDK port supports the full set of Win32 APIs, renderers, controllers, input devices, etc., as the normal Windows x64 build of SDL.
|
|
||||||
|
* Additionally, the GDK port adds the following:
|
||||||
* Additionally, the GDK port adds the following:
|
* Compile-time platform detection for SDL programs. The `__GDK__` is `#define`d on every GDK platform, and the `__WINGDK__` is `#define`d on Windows GDK, specifically. (This distinction exists because other GDK platforms support a smaller subset of functionality. This allows you to mark code for "any" GDK separate from Windows GDK.)
|
||||||
* Compile-time platform detection for SDL programs. The `__GDK__` is `#define`d on every GDK platform, and the `__WINGDK__` is `#define`d on Windows GDK, specifically. (This distinction exists because other GDK platforms support a smaller subset of functionality. This allows you to mark code for "any" GDK separate from Windows GDK.)
|
* GDK-specific setup:
|
||||||
* GDK-specific setup:
|
* Initializing/uninitializing the game runtime, and initializing Xbox Live services
|
||||||
* Initializing/uninitializing the game runtime, and initializing Xbox Live services
|
* Creating a global task queue and setting it as the default for the process. When running any async operations, passing in `NULL` as the task queue will make the task get added to the global task queue.
|
||||||
* Creating a global task queue and setting it as the default for the process. When running any async operations, passing in `NULL` as the task queue will make the task get added to the global task queue.
|
|
||||||
|
* An implementation on `WinMain` that performs the above GDK setup (you should link against SDL2main.lib, as in Windows x64). If you are unable to do this, you can instead manually call `SDL_GDKRunApp` from your entry point, passing in your `SDL_main` function and `NULL` as the parameters.
|
||||||
* An implementation on `WinMain` that performs the above GDK setup (you should link against SDL2main.lib, as in Windows x64). If you are unable to do this, you can instead manually call `SDL_GDKRunApp` from your entry point, passing in your `SDL_main` function and `NULL` as the parameters.
|
* Global task queue callbacks are dispatched during `SDL_PumpEvents` (which is also called internally if using `SDL_PollEvent`).
|
||||||
* Global task queue callbacks are dispatched during `SDL_PumpEvents` (which is also called internally if using `SDL_PollEvent`).
|
* You can get the handle of the global task queue through `SDL_GDKGetTaskQueue`, if needed. When done with the queue, be sure to use `XTaskQueueCloseHandle` to decrement the reference count (otherwise it will cause a resource leak).
|
||||||
* You can get the handle of the global task queue through `SDL_GDKGetTaskQueue`, if needed. When done with the queue, be sure to use `XTaskQueueCloseHandle` to decrement the reference count (otherwise it will cause a resource leak).
|
|
||||||
|
* What doesn't work:
|
||||||
* Single-player games have some additional features available:
|
* Compilation with anything other than through the included Visual C++ solution file
|
||||||
* Call `SDL_GDKGetDefaultUser` to get the default XUserHandle pointer.
|
|
||||||
* `SDL_GetPrefPath` still works, but only for single-player titles.
|
## VisualC-GDK Solution
|
||||||
|
|
||||||
These functions mostly wrap around async APIs, and thus should be treated as synchronous alternatives. Also note that the single-player functions return on any OS errors, so be sure to validate the return values!
|
The included `VisualC-GDK/SDL.sln` solution includes the following targets for the Gaming.Desktop.x64 configuration:
|
||||||
|
|
||||||
* What doesn't work:
|
* SDL2 (DLL) - This is the typical SDL2.dll, but for Gaming.Desktop.x64.
|
||||||
* Compilation with anything other than through the included Visual C++ solution file
|
* SDL2main (lib) - This contains a drop-in implementation of `WinMain` that is used as the entry point for GDK programs.
|
||||||
|
* tests/testgamecontroller - Standard SDL test program demonstrating controller functionality.
|
||||||
## VisualC-GDK Solution
|
* tests/testgdk - GDK-specific test program that demonstrates using the global task queue to login a user into Xbox Live.
|
||||||
|
*NOTE*: As of the June 2022 GDK, you cannot test user logins without a valid Title ID and MSAAppId. You will need to manually change the identifiers in the `MicrosoftGame.config` to your valid IDs from Partner Center if you wish to test this.
|
||||||
The included `VisualC-GDK/SDL.sln` solution includes the following targets for the Gaming.Desktop.x64 configuration:
|
* tests/testsprite2 - Standard SDL test program demonstrating sprite drawing functionality.
|
||||||
|
|
||||||
* SDL2 (DLL) - This is the typical SDL2.dll, but for Gaming.Desktop.x64.
|
If you set one of the test programs as a startup project, you can run it directly from Visual Studio.
|
||||||
* SDL2main (lib) - This contains a drop-in implementation of `WinMain` that is used as the entry point for GDK programs.
|
|
||||||
* tests/testgamecontroller - Standard SDL test program demonstrating controller functionality.
|
Windows GDK Setup, Detailed Steps
|
||||||
* tests/testgdk - GDK-specific test program that demonstrates using the global task queue to login a user into Xbox Live.
|
---------------------
|
||||||
*NOTE*: As of the June 2022 GDK, you cannot test user logins without a valid Title ID and MSAAppId. You will need to manually change the identifiers in the `MicrosoftGame.config` to your valid IDs from Partner Center if you wish to test this.
|
|
||||||
* tests/testsprite2 - Standard SDL test program demonstrating sprite drawing functionality.
|
These steps assume you already have a game using SDL that runs on Windows x64 along with a corresponding Visual Studio solution file for the x64 version. If you don't have this, it's easiest to use one of the test program vcxproj files in the `VisualC-GDK` directory as a starting point, though you will still need to do most of the steps below.
|
||||||
|
|
||||||
If you set one of the test programs as a startup project, you can run it directly from Visual Studio.
|
### 1. Add a Gaming.Desktop.x64 Configuration ###
|
||||||
|
|
||||||
Windows GDK Setup, Detailed Steps
|
In your game's existing Visual Studio Solution, go to Build > Configuration Manager. From the "Active solution platform" drop-down select "New...". From the drop-down list, select Gaming.Desktop.x64 and copy the settings from the x64 configuration.
|
||||||
---------------------
|
|
||||||
|
### 2. Build SDL2 and SDL2main for GDK ###
|
||||||
These steps assume you already have a game using SDL that runs on Windows x64 along with a corresponding Visual Studio solution file for the x64 version. If you don't have this, it's easiest to use one of the test program vcxproj files in the `VisualC-GDK` directory as a starting point, though you will still need to do most of the steps below.
|
|
||||||
|
Open `VisualC-GDK/SDL.sln` in Visual Studio, you need to build the SDL2 and SDL2main targets for the Gaming.Desktop.x64 platform (Release is recommended). You will need to copy/keep track of the `SDL2.dll`, `XCurl.dll` (which is output by Gaming.Desktop.x64), `SDL2.lib`, and `SDL2main.lib` output files for your game project.
|
||||||
### 1. Add a Gaming.Desktop.x64 Configuration ###
|
|
||||||
|
*Alternatively*, you could setup your solution file to instead reference the SDL2/SDL2main project file targets from the SDL source, and add those projects as a dependency. This would mean that SDL2 and SDL2main would both be built when your game is built.
|
||||||
In your game's existing Visual Studio Solution, go to Build > Configuration Manager. From the "Active solution platform" drop-down select "New...". From the drop-down list, select Gaming.Desktop.x64 and copy the settings from the x64 configuration.
|
|
||||||
|
### 3. Configuring Project Settings ###
|
||||||
### 2. Build SDL2 and SDL2main for GDK ###
|
|
||||||
|
While the Gaming.Desktop.x64 configuration sets most of the required settings, there are some additional items to configure for your game project under the Gaming.Desktop.x64 Configuration:
|
||||||
Open `VisualC-GDK/SDL.sln` in Visual Studio, you need to build the SDL2 and SDL2main targets for the Gaming.Desktop.x64 platform (Release is recommended). You will need to copy/keep track of the `SDL2.dll`, `XCurl.dll` (which is output by Gaming.Desktop.x64), `SDL2.lib`, and `SDL2main.lib` output files for your game project.
|
|
||||||
|
* Under C/C++ > General > Additional Include Directories, make sure the `SDL/include` path is referenced
|
||||||
*Alternatively*, you could setup your solution file to instead reference the SDL2/SDL2main project file targets from the SDL source, and add those projects as a dependency. This would mean that SDL2 and SDL2main would both be built when your game is built.
|
* Under Linker > General > Additional Library Directories, make sure to reference the path where the newly-built SDL2.lib and SDL2main.lib are
|
||||||
|
* Under Linker > Input > Additional Dependencies, you need the following:
|
||||||
### 3. Configuring Project Settings ###
|
* `SDL2.lib`
|
||||||
|
* `SDL2main.lib` (unless not using)
|
||||||
While the Gaming.Desktop.x64 configuration sets most of the required settings, there are some additional items to configure for your game project under the Gaming.Desktop.x64 Configuration:
|
* `xgameruntime.lib`
|
||||||
|
* `../Microsoft.Xbox.Services.141.GDK.C.Thunks.lib`
|
||||||
* Under C/C++ > General > Additional Include Directories, make sure the `SDL/include` path is referenced
|
* Note that in general, the GDK libraries depend on the MSVC C/C++ runtime, so there is no way to remove this dependency from a GDK program that links against GDK.
|
||||||
* Under Linker > General > Additional Library Directories, make sure to reference the path where the newly-built SDL2.lib and SDL2main.lib are
|
|
||||||
* Under Linker > Input > Additional Dependencies, you need the following:
|
### 4. Setting up SDL_main ###
|
||||||
* `SDL2.lib`
|
|
||||||
* `SDL2main.lib` (unless not using)
|
Rather than using your own implementation of `WinMain`, it's recommended that you instead `#include "SDL_main.h"` and declare a standard main function. If you are unable to do this, you can instead manually call `SDL_GDKRunApp` from your entry point, passing in your `SDL_main` function and `NULL` as the parameters.
|
||||||
* `xgameruntime.lib`
|
|
||||||
* `../Microsoft.Xbox.Services.141.GDK.C.Thunks.lib`
|
### 5. Required DLLs ###
|
||||||
* Note that in general, the GDK libraries depend on the MSVC C/C++ runtime, so there is no way to remove this dependency from a GDK program that links against GDK.
|
|
||||||
|
The game will not launch in the debugger unless required DLLs are included in the directory that contains the game's .exe file. You need to make sure that the following files are copied into the directory:
|
||||||
### 4. Setting up SDL_main ###
|
|
||||||
|
* Your SDL2.dll
|
||||||
Rather than using your own implementation of `WinMain`, it's recommended that you instead `#include "SDL_main.h"` and declare a standard main function. If you are unable to do this, you can instead manually call `SDL_GDKRunApp` from your entry point, passing in your `SDL_main` function and `NULL` as the parameters.
|
* "$(Console_GRDKExtLibRoot)Xbox.Services.API.C\DesignTime\CommonConfiguration\Neutral\Lib\Release\Microsoft.Xbox.Services.141.GDK.C.Thunks.dll"
|
||||||
|
* XCurl.dll
|
||||||
### 5. Required DLLs ###
|
|
||||||
|
You can either copy these in a post-build step, or you can add the dlls into the project and set its Configuration Properties > General > Item type to "Copy file," which will also copy them into the output directory.
|
||||||
The game will not launch in the debugger unless required DLLs are included in the directory that contains the game's .exe file. You need to make sure that the following files are copied into the directory:
|
|
||||||
|
### 6. Setting up MicrosoftGame.config ###
|
||||||
* Your SDL2.dll
|
|
||||||
* "$(Console_GRDKExtLibRoot)Xbox.Services.API.C\DesignTime\CommonConfiguration\Neutral\Lib\Release\Microsoft.Xbox.Services.141.GDK.C.Thunks.dll"
|
You can copy `VisualC-GDK/tests/testgdk/MicrosoftGame.config` and use that as a starting point in your project. Minimally, you will want to change the Executable Name attribute, the DefaultDisplayName, and the Description.
|
||||||
* XCurl.dll
|
|
||||||
|
This file must be copied into the same directory as the game's .exe file. As with the DLLs, you can either use a post-build step or the "Copy file" item type.
|
||||||
You can either copy these in a post-build step, or you can add the dlls into the project and set its Configuration Properties > General > Item type to "Copy file," which will also copy them into the output directory.
|
|
||||||
|
For basic testing, you do not need to change anything else in `MicrosoftGame.config`. However, if you want to test any Xbox Live services (such as logging in users) _or_ publish a package, you will need to setup a Game app on Partner Center.
|
||||||
### 6. Setting up MicrosoftGame.config ###
|
|
||||||
|
Then, you need to set the following values to the values from Partner Center:
|
||||||
You can copy `VisualC-GDK/tests/testgdk/MicrosoftGame.config` and use that as a starting point in your project. Minimally, you will want to change the Executable Name attribute, the DefaultDisplayName, and the Description.
|
|
||||||
|
* Identity tag - Name and Publisher attributes
|
||||||
This file must be copied into the same directory as the game's .exe file. As with the DLLs, you can either use a post-build step or the "Copy file" item type.
|
* TitleId
|
||||||
|
* MSAAppId
|
||||||
For basic testing, you do not need to change anything else in `MicrosoftGame.config`. However, if you want to test any Xbox Live services (such as logging in users) _or_ publish a package, you will need to setup a Game app on Partner Center.
|
|
||||||
|
### 7. Adding Required Logos
|
||||||
Then, you need to set the following values to the values from Partner Center:
|
|
||||||
|
Several logo PNG files are required to be able to launch the game, even from the debugger. You can use the sample logos provided in `VisualC-GDK/logos`. As with the other files, they must be copied into the same directory as the game's .exe file.
|
||||||
* Identity tag - Name and Publisher attributes
|
|
||||||
* TitleId
|
|
||||||
* MSAAppId
|
### 8. Copying any Data Files ###
|
||||||
|
|
||||||
### 7. Adding Required Logos
|
When debugging GDK games, there is no way to specify a working directory. Therefore, any required game data must also be copied into the output directory, likely in a post-build step.
|
||||||
|
|
||||||
Several logo PNG files are required to be able to launch the game, even from the debugger. You can use the sample logos provided in `VisualC-GDK/logos`. As with the other files, they must be copied into the same directory as the game's .exe file.
|
|
||||||
|
### 9. Build and Run from Visual Studio ###
|
||||||
|
|
||||||
### 8. Copying any Data Files ###
|
At this point, you should be able to build and run your game from the Visual Studio Debugger. If you get any linker errors, make sure you double-check that you referenced all the required libs.
|
||||||
|
|
||||||
When debugging GDK games, there is no way to specify a working directory. Therefore, any required game data must also be copied into the output directory, likely in a post-build step.
|
If you are testing Xbox Live functionality, it's likely you will need to change to the Sandbox for your title. To do this:
|
||||||
|
|
||||||
|
1. Run "Desktop VS 2022 Gaming Command Prompt" from the Start Menu
|
||||||
### 9. Build and Run from Visual Studio ###
|
2. Switch the sandbox name with:
|
||||||
|
`XblPCSandbox SANDBOX.#`
|
||||||
At this point, you should be able to build and run your game from the Visual Studio Debugger. If you get any linker errors, make sure you double-check that you referenced all the required libs.
|
3. (To switch back to the retail sandbox):
|
||||||
|
`XblPCSandbox RETAIL`
|
||||||
If you are testing Xbox Live functionality, it's likely you will need to change to the Sandbox for your title. To do this:
|
|
||||||
|
### 10. Packaging and Installing Locally
|
||||||
1. Run "Desktop VS 2022 Gaming Command Prompt" from the Start Menu
|
|
||||||
2. Switch the sandbox name with:
|
You can use one of the test program's `PackageLayout.xml` as a starting point. Minimally, you will need to change the exe to the correct name and also reference any required game data. As with the other data files, it's easiest if you have this copy to the output directory, although it's not a requirement as you can specify relative paths to files.
|
||||||
`XblPCSandbox SANDBOX.#`
|
|
||||||
3. (To switch back to the retail sandbox):
|
To create the package:
|
||||||
`XblPCSandbox RETAIL`
|
|
||||||
|
1. Run "Desktop VS 2022 Gaming Command Prompt" from the Start Menu
|
||||||
### 10. Packaging and Installing Locally
|
2. `cd` to the directory containing the `PackageLayout.xml` with the correct paths (if you use the local path as in the sample package layout, this would be from your .exe output directory)
|
||||||
|
3. `mkdir Package` to create an output directory
|
||||||
You can use one of the test program's `PackageLayout.xml` as a starting point. Minimally, you will need to change the exe to the correct name and also reference any required game data. As with the other data files, it's easiest if you have this copy to the output directory, although it's not a requirement as you can specify relative paths to files.
|
4. To package the file into the `Package` directory, use:
|
||||||
|
`makepkg pack /f PackageLayout.xml /lt /d . /nogameos /pc /pd Package`
|
||||||
To create the package:
|
5. To install the package, use:
|
||||||
|
`wdapp install PACKAGENAME.msixvc`
|
||||||
1. Run "Desktop VS 2022 Gaming Command Prompt" from the Start Menu
|
6. Once the package is installed, you can run it from the start menu.
|
||||||
2. `cd` to the directory containing the `PackageLayout.xml` with the correct paths (if you use the local path as in the sample package layout, this would be from your .exe output directory)
|
7. As with when running from Visual Studio, if you need to test any Xbox Live functionality you must switch to the correct sandbox.
|
||||||
3. `mkdir Package` to create an output directory
|
|
||||||
4. To package the file into the `Package` directory, use:
|
|
||||||
`makepkg pack /f PackageLayout.xml /lt /d . /nogameos /pc /pd Package`
|
Troubleshooting
|
||||||
5. To install the package, use:
|
---------------
|
||||||
`wdapp install PACKAGENAME.msixvc`
|
|
||||||
6. Once the package is installed, you can run it from the start menu.
|
#### Xbox Live Login does not work
|
||||||
7. As with when running from Visual Studio, if you need to test any Xbox Live functionality you must switch to the correct sandbox.
|
|
||||||
|
As of June 2022 GDK, you must have a valid Title Id and MSAAppId in order to test Xbox Live functionality such as user login. Make sure these are set correctly in the `MicrosoftGame.config`. This means that even testgdk will not let you login without setting these properties to valid values.
|
||||||
Xbox GDKX Setup
|
|
||||||
---------------------
|
Furthermore, confirm that your PC is set to the correct sandbox.
|
||||||
In general, the same process in the Windows GDK instructions work. There are just a few additional notes:
|
|
||||||
* For Xbox One consoles, use the Gaming.Xbox.XboxOne.x64 target
|
|
||||||
* For Xbox Series consoles, use the Gaming.Xbox.Scarlett.x64 target
|
#### "The current user has already installed an unpackaged version of this app. A packaged version cannot replace this." error when installing
|
||||||
* The Xbox One target sets the `__XBOXONE__` define and the Xbox Series target sets the `__XBOXSERIES__` define
|
|
||||||
* You don't need to link against the Xbox.Services Thunks lib nor include that dll in your package (it doesn't exist for Xbox)
|
Prior to June 2022 GDK, running from the Visual Studio debugger would still locally register the app (and it would appear on the start menu). To fix this, you have to uninstall it (it's simplest to right click on it from the start menu to uninstall it).
|
||||||
* The shader blobs for Xbox are created in a pre-build step for the Xbox targets, rather than included in the source (due to NDA and version compatability reasons)
|
|
||||||
* To create a package, use:
|
|
||||||
`makepkg pack /f PackageLayout.xml /lt /d . /pd Package`
|
|
||||||
* To install the package, use:
|
|
||||||
`xbapp install [PACKAGE].xvc`
|
|
||||||
* For some reason, if you make changes that require SDL2.dll to build, and you are running through the debugger (instead of a package), you have to rebuild your .exe target for the debugger to recognize the dll has changed and needs to be transferred to the console again
|
|
||||||
* While there are successful releases of Xbox titles using this port, it is not as extensively tested as other targets
|
|
||||||
|
|
||||||
Troubleshooting
|
|
||||||
---------------
|
|
||||||
|
|
||||||
#### Xbox Live Login does not work
|
|
||||||
|
|
||||||
As of June 2022 GDK, you must have a valid Title Id and MSAAppId in order to test Xbox Live functionality such as user login. Make sure these are set correctly in the `MicrosoftGame.config`. This means that even testgdk will not let you login without setting these properties to valid values.
|
|
||||||
|
|
||||||
Furthermore, confirm that your PC is set to the correct sandbox.
|
|
||||||
|
|
||||||
|
|
||||||
#### "The current user has already installed an unpackaged version of this app. A packaged version cannot replace this." error when installing
|
|
||||||
|
|
||||||
Prior to June 2022 GDK, running from the Visual Studio debugger would still locally register the app (and it would appear on the start menu). To fix this, you have to uninstall it (it's simplest to right click on it from the start menu to uninstall it).
|
|
||||||
@@ -1,71 +1,71 @@
|
|||||||
Dollar Gestures
|
Dollar Gestures
|
||||||
===========================================================================
|
===========================================================================
|
||||||
SDL provides an implementation of the $1 gesture recognition system. This allows for recording, saving, loading, and performing single stroke gestures.
|
SDL provides an implementation of the $1 gesture recognition system. This allows for recording, saving, loading, and performing single stroke gestures.
|
||||||
|
|
||||||
Gestures can be performed with any number of fingers (the centroid of the fingers must follow the path of the gesture), but the number of fingers must be constant (a finger cannot go down in the middle of a gesture). The path of a gesture is considered the path from the time when the final finger went down, to the first time any finger comes up.
|
Gestures can be performed with any number of fingers (the centroid of the fingers must follow the path of the gesture), but the number of fingers must be constant (a finger cannot go down in the middle of a gesture). The path of a gesture is considered the path from the time when the final finger went down, to the first time any finger comes up.
|
||||||
|
|
||||||
Dollar gestures are assigned an Id based on a hash function. This is guaranteed to remain constant for a given gesture. There is a (small) chance that two different gestures will be assigned the same ID. In this case, simply re-recording one of the gestures should result in a different ID.
|
Dollar gestures are assigned an Id based on a hash function. This is guaranteed to remain constant for a given gesture. There is a (small) chance that two different gestures will be assigned the same ID. In this case, simply re-recording one of the gestures should result in a different ID.
|
||||||
|
|
||||||
Recording:
|
Recording:
|
||||||
----------
|
----------
|
||||||
To begin recording on a touch device call:
|
To begin recording on a touch device call:
|
||||||
SDL_RecordGesture(SDL_TouchID touchId), where touchId is the id of the touch device you wish to record on, or -1 to record on all connected devices.
|
SDL_RecordGesture(SDL_TouchID touchId), where touchId is the id of the touch device you wish to record on, or -1 to record on all connected devices.
|
||||||
|
|
||||||
Recording terminates as soon as a finger comes up. Recording is acknowledged by an SDL_DOLLARRECORD event.
|
Recording terminates as soon as a finger comes up. Recording is acknowledged by an SDL_DOLLARRECORD event.
|
||||||
A SDL_DOLLARRECORD event is a dgesture with the following fields:
|
A SDL_DOLLARRECORD event is a dgesture with the following fields:
|
||||||
|
|
||||||
* event.dgesture.touchId - the Id of the touch used to record the gesture.
|
* event.dgesture.touchId - the Id of the touch used to record the gesture.
|
||||||
* event.dgesture.gestureId - the unique id of the recorded gesture.
|
* event.dgesture.gestureId - the unique id of the recorded gesture.
|
||||||
|
|
||||||
|
|
||||||
Performing:
|
Performing:
|
||||||
-----------
|
-----------
|
||||||
As long as there is a dollar gesture assigned to a touch, every finger-up event will also cause an SDL_DOLLARGESTURE event with the following fields:
|
As long as there is a dollar gesture assigned to a touch, every finger-up event will also cause an SDL_DOLLARGESTURE event with the following fields:
|
||||||
|
|
||||||
* event.dgesture.touchId - the Id of the touch which performed the gesture.
|
* event.dgesture.touchId - the Id of the touch which performed the gesture.
|
||||||
* event.dgesture.gestureId - the unique id of the closest gesture to the performed stroke.
|
* event.dgesture.gestureId - the unique id of the closest gesture to the performed stroke.
|
||||||
* event.dgesture.error - the difference between the gesture template and the actual performed gesture. Lower error is a better match.
|
* event.dgesture.error - the difference between the gesture template and the actual performed gesture. Lower error is a better match.
|
||||||
* event.dgesture.numFingers - the number of fingers used to draw the stroke.
|
* event.dgesture.numFingers - the number of fingers used to draw the stroke.
|
||||||
|
|
||||||
Most programs will want to define an appropriate error threshold and check to be sure that the error of a gesture is not abnormally high (an indicator that no gesture was performed).
|
Most programs will want to define an appropriate error threshold and check to be sure that the error of a gesture is not abnormally high (an indicator that no gesture was performed).
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Saving:
|
Saving:
|
||||||
-------
|
-------
|
||||||
To save a template, call SDL_SaveDollarTemplate(gestureId, dst) where gestureId is the id of the gesture you want to save, and dst is an SDL_RWops pointer to the file where the gesture will be stored.
|
To save a template, call SDL_SaveDollarTemplate(gestureId, dst) where gestureId is the id of the gesture you want to save, and dst is an SDL_RWops pointer to the file where the gesture will be stored.
|
||||||
|
|
||||||
To save all currently loaded templates, call SDL_SaveAllDollarTemplates(dst) where dst is an SDL_RWops pointer to the file where the gesture will be stored.
|
To save all currently loaded templates, call SDL_SaveAllDollarTemplates(dst) where dst is an SDL_RWops pointer to the file where the gesture will be stored.
|
||||||
|
|
||||||
Both functions return the number of gestures successfully saved.
|
Both functions return the number of gestures successfully saved.
|
||||||
|
|
||||||
|
|
||||||
Loading:
|
Loading:
|
||||||
--------
|
--------
|
||||||
To load templates from a file, call SDL_LoadDollarTemplates(touchId,src) where touchId is the id of the touch to load to (or -1 to load to all touch devices), and src is an SDL_RWops pointer to a gesture save file.
|
To load templates from a file, call SDL_LoadDollarTemplates(touchId,src) where touchId is the id of the touch to load to (or -1 to load to all touch devices), and src is an SDL_RWops pointer to a gesture save file.
|
||||||
|
|
||||||
SDL_LoadDollarTemplates returns the number of templates successfully loaded.
|
SDL_LoadDollarTemplates returns the number of templates successfully loaded.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
===========================================================================
|
===========================================================================
|
||||||
Multi Gestures
|
Multi Gestures
|
||||||
===========================================================================
|
===========================================================================
|
||||||
SDL provides simple support for pinch/rotate/swipe gestures.
|
SDL provides simple support for pinch/rotate/swipe gestures.
|
||||||
Every time a finger is moved an SDL_MULTIGESTURE event is sent with the following fields:
|
Every time a finger is moved an SDL_MULTIGESTURE event is sent with the following fields:
|
||||||
|
|
||||||
* event.mgesture.touchId - the Id of the touch on which the gesture was performed.
|
* event.mgesture.touchId - the Id of the touch on which the gesture was performed.
|
||||||
* event.mgesture.x - the normalized x coordinate of the gesture. (0..1)
|
* event.mgesture.x - the normalized x coordinate of the gesture. (0..1)
|
||||||
* event.mgesture.y - the normalized y coordinate of the gesture. (0..1)
|
* event.mgesture.y - the normalized y coordinate of the gesture. (0..1)
|
||||||
* event.mgesture.dTheta - the amount that the fingers rotated during this motion.
|
* event.mgesture.dTheta - the amount that the fingers rotated during this motion.
|
||||||
* event.mgesture.dDist - the amount that the fingers pinched during this motion.
|
* event.mgesture.dDist - the amount that the fingers pinched during this motion.
|
||||||
* event.mgesture.numFingers - the number of fingers used in the gesture.
|
* event.mgesture.numFingers - the number of fingers used in the gesture.
|
||||||
|
|
||||||
|
|
||||||
===========================================================================
|
===========================================================================
|
||||||
Notes
|
Notes
|
||||||
===========================================================================
|
===========================================================================
|
||||||
For a complete example see test/testgesture.c
|
For a complete example see test/testgesture.c
|
||||||
|
|
||||||
Please direct questions/comments to:
|
Please direct questions/comments to:
|
||||||
jim.tla+sdl_touch@gmail.com
|
jim.tla+sdl_touch@gmail.com
|
||||||
@@ -1,19 +1,19 @@
|
|||||||
git
|
git
|
||||||
=========
|
=========
|
||||||
|
|
||||||
The latest development version of SDL is available via git.
|
The latest development version of SDL is available via git.
|
||||||
Git allows you to get up-to-the-minute fixes and enhancements;
|
Git allows you to get up-to-the-minute fixes and enhancements;
|
||||||
as a developer works on a source tree, you can use "git" to mirror that
|
as a developer works on a source tree, you can use "git" to mirror that
|
||||||
source tree instead of waiting for an official release. Please look
|
source tree instead of waiting for an official release. Please look
|
||||||
at the Git website ( https://git-scm.com/ ) for more
|
at the Git website ( https://git-scm.com/ ) for more
|
||||||
information on using git, where you can also download software for
|
information on using git, where you can also download software for
|
||||||
macOS, Windows, and Unix systems.
|
macOS, Windows, and Unix systems.
|
||||||
|
|
||||||
git clone https://github.com/libsdl-org/SDL
|
git clone https://github.com/libsdl-org/SDL
|
||||||
|
|
||||||
If you are building SDL via configure, you will need to run autogen.sh
|
If you are building SDL via configure, you will need to run autogen.sh
|
||||||
before running configure.
|
before running configure.
|
||||||
|
|
||||||
There is a web interface to the Git repository at:
|
There is a web interface to the Git repository at:
|
||||||
http://github.com/libsdl-org/SDL/
|
http://github.com/libsdl-org/SDL/
|
||||||
|
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
We are no longer hosted in Mercurial. Please see README-git.md for details.
|
We are no longer hosted in Mercurial. Please see README-git.md for details.
|
||||||
|
|
||||||
Thanks!
|
Thanks!
|
||||||
|
|
||||||
+307
-307
@@ -1,307 +1,307 @@
|
|||||||
iOS
|
iOS
|
||||||
======
|
======
|
||||||
|
|
||||||
Building the Simple DirectMedia Layer for iOS 9.0+
|
Building the Simple DirectMedia Layer for iOS 9.0+
|
||||||
==============================================================================
|
==============================================================================
|
||||||
|
|
||||||
Requirements: Mac OS X 10.9 or later and the iOS 9.0 or newer SDK.
|
Requirements: Mac OS X 10.9 or later and the iOS 9.0 or newer SDK.
|
||||||
|
|
||||||
Instructions:
|
Instructions:
|
||||||
|
|
||||||
1. Open SDL.xcodeproj (located in Xcode/SDL) in Xcode.
|
1. Open SDL.xcodeproj (located in Xcode/SDL) in Xcode.
|
||||||
2. Select your desired target, and hit build.
|
2. Select your desired target, and hit build.
|
||||||
|
|
||||||
|
|
||||||
Using the Simple DirectMedia Layer for iOS
|
Using the Simple DirectMedia Layer for iOS
|
||||||
==============================================================================
|
==============================================================================
|
||||||
|
|
||||||
1. Run Xcode and create a new project using the iOS Game template, selecting the Objective C language and Metal game technology.
|
1. Run Xcode and create a new project using the iOS Game template, selecting the Objective C language and Metal game technology.
|
||||||
2. In the main view, delete all files except for Assets and LaunchScreen
|
2. In the main view, delete all files except for Assets and LaunchScreen
|
||||||
3. Right click the project in the main view, select "Add Files...", and add the SDL project, Xcode/SDL/SDL.xcodeproj
|
3. Right click the project in the main view, select "Add Files...", and add the SDL project, Xcode/SDL/SDL.xcodeproj
|
||||||
4. Select the project in the main view, go to the "Info" tab and under "Custom iOS Target Properties" remove the line "Main storyboard file base name"
|
4. Select the project in the main view, go to the "Info" tab and under "Custom iOS Target Properties" remove the line "Main storyboard file base name"
|
||||||
5. Select the project in the main view, go to the "Build Settings" tab, select "All", and edit "Header Search Path" and drag over the SDL "Public Headers" folder from the left
|
5. Select the project in the main view, go to the "Build Settings" tab, select "All", and edit "Header Search Path" and drag over the SDL "Public Headers" folder from the left
|
||||||
6. Select the project in the main view, go to the "Build Phases" tab, select "Link Binary With Libraries", and add SDL2.framework from "Framework-iOS"
|
6. Select the project in the main view, go to the "Build Phases" tab, select "Link Binary With Libraries", and add SDL2.framework from "Framework-iOS"
|
||||||
7. Select the project in the main view, go to the "General" tab, scroll down to "Frameworks, Libraries, and Embedded Content", and select "Embed & Sign" for the SDL library.
|
7. Select the project in the main view, go to the "General" tab, scroll down to "Frameworks, Libraries, and Embedded Content", and select "Embed & Sign" for the SDL library.
|
||||||
8. In the main view, expand SDL -> Library Source -> main -> uikit and drag SDL_uikit_main.c into your game files
|
8. In the main view, expand SDL -> Library Source -> main -> uikit and drag SDL_uikit_main.c into your game files
|
||||||
9. Add the source files that you would normally have for an SDL program, making sure to have #include "SDL.h" at the top of the file containing your main() function.
|
9. Add the source files that you would normally have for an SDL program, making sure to have #include "SDL.h" at the top of the file containing your main() function.
|
||||||
10. Add any assets that your application needs.
|
10. Add any assets that your application needs.
|
||||||
11. Enjoy!
|
11. Enjoy!
|
||||||
|
|
||||||
|
|
||||||
TODO: Add information regarding App Store requirements such as icons, etc.
|
TODO: Add information regarding App Store requirements such as icons, etc.
|
||||||
|
|
||||||
|
|
||||||
Notes -- Retina / High-DPI and window sizes
|
Notes -- Retina / High-DPI and window sizes
|
||||||
==============================================================================
|
==============================================================================
|
||||||
|
|
||||||
Window and display mode sizes in SDL are in "screen coordinates" (or "points",
|
Window and display mode sizes in SDL are in "screen coordinates" (or "points",
|
||||||
in Apple's terminology) rather than in pixels. On iOS this means that a window
|
in Apple's terminology) rather than in pixels. On iOS this means that a window
|
||||||
created on an iPhone 6 will have a size in screen coordinates of 375 x 667,
|
created on an iPhone 6 will have a size in screen coordinates of 375 x 667,
|
||||||
rather than a size in pixels of 750 x 1334. All iOS apps are expected to
|
rather than a size in pixels of 750 x 1334. All iOS apps are expected to
|
||||||
size their content based on screen coordinates / points rather than pixels,
|
size their content based on screen coordinates / points rather than pixels,
|
||||||
as this allows different iOS devices to have different pixel densities
|
as this allows different iOS devices to have different pixel densities
|
||||||
(Retina versus non-Retina screens, etc.) without apps caring too much.
|
(Retina versus non-Retina screens, etc.) without apps caring too much.
|
||||||
|
|
||||||
By default SDL will not use the full pixel density of the screen on
|
By default SDL will not use the full pixel density of the screen on
|
||||||
Retina/high-dpi capable devices. Use the SDL_WINDOW_ALLOW_HIGHDPI flag when
|
Retina/high-dpi capable devices. Use the SDL_WINDOW_ALLOW_HIGHDPI flag when
|
||||||
creating your window to enable high-dpi support.
|
creating your window to enable high-dpi support.
|
||||||
|
|
||||||
When high-dpi support is enabled, SDL_GetWindowSize() and display mode sizes
|
When high-dpi support is enabled, SDL_GetWindowSize() and display mode sizes
|
||||||
will still be in "screen coordinates" rather than pixels, but the window will
|
will still be in "screen coordinates" rather than pixels, but the window will
|
||||||
have a much greater pixel density when the device supports it, and the
|
have a much greater pixel density when the device supports it, and the
|
||||||
SDL_GL_GetDrawableSize() or SDL_GetRendererOutputSize() functions (depending on
|
SDL_GL_GetDrawableSize() or SDL_GetRendererOutputSize() functions (depending on
|
||||||
whether raw OpenGL or the SDL_Render API is used) can be queried to determine
|
whether raw OpenGL or the SDL_Render API is used) can be queried to determine
|
||||||
the size in pixels of the drawable screen framebuffer.
|
the size in pixels of the drawable screen framebuffer.
|
||||||
|
|
||||||
Some OpenGL ES functions such as glViewport expect sizes in pixels rather than
|
Some OpenGL ES functions such as glViewport expect sizes in pixels rather than
|
||||||
sizes in screen coordinates. When doing 2D rendering with OpenGL ES, an
|
sizes in screen coordinates. When doing 2D rendering with OpenGL ES, an
|
||||||
orthographic projection matrix using the size in screen coordinates
|
orthographic projection matrix using the size in screen coordinates
|
||||||
(SDL_GetWindowSize()) can be used in order to display content at the same scale
|
(SDL_GetWindowSize()) can be used in order to display content at the same scale
|
||||||
no matter whether a Retina device is used or not.
|
no matter whether a Retina device is used or not.
|
||||||
|
|
||||||
|
|
||||||
Notes -- Application events
|
Notes -- Application events
|
||||||
==============================================================================
|
==============================================================================
|
||||||
|
|
||||||
On iOS the application goes through a fixed life cycle and you will get
|
On iOS the application goes through a fixed life cycle and you will get
|
||||||
notifications of state changes via application events. When these events
|
notifications of state changes via application events. When these events
|
||||||
are delivered you must handle them in an event callback because the OS may
|
are delivered you must handle them in an event callback because the OS may
|
||||||
not give you any processing time after the events are delivered.
|
not give you any processing time after the events are delivered.
|
||||||
|
|
||||||
e.g.
|
e.g.
|
||||||
|
|
||||||
int HandleAppEvents(void *userdata, SDL_Event *event)
|
int HandleAppEvents(void *userdata, SDL_Event *event)
|
||||||
{
|
{
|
||||||
switch (event->type)
|
switch (event->type)
|
||||||
{
|
{
|
||||||
case SDL_APP_TERMINATING:
|
case SDL_APP_TERMINATING:
|
||||||
/* Terminate the app.
|
/* Terminate the app.
|
||||||
Shut everything down before returning from this function.
|
Shut everything down before returning from this function.
|
||||||
*/
|
*/
|
||||||
return 0;
|
return 0;
|
||||||
case SDL_APP_LOWMEMORY:
|
case SDL_APP_LOWMEMORY:
|
||||||
/* You will get this when your app is paused and iOS wants more memory.
|
/* You will get this when your app is paused and iOS wants more memory.
|
||||||
Release as much memory as possible.
|
Release as much memory as possible.
|
||||||
*/
|
*/
|
||||||
return 0;
|
return 0;
|
||||||
case SDL_APP_WILLENTERBACKGROUND:
|
case SDL_APP_WILLENTERBACKGROUND:
|
||||||
/* Prepare your app to go into the background. Stop loops, etc.
|
/* Prepare your app to go into the background. Stop loops, etc.
|
||||||
This gets called when the user hits the home button, or gets a call.
|
This gets called when the user hits the home button, or gets a call.
|
||||||
*/
|
*/
|
||||||
return 0;
|
return 0;
|
||||||
case SDL_APP_DIDENTERBACKGROUND:
|
case SDL_APP_DIDENTERBACKGROUND:
|
||||||
/* This will get called if the user accepted whatever sent your app to the background.
|
/* This will get called if the user accepted whatever sent your app to the background.
|
||||||
If the user got a phone call and canceled it, you'll instead get an SDL_APP_DIDENTERFOREGROUND event and restart your loops.
|
If the user got a phone call and canceled it, you'll instead get an SDL_APP_DIDENTERFOREGROUND event and restart your loops.
|
||||||
When you get this, you have 5 seconds to save all your state or the app will be terminated.
|
When you get this, you have 5 seconds to save all your state or the app will be terminated.
|
||||||
Your app is NOT active at this point.
|
Your app is NOT active at this point.
|
||||||
*/
|
*/
|
||||||
return 0;
|
return 0;
|
||||||
case SDL_APP_WILLENTERFOREGROUND:
|
case SDL_APP_WILLENTERFOREGROUND:
|
||||||
/* This call happens when your app is coming back to the foreground.
|
/* This call happens when your app is coming back to the foreground.
|
||||||
Restore all your state here.
|
Restore all your state here.
|
||||||
*/
|
*/
|
||||||
return 0;
|
return 0;
|
||||||
case SDL_APP_DIDENTERFOREGROUND:
|
case SDL_APP_DIDENTERFOREGROUND:
|
||||||
/* Restart your loops here.
|
/* Restart your loops here.
|
||||||
Your app is interactive and getting CPU again.
|
Your app is interactive and getting CPU again.
|
||||||
*/
|
*/
|
||||||
return 0;
|
return 0;
|
||||||
default:
|
default:
|
||||||
/* No special processing, add it to the event queue */
|
/* No special processing, add it to the event queue */
|
||||||
return 1;
|
return 1;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
int main(int argc, char *argv[])
|
int main(int argc, char *argv[])
|
||||||
{
|
{
|
||||||
SDL_SetEventFilter(HandleAppEvents, NULL);
|
SDL_SetEventFilter(HandleAppEvents, NULL);
|
||||||
|
|
||||||
... run your main loop
|
... run your main loop
|
||||||
|
|
||||||
return 0;
|
return 0;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
Notes -- Accelerometer as Joystick
|
Notes -- Accelerometer as Joystick
|
||||||
==============================================================================
|
==============================================================================
|
||||||
|
|
||||||
SDL for iPhone supports polling the built in accelerometer as a joystick device. For an example on how to do this, see the accelerometer.c in the demos directory.
|
SDL for iPhone supports polling the built in accelerometer as a joystick device. For an example on how to do this, see the accelerometer.c in the demos directory.
|
||||||
|
|
||||||
The main thing to note when using the accelerometer with SDL is that while the iPhone natively reports accelerometer as floating point values in units of g-force, SDL_JoystickGetAxis() reports joystick values as signed integers. Hence, in order to convert between the two, some clamping and scaling is necessary on the part of the iPhone SDL joystick driver. To convert SDL_JoystickGetAxis() reported values BACK to units of g-force, simply multiply the values by SDL_IPHONE_MAX_GFORCE / 0x7FFF.
|
The main thing to note when using the accelerometer with SDL is that while the iPhone natively reports accelerometer as floating point values in units of g-force, SDL_JoystickGetAxis() reports joystick values as signed integers. Hence, in order to convert between the two, some clamping and scaling is necessary on the part of the iPhone SDL joystick driver. To convert SDL_JoystickGetAxis() reported values BACK to units of g-force, simply multiply the values by SDL_IPHONE_MAX_GFORCE / 0x7FFF.
|
||||||
|
|
||||||
|
|
||||||
Notes -- OpenGL ES
|
Notes -- OpenGL ES
|
||||||
==============================================================================
|
==============================================================================
|
||||||
|
|
||||||
Your SDL application for iOS uses OpenGL ES for video by default.
|
Your SDL application for iOS uses OpenGL ES for video by default.
|
||||||
|
|
||||||
OpenGL ES for iOS supports several display pixel formats, such as RGBA8 and RGB565, which provide a 32 bit and 16 bit color buffer respectively. By default, the implementation uses RGB565, but you may use RGBA8 by setting each color component to 8 bits in SDL_GL_SetAttribute().
|
OpenGL ES for iOS supports several display pixel formats, such as RGBA8 and RGB565, which provide a 32 bit and 16 bit color buffer respectively. By default, the implementation uses RGB565, but you may use RGBA8 by setting each color component to 8 bits in SDL_GL_SetAttribute().
|
||||||
|
|
||||||
If your application doesn't use OpenGL's depth buffer, you may find significant performance improvement by setting SDL_GL_DEPTH_SIZE to 0.
|
If your application doesn't use OpenGL's depth buffer, you may find significant performance improvement by setting SDL_GL_DEPTH_SIZE to 0.
|
||||||
|
|
||||||
Finally, if your application completely redraws the screen each frame, you may find significant performance improvement by setting the attribute SDL_GL_RETAINED_BACKING to 0.
|
Finally, if your application completely redraws the screen each frame, you may find significant performance improvement by setting the attribute SDL_GL_RETAINED_BACKING to 0.
|
||||||
|
|
||||||
OpenGL ES on iOS doesn't use the traditional system-framebuffer setup provided in other operating systems. Special care must be taken because of this:
|
OpenGL ES on iOS doesn't use the traditional system-framebuffer setup provided in other operating systems. Special care must be taken because of this:
|
||||||
|
|
||||||
- The drawable Renderbuffer must be bound to the GL_RENDERBUFFER binding point when SDL_GL_SwapWindow() is called.
|
- The drawable Renderbuffer must be bound to the GL_RENDERBUFFER binding point when SDL_GL_SwapWindow() is called.
|
||||||
- The drawable Framebuffer Object must be bound while rendering to the screen and when SDL_GL_SwapWindow() is called.
|
- The drawable Framebuffer Object must be bound while rendering to the screen and when SDL_GL_SwapWindow() is called.
|
||||||
- If multisample antialiasing (MSAA) is used and glReadPixels is used on the screen, the drawable framebuffer must be resolved to the MSAA resolve framebuffer (via glBlitFramebuffer or glResolveMultisampleFramebufferAPPLE), and the MSAA resolve framebuffer must be bound to the GL_READ_FRAMEBUFFER binding point, before glReadPixels is called.
|
- If multisample antialiasing (MSAA) is used and glReadPixels is used on the screen, the drawable framebuffer must be resolved to the MSAA resolve framebuffer (via glBlitFramebuffer or glResolveMultisampleFramebufferAPPLE), and the MSAA resolve framebuffer must be bound to the GL_READ_FRAMEBUFFER binding point, before glReadPixels is called.
|
||||||
|
|
||||||
The above objects can be obtained via SDL_GetWindowWMInfo() (in SDL_syswm.h).
|
The above objects can be obtained via SDL_GetWindowWMInfo() (in SDL_syswm.h).
|
||||||
|
|
||||||
|
|
||||||
Notes -- Keyboard
|
Notes -- Keyboard
|
||||||
==============================================================================
|
==============================================================================
|
||||||
|
|
||||||
The SDL keyboard API has been extended to support on-screen keyboards:
|
The SDL keyboard API has been extended to support on-screen keyboards:
|
||||||
|
|
||||||
void SDL_StartTextInput()
|
void SDL_StartTextInput()
|
||||||
-- enables text events and reveals the onscreen keyboard.
|
-- enables text events and reveals the onscreen keyboard.
|
||||||
|
|
||||||
void SDL_StopTextInput()
|
void SDL_StopTextInput()
|
||||||
-- disables text events and hides the onscreen keyboard.
|
-- disables text events and hides the onscreen keyboard.
|
||||||
|
|
||||||
SDL_bool SDL_IsTextInputActive()
|
SDL_bool SDL_IsTextInputActive()
|
||||||
-- returns whether or not text events are enabled (and the onscreen keyboard is visible)
|
-- returns whether or not text events are enabled (and the onscreen keyboard is visible)
|
||||||
|
|
||||||
|
|
||||||
Notes -- Mouse
|
Notes -- Mouse
|
||||||
==============================================================================
|
==============================================================================
|
||||||
|
|
||||||
iOS now supports Bluetooth mice on iPad, but by default will provide the mouse input as touch. In order for SDL to see the real mouse events, you should set the key UIApplicationSupportsIndirectInputEvents to true in your Info.plist
|
iOS now supports Bluetooth mice on iPad, but by default will provide the mouse input as touch. In order for SDL to see the real mouse events, you should set the key UIApplicationSupportsIndirectInputEvents to true in your Info.plist
|
||||||
|
|
||||||
|
|
||||||
Notes -- Reading and Writing files
|
Notes -- Reading and Writing files
|
||||||
==============================================================================
|
==============================================================================
|
||||||
|
|
||||||
Each application installed on iPhone resides in a sandbox which includes its own Application Home directory. Your application may not access files outside this directory.
|
Each application installed on iPhone resides in a sandbox which includes its own Application Home directory. Your application may not access files outside this directory.
|
||||||
|
|
||||||
Once your application is installed its directory tree looks like:
|
Once your application is installed its directory tree looks like:
|
||||||
|
|
||||||
MySDLApp Home/
|
MySDLApp Home/
|
||||||
MySDLApp.app
|
MySDLApp.app
|
||||||
Documents/
|
Documents/
|
||||||
Library/
|
Library/
|
||||||
Preferences/
|
Preferences/
|
||||||
tmp/
|
tmp/
|
||||||
|
|
||||||
When your SDL based iPhone application starts up, it sets the working directory to the main bundle (MySDLApp Home/MySDLApp.app), where your application resources are stored. You cannot write to this directory. Instead, I advise you to write document files to "../Documents/" and preferences to "../Library/Preferences".
|
When your SDL based iPhone application starts up, it sets the working directory to the main bundle (MySDLApp Home/MySDLApp.app), where your application resources are stored. You cannot write to this directory. Instead, I advise you to write document files to "../Documents/" and preferences to "../Library/Preferences".
|
||||||
|
|
||||||
More information on this subject is available here:
|
More information on this subject is available here:
|
||||||
http://developer.apple.com/library/ios/#documentation/iPhone/Conceptual/iPhoneOSProgrammingGuide/Introduction/Introduction.html
|
http://developer.apple.com/library/ios/#documentation/iPhone/Conceptual/iPhoneOSProgrammingGuide/Introduction/Introduction.html
|
||||||
|
|
||||||
|
|
||||||
Notes -- xcFramework
|
Notes -- xcFramework
|
||||||
==============================================================================
|
==============================================================================
|
||||||
|
|
||||||
The SDL.xcodeproj file now includes a target to build SDL2.xcframework. An xcframework is a new (Xcode 11) uber-framework which can handle any combination of processor type and target OS platform.
|
The SDL.xcodeproj file now includes a target to build SDL2.xcframework. An xcframework is a new (Xcode 11) uber-framework which can handle any combination of processor type and target OS platform.
|
||||||
|
|
||||||
In the past, iOS devices were always an ARM variant processor, and the simulator was always i386 or x86_64, and thus libraries could be combined into a single framework for both simulator and device. With the introduction of the Apple Silicon ARM-based machines, regular frameworks would collide as CPU type was no longer sufficient to differentiate the platform. So Apple created the new xcframework library package.
|
In the past, iOS devices were always an ARM variant processor, and the simulator was always i386 or x86_64, and thus libraries could be combined into a single framework for both simulator and device. With the introduction of the Apple Silicon ARM-based machines, regular frameworks would collide as CPU type was no longer sufficient to differentiate the platform. So Apple created the new xcframework library package.
|
||||||
|
|
||||||
The xcframework target builds into a Products directory alongside the SDL.xcodeproj file, as SDL2.xcframework. This can be brought in to any iOS project and will function properly for both simulator and device, no matter their CPUs. Note that Intel Macs cannot cross-compile for Apple Silicon Macs. If you need AS compatibility, perform this build on an Apple Silicon Mac.
|
The xcframework target builds into a Products directory alongside the SDL.xcodeproj file, as SDL2.xcframework. This can be brought in to any iOS project and will function properly for both simulator and device, no matter their CPUs. Note that Intel Macs cannot cross-compile for Apple Silicon Macs. If you need AS compatibility, perform this build on an Apple Silicon Mac.
|
||||||
|
|
||||||
This target requires Xcode 11 or later. The target will simply fail to build if attempted on older Xcodes.
|
This target requires Xcode 11 or later. The target will simply fail to build if attempted on older Xcodes.
|
||||||
|
|
||||||
In addition, on Apple platforms, main() cannot be in a dynamically loaded library. This means that iOS apps which used the statically-linked libSDL2.lib and now link with the xcframwork will need to define their own main() to call SDL_UIKitRunApp(), like this:
|
In addition, on Apple platforms, main() cannot be in a dynamically loaded library. This means that iOS apps which used the statically-linked libSDL2.lib and now link with the xcframwork will need to define their own main() to call SDL_UIKitRunApp(), like this:
|
||||||
|
|
||||||
#ifndef SDL_MAIN_HANDLED
|
#ifndef SDL_MAIN_HANDLED
|
||||||
#ifdef main
|
#ifdef main
|
||||||
#undef main
|
#undef main
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
int
|
int
|
||||||
main(int argc, char *argv[])
|
main(int argc, char *argv[])
|
||||||
{
|
{
|
||||||
return SDL_UIKitRunApp(argc, argv, SDL_main);
|
return SDL_UIKitRunApp(argc, argv, SDL_main);
|
||||||
}
|
}
|
||||||
#endif /* !SDL_MAIN_HANDLED */
|
#endif /* !SDL_MAIN_HANDLED */
|
||||||
|
|
||||||
Using an xcFramework is similar to using a regular framework. However, issues have been seen with the build system not seeing the headers in the xcFramework. To remedy this, add the path to the xcFramework in your app's target ==> Build Settings ==> Framework Search Paths and mark it recursive (this is critical). Also critical is to remove "*.framework" from Build Settings ==> Sub-Directories to Exclude in Recursive Searches. Clean the build folder, and on your next build the build system should be able to see any of these in your code, as expected:
|
Using an xcFramework is similar to using a regular framework. However, issues have been seen with the build system not seeing the headers in the xcFramework. To remedy this, add the path to the xcFramework in your app's target ==> Build Settings ==> Framework Search Paths and mark it recursive (this is critical). Also critical is to remove "*.framework" from Build Settings ==> Sub-Directories to Exclude in Recursive Searches. Clean the build folder, and on your next build the build system should be able to see any of these in your code, as expected:
|
||||||
|
|
||||||
#include "SDL_main.h"
|
#include "SDL_main.h"
|
||||||
#include <SDL.h>
|
#include <SDL.h>
|
||||||
#include <SDL_main.h>
|
#include <SDL_main.h>
|
||||||
|
|
||||||
|
|
||||||
Notes -- iPhone SDL limitations
|
Notes -- iPhone SDL limitations
|
||||||
==============================================================================
|
==============================================================================
|
||||||
|
|
||||||
Windows:
|
Windows:
|
||||||
Full-size, single window applications only. You cannot create multi-window SDL applications for iPhone OS. The application window will fill the display, though you have the option of turning on or off the menu-bar (pass SDL_CreateWindow() the flag SDL_WINDOW_BORDERLESS).
|
Full-size, single window applications only. You cannot create multi-window SDL applications for iPhone OS. The application window will fill the display, though you have the option of turning on or off the menu-bar (pass SDL_CreateWindow() the flag SDL_WINDOW_BORDERLESS).
|
||||||
|
|
||||||
Textures:
|
Textures:
|
||||||
The optimal texture formats on iOS are SDL_PIXELFORMAT_ABGR8888, SDL_PIXELFORMAT_ABGR8888, SDL_PIXELFORMAT_BGR888, and SDL_PIXELFORMAT_RGB24 pixel formats.
|
The optimal texture formats on iOS are SDL_PIXELFORMAT_ABGR8888, SDL_PIXELFORMAT_ABGR8888, SDL_PIXELFORMAT_BGR888, and SDL_PIXELFORMAT_RGB24 pixel formats.
|
||||||
|
|
||||||
Loading Shared Objects:
|
Loading Shared Objects:
|
||||||
This is disabled by default since it seems to break the terms of the iOS SDK agreement for iOS versions prior to iOS 8. It can be re-enabled in SDL_config_iphoneos.h.
|
This is disabled by default since it seems to break the terms of the iOS SDK agreement for iOS versions prior to iOS 8. It can be re-enabled in SDL_config_iphoneos.h.
|
||||||
|
|
||||||
|
|
||||||
Notes -- CoreBluetooth.framework
|
Notes -- CoreBluetooth.framework
|
||||||
==============================================================================
|
==============================================================================
|
||||||
|
|
||||||
SDL_JOYSTICK_HIDAPI is disabled by default. It can give you access to a lot
|
SDL_JOYSTICK_HIDAPI is disabled by default. It can give you access to a lot
|
||||||
more game controller devices, but it requires permission from the user before
|
more game controller devices, but it requires permission from the user before
|
||||||
your app will be able to talk to the Bluetooth hardware. "Made For iOS"
|
your app will be able to talk to the Bluetooth hardware. "Made For iOS"
|
||||||
branded controllers do not need this as we don't have to speak to them
|
branded controllers do not need this as we don't have to speak to them
|
||||||
directly with raw bluetooth, so many apps can live without this.
|
directly with raw bluetooth, so many apps can live without this.
|
||||||
|
|
||||||
You'll need to link with CoreBluetooth.framework and add something like this
|
You'll need to link with CoreBluetooth.framework and add something like this
|
||||||
to your Info.plist:
|
to your Info.plist:
|
||||||
|
|
||||||
<key>NSBluetoothPeripheralUsageDescription</key>
|
<key>NSBluetoothPeripheralUsageDescription</key>
|
||||||
<string>MyApp would like to remain connected to nearby bluetooth Game Controllers and Game Pads even when you're not using the app.</string>
|
<string>MyApp would like to remain connected to nearby bluetooth Game Controllers and Game Pads even when you're not using the app.</string>
|
||||||
|
|
||||||
|
|
||||||
Game Center
|
Game Center
|
||||||
==============================================================================
|
==============================================================================
|
||||||
|
|
||||||
Game Center integration might require that you break up your main loop in order to yield control back to the system. In other words, instead of running an endless main loop, you run each frame in a callback function, using:
|
Game Center integration might require that you break up your main loop in order to yield control back to the system. In other words, instead of running an endless main loop, you run each frame in a callback function, using:
|
||||||
|
|
||||||
int SDL_iPhoneSetAnimationCallback(SDL_Window * window, int interval, SDL_iOSAnimationCallback callback, void *callbackParam);
|
int SDL_iPhoneSetAnimationCallback(SDL_Window * window, int interval, void (*callback)(void*), void *callbackParam);
|
||||||
|
|
||||||
This will set up the given function to be called back on the animation callback, and then you have to return from main() to let the Cocoa event loop run.
|
This will set up the given function to be called back on the animation callback, and then you have to return from main() to let the Cocoa event loop run.
|
||||||
|
|
||||||
e.g.
|
e.g.
|
||||||
|
|
||||||
extern "C"
|
extern "C"
|
||||||
void ShowFrame(void*)
|
void ShowFrame(void*)
|
||||||
{
|
{
|
||||||
... do event handling, frame logic and rendering ...
|
... do event handling, frame logic and rendering ...
|
||||||
}
|
}
|
||||||
|
|
||||||
int main(int argc, char *argv[])
|
int main(int argc, char *argv[])
|
||||||
{
|
{
|
||||||
... initialize game ...
|
... initialize game ...
|
||||||
|
|
||||||
#ifdef __IPHONEOS__
|
#if __IPHONEOS__
|
||||||
// Initialize the Game Center for scoring and matchmaking
|
// Initialize the Game Center for scoring and matchmaking
|
||||||
InitGameCenter();
|
InitGameCenter();
|
||||||
|
|
||||||
// Set up the game to run in the window animation callback on iOS
|
// Set up the game to run in the window animation callback on iOS
|
||||||
// so that Game Center and so forth works correctly.
|
// so that Game Center and so forth works correctly.
|
||||||
SDL_iPhoneSetAnimationCallback(window, 1, ShowFrame, NULL);
|
SDL_iPhoneSetAnimationCallback(window, 1, ShowFrame, NULL);
|
||||||
#else
|
#else
|
||||||
while ( running ) {
|
while ( running ) {
|
||||||
ShowFrame(0);
|
ShowFrame(0);
|
||||||
DelayFrame();
|
DelayFrame();
|
||||||
}
|
}
|
||||||
#endif
|
#endif
|
||||||
return 0;
|
return 0;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
Deploying to older versions of iOS
|
Deploying to older versions of iOS
|
||||||
==============================================================================
|
==============================================================================
|
||||||
|
|
||||||
SDL supports deploying to older versions of iOS than are supported by the latest version of Xcode, all the way back to iOS 8.0
|
SDL supports deploying to older versions of iOS than are supported by the latest version of Xcode, all the way back to iOS 8.0
|
||||||
|
|
||||||
In order to do that you need to download an older version of Xcode:
|
In order to do that you need to download an older version of Xcode:
|
||||||
https://developer.apple.com/download/more/?name=Xcode
|
https://developer.apple.com/download/more/?name=Xcode
|
||||||
|
|
||||||
Open the package contents of the older Xcode and your newer version of Xcode and copy over the folders in Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform/DeviceSupport
|
Open the package contents of the older Xcode and your newer version of Xcode and copy over the folders in Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform/DeviceSupport
|
||||||
|
|
||||||
Then open the file Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS.sdk/SDKSettings.plist and add the versions of iOS you want to deploy to the key Root/DefaultProperties/DEPLOYMENT_TARGET_SUGGESTED_VALUES
|
Then open the file Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS.sdk/SDKSettings.plist and add the versions of iOS you want to deploy to the key Root/DefaultProperties/DEPLOYMENT_TARGET_SUGGESTED_VALUES
|
||||||
|
|
||||||
Open your project and set your deployment target to the desired version of iOS
|
Open your project and set your deployment target to the desired version of iOS
|
||||||
|
|
||||||
Finally, remove GameController from the list of frameworks linked by your application and edit the build settings for "Other Linker Flags" and add -weak_framework GameController
|
Finally, remove GameController from the list of frameworks linked by your application and edit the build settings for "Other Linker Flags" and add -weak_framework GameController
|
||||||
@@ -1,27 +1,27 @@
|
|||||||
KMSDRM on *BSD
|
KMSDRM on *BSD
|
||||||
==================================================
|
==================================================
|
||||||
|
|
||||||
KMSDRM is supported on FreeBSD and OpenBSD. DragonFlyBSD works but requires being a root user. NetBSD isn't supported yet because the application will crash when creating the KMSDRM screen.
|
KMSDRM is supported on FreeBSD and OpenBSD. DragonFlyBSD works but requires being a root user. NetBSD isn't supported yet because the application will crash when creating the KMSDRM screen.
|
||||||
|
|
||||||
WSCONS support has been brought back, but only as an input backend. It will not be brought back as a video backend to ease maintenance.
|
WSCONS support has been brought back, but only as an input backend. It will not be brought back as a video backend to ease maintenance.
|
||||||
|
|
||||||
OpenBSD note: Note that the video backend assumes that the user has read/write permissions to the /dev/drm* devices.
|
OpenBSD note: Note that the video backend assumes that the user has read/write permissions to the /dev/drm* devices.
|
||||||
|
|
||||||
|
|
||||||
SDL2 WSCONS input backend features
|
SDL2 WSCONS input backend features
|
||||||
===================================================
|
===================================================
|
||||||
1. It is keymap-aware; it will work properly with different keymaps.
|
1. It is keymap-aware; it will work properly with different keymaps.
|
||||||
2. It has mouse support.
|
2. It has mouse support.
|
||||||
3. Accent input is supported.
|
3. Accent input is supported.
|
||||||
4. Compose keys are supported.
|
4. Compose keys are supported.
|
||||||
5. AltGr and Meta Shift keys work as intended.
|
5. AltGr and Meta Shift keys work as intended.
|
||||||
|
|
||||||
Partially working or no input on OpenBSD/NetBSD.
|
Partially working or no input on OpenBSD/NetBSD.
|
||||||
==================================================
|
==================================================
|
||||||
|
|
||||||
The WSCONS input backend needs read/write access to the /dev/wskbd* devices, without which it will not work properly. /dev/wsmouse must also be read/write accessible, otherwise mouse input will not work.
|
The WSCONS input backend needs read/write access to the /dev/wskbd* devices, without which it will not work properly. /dev/wsmouse must also be read/write accessible, otherwise mouse input will not work.
|
||||||
|
|
||||||
Partially working or no input on FreeBSD.
|
Partially working or no input on FreeBSD.
|
||||||
==================================================
|
==================================================
|
||||||
|
|
||||||
The evdev devices are only accessible to the root user by default. Edit devfs rules to allow access to such devices. The /dev/kbd* devices are also only accessible to the root user by default. Edit devfs rules to allow access to such devices.
|
The evdev devices are only accessible to the root user by default. Edit devfs rules to allow access to such devices. The /dev/kbd* devices are also only accessible to the root user by default. Edit devfs rules to allow access to such devices.
|
||||||
@@ -1,96 +1,96 @@
|
|||||||
Linux
|
Linux
|
||||||
================================================================================
|
================================================================================
|
||||||
|
|
||||||
By default SDL will only link against glibc, the rest of the features will be
|
By default SDL will only link against glibc, the rest of the features will be
|
||||||
enabled dynamically at runtime depending on the available features on the target
|
enabled dynamically at runtime depending on the available features on the target
|
||||||
system. So, for example if you built SDL with XRandR support and the target
|
system. So, for example if you built SDL with XRandR support and the target
|
||||||
system does not have the XRandR libraries installed, it will be disabled
|
system does not have the XRandR libraries installed, it will be disabled
|
||||||
at runtime, and you won't get a missing library error, at least with the
|
at runtime, and you won't get a missing library error, at least with the
|
||||||
default configuration parameters.
|
default configuration parameters.
|
||||||
|
|
||||||
|
|
||||||
Build Dependencies
|
Build Dependencies
|
||||||
--------------------------------------------------------------------------------
|
--------------------------------------------------------------------------------
|
||||||
|
|
||||||
Ubuntu 18.04, all available features enabled:
|
Ubuntu 18.04, all available features enabled:
|
||||||
|
|
||||||
sudo apt-get install build-essential git make autoconf automake libtool \
|
sudo apt-get install build-essential git make autoconf automake libtool \
|
||||||
pkg-config cmake ninja-build gnome-desktop-testing libasound2-dev libpulse-dev \
|
pkg-config cmake ninja-build gnome-desktop-testing libasound2-dev libpulse-dev \
|
||||||
libaudio-dev libjack-dev libsndio-dev libsamplerate0-dev libx11-dev libxext-dev \
|
libaudio-dev libjack-dev libsndio-dev libsamplerate0-dev libx11-dev libxext-dev \
|
||||||
libxrandr-dev libxcursor-dev libxfixes-dev libxi-dev libxss-dev libwayland-dev \
|
libxrandr-dev libxcursor-dev libxfixes-dev libxi-dev libxss-dev libwayland-dev \
|
||||||
libxkbcommon-dev libdrm-dev libgbm-dev libgl1-mesa-dev libgles2-mesa-dev \
|
libxkbcommon-dev libdrm-dev libgbm-dev libgl1-mesa-dev libgles2-mesa-dev \
|
||||||
libegl1-mesa-dev libdbus-1-dev libibus-1.0-dev libudev-dev fcitx-libs-dev
|
libegl1-mesa-dev libdbus-1-dev libibus-1.0-dev libudev-dev fcitx-libs-dev
|
||||||
|
|
||||||
Ubuntu 22.04+ can also add `libpipewire-0.3-dev libdecor-0-dev` to that command line.
|
Ubuntu 22.04+ can also add `libpipewire-0.3-dev libdecor-0-dev` to that command line.
|
||||||
|
|
||||||
Fedora 35, all available features enabled:
|
Fedora 35, all available features enabled:
|
||||||
|
|
||||||
sudo yum install gcc git-core make cmake autoconf automake libtool \
|
sudo yum install gcc git-core make cmake autoconf automake libtool \
|
||||||
alsa-lib-devel pulseaudio-libs-devel nas-devel pipewire-devel \
|
alsa-lib-devel pulseaudio-libs-devel nas-devel pipewire-devel \
|
||||||
libX11-devel libXext-devel libXrandr-devel libXcursor-devel libXfixes-devel \
|
libX11-devel libXext-devel libXrandr-devel libXcursor-devel libXfixes-devel \
|
||||||
libXi-devel libXScrnSaver-devel dbus-devel ibus-devel fcitx-devel \
|
libXi-devel libXScrnSaver-devel dbus-devel ibus-devel fcitx-devel \
|
||||||
systemd-devel mesa-libGL-devel libxkbcommon-devel mesa-libGLES-devel \
|
systemd-devel mesa-libGL-devel libxkbcommon-devel mesa-libGLES-devel \
|
||||||
mesa-libEGL-devel vulkan-devel wayland-devel wayland-protocols-devel \
|
mesa-libEGL-devel vulkan-devel wayland-devel wayland-protocols-devel \
|
||||||
libdrm-devel mesa-libgbm-devel libusb-devel libdecor-devel \
|
libdrm-devel mesa-libgbm-devel libusb-devel libdecor-devel \
|
||||||
libsamplerate-devel pipewire-jack-audio-connection-kit-devel \
|
libsamplerate-devel pipewire-jack-audio-connection-kit-devel \
|
||||||
|
|
||||||
NOTES:
|
NOTES:
|
||||||
- This includes all the audio targets except arts and esd, because Ubuntu
|
- This includes all the audio targets except arts and esd, because Ubuntu
|
||||||
(and/or Debian) pulled their packages, but in theory SDL still supports them.
|
(and/or Debian) pulled their packages, but in theory SDL still supports them.
|
||||||
The sndio audio target is also unavailable on Fedora.
|
The sndio audio target is also unavailable on Fedora.
|
||||||
- libsamplerate0-dev lets SDL optionally link to libresamplerate at runtime
|
- libsamplerate0-dev lets SDL optionally link to libresamplerate at runtime
|
||||||
for higher-quality audio resampling. SDL will work without it if the library
|
for higher-quality audio resampling. SDL will work without it if the library
|
||||||
is missing, so it's safe to build in support even if the end user doesn't
|
is missing, so it's safe to build in support even if the end user doesn't
|
||||||
have this library installed.
|
have this library installed.
|
||||||
- DirectFB isn't included because the configure script (currently) fails to find
|
- DirectFB isn't included because the configure script (currently) fails to find
|
||||||
it at all. You can do "sudo apt-get install libdirectfb-dev" and fix the
|
it at all. You can do "sudo apt-get install libdirectfb-dev" and fix the
|
||||||
configure script to include DirectFB support. Send patches. :)
|
configure script to include DirectFB support. Send patches. :)
|
||||||
|
|
||||||
|
|
||||||
Joystick does not work
|
Joystick does not work
|
||||||
--------------------------------------------------------------------------------
|
--------------------------------------------------------------------------------
|
||||||
|
|
||||||
If you compiled or are using a version of SDL with udev support (and you should!)
|
If you compiled or are using a version of SDL with udev support (and you should!)
|
||||||
there's a few issues that may cause SDL to fail to detect your joystick. To
|
there's a few issues that may cause SDL to fail to detect your joystick. To
|
||||||
debug this, start by installing the evtest utility. On Ubuntu/Debian:
|
debug this, start by installing the evtest utility. On Ubuntu/Debian:
|
||||||
|
|
||||||
sudo apt-get install evtest
|
sudo apt-get install evtest
|
||||||
|
|
||||||
Then run:
|
Then run:
|
||||||
|
|
||||||
sudo evtest
|
sudo evtest
|
||||||
|
|
||||||
You'll hopefully see your joystick listed along with a name like "/dev/input/eventXX"
|
You'll hopefully see your joystick listed along with a name like "/dev/input/eventXX"
|
||||||
Now run:
|
Now run:
|
||||||
|
|
||||||
cat /dev/input/event/XX
|
cat /dev/input/event/XX
|
||||||
|
|
||||||
If you get a permission error, you need to set a udev rule to change the mode of
|
If you get a permission error, you need to set a udev rule to change the mode of
|
||||||
your device (see below)
|
your device (see below)
|
||||||
|
|
||||||
Also, try:
|
Also, try:
|
||||||
|
|
||||||
sudo udevadm info --query=all --name=input/eventXX
|
sudo udevadm info --query=all --name=input/eventXX
|
||||||
|
|
||||||
If you see a line stating ID_INPUT_JOYSTICK=1, great, if you don't see it,
|
If you see a line stating ID_INPUT_JOYSTICK=1, great, if you don't see it,
|
||||||
you need to set up an udev rule to force this variable.
|
you need to set up an udev rule to force this variable.
|
||||||
|
|
||||||
A combined rule for the Saitek Pro Flight Rudder Pedals to fix both issues looks
|
A combined rule for the Saitek Pro Flight Rudder Pedals to fix both issues looks
|
||||||
like:
|
like:
|
||||||
|
|
||||||
SUBSYSTEM=="input", ATTRS{idProduct}=="0763", ATTRS{idVendor}=="06a3", MODE="0666", ENV{ID_INPUT_JOYSTICK}="1"
|
SUBSYSTEM=="input", ATTRS{idProduct}=="0763", ATTRS{idVendor}=="06a3", MODE="0666", ENV{ID_INPUT_JOYSTICK}="1"
|
||||||
SUBSYSTEM=="input", ATTRS{idProduct}=="0764", ATTRS{idVendor}=="06a3", MODE="0666", ENV{ID_INPUT_JOYSTICK}="1"
|
SUBSYSTEM=="input", ATTRS{idProduct}=="0764", ATTRS{idVendor}=="06a3", MODE="0666", ENV{ID_INPUT_JOYSTICK}="1"
|
||||||
|
|
||||||
You can set up similar rules for your device by changing the values listed in
|
You can set up similar rules for your device by changing the values listed in
|
||||||
idProduct and idVendor. To obtain these values, try:
|
idProduct and idVendor. To obtain these values, try:
|
||||||
|
|
||||||
sudo udevadm info -a --name=input/eventXX | grep idVendor
|
sudo udevadm info -a --name=input/eventXX | grep idVendor
|
||||||
sudo udevadm info -a --name=input/eventXX | grep idProduct
|
sudo udevadm info -a --name=input/eventXX | grep idProduct
|
||||||
|
|
||||||
If multiple values come up for each of these, the one you want is the first one of each.
|
If multiple values come up for each of these, the one you want is the first one of each.
|
||||||
|
|
||||||
On other systems which ship with an older udev (such as CentOS), you may need
|
On other systems which ship with an older udev (such as CentOS), you may need
|
||||||
to set up a rule such as:
|
to set up a rule such as:
|
||||||
|
|
||||||
SUBSYSTEM=="input", ENV{ID_CLASS}=="joystick", ENV{ID_INPUT_JOYSTICK}="1"
|
SUBSYSTEM=="input", ENV{ID_CLASS}=="joystick", ENV{ID_INPUT_JOYSTICK}="1"
|
||||||
|
|
||||||
+285
-285
@@ -1,285 +1,285 @@
|
|||||||
# Mac OS X (aka macOS).
|
# Mac OS X (aka macOS).
|
||||||
|
|
||||||
These instructions are for people using Apple's Mac OS X (pronounced
|
These instructions are for people using Apple's Mac OS X (pronounced
|
||||||
"ten"), which in newer versions is just referred to as "macOS".
|
"ten"), which in newer versions is just referred to as "macOS".
|
||||||
|
|
||||||
From the developer's point of view, macOS is a sort of hybrid Mac and
|
From the developer's point of view, macOS is a sort of hybrid Mac and
|
||||||
Unix system, and you have the option of using either traditional
|
Unix system, and you have the option of using either traditional
|
||||||
command line tools or Apple's IDE Xcode.
|
command line tools or Apple's IDE Xcode.
|
||||||
|
|
||||||
# Command Line Build
|
# Command Line Build
|
||||||
|
|
||||||
To build SDL using the command line, use the standard configure and make
|
To build SDL using the command line, use the standard configure and make
|
||||||
process:
|
process:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
mkdir build
|
mkdir build
|
||||||
cd build
|
cd build
|
||||||
../configure
|
../configure
|
||||||
make
|
make
|
||||||
sudo make install
|
sudo make install
|
||||||
```
|
```
|
||||||
|
|
||||||
CMake is also known to work, although it continues to be a work in progress:
|
CMake is also known to work, although it continues to be a work in progress:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
mkdir build
|
mkdir build
|
||||||
cd build
|
cd build
|
||||||
cmake -DCMAKE_BUILD_TYPE=Release ..
|
cmake -DCMAKE_BUILD_TYPE=Release ..
|
||||||
make
|
make
|
||||||
sudo make install
|
sudo make install
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
You can also build SDL as a Universal library (a single binary for both
|
You can also build SDL as a Universal library (a single binary for both
|
||||||
64-bit Intel and ARM architectures), by using the build-scripts/clang-fat.sh
|
64-bit Intel and ARM architectures), by using the build-scripts/clang-fat.sh
|
||||||
script.
|
script.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
mkdir build
|
mkdir build
|
||||||
cd build
|
cd build
|
||||||
CC=$PWD/../build-scripts/clang-fat.sh ../configure
|
CC=$PWD/../build-scripts/clang-fat.sh ../configure
|
||||||
make
|
make
|
||||||
sudo make install
|
sudo make install
|
||||||
```
|
```
|
||||||
|
|
||||||
This script builds SDL with 10.9 ABI compatibility on 64-bit Intel and 11.0
|
This script builds SDL with 10.9 ABI compatibility on 64-bit Intel and 11.0
|
||||||
ABI compatibility on ARM64 architectures. For best compatibility you
|
ABI compatibility on ARM64 architectures. For best compatibility you
|
||||||
should compile your application the same way.
|
should compile your application the same way.
|
||||||
|
|
||||||
Please note that building SDL requires at least Xcode 6 and the 10.9 SDK.
|
Please note that building SDL requires at least Xcode 6 and the 10.9 SDK.
|
||||||
PowerPC support for macOS has been officially dropped as of SDL 2.0.2.
|
PowerPC support for macOS has been officially dropped as of SDL 2.0.2.
|
||||||
32-bit Intel and macOS 10.8 runtime support has been officially dropped as
|
32-bit Intel and macOS 10.8 runtime support has been officially dropped as
|
||||||
of SDL 2.24.0.
|
of SDL 2.24.0.
|
||||||
|
|
||||||
To use the library once it's built, you essential have two possibilities:
|
To use the library once it's built, you essential have two possibilities:
|
||||||
use the traditional autoconf/automake/make method, or use Xcode.
|
use the traditional autoconf/automake/make method, or use Xcode.
|
||||||
|
|
||||||
|
|
||||||
# Caveats for using SDL with Mac OS X
|
# Caveats for using SDL with Mac OS X
|
||||||
|
|
||||||
If you register your own NSApplicationDelegate (using [NSApp setDelegate:]),
|
If you register your own NSApplicationDelegate (using [NSApp setDelegate:]),
|
||||||
SDL will not register its own. This means that SDL will not terminate using
|
SDL will not register its own. This means that SDL will not terminate using
|
||||||
SDL_Quit if it receives a termination request, it will terminate like a
|
SDL_Quit if it receives a termination request, it will terminate like a
|
||||||
normal app, and it will not send a SDL_DROPFILE when you request to open a
|
normal app, and it will not send a SDL_DROPFILE when you request to open a
|
||||||
file with the app. To solve these issues, put the following code in your
|
file with the app. To solve these issues, put the following code in your
|
||||||
NSApplicationDelegate implementation:
|
NSApplicationDelegate implementation:
|
||||||
|
|
||||||
|
|
||||||
```objc
|
```objc
|
||||||
- (NSApplicationTerminateReply)applicationShouldTerminate:(NSApplication *)sender
|
- (NSApplicationTerminateReply)applicationShouldTerminate:(NSApplication *)sender
|
||||||
{
|
{
|
||||||
if (SDL_GetEventState(SDL_QUIT) == SDL_ENABLE) {
|
if (SDL_GetEventState(SDL_QUIT) == SDL_ENABLE) {
|
||||||
SDL_Event event;
|
SDL_Event event;
|
||||||
event.type = SDL_QUIT;
|
event.type = SDL_QUIT;
|
||||||
SDL_PushEvent(&event);
|
SDL_PushEvent(&event);
|
||||||
}
|
}
|
||||||
|
|
||||||
return NSTerminateCancel;
|
return NSTerminateCancel;
|
||||||
}
|
}
|
||||||
|
|
||||||
- (BOOL)application:(NSApplication *)theApplication openFile:(NSString *)filename
|
- (BOOL)application:(NSApplication *)theApplication openFile:(NSString *)filename
|
||||||
{
|
{
|
||||||
if (SDL_GetEventState(SDL_DROPFILE) == SDL_ENABLE) {
|
if (SDL_GetEventState(SDL_DROPFILE) == SDL_ENABLE) {
|
||||||
SDL_Event event;
|
SDL_Event event;
|
||||||
event.type = SDL_DROPFILE;
|
event.type = SDL_DROPFILE;
|
||||||
event.drop.file = SDL_strdup([filename UTF8String]);
|
event.drop.file = SDL_strdup([filename UTF8String]);
|
||||||
return (SDL_PushEvent(&event) > 0);
|
return (SDL_PushEvent(&event) > 0);
|
||||||
}
|
}
|
||||||
|
|
||||||
return NO;
|
return NO;
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
# Using the Simple DirectMedia Layer with a traditional Makefile
|
# Using the Simple DirectMedia Layer with a traditional Makefile
|
||||||
|
|
||||||
An existing autoconf/automake build system for your SDL app has good chances
|
An existing autoconf/automake build system for your SDL app has good chances
|
||||||
to work almost unchanged on macOS. However, to produce a "real" Mac binary
|
to work almost unchanged on macOS. However, to produce a "real" Mac binary
|
||||||
that you can distribute to users, you need to put the generated binary into a
|
that you can distribute to users, you need to put the generated binary into a
|
||||||
so called "bundle", which is basically a fancy folder with a name like
|
so called "bundle", which is basically a fancy folder with a name like
|
||||||
"MyCoolGame.app".
|
"MyCoolGame.app".
|
||||||
|
|
||||||
To get this build automatically, add something like the following rule to
|
To get this build automatically, add something like the following rule to
|
||||||
your Makefile.am:
|
your Makefile.am:
|
||||||
|
|
||||||
```make
|
```make
|
||||||
bundle_contents = APP_NAME.app/Contents
|
bundle_contents = APP_NAME.app/Contents
|
||||||
APP_NAME_bundle: EXE_NAME
|
APP_NAME_bundle: EXE_NAME
|
||||||
mkdir -p $(bundle_contents)/MacOS
|
mkdir -p $(bundle_contents)/MacOS
|
||||||
mkdir -p $(bundle_contents)/Resources
|
mkdir -p $(bundle_contents)/Resources
|
||||||
echo "APPL????" > $(bundle_contents)/PkgInfo
|
echo "APPL????" > $(bundle_contents)/PkgInfo
|
||||||
$(INSTALL_PROGRAM) $< $(bundle_contents)/MacOS/
|
$(INSTALL_PROGRAM) $< $(bundle_contents)/MacOS/
|
||||||
```
|
```
|
||||||
|
|
||||||
You should replace `EXE_NAME` with the name of the executable. `APP_NAME` is
|
You should replace `EXE_NAME` with the name of the executable. `APP_NAME` is
|
||||||
what will be visible to the user in the Finder. Usually it will be the same
|
what will be visible to the user in the Finder. Usually it will be the same
|
||||||
as `EXE_NAME` but capitalized. E.g. if `EXE_NAME` is "testgame" then `APP_NAME`
|
as `EXE_NAME` but capitalized. E.g. if `EXE_NAME` is "testgame" then `APP_NAME`
|
||||||
usually is "TestGame". You might also want to use `@PACKAGE@` to use the
|
usually is "TestGame". You might also want to use `@PACKAGE@` to use the
|
||||||
package name as specified in your configure.ac file.
|
package name as specified in your configure.ac file.
|
||||||
|
|
||||||
If your project builds more than one application, you will have to do a bit
|
If your project builds more than one application, you will have to do a bit
|
||||||
more. For each of your target applications, you need a separate rule.
|
more. For each of your target applications, you need a separate rule.
|
||||||
|
|
||||||
If you want the created bundles to be installed, you may want to add this
|
If you want the created bundles to be installed, you may want to add this
|
||||||
rule to your Makefile.am:
|
rule to your Makefile.am:
|
||||||
|
|
||||||
```make
|
```make
|
||||||
install-exec-hook: APP_NAME_bundle
|
install-exec-hook: APP_NAME_bundle
|
||||||
rm -rf $(DESTDIR)$(prefix)/Applications/APP_NAME.app
|
rm -rf $(DESTDIR)$(prefix)/Applications/APP_NAME.app
|
||||||
mkdir -p $(DESTDIR)$(prefix)/Applications/
|
mkdir -p $(DESTDIR)$(prefix)/Applications/
|
||||||
cp -r $< /$(DESTDIR)$(prefix)Applications/
|
cp -r $< /$(DESTDIR)$(prefix)Applications/
|
||||||
```
|
```
|
||||||
|
|
||||||
This rule takes the Bundle created by the rule from step 3 and installs them
|
This rule takes the Bundle created by the rule from step 3 and installs them
|
||||||
into "$(DESTDIR)$(prefix)/Applications/".
|
into "$(DESTDIR)$(prefix)/Applications/".
|
||||||
|
|
||||||
Again, if you want to install multiple applications, you will have to augment
|
Again, if you want to install multiple applications, you will have to augment
|
||||||
the make rule accordingly.
|
the make rule accordingly.
|
||||||
|
|
||||||
But beware! That is only part of the story! With the above, you end up with
|
But beware! That is only part of the story! With the above, you end up with
|
||||||
a barebones .app bundle, which is double-clickable from the Finder. But
|
a barebones .app bundle, which is double-clickable from the Finder. But
|
||||||
there are some more things you should do before shipping your product...
|
there are some more things you should do before shipping your product...
|
||||||
|
|
||||||
1. The bundle right now probably is dynamically linked against SDL. That
|
1. The bundle right now probably is dynamically linked against SDL. That
|
||||||
means that when you copy it to another computer, *it will not run*,
|
means that when you copy it to another computer, *it will not run*,
|
||||||
unless you also install SDL on that other computer. A good solution
|
unless you also install SDL on that other computer. A good solution
|
||||||
for this dilemma is to static link against SDL. On OS X, you can
|
for this dilemma is to static link against SDL. On OS X, you can
|
||||||
achieve that by linking against the libraries listed by
|
achieve that by linking against the libraries listed by
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
sdl-config --static-libs
|
sdl-config --static-libs
|
||||||
```
|
```
|
||||||
|
|
||||||
instead of those listed by
|
instead of those listed by
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
sdl-config --libs
|
sdl-config --libs
|
||||||
```
|
```
|
||||||
|
|
||||||
Depending on how exactly SDL is integrated into your build systems, the
|
Depending on how exactly SDL is integrated into your build systems, the
|
||||||
way to achieve that varies, so I won't describe it here in detail
|
way to achieve that varies, so I won't describe it here in detail
|
||||||
|
|
||||||
2. Add an 'Info.plist' to your application. That is a special XML file which
|
2. Add an 'Info.plist' to your application. That is a special XML file which
|
||||||
contains some meta-information about your application (like some copyright
|
contains some meta-information about your application (like some copyright
|
||||||
information, the version of your app, the name of an optional icon file,
|
information, the version of your app, the name of an optional icon file,
|
||||||
and other things). Part of that information is displayed by the Finder
|
and other things). Part of that information is displayed by the Finder
|
||||||
when you click on the .app, or if you look at the "Get Info" window.
|
when you click on the .app, or if you look at the "Get Info" window.
|
||||||
More information about Info.plist files can be found on Apple's homepage.
|
More information about Info.plist files can be found on Apple's homepage.
|
||||||
|
|
||||||
|
|
||||||
As a final remark, let me add that I use some of the techniques (and some
|
As a final remark, let me add that I use some of the techniques (and some
|
||||||
variations of them) in [Exult](https://github.com/exult/exult) and
|
variations of them) in [Exult](https://github.com/exult/exult) and
|
||||||
[ScummVM](https://github.com/scummvm/scummvm); both are available in source on
|
[ScummVM](https://github.com/scummvm/scummvm); both are available in source on
|
||||||
the net, so feel free to take a peek at them for inspiration!
|
the net, so feel free to take a peek at them for inspiration!
|
||||||
|
|
||||||
|
|
||||||
# Using the Simple DirectMedia Layer with Xcode
|
# Using the Simple DirectMedia Layer with Xcode
|
||||||
|
|
||||||
These instructions are for using Apple's Xcode IDE to build SDL applications.
|
These instructions are for using Apple's Xcode IDE to build SDL applications.
|
||||||
|
|
||||||
## First steps
|
## First steps
|
||||||
|
|
||||||
The first thing to do is to unpack the Xcode.tar.gz archive in the
|
The first thing to do is to unpack the Xcode.tar.gz archive in the
|
||||||
top level SDL directory (where the Xcode.tar.gz archive resides).
|
top level SDL directory (where the Xcode.tar.gz archive resides).
|
||||||
Because Stuffit Expander will unpack the archive into a subdirectory,
|
Because Stuffit Expander will unpack the archive into a subdirectory,
|
||||||
you should unpack the archive manually from the command line:
|
you should unpack the archive manually from the command line:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
cd [path_to_SDL_source]
|
cd [path_to_SDL_source]
|
||||||
tar zxf Xcode.tar.gz
|
tar zxf Xcode.tar.gz
|
||||||
```
|
```
|
||||||
|
|
||||||
This will create a new folder called Xcode, which you can browse
|
This will create a new folder called Xcode, which you can browse
|
||||||
normally from the Finder.
|
normally from the Finder.
|
||||||
|
|
||||||
## Building the Framework
|
## Building the Framework
|
||||||
|
|
||||||
The SDL Library is packaged as a framework bundle, an organized
|
The SDL Library is packaged as a framework bundle, an organized
|
||||||
relocatable folder hierarchy of executable code, interface headers,
|
relocatable folder hierarchy of executable code, interface headers,
|
||||||
and additional resources. For practical purposes, you can think of a
|
and additional resources. For practical purposes, you can think of a
|
||||||
framework as a more user and system-friendly shared library, whose library
|
framework as a more user and system-friendly shared library, whose library
|
||||||
file behaves more or less like a standard UNIX shared library.
|
file behaves more or less like a standard UNIX shared library.
|
||||||
|
|
||||||
To build the framework, simply open the framework project and build it.
|
To build the framework, simply open the framework project and build it.
|
||||||
By default, the framework bundle "SDL.framework" is installed in
|
By default, the framework bundle "SDL.framework" is installed in
|
||||||
/Library/Frameworks. Therefore, the testers and project stationary expect
|
/Library/Frameworks. Therefore, the testers and project stationary expect
|
||||||
it to be located there. However, it will function the same in any of the
|
it to be located there. However, it will function the same in any of the
|
||||||
following locations:
|
following locations:
|
||||||
|
|
||||||
* ~/Library/Frameworks
|
* ~/Library/Frameworks
|
||||||
* /Local/Library/Frameworks
|
* /Local/Library/Frameworks
|
||||||
* /System/Library/Frameworks
|
* /System/Library/Frameworks
|
||||||
|
|
||||||
## Build Options
|
## Build Options
|
||||||
|
|
||||||
There are two "Build Styles" (See the "Targets" tab) for SDL.
|
There are two "Build Styles" (See the "Targets" tab) for SDL.
|
||||||
"Deployment" should be used if you aren't tweaking the SDL library.
|
"Deployment" should be used if you aren't tweaking the SDL library.
|
||||||
"Development" should be used to debug SDL apps or the library itself.
|
"Development" should be used to debug SDL apps or the library itself.
|
||||||
|
|
||||||
## Building the Testers
|
## Building the Testers
|
||||||
|
|
||||||
Open the SDLTest project and build away!
|
Open the SDLTest project and build away!
|
||||||
|
|
||||||
## Using the Project Stationary
|
## Using the Project Stationary
|
||||||
|
|
||||||
Copy the stationary to the indicated folders to access it from
|
Copy the stationary to the indicated folders to access it from
|
||||||
the "New Project" and "Add target" menus. What could be easier?
|
the "New Project" and "Add target" menus. What could be easier?
|
||||||
|
|
||||||
## Setting up a new project by hand
|
## Setting up a new project by hand
|
||||||
|
|
||||||
Some of you won't want to use the Stationary so I'll give some tips:
|
Some of you won't want to use the Stationary so I'll give some tips:
|
||||||
|
|
||||||
(this is accurate as of Xcode 12.5.)
|
(this is accurate as of Xcode 12.5.)
|
||||||
|
|
||||||
* Click "File" -> "New" -> "Project...
|
* Click "File" -> "New" -> "Project...
|
||||||
* Choose "macOS" and then "App" from the "Application" section.
|
* Choose "macOS" and then "App" from the "Application" section.
|
||||||
* Fill out the options in the next window. User interface is "XIB" and
|
* Fill out the options in the next window. User interface is "XIB" and
|
||||||
Language is "Objective-C".
|
Language is "Objective-C".
|
||||||
* Remove "main.m" from your project
|
* Remove "main.m" from your project
|
||||||
* Remove "MainMenu.xib" from your project
|
* Remove "MainMenu.xib" from your project
|
||||||
* Remove "AppDelegates.*" from your project
|
* Remove "AppDelegates.*" from your project
|
||||||
* Add "\$(HOME)/Library/Frameworks/SDL.framework/Headers" to include path
|
* Add "\$(HOME)/Library/Frameworks/SDL.framework/Headers" to include path
|
||||||
* Add "\$(HOME)/Library/Frameworks" to the frameworks search path
|
* Add "\$(HOME)/Library/Frameworks" to the frameworks search path
|
||||||
* Add "-framework SDL -framework Foundation -framework AppKit" to "OTHER_LDFLAGS"
|
* Add "-framework SDL -framework Foundation -framework AppKit" to "OTHER_LDFLAGS"
|
||||||
* Add your files
|
* Add your files
|
||||||
* Clean and build
|
* Clean and build
|
||||||
|
|
||||||
## Building from command line
|
## Building from command line
|
||||||
|
|
||||||
Use `xcode-build` in the same directory as your .pbxproj file
|
Use `xcode-build` in the same directory as your .pbxproj file
|
||||||
|
|
||||||
## Running your app
|
## Running your app
|
||||||
|
|
||||||
You can send command line args to your app by either invoking it from
|
You can send command line args to your app by either invoking it from
|
||||||
the command line (in *.app/Contents/MacOS) or by entering them in the
|
the command line (in *.app/Contents/MacOS) or by entering them in the
|
||||||
Executables" panel of the target settings.
|
Executables" panel of the target settings.
|
||||||
|
|
||||||
# Implementation Notes
|
# Implementation Notes
|
||||||
|
|
||||||
Some things that may be of interest about how it all works...
|
Some things that may be of interest about how it all works...
|
||||||
|
|
||||||
## Working directory
|
## Working directory
|
||||||
|
|
||||||
In SDL 1.2, the working directory of your SDL app is by default set to its
|
In SDL 1.2, the working directory of your SDL app is by default set to its
|
||||||
parent, but this is no longer the case in SDL 2.0 and later. SDL2 does not
|
parent, but this is no longer the case in SDL 2.0. SDL2 does change the
|
||||||
change the working directory, which means it'll be whatever the command line
|
working directory, which means it'll be whatever the command line prompt
|
||||||
prompt that launched the program was using, or if launched by double-clicking
|
that launched the program was using, or if launched by double-clicking in
|
||||||
in the Finder, it will be "/", the _root of the filesystem_. Plan accordingly!
|
the finger, it will be "/", the _root of the filesystem_. Plan accordingly!
|
||||||
You can use SDL_GetBasePath() to find where the program is running from and
|
You can use SDL_GetBasePath() to find where the program is running from and
|
||||||
chdir() there directly.
|
chdir() there directly.
|
||||||
|
|
||||||
|
|
||||||
## You have a Cocoa App!
|
## You have a Cocoa App!
|
||||||
|
|
||||||
Your SDL app is essentially a Cocoa application. When your app
|
Your SDL app is essentially a Cocoa application. When your app
|
||||||
starts up and the libraries finish loading, a Cocoa procedure is called,
|
starts up and the libraries finish loading, a Cocoa procedure is called,
|
||||||
which sets up the working directory and calls your main() method.
|
which sets up the working directory and calls your main() method.
|
||||||
You are free to modify your Cocoa app with generally no consequence
|
You are free to modify your Cocoa app with generally no consequence
|
||||||
to SDL. You cannot, however, easily change the SDL window itself.
|
to SDL. You cannot, however, easily change the SDL window itself.
|
||||||
Functionality may be added in the future to help this.
|
Functionality may be added in the future to help this.
|
||||||
|
|
||||||
# Bug reports
|
# Bug reports
|
||||||
|
|
||||||
Bugs are tracked at [the GitHub issue tracker](https://github.com/libsdl-org/SDL/issues/).
|
Bugs are tracked at [the GitHub issue tracker](https://github.com/libsdl-org/SDL/issues/).
|
||||||
Please feel free to report bugs there!
|
Please feel free to report bugs there!
|
||||||
|
|
||||||
@@ -1,28 +1,28 @@
|
|||||||
# Nintendo 3DS
|
# Nintendo 3DS
|
||||||
|
|
||||||
SDL port for the Nintendo 3DS [Homebrew toolchain](https://devkitpro.org/) contributed by:
|
SDL port for the Nintendo 3DS [Homebrew toolchain](https://devkitpro.org/) contributed by:
|
||||||
|
|
||||||
- [Pierre Wendling](https://github.com/FtZPetruska)
|
- [Pierre Wendling](https://github.com/FtZPetruska)
|
||||||
|
|
||||||
Credits to:
|
Credits to:
|
||||||
|
|
||||||
- The awesome people who ported SDL to other homebrew platforms.
|
- The awesome people who ported SDL to other homebrew platforms.
|
||||||
- The Devkitpro team for making all the tools necessary to achieve this.
|
- The Devkitpro team for making all the tools necessary to achieve this.
|
||||||
|
|
||||||
## Building
|
## Building
|
||||||
|
|
||||||
To build for the Nintendo 3DS, make sure you have devkitARM and cmake installed and run:
|
To build for the Nintendo 3DS, make sure you have devkitARM and cmake installed and run:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
cmake -S. -Bbuild -DCMAKE_TOOLCHAIN_FILE="$DEVKITPRO/cmake/3DS.cmake" -DCMAKE_BUILD_TYPE=Release
|
cmake -S. -Bbuild -DCMAKE_TOOLCHAIN_FILE="$DEVKITPRO/cmake/3DS.cmake" -DCMAKE_BUILD_TYPE=Release
|
||||||
cmake --build build
|
cmake --build build
|
||||||
cmake --install build
|
cmake --install build
|
||||||
```
|
```
|
||||||
|
|
||||||
## Notes
|
## Notes
|
||||||
|
|
||||||
- Currently only software rendering is supported.
|
- Currently only software rendering is supported.
|
||||||
- SDL2main should be used to ensure ROMFS is enabled.
|
- SDL2main should be used to ensure ROMFS is enabled.
|
||||||
- By default, the extra L2 cache and higher clock speeds of the New 2/3DS lineup are enabled. If you wish to turn it off, use `osSetSpeedupEnable(false)` in your main function.
|
- By default, the extra L2 cache and higher clock speeds of the New 2/3DS lineup are enabled. If you wish to turn it off, use `osSetSpeedupEnable(false)` in your main function.
|
||||||
- `SDL_GetBasePath` returns the romfs root instead of the executable's directory.
|
- `SDL_GetBasePath` returns the romfs root instead of the executable's directory.
|
||||||
- The Nintendo 3DS uses a cooperative threading model on a single core, meaning a thread will never yield unless done manually through the `SDL_Delay` functions, or blocking waits (`SDL_LockMutex`, `SDL_SemWait`, `SDL_CondWait`, `SDL_WaitThread`). To avoid starving other threads, `SDL_SemTryWait` and `SDL_SemWaitTimeout` will yield if they fail to acquire the semaphore, see https://github.com/libsdl-org/SDL/pull/6776 for more information.
|
- The Nintendo 3DS uses a cooperative threading model on a single core, meaning a thread will never yield unless done manually through the `SDL_Delay` functions, or blocking waits (`SDL_LockMutex`, `SDL_SemWait`, `SDL_CondWait`, `SDL_WaitThread`). To avoid starving other threads, `SDL_SemTryWait` and `SDL_SemWaitTimeout` will yield if they fail to acquire the semaphore, see https://github.com/libsdl-org/SDL/pull/6776 for more information.
|
||||||
+103
-103
@@ -1,103 +1,103 @@
|
|||||||
Native Client
|
Native Client
|
||||||
================================================================================
|
================================================================================
|
||||||
|
|
||||||
Requirements:
|
Requirements:
|
||||||
|
|
||||||
* Native Client SDK (https://developer.chrome.com/native-client),
|
* Native Client SDK (https://developer.chrome.com/native-client),
|
||||||
(tested with Pepper version 33 or higher).
|
(tested with Pepper version 33 or higher).
|
||||||
|
|
||||||
The SDL backend for Chrome's Native Client has been tested only with the PNaCl
|
The SDL backend for Chrome's Native Client has been tested only with the PNaCl
|
||||||
toolchain, which generates binaries designed to run on ARM and x86_32/64
|
toolchain, which generates binaries designed to run on ARM and x86_32/64
|
||||||
platforms. This does not mean it won't work with the other toolchains!
|
platforms. This does not mean it won't work with the other toolchains!
|
||||||
|
|
||||||
================================================================================
|
================================================================================
|
||||||
Building SDL for NaCl
|
Building SDL for NaCl
|
||||||
================================================================================
|
================================================================================
|
||||||
|
|
||||||
Set up the right environment variables (see naclbuild.sh), then configure SDL with:
|
Set up the right environment variables (see naclbuild.sh), then configure SDL with:
|
||||||
|
|
||||||
configure --host=pnacl --prefix some/install/destination
|
configure --host=pnacl --prefix some/install/destination
|
||||||
|
|
||||||
Then "make".
|
Then "make".
|
||||||
|
|
||||||
As an example of how to create a deployable app a Makefile project is provided
|
As an example of how to create a deployable app a Makefile project is provided
|
||||||
in test/nacl/Makefile, which includes some monkey patching of the common.mk file
|
in test/nacl/Makefile, which includes some monkey patching of the common.mk file
|
||||||
provided by NaCl, without which linking properly to SDL won't work (the search
|
provided by NaCl, without which linking properly to SDL won't work (the search
|
||||||
path can't be modified externally, so the linker won't find SDL's binaries unless
|
path can't be modified externally, so the linker won't find SDL's binaries unless
|
||||||
you dump them into the SDK path, which is inconvenient).
|
you dump them into the SDK path, which is inconvenient).
|
||||||
Also provided in test/nacl is the required support file, such as index.html,
|
Also provided in test/nacl is the required support file, such as index.html,
|
||||||
manifest.json, etc.
|
manifest.json, etc.
|
||||||
SDL apps for NaCl run on a worker thread using the ppapi_simple infrastructure.
|
SDL apps for NaCl run on a worker thread using the ppapi_simple infrastructure.
|
||||||
This allows for blocking calls on all the relevant systems (OpenGL ES, filesystem),
|
This allows for blocking calls on all the relevant systems (OpenGL ES, filesystem),
|
||||||
hiding the asynchronous nature of the browser behind the scenes...which is not the
|
hiding the asynchronous nature of the browser behind the scenes...which is not the
|
||||||
same as making it disappear!
|
same as making it disappear!
|
||||||
|
|
||||||
|
|
||||||
================================================================================
|
================================================================================
|
||||||
Running tests
|
Running tests
|
||||||
================================================================================
|
================================================================================
|
||||||
|
|
||||||
Due to the nature of NaCl programs, building and running SDL tests is not as
|
Due to the nature of NaCl programs, building and running SDL tests is not as
|
||||||
straightforward as one would hope. The script naclbuild.sh in build-scripts
|
straightforward as one would hope. The script naclbuild.sh in build-scripts
|
||||||
automates the process and should serve as a guide for users of SDL trying to build
|
automates the process and should serve as a guide for users of SDL trying to build
|
||||||
their own applications.
|
their own applications.
|
||||||
|
|
||||||
Basic usage:
|
Basic usage:
|
||||||
|
|
||||||
./naclbuild.sh path/to/pepper/toolchain (i.e. ~/naclsdk/pepper_35)
|
./naclbuild.sh path/to/pepper/toolchain (i.e. ~/naclsdk/pepper_35)
|
||||||
|
|
||||||
This will build testgles2.c by default.
|
This will build testgles2.c by default.
|
||||||
|
|
||||||
If you want to build a different test, for example testrendercopyex.c:
|
If you want to build a different test, for example testrendercopyex.c:
|
||||||
|
|
||||||
SOURCES=~/sdl/SDL/test/testrendercopyex.c ./naclbuild.sh ~/naclsdk/pepper_35
|
SOURCES=~/sdl/SDL/test/testrendercopyex.c ./naclbuild.sh ~/naclsdk/pepper_35
|
||||||
|
|
||||||
Once the build finishes, you have to serve the contents with a web server (the
|
Once the build finishes, you have to serve the contents with a web server (the
|
||||||
script will give you instructions on how to do that with Python).
|
script will give you instructions on how to do that with Python).
|
||||||
|
|
||||||
================================================================================
|
================================================================================
|
||||||
RWops and nacl_io
|
RWops and nacl_io
|
||||||
================================================================================
|
================================================================================
|
||||||
|
|
||||||
SDL_RWops work transparently with nacl_io. Two functions control the mount points:
|
SDL_RWops work transparently with nacl_io. Two functions control the mount points:
|
||||||
|
|
||||||
int mount(const char* source, const char* target,
|
int mount(const char* source, const char* target,
|
||||||
const char* filesystemtype,
|
const char* filesystemtype,
|
||||||
unsigned long mountflags, const void *data);
|
unsigned long mountflags, const void *data);
|
||||||
int umount(const char *target);
|
int umount(const char *target);
|
||||||
|
|
||||||
For convenience, SDL will by default mount an httpfs tree at / before calling
|
For convenience, SDL will by default mount an httpfs tree at / before calling
|
||||||
the app's main function. Such setting can be overridden by calling:
|
the app's main function. Such setting can be overridden by calling:
|
||||||
|
|
||||||
umount("/");
|
umount("/");
|
||||||
|
|
||||||
And then mounting a different filesystem at /
|
And then mounting a different filesystem at /
|
||||||
|
|
||||||
It's important to consider that the asynchronous nature of file operations on a
|
It's important to consider that the asynchronous nature of file operations on a
|
||||||
browser is hidden from the application, effectively providing the developer with
|
browser is hidden from the application, effectively providing the developer with
|
||||||
a set of blocking file operations just like you get in a regular desktop
|
a set of blocking file operations just like you get in a regular desktop
|
||||||
environment, which eases the job of porting to Native Client, but also introduces
|
environment, which eases the job of porting to Native Client, but also introduces
|
||||||
a set of challenges of its own, in particular when big file sizes and slow
|
a set of challenges of its own, in particular when big file sizes and slow
|
||||||
connections are involved.
|
connections are involved.
|
||||||
|
|
||||||
For more information on how nacl_io and mount points work, see:
|
For more information on how nacl_io and mount points work, see:
|
||||||
|
|
||||||
https://developer.chrome.com/native-client/devguide/coding/nacl_io
|
https://developer.chrome.com/native-client/devguide/coding/nacl_io
|
||||||
https://src.chromium.org/chrome/trunk/src/native_client_sdk/src/libraries/nacl_io/nacl_io.h
|
https://src.chromium.org/chrome/trunk/src/native_client_sdk/src/libraries/nacl_io/nacl_io.h
|
||||||
|
|
||||||
To be able to save into the directory "/save/" (like backup of game) :
|
To be able to save into the directory "/save/" (like backup of game) :
|
||||||
|
|
||||||
mount("", "/save", "html5fs", 0, "type=PERSISTENT");
|
mount("", "/save", "html5fs", 0, "type=PERSISTENT");
|
||||||
|
|
||||||
And add to manifest.json :
|
And add to manifest.json :
|
||||||
|
|
||||||
"permissions": [
|
"permissions": [
|
||||||
"unlimitedStorage"
|
"unlimitedStorage"
|
||||||
]
|
]
|
||||||
|
|
||||||
================================================================================
|
================================================================================
|
||||||
TODO - Known Issues
|
TODO - Known Issues
|
||||||
================================================================================
|
================================================================================
|
||||||
* Testing of all systems with a real application (something other than SDL's tests)
|
* Testing of all systems with a real application (something other than SDL's tests)
|
||||||
* Key events don't seem to work properly
|
* Key events don't seem to work properly
|
||||||
|
|
||||||
@@ -1,44 +1,44 @@
|
|||||||
Nokia N-Gage
|
Nokia N-Gage
|
||||||
============
|
============
|
||||||
|
|
||||||
SDL2 port for Symbian S60v1 and v2 with a main focus on the Nokia N-Gage
|
SDL2 port for Symbian S60v1 and v2 with a main focus on the Nokia N-Gage
|
||||||
(Classic and QD) by [Michael Fitzmayer](https://github.com/mupfdev).
|
(Classic and QD) by [Michael Fitzmayer](https://github.com/mupfdev).
|
||||||
|
|
||||||
Compiling
|
Compiling
|
||||||
---------
|
---------
|
||||||
|
|
||||||
SDL is part of the [N-Gage SDK.](https://github.com/ngagesdk) project.
|
SDL is part of the [N-Gage SDK.](https://github.com/ngagesdk) project.
|
||||||
The library is included in the
|
The library is included in the
|
||||||
[toolchain](https://github.com/ngagesdk/ngage-toolchain) as a
|
[toolchain](https://github.com/ngagesdk/ngage-toolchain) as a
|
||||||
sub-module.
|
sub-module.
|
||||||
|
|
||||||
A complete example project based on SDL2 can be found in the GitHub
|
A complete example project based on SDL2 can be found in the GitHub
|
||||||
account of the SDK: [Wordle](https://github.com/ngagesdk/wordle).
|
account of the SDK: [Wordle](https://github.com/ngagesdk/wordle).
|
||||||
|
|
||||||
Current level of implementation
|
Current level of implementation
|
||||||
-------------------------------
|
-------------------------------
|
||||||
|
|
||||||
The video driver currently provides full screen video support with
|
The video driver currently provides full screen video support with
|
||||||
keyboard input.
|
keyboard input.
|
||||||
|
|
||||||
At the moment only the software renderer works.
|
At the moment only the software renderer works.
|
||||||
|
|
||||||
Audio is not yet implemented.
|
Audio is not yet implemented.
|
||||||
|
|
||||||
Acknowledgements
|
Acknowledgements
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
Thanks to Hannu Viitala, Kimmo Kinnunen and Markus Mertama for the
|
Thanks to Hannu Viitala, Kimmo Kinnunen and Markus Mertama for the
|
||||||
valuable insight into Symbian programming. Without the SDL 1.2 port
|
valuable insight into Symbian programming. Without the SDL 1.2 port
|
||||||
which was specially developed for CDoom (Doom for the Nokia 9210), this
|
which was specially developed for CDoom (Doom for the Nokia 9210), this
|
||||||
adaptation would not have been possible.
|
adaptation would not have been possible.
|
||||||
|
|
||||||
I would like to thank my friends
|
I would like to thank my friends
|
||||||
[Razvan](https://twitter.com/bewarerazvan) and [Dan
|
[Razvan](https://twitter.com/bewarerazvan) and [Dan
|
||||||
Whelan](https://danwhelan.ie/), for their continuous support. Without
|
Whelan](https://danwhelan.ie/), for their continuous support. Without
|
||||||
you and the [N-Gage community](https://discord.gg/dbUzqJ26vs), I would
|
you and the [N-Gage community](https://discord.gg/dbUzqJ26vs), I would
|
||||||
have lost my patience long ago.
|
have lost my patience long ago.
|
||||||
|
|
||||||
Last but not least, I would like to thank the development team of
|
Last but not least, I would like to thank the development team of
|
||||||
[EKA2L1](https://12z1.com/) (an experimental Symbian OS emulator). Your
|
[EKA2L1](https://12z1.com/) (an experimental Symbian OS emulator). Your
|
||||||
patience and support in troubleshooting helped me a lot.
|
patience and support in troubleshooting helped me a lot.
|
||||||
@@ -1,92 +1,92 @@
|
|||||||
Simple DirectMedia Layer 2 for OS/2 & eComStation
|
Simple DirectMedia Layer 2 for OS/2 & eComStation
|
||||||
================================================================================
|
================================================================================
|
||||||
SDL port for OS/2, authored by Andrey Vasilkin <digi@os2.snc.ru>, 2016
|
SDL port for OS/2, authored by Andrey Vasilkin <digi@os2.snc.ru>, 2016
|
||||||
|
|
||||||
|
|
||||||
OpenGL not supported by this port.
|
OpenGL not supported by this port.
|
||||||
|
|
||||||
Additional optional environment variables:
|
Additional optional environment variables:
|
||||||
|
|
||||||
SDL_AUDIO_SHARE
|
SDL_AUDIO_SHARE
|
||||||
Values: 0 or 1, default is 0
|
Values: 0 or 1, default is 0
|
||||||
Initializes the device as shareable or exclusively acquired.
|
Initializes the device as shareable or exclusively acquired.
|
||||||
|
|
||||||
SDL_VIDEODRIVER
|
SDL_VIDEODRIVER
|
||||||
Values: DIVE or VMAN, default is DIVE
|
Values: DIVE or VMAN, default is DIVE
|
||||||
Use video subsystem: Direct interface video extensions (DIVE) or
|
Use video subsystem: Direct interface video extensions (DIVE) or
|
||||||
Video Manager (VMAN).
|
Video Manager (VMAN).
|
||||||
|
|
||||||
You may significantly increase video output speed with OS4 kernel and patched
|
You may significantly increase video output speed with OS4 kernel and patched
|
||||||
files vman.dll and dive.dll or with latest versions of ACPI support and video
|
files vman.dll and dive.dll or with latest versions of ACPI support and video
|
||||||
driver Panorama.
|
driver Panorama.
|
||||||
|
|
||||||
Latest versions of OS/4 kernel:
|
Latest versions of OS/4 kernel:
|
||||||
http://gus.biysk.ru/os4/
|
http://gus.biysk.ru/os4/
|
||||||
(Info: https://www.os2world.com/wiki/index.php/Phoenix_OS/4)
|
(Info: https://www.os2world.com/wiki/index.php/Phoenix_OS/4)
|
||||||
|
|
||||||
Patched files vman.dll and dive.dll:
|
Patched files vman.dll and dive.dll:
|
||||||
http://gus.biysk.ru/os4/test/pached_dll/PATCHED_DLL.RAR
|
http://gus.biysk.ru/os4/test/pached_dll/PATCHED_DLL.RAR
|
||||||
|
|
||||||
|
|
||||||
Compiling:
|
Compiling:
|
||||||
----------
|
----------
|
||||||
|
|
||||||
Open Watcom 1.9 or newer is tested. For the new Open Watcom V2 fork, see:
|
Open Watcom 1.9 or newer is tested. For the new Open Watcom V2 fork, see:
|
||||||
https://github.com/open-watcom/ and https://open-watcom.github.io
|
https://github.com/open-watcom/ and https://open-watcom.github.io
|
||||||
WATCOM environment variable must to be set to the Open Watcom install
|
WATCOM environment variable must to be set to the Open Watcom install
|
||||||
directory. To compile, run: wmake -f Makefile.os2
|
directory. To compile, run: wmake -f Makefile.os2
|
||||||
|
|
||||||
|
|
||||||
Installing:
|
Installing:
|
||||||
-----------
|
-----------
|
||||||
|
|
||||||
- eComStation:
|
- eComStation:
|
||||||
|
|
||||||
If you have previously installed SDL2, make a Backup copy of SDL2.dll
|
If you have previously installed SDL2, make a Backup copy of SDL2.dll
|
||||||
located in D:\ecs\dll (where D: is disk on which installed eComStation).
|
located in D:\ecs\dll (where D: is disk on which installed eComStation).
|
||||||
Stop all programs running with SDL2. Copy SDL2.dll to D:\ecs\dll
|
Stop all programs running with SDL2. Copy SDL2.dll to D:\ecs\dll
|
||||||
|
|
||||||
- OS/2:
|
- OS/2:
|
||||||
|
|
||||||
Copy SDL2.dll to any directory on your LIBPATH. If you have a previous
|
Copy SDL2.dll to any directory on your LIBPATH. If you have a previous
|
||||||
version installed, close all SDL2 applications before replacing the old
|
version installed, close all SDL2 applications before replacing the old
|
||||||
copy. Also make sure that any other older versions of DLLs are removed
|
copy. Also make sure that any other older versions of DLLs are removed
|
||||||
from your system.
|
from your system.
|
||||||
|
|
||||||
|
|
||||||
Joysticks in SDL2:
|
Joysticks in SDL2:
|
||||||
------------------
|
------------------
|
||||||
|
|
||||||
The joystick code in SDL2 is a direct forward-port from the SDL-1.2 version.
|
The joystick code in SDL2 is a direct forward-port from the SDL-1.2 version.
|
||||||
Here is the original documentation from SDL-1.2:
|
Here is the original documentation from SDL-1.2:
|
||||||
|
|
||||||
The Joystick detection only works for standard joysticks (2 buttons, 2 axes
|
The Joystick detection only works for standard joysticks (2 buttons, 2 axes
|
||||||
and the like). Therefore, if you use a non-standard joystick, you should
|
and the like). Therefore, if you use a non-standard joystick, you should
|
||||||
specify its features in the SDL_OS2_JOYSTICK environment variable in a batch
|
specify its features in the SDL_OS2_JOYSTICK environment variable in a batch
|
||||||
file or CONFIG.SYS, so SDL applications can provide full capability to your
|
file or CONFIG.SYS, so SDL applications can provide full capability to your
|
||||||
device. The syntax is:
|
device. The syntax is:
|
||||||
|
|
||||||
SET SDL_OS2_JOYSTICK=[JOYSTICK_NAME] [AXES] [BUTTONS] [HATS] [BALLS]
|
SET SDL_OS2_JOYSTICK=[JOYSTICK_NAME] [AXES] [BUTTONS] [HATS] [BALLS]
|
||||||
|
|
||||||
So, it you have a Gravis GamePad with 4 axes, 2 buttons, 2 hats and 0 balls,
|
So, it you have a Gravis GamePad with 4 axes, 2 buttons, 2 hats and 0 balls,
|
||||||
the line should be:
|
the line should be:
|
||||||
|
|
||||||
SET SDL_OS2_JOYSTICK=Gravis_GamePad 4 2 2 0
|
SET SDL_OS2_JOYSTICK=Gravis_GamePad 4 2 2 0
|
||||||
|
|
||||||
If you want to add spaces in your joystick name, just surround it with
|
If you want to add spaces in your joystick name, just surround it with
|
||||||
quotes or double-quotes:
|
quotes or double-quotes:
|
||||||
|
|
||||||
SET SDL_OS2_JOYSTICK='Gravis GamePad' 4 2 2 0
|
SET SDL_OS2_JOYSTICK='Gravis GamePad' 4 2 2 0
|
||||||
|
|
||||||
or
|
or
|
||||||
|
|
||||||
SET SDL_OS2_JOYSTICK="Gravis GamePad" 4 2 2 0
|
SET SDL_OS2_JOYSTICK="Gravis GamePad" 4 2 2 0
|
||||||
|
|
||||||
Note however that Balls and Hats are not supported under OS/2, and the
|
Note however that Balls and Hats are not supported under OS/2, and the
|
||||||
value will be ignored... but it is wise to define these correctly because
|
value will be ignored... but it is wise to define these correctly because
|
||||||
in the future those can be supported.
|
in the future those can be supported.
|
||||||
|
|
||||||
Also the number of buttons is limited to 2 when using two joysticks,
|
Also the number of buttons is limited to 2 when using two joysticks,
|
||||||
4 when using one joystick with 4 axes, 6 when using a joystick with 3 axes
|
4 when using one joystick with 4 axes, 6 when using a joystick with 3 axes
|
||||||
and 8 when using a joystick with 2 axes. Notice however these are limitations
|
and 8 when using a joystick with 2 axes. Notice however these are limitations
|
||||||
of the Joystick Port hardware, not OS/2.
|
of the Joystick Port hardware, not OS/2.
|
||||||
@@ -1,17 +1,17 @@
|
|||||||
Pandora
|
Pandora
|
||||||
=====================================================================
|
=====================================================================
|
||||||
|
|
||||||
( http://openpandora.org/ )
|
( http://openpandora.org/ )
|
||||||
- A pandora specific video driver was written to allow SDL 2.0 with OpenGL ES
|
- A pandora specific video driver was written to allow SDL 2.0 with OpenGL ES
|
||||||
support to work on the pandora under the framebuffer. This driver do not have
|
support to work on the pandora under the framebuffer. This driver do not have
|
||||||
input support for now, so if you use it you will have to add your own control code.
|
input support for now, so if you use it you will have to add your own control code.
|
||||||
The video driver name is "pandora" so if you have problem running it from
|
The video driver name is "pandora" so if you have problem running it from
|
||||||
the framebuffer, try to set the following variable before starting your application :
|
the framebuffer, try to set the following variable before starting your application :
|
||||||
"export SDL_VIDEODRIVER=pandora"
|
"export SDL_VIDEODRIVER=pandora"
|
||||||
|
|
||||||
- OpenGL ES support was added to the x11 driver, so it's working like the normal
|
- OpenGL ES support was added to the x11 driver, so it's working like the normal
|
||||||
x11 driver one with OpenGLX support, with SDL input event's etc..
|
x11 driver one with OpenGLX support, with SDL input event's etc..
|
||||||
|
|
||||||
|
|
||||||
David Carré (Cpasjuste)
|
David Carré (Cpasjuste)
|
||||||
cpasjuste@gmail.com
|
cpasjuste@gmail.com
|
||||||
@@ -1,8 +1,8 @@
|
|||||||
Platforms
|
Platforms
|
||||||
=========
|
=========
|
||||||
|
|
||||||
We maintain the list of supported platforms on our wiki now, and how to
|
We maintain the list of supported platforms on our wiki now, and how to
|
||||||
build and install SDL for those platforms:
|
build and install SDL for those platforms:
|
||||||
|
|
||||||
https://wiki.libsdl.org/Installation
|
https://wiki.libsdl.org/Installation
|
||||||
|
|
||||||
@@ -1,68 +1,68 @@
|
|||||||
Porting
|
Porting
|
||||||
=======
|
=======
|
||||||
|
|
||||||
* Porting To A New Platform
|
* Porting To A New Platform
|
||||||
|
|
||||||
The first thing you have to do when porting to a new platform, is look at
|
The first thing you have to do when porting to a new platform, is look at
|
||||||
include/SDL_platform.h and create an entry there for your operating system.
|
include/SDL_platform.h and create an entry there for your operating system.
|
||||||
The standard format is "__PLATFORM__", where PLATFORM is the name of the OS.
|
The standard format is "__PLATFORM__", where PLATFORM is the name of the OS.
|
||||||
Ideally SDL_platform.h will be able to auto-detect the system it's building
|
Ideally SDL_platform.h will be able to auto-detect the system it's building
|
||||||
on based on C preprocessor symbols.
|
on based on C preprocessor symbols.
|
||||||
|
|
||||||
There are two basic ways of building SDL at the moment:
|
There are two basic ways of building SDL at the moment:
|
||||||
|
|
||||||
1. The "UNIX" way: ./configure; make; make install
|
1. The "UNIX" way: ./configure; make; make install
|
||||||
|
|
||||||
If you have a GNUish system, then you might try this. Edit configure.ac,
|
If you have a GNUish system, then you might try this. Edit configure.ac,
|
||||||
take a look at the large section labelled:
|
take a look at the large section labelled:
|
||||||
|
|
||||||
"Set up the configuration based on the host platform!"
|
"Set up the configuration based on the host platform!"
|
||||||
|
|
||||||
Add a section for your platform, and then re-run autogen.sh and build!
|
Add a section for your platform, and then re-run autogen.sh and build!
|
||||||
|
|
||||||
2. Using an IDE:
|
2. Using an IDE:
|
||||||
|
|
||||||
If you're using an IDE or other non-configure build system, you'll probably
|
If you're using an IDE or other non-configure build system, you'll probably
|
||||||
want to create a custom SDL_config.h for your platform. Edit SDL_config.h,
|
want to create a custom SDL_config.h for your platform. Edit SDL_config.h,
|
||||||
add a section for your platform, and create a custom SDL_config_{platform}.h,
|
add a section for your platform, and create a custom SDL_config_{platform}.h,
|
||||||
based on SDL_config_minimal.h and SDL_config.h.in
|
based on SDL_config_minimal.h and SDL_config.h.in
|
||||||
|
|
||||||
Add the top level include directory to the header search path, and then add
|
Add the top level include directory to the header search path, and then add
|
||||||
the following sources to the project:
|
the following sources to the project:
|
||||||
|
|
||||||
src/*.c
|
src/*.c
|
||||||
src/atomic/*.c
|
src/atomic/*.c
|
||||||
src/audio/*.c
|
src/audio/*.c
|
||||||
src/cpuinfo/*.c
|
src/cpuinfo/*.c
|
||||||
src/events/*.c
|
src/events/*.c
|
||||||
src/file/*.c
|
src/file/*.c
|
||||||
src/haptic/*.c
|
src/haptic/*.c
|
||||||
src/joystick/*.c
|
src/joystick/*.c
|
||||||
src/power/*.c
|
src/power/*.c
|
||||||
src/render/*.c
|
src/render/*.c
|
||||||
src/render/software/*.c
|
src/render/software/*.c
|
||||||
src/stdlib/*.c
|
src/stdlib/*.c
|
||||||
src/thread/*.c
|
src/thread/*.c
|
||||||
src/timer/*.c
|
src/timer/*.c
|
||||||
src/video/*.c
|
src/video/*.c
|
||||||
src/audio/disk/*.c
|
src/audio/disk/*.c
|
||||||
src/audio/dummy/*.c
|
src/audio/dummy/*.c
|
||||||
src/filesystem/dummy/*.c
|
src/filesystem/dummy/*.c
|
||||||
src/video/dummy/*.c
|
src/video/dummy/*.c
|
||||||
src/haptic/dummy/*.c
|
src/haptic/dummy/*.c
|
||||||
src/joystick/dummy/*.c
|
src/joystick/dummy/*.c
|
||||||
src/main/dummy/*.c
|
src/main/dummy/*.c
|
||||||
src/thread/generic/*.c
|
src/thread/generic/*.c
|
||||||
src/timer/dummy/*.c
|
src/timer/dummy/*.c
|
||||||
src/loadso/dummy/*.c
|
src/loadso/dummy/*.c
|
||||||
|
|
||||||
|
|
||||||
Once you have a working library without any drivers, you can go back to each
|
Once you have a working library without any drivers, you can go back to each
|
||||||
of the major subsystems and start implementing drivers for your platform.
|
of the major subsystems and start implementing drivers for your platform.
|
||||||
|
|
||||||
If you have any questions, don't hesitate to ask on the SDL mailing list:
|
If you have any questions, don't hesitate to ask on the SDL mailing list:
|
||||||
http://www.libsdl.org/mailing-list.php
|
http://www.libsdl.org/mailing-list.php
|
||||||
|
|
||||||
Enjoy!
|
Enjoy!
|
||||||
Sam Lantinga (slouken@libsdl.org)
|
Sam Lantinga (slouken@libsdl.org)
|
||||||
|
|
||||||
@@ -1,51 +1,51 @@
|
|||||||
PS2
|
PS2
|
||||||
======
|
======
|
||||||
SDL2 port for the Sony Playstation 2 contributed by:
|
SDL2 port for the Sony Playstation 2 contributed by:
|
||||||
- Francisco Javier Trujillo Mata
|
- Francisco Javier Trujillo Mata
|
||||||
|
|
||||||
|
|
||||||
Credit to
|
Credit to
|
||||||
- The guys that ported SDL to PSP & Vita because I'm taking them as reference.
|
- The guys that ported SDL to PSP & Vita because I'm taking them as reference.
|
||||||
- David G. F. for helping me with several issues and tests.
|
- David G. F. for helping me with several issues and tests.
|
||||||
|
|
||||||
## Building
|
## Building
|
||||||
To build SDL2 library for the PS2, make sure you have the latest PS2Dev status and run:
|
To build SDL2 library for the PS2, make sure you have the latest PS2Dev status and run:
|
||||||
```bash
|
```bash
|
||||||
cmake -S. -Bbuild -DCMAKE_BUILD_TYPE=Release -DCMAKE_TOOLCHAIN_FILE=$PS2DEV/ps2sdk/ps2dev.cmake
|
cmake -S. -Bbuild -DCMAKE_BUILD_TYPE=Release -DCMAKE_TOOLCHAIN_FILE=$PS2DEV/ps2sdk/ps2dev.cmake
|
||||||
cmake --build build
|
cmake --build build
|
||||||
cmake --install build
|
cmake --install build
|
||||||
```
|
```
|
||||||
|
|
||||||
## Hints
|
## Hints
|
||||||
The PS2 port has a special Hint for having a dynamic VSYNC. The Hint is `SDL_HINT_PS2_DYNAMIC_VSYNC`.
|
The PS2 port has a special Hint for having a dynamic VSYNC. The Hint is `SDL_HINT_PS2_DYNAMIC_VSYNC`.
|
||||||
If you enabled the dynamic vsync having as well `SDL_RENDERER_PRESENTVSYNC` enabled, then if the app is not able to run at 60 FPS, automatically the `vsync` will be disabled having a better performance, instead of droping FPS to 30.
|
If you enabled the dynamic vsync having as well `SDL_RENDERER_PRESENTVSYNC` enabled, then if the app is not able to run at 60 FPS, automatically the `vsync` will be disabled having a better performance, instead of droping FPS to 30.
|
||||||
|
|
||||||
## Notes
|
## Notes
|
||||||
If you trying to debug a SDL app through [ps2client](https://github.com/ps2dev/ps2client) you need to avoid the IOP reset, otherwise you will lose the conection with your computer.
|
If you trying to debug a SDL app through [ps2client](https://github.com/ps2dev/ps2client) you need to avoid the IOP reset, otherwise you will lose the conection with your computer.
|
||||||
So to avoid the reset of the IOP CPU, you need to call to the macro `SDL_PS2_SKIP_IOP_RESET();`.
|
So to avoid the reset of the IOP CPU, you need to call to the macro `SDL_PS2_SKIP_IOP_RESET();`.
|
||||||
It could be something similar as:
|
It could be something similar as:
|
||||||
```c
|
```c
|
||||||
.....
|
.....
|
||||||
|
|
||||||
SDL_PS2_SKIP_IOP_RESET();
|
SDL_PS2_SKIP_IOP_RESET();
|
||||||
|
|
||||||
int main(int argc, char *argv[])
|
int main(int argc, char *argv[])
|
||||||
{
|
{
|
||||||
.....
|
.....
|
||||||
```
|
```
|
||||||
For a release binary is recommendable to reset the IOP always.
|
For a release binary is recommendable to reset the IOP always.
|
||||||
|
|
||||||
Remember to do a clean compilation everytime you enable or disable the `SDL_PS2_SKIP_IOP_RESET` otherwise the change won't be reflected.
|
Remember to do a clean compilation everytime you enable or disable the `SDL_PS2_SKIP_IOP_RESET` otherwise the change won't be reflected.
|
||||||
|
|
||||||
## Getting PS2 Dev
|
## Getting PS2 Dev
|
||||||
[Installing PS2 Dev](https://github.com/ps2dev/ps2dev)
|
[Installing PS2 Dev](https://github.com/ps2dev/ps2dev)
|
||||||
|
|
||||||
## Running on PCSX2 Emulator
|
## Running on PCSX2 Emulator
|
||||||
[PCSX2](https://github.com/PCSX2/pcsx2)
|
[PCSX2](https://github.com/PCSX2/pcsx2)
|
||||||
|
|
||||||
[More PCSX2 information](https://pcsx2.net/)
|
[More PCSX2 information](https://pcsx2.net/)
|
||||||
|
|
||||||
## To Do
|
## To Do
|
||||||
- PS2 Screen Keyboard
|
- PS2 Screen Keyboard
|
||||||
- Dialogs
|
- Dialogs
|
||||||
- Others
|
- Others
|
||||||
@@ -1,36 +1,36 @@
|
|||||||
PSP
|
PSP
|
||||||
======
|
======
|
||||||
SDL2 port for the Sony PSP contributed by:
|
SDL2 port for the Sony PSP contributed by:
|
||||||
- Captian Lex
|
- Captian Lex
|
||||||
- Francisco Javier Trujillo Mata
|
- Francisco Javier Trujillo Mata
|
||||||
- Wouter Wijsman
|
- Wouter Wijsman
|
||||||
|
|
||||||
|
|
||||||
Credit to
|
Credit to
|
||||||
Marcus R.Brown,Jim Paris,Matthew H for the original SDL 1.2 for PSP
|
Marcus R.Brown,Jim Paris,Matthew H for the original SDL 1.2 for PSP
|
||||||
Geecko for his PSP GU lib "Glib2d"
|
Geecko for his PSP GU lib "Glib2d"
|
||||||
|
|
||||||
## Building
|
## Building
|
||||||
To build SDL2 library for the PSP, make sure you have the latest PSPDev status and run:
|
To build SDL2 library for the PSP, make sure you have the latest PSPDev status and run:
|
||||||
```bash
|
```bash
|
||||||
cmake -S. -Bbuild -DCMAKE_BUILD_TYPE=Release -DCMAKE_TOOLCHAIN_FILE=$PSPDEV/psp/share/pspdev.cmake
|
cmake -S. -Bbuild -DCMAKE_BUILD_TYPE=Release -DCMAKE_TOOLCHAIN_FILE=$PSPDEV/psp/share/pspdev.cmake
|
||||||
cmake --build build
|
cmake --build build
|
||||||
cmake --install build
|
cmake --install build
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
## Getting PSP Dev
|
## Getting PSP Dev
|
||||||
[Installing PSP Dev](https://github.com/pspdev/pspdev)
|
[Installing PSP Dev](https://github.com/pspdev/pspdev)
|
||||||
|
|
||||||
## Running on PPSSPP Emulator
|
## Running on PPSSPP Emulator
|
||||||
[PPSSPP](https://github.com/hrydgard/ppsspp)
|
[PPSSPP](https://github.com/hrydgard/ppsspp)
|
||||||
|
|
||||||
[Build Instructions](https://github.com/hrydgard/ppsspp/wiki/Build-instructions)
|
[Build Instructions](https://github.com/hrydgard/ppsspp/wiki/Build-instructions)
|
||||||
|
|
||||||
|
|
||||||
## Compiling a HelloWorld
|
## Compiling a HelloWorld
|
||||||
[PSP Hello World](https://psp-dev.org/doku.php?id=tutorial:hello_world)
|
[PSP Hello World](https://psp-dev.org/doku.php?id=tutorial:hello_world)
|
||||||
|
|
||||||
## To Do
|
## To Do
|
||||||
- PSP Screen Keyboard
|
- PSP Screen Keyboard
|
||||||
- Dialogs
|
- Dialogs
|
||||||
@@ -1,180 +1,180 @@
|
|||||||
Raspberry Pi
|
Raspberry Pi
|
||||||
============
|
============
|
||||||
|
|
||||||
Requirements:
|
Requirements:
|
||||||
|
|
||||||
Raspbian (other Linux distros may work as well).
|
Raspbian (other Linux distros may work as well).
|
||||||
|
|
||||||
Features
|
Features
|
||||||
--------
|
--------
|
||||||
|
|
||||||
* Works without X11
|
* Works without X11
|
||||||
* Hardware accelerated OpenGL ES 2.x
|
* Hardware accelerated OpenGL ES 2.x
|
||||||
* Sound via ALSA
|
* Sound via ALSA
|
||||||
* Input (mouse/keyboard/joystick) via EVDEV
|
* Input (mouse/keyboard/joystick) via EVDEV
|
||||||
* Hotplugging of input devices via UDEV
|
* Hotplugging of input devices via UDEV
|
||||||
|
|
||||||
|
|
||||||
Raspbian Build Dependencies
|
Raspbian Build Dependencies
|
||||||
---------------------------
|
---------------------------
|
||||||
|
|
||||||
sudo apt-get install libudev-dev libasound2-dev libdbus-1-dev
|
sudo apt-get install libudev-dev libasound2-dev libdbus-1-dev
|
||||||
|
|
||||||
You also need the VideoCore binary stuff that ships in /opt/vc for EGL and
|
You also need the VideoCore binary stuff that ships in /opt/vc for EGL and
|
||||||
OpenGL ES 2.x, it usually comes pre-installed, but in any case:
|
OpenGL ES 2.x, it usually comes pre-installed, but in any case:
|
||||||
|
|
||||||
sudo apt-get install libraspberrypi0 libraspberrypi-bin libraspberrypi-dev
|
sudo apt-get install libraspberrypi0 libraspberrypi-bin libraspberrypi-dev
|
||||||
|
|
||||||
|
|
||||||
NEON
|
NEON
|
||||||
----
|
----
|
||||||
|
|
||||||
If your Pi has NEON support, make sure you add -mfpu=neon to your CFLAGS so
|
If your Pi has NEON support, make sure you add -mfpu=neon to your CFLAGS so
|
||||||
that SDL will select some otherwise-disabled highly-optimized code. The
|
that SDL will select some otherwise-disabled highly-optimized code. The
|
||||||
original Pi units don't have NEON, the Pi2 probably does, and the Pi3
|
original Pi units don't have NEON, the Pi2 probably does, and the Pi3
|
||||||
definitely does.
|
definitely does.
|
||||||
|
|
||||||
|
|
||||||
Cross compiling from x86 Linux
|
Cross compiling from x86 Linux
|
||||||
------------------------------
|
------------------------------
|
||||||
|
|
||||||
To cross compile SDL for Raspbian from your desktop machine, you'll need a
|
To cross compile SDL for Raspbian from your desktop machine, you'll need a
|
||||||
Raspbian system root and the cross compilation tools. We'll assume these tools
|
Raspbian system root and the cross compilation tools. We'll assume these tools
|
||||||
will be placed in /opt/rpi-tools
|
will be placed in /opt/rpi-tools
|
||||||
|
|
||||||
sudo git clone --depth 1 https://github.com/raspberrypi/tools /opt/rpi-tools
|
sudo git clone --depth 1 https://github.com/raspberrypi/tools /opt/rpi-tools
|
||||||
|
|
||||||
You'll also need a Raspbian binary image.
|
You'll also need a Raspbian binary image.
|
||||||
Get it from: http://downloads.raspberrypi.org/raspbian_latest
|
Get it from: http://downloads.raspberrypi.org/raspbian_latest
|
||||||
After unzipping, you'll get file with a name like: "<date>-wheezy-raspbian.img"
|
After unzipping, you'll get file with a name like: "<date>-wheezy-raspbian.img"
|
||||||
Let's assume the sysroot will be built in /opt/rpi-sysroot.
|
Let's assume the sysroot will be built in /opt/rpi-sysroot.
|
||||||
|
|
||||||
export SYSROOT=/opt/rpi-sysroot
|
export SYSROOT=/opt/rpi-sysroot
|
||||||
sudo kpartx -a -v <path_to_raspbian_image>.img
|
sudo kpartx -a -v <path_to_raspbian_image>.img
|
||||||
sudo mount -o loop /dev/mapper/loop0p2 /mnt
|
sudo mount -o loop /dev/mapper/loop0p2 /mnt
|
||||||
sudo cp -r /mnt $SYSROOT
|
sudo cp -r /mnt $SYSROOT
|
||||||
sudo apt-get install qemu binfmt-support qemu-user-static
|
sudo apt-get install qemu binfmt-support qemu-user-static
|
||||||
sudo cp /usr/bin/qemu-arm-static $SYSROOT/usr/bin
|
sudo cp /usr/bin/qemu-arm-static $SYSROOT/usr/bin
|
||||||
sudo mount --bind /dev $SYSROOT/dev
|
sudo mount --bind /dev $SYSROOT/dev
|
||||||
sudo mount --bind /proc $SYSROOT/proc
|
sudo mount --bind /proc $SYSROOT/proc
|
||||||
sudo mount --bind /sys $SYSROOT/sys
|
sudo mount --bind /sys $SYSROOT/sys
|
||||||
|
|
||||||
Now, before chrooting into the ARM sysroot, you'll need to apply a workaround,
|
Now, before chrooting into the ARM sysroot, you'll need to apply a workaround,
|
||||||
edit $SYSROOT/etc/ld.so.preload and comment out all lines in it.
|
edit $SYSROOT/etc/ld.so.preload and comment out all lines in it.
|
||||||
|
|
||||||
sudo chroot $SYSROOT
|
sudo chroot $SYSROOT
|
||||||
apt-get install libudev-dev libasound2-dev libdbus-1-dev libraspberrypi0 libraspberrypi-bin libraspberrypi-dev libx11-dev libxext-dev libxrandr-dev libxcursor-dev libxi-dev libxss-dev
|
apt-get install libudev-dev libasound2-dev libdbus-1-dev libraspberrypi0 libraspberrypi-bin libraspberrypi-dev libx11-dev libxext-dev libxrandr-dev libxcursor-dev libxi-dev libxss-dev
|
||||||
exit
|
exit
|
||||||
sudo umount $SYSROOT/dev
|
sudo umount $SYSROOT/dev
|
||||||
sudo umount $SYSROOT/proc
|
sudo umount $SYSROOT/proc
|
||||||
sudo umount $SYSROOT/sys
|
sudo umount $SYSROOT/sys
|
||||||
sudo umount /mnt
|
sudo umount /mnt
|
||||||
|
|
||||||
There's one more fix required, as the libdl.so symlink uses an absolute path
|
There's one more fix required, as the libdl.so symlink uses an absolute path
|
||||||
which doesn't quite work in our setup.
|
which doesn't quite work in our setup.
|
||||||
|
|
||||||
sudo rm -rf $SYSROOT/usr/lib/arm-linux-gnueabihf/libdl.so
|
sudo rm -rf $SYSROOT/usr/lib/arm-linux-gnueabihf/libdl.so
|
||||||
sudo ln -s ../../../lib/arm-linux-gnueabihf/libdl.so.2 $SYSROOT/usr/lib/arm-linux-gnueabihf/libdl.so
|
sudo ln -s ../../../lib/arm-linux-gnueabihf/libdl.so.2 $SYSROOT/usr/lib/arm-linux-gnueabihf/libdl.so
|
||||||
|
|
||||||
The final step is compiling SDL itself.
|
The final step is compiling SDL itself.
|
||||||
|
|
||||||
export CC="/opt/rpi-tools/arm-bcm2708/gcc-linaro-arm-linux-gnueabihf-raspbian/bin/arm-linux-gnueabihf-gcc --sysroot=$SYSROOT -I$SYSROOT/opt/vc/include -I$SYSROOT/usr/include -I$SYSROOT/opt/vc/include/interface/vcos/pthreads -I$SYSROOT/opt/vc/include/interface/vmcs_host/linux"
|
export CC="/opt/rpi-tools/arm-bcm2708/gcc-linaro-arm-linux-gnueabihf-raspbian/bin/arm-linux-gnueabihf-gcc --sysroot=$SYSROOT -I$SYSROOT/opt/vc/include -I$SYSROOT/usr/include -I$SYSROOT/opt/vc/include/interface/vcos/pthreads -I$SYSROOT/opt/vc/include/interface/vmcs_host/linux"
|
||||||
cd <SDL SOURCE>
|
cd <SDL SOURCE>
|
||||||
mkdir -p build;cd build
|
mkdir -p build;cd build
|
||||||
LDFLAGS="-L$SYSROOT/opt/vc/lib" ../configure --with-sysroot=$SYSROOT --host=arm-raspberry-linux-gnueabihf --prefix=$PWD/rpi-sdl2-installed --disable-pulseaudio --disable-esd
|
LDFLAGS="-L$SYSROOT/opt/vc/lib" ../configure --with-sysroot=$SYSROOT --host=arm-raspberry-linux-gnueabihf --prefix=$PWD/rpi-sdl2-installed --disable-pulseaudio --disable-esd
|
||||||
make
|
make
|
||||||
make install
|
make install
|
||||||
|
|
||||||
To be able to deploy this to /usr/local in the Raspbian system you need to fix up a few paths:
|
To be able to deploy this to /usr/local in the Raspbian system you need to fix up a few paths:
|
||||||
|
|
||||||
perl -w -pi -e "s#$PWD/rpi-sdl2-installed#/usr/local#g;" ./rpi-sdl2-installed/lib/libSDL2.la ./rpi-sdl2-installed/lib/pkgconfig/sdl2.pc ./rpi-sdl2-installed/bin/sdl2-config
|
perl -w -pi -e "s#$PWD/rpi-sdl2-installed#/usr/local#g;" ./rpi-sdl2-installed/lib/libSDL2.la ./rpi-sdl2-installed/lib/pkgconfig/sdl2.pc ./rpi-sdl2-installed/bin/sdl2-config
|
||||||
|
|
||||||
Apps don't work or poor video/audio performance
|
Apps don't work or poor video/audio performance
|
||||||
-----------------------------------------------
|
-----------------------------------------------
|
||||||
|
|
||||||
If you get sound problems, buffer underruns, etc, run "sudo rpi-update" to
|
If you get sound problems, buffer underruns, etc, run "sudo rpi-update" to
|
||||||
update the RPi's firmware. Note that doing so will fix these problems, but it
|
update the RPi's firmware. Note that doing so will fix these problems, but it
|
||||||
will also render the CMA - Dynamic Memory Split functionality useless.
|
will also render the CMA - Dynamic Memory Split functionality useless.
|
||||||
|
|
||||||
Also, by default the Raspbian distro configures the GPU RAM at 64MB, this is too
|
Also, by default the Raspbian distro configures the GPU RAM at 64MB, this is too
|
||||||
low in general, specially if a 1080p TV is hooked up.
|
low in general, specially if a 1080p TV is hooked up.
|
||||||
|
|
||||||
See here how to configure this setting: http://elinux.org/RPiconfig
|
See here how to configure this setting: http://elinux.org/RPiconfig
|
||||||
|
|
||||||
Using a fixed gpu_mem=128 is the best option (specially if you updated the
|
Using a fixed gpu_mem=128 is the best option (specially if you updated the
|
||||||
firmware, using CMA probably won't work, at least it's the current case).
|
firmware, using CMA probably won't work, at least it's the current case).
|
||||||
|
|
||||||
No input
|
No input
|
||||||
--------
|
--------
|
||||||
|
|
||||||
Make sure you belong to the "input" group.
|
Make sure you belong to the "input" group.
|
||||||
|
|
||||||
sudo usermod -aG input `whoami`
|
sudo usermod -aG input `whoami`
|
||||||
|
|
||||||
No HDMI Audio
|
No HDMI Audio
|
||||||
-------------
|
-------------
|
||||||
|
|
||||||
If you notice that ALSA works but there's no audio over HDMI, try adding:
|
If you notice that ALSA works but there's no audio over HDMI, try adding:
|
||||||
|
|
||||||
hdmi_drive=2
|
hdmi_drive=2
|
||||||
|
|
||||||
to your config.txt file and reboot.
|
to your config.txt file and reboot.
|
||||||
|
|
||||||
Reference: http://www.raspberrypi.org/phpBB3/viewtopic.php?t=5062
|
Reference: http://www.raspberrypi.org/phpBB3/viewtopic.php?t=5062
|
||||||
|
|
||||||
Text Input API support
|
Text Input API support
|
||||||
----------------------
|
----------------------
|
||||||
|
|
||||||
The Text Input API is supported, with translation of scan codes done via the
|
The Text Input API is supported, with translation of scan codes done via the
|
||||||
kernel symbol tables. For this to work, SDL needs access to a valid console.
|
kernel symbol tables. For this to work, SDL needs access to a valid console.
|
||||||
If you notice there's no SDL_TEXTINPUT message being emitted, double check that
|
If you notice there's no SDL_TEXTINPUT message being emitted, double check that
|
||||||
your app has read access to one of the following:
|
your app has read access to one of the following:
|
||||||
|
|
||||||
* /proc/self/fd/0
|
* /proc/self/fd/0
|
||||||
* /dev/tty
|
* /dev/tty
|
||||||
* /dev/tty[0...6]
|
* /dev/tty[0...6]
|
||||||
* /dev/vc/0
|
* /dev/vc/0
|
||||||
* /dev/console
|
* /dev/console
|
||||||
|
|
||||||
This is usually not a problem if you run from the physical terminal (as opposed
|
This is usually not a problem if you run from the physical terminal (as opposed
|
||||||
to running from a pseudo terminal, such as via SSH). If running from a PTS, a
|
to running from a pseudo terminal, such as via SSH). If running from a PTS, a
|
||||||
quick workaround is to run your app as root or add yourself to the tty group,
|
quick workaround is to run your app as root or add yourself to the tty group,
|
||||||
then re-login to the system.
|
then re-login to the system.
|
||||||
|
|
||||||
sudo usermod -aG tty `whoami`
|
sudo usermod -aG tty `whoami`
|
||||||
|
|
||||||
The keyboard layout used by SDL is the same as the one the kernel uses.
|
The keyboard layout used by SDL is the same as the one the kernel uses.
|
||||||
To configure the layout on Raspbian:
|
To configure the layout on Raspbian:
|
||||||
|
|
||||||
sudo dpkg-reconfigure keyboard-configuration
|
sudo dpkg-reconfigure keyboard-configuration
|
||||||
|
|
||||||
To configure the locale, which controls which keys are interpreted as letters,
|
To configure the locale, which controls which keys are interpreted as letters,
|
||||||
this determining the CAPS LOCK behavior:
|
this determining the CAPS LOCK behavior:
|
||||||
|
|
||||||
sudo dpkg-reconfigure locales
|
sudo dpkg-reconfigure locales
|
||||||
|
|
||||||
|
|
||||||
OpenGL problems
|
OpenGL problems
|
||||||
---------------
|
---------------
|
||||||
|
|
||||||
If you have desktop OpenGL headers installed at build time in your RPi or cross
|
If you have desktop OpenGL headers installed at build time in your RPi or cross
|
||||||
compilation environment, support for it will be built in. However, the chipset
|
compilation environment, support for it will be built in. However, the chipset
|
||||||
does not actually have support for it, which causes issues in certain SDL apps
|
does not actually have support for it, which causes issues in certain SDL apps
|
||||||
since the presence of OpenGL support supersedes the ES/ES2 variants.
|
since the presence of OpenGL support supersedes the ES/ES2 variants.
|
||||||
The workaround is to disable OpenGL at configuration time:
|
The workaround is to disable OpenGL at configuration time:
|
||||||
|
|
||||||
./configure --disable-video-opengl
|
./configure --disable-video-opengl
|
||||||
|
|
||||||
Or if the application uses the Render functions, you can use the SDL_RENDER_DRIVER
|
Or if the application uses the Render functions, you can use the SDL_RENDER_DRIVER
|
||||||
environment variable:
|
environment variable:
|
||||||
|
|
||||||
export SDL_RENDER_DRIVER=opengles2
|
export SDL_RENDER_DRIVER=opengles2
|
||||||
|
|
||||||
Notes
|
Notes
|
||||||
-----
|
-----
|
||||||
|
|
||||||
* When launching apps remotely (via SSH), SDL can prevent local keystrokes from
|
* When launching apps remotely (via SSH), SDL can prevent local keystrokes from
|
||||||
leaking into the console only if it has root privileges. Launching apps locally
|
leaking into the console only if it has root privileges. Launching apps locally
|
||||||
does not suffer from this issue.
|
does not suffer from this issue.
|
||||||
|
|
||||||
|
|
||||||
@@ -1,41 +1,41 @@
|
|||||||
RISC OS
|
RISC OS
|
||||||
=======
|
=======
|
||||||
|
|
||||||
Requirements:
|
Requirements:
|
||||||
|
|
||||||
* RISC OS 3.5 or later.
|
* RISC OS 3.5 or later.
|
||||||
* [SharedUnixLibrary](http://www.riscos.info/packages/LibraryDetails.html#SharedUnixLibraryarm).
|
* [SharedUnixLibrary](http://www.riscos.info/packages/LibraryDetails.html#SharedUnixLibraryarm).
|
||||||
* [DigitalRenderer](http://www.riscos.info/packages/LibraryDetails.html#DRendererarm), for audio support.
|
* [DigitalRenderer](http://www.riscos.info/packages/LibraryDetails.html#DRendererarm), for audio support.
|
||||||
* [Iconv](http://www.netsurf-browser.org/projects/iconv/), for `SDL_iconv` and related functions.
|
* [Iconv](http://www.netsurf-browser.org/projects/iconv/), for `SDL_iconv` and related functions.
|
||||||
|
|
||||||
|
|
||||||
Compiling:
|
Compiling:
|
||||||
----------
|
----------
|
||||||
|
|
||||||
Currently, SDL2 for RISC OS only supports compiling with GCCSDK under Linux. Both the autoconf and CMake build systems are supported.
|
Currently, SDL2 for RISC OS only supports compiling with GCCSDK under Linux. Both the autoconf and CMake build systems are supported.
|
||||||
|
|
||||||
The following commands can be used to build SDL2 for RISC OS using autoconf:
|
The following commands can be used to build SDL2 for RISC OS using autoconf:
|
||||||
|
|
||||||
./configure --host=arm-unknown-riscos --prefix=$GCCSDK_INSTALL_ENV --disable-gcc-atomics
|
./configure --host=arm-unknown-riscos --prefix=$GCCSDK_INSTALL_ENV --disable-gcc-atomics
|
||||||
make
|
make
|
||||||
make install
|
make install
|
||||||
|
|
||||||
The following commands can be used to build SDL2 for RISC OS using CMake:
|
The following commands can be used to build SDL2 for RISC OS using CMake:
|
||||||
|
|
||||||
cmake -Bbuild-riscos -DCMAKE_TOOLCHAIN_FILE=$GCCSDK_INSTALL_ENV/toolchain-riscos.cmake -DRISCOS=ON -DCMAKE_INSTALL_PREFIX=$GCCSDK_INSTALL_ENV -DCMAKE_BUILD_TYPE=Release -DSDL_GCC_ATOMICS=OFF
|
cmake -Bbuild-riscos -DCMAKE_TOOLCHAIN_FILE=$GCCSDK_INSTALL_ENV/toolchain-riscos.cmake -DRISCOS=ON -DCMAKE_INSTALL_PREFIX=$GCCSDK_INSTALL_ENV -DCMAKE_BUILD_TYPE=Release -DSDL_GCC_ATOMICS=OFF
|
||||||
cmake --build build-riscos
|
cmake --build build-riscos
|
||||||
cmake --build build-riscos --target install
|
cmake --build build-riscos --target install
|
||||||
|
|
||||||
|
|
||||||
Current level of implementation
|
Current level of implementation
|
||||||
-------------------------------
|
-------------------------------
|
||||||
|
|
||||||
The video driver currently provides full screen video support with keyboard and mouse input. Windowed mode is not yet supported, but is planned in the future. Only software rendering is supported.
|
The video driver currently provides full screen video support with keyboard and mouse input. Windowed mode is not yet supported, but is planned in the future. Only software rendering is supported.
|
||||||
|
|
||||||
The filesystem APIs return either Unix-style paths or RISC OS-style paths based on the value of the `__riscosify_control` symbol, as is standard for UnixLib functions.
|
The filesystem APIs return either Unix-style paths or RISC OS-style paths based on the value of the `__riscosify_control` symbol, as is standard for UnixLib functions.
|
||||||
|
|
||||||
The audio, loadso, thread and timer APIs are currently provided by UnixLib.
|
The audio, loadso, thread and timer APIs are currently provided by UnixLib.
|
||||||
|
|
||||||
GCC atomics are currently broken on some platforms, meaning it's currently necessary to compile with `--disable-gcc-atomics` using autotools or `-DSDL_GCC_ATOMICS=OFF` using CMake.
|
GCC atomics are currently broken on some platforms, meaning it's currently necessary to compile with `--disable-gcc-atomics` using autotools or `-DSDL_GCC_ATOMICS=OFF` using CMake.
|
||||||
|
|
||||||
The joystick, locale and power APIs are not yet implemented.
|
The joystick, locale and power APIs are not yet implemented.
|
||||||
@@ -1,86 +1,86 @@
|
|||||||
Touch
|
Touch
|
||||||
===========================================================================
|
===========================================================================
|
||||||
System Specific Notes
|
System Specific Notes
|
||||||
===========================================================================
|
===========================================================================
|
||||||
Linux:
|
Linux:
|
||||||
The linux touch system is currently based off event streams, and proc/bus/devices. The active user must be given permissions to read /dev/input/TOUCHDEVICE, where TOUCHDEVICE is the event stream for your device. Currently only Wacom tablets are supported. If you have an unsupported tablet contact me at jim.tla+sdl_touch@gmail.com and I will help you get support for it.
|
The linux touch system is currently based off event streams, and proc/bus/devices. The active user must be given permissions to read /dev/input/TOUCHDEVICE, where TOUCHDEVICE is the event stream for your device. Currently only Wacom tablets are supported. If you have an unsupported tablet contact me at jim.tla+sdl_touch@gmail.com and I will help you get support for it.
|
||||||
|
|
||||||
Mac:
|
Mac:
|
||||||
The Mac and iPhone APIs are pretty. If your touch device supports them then you'll be fine. If it doesn't, then there isn't much we can do.
|
The Mac and iPhone APIs are pretty. If your touch device supports them then you'll be fine. If it doesn't, then there isn't much we can do.
|
||||||
|
|
||||||
iPhone:
|
iPhone:
|
||||||
Works out of box.
|
Works out of box.
|
||||||
|
|
||||||
Windows:
|
Windows:
|
||||||
Unfortunately there is no windows support as of yet. Support for Windows 7 is planned, but we currently have no way to test. If you have a Windows 7 WM_TOUCH supported device, and are willing to help test please contact me at jim.tla+sdl_touch@gmail.com
|
Unfortunately there is no windows support as of yet. Support for Windows 7 is planned, but we currently have no way to test. If you have a Windows 7 WM_TOUCH supported device, and are willing to help test please contact me at jim.tla+sdl_touch@gmail.com
|
||||||
|
|
||||||
===========================================================================
|
===========================================================================
|
||||||
Events
|
Events
|
||||||
===========================================================================
|
===========================================================================
|
||||||
SDL_FINGERDOWN:
|
SDL_FINGERDOWN:
|
||||||
Sent when a finger (or stylus) is placed on a touch device.
|
Sent when a finger (or stylus) is placed on a touch device.
|
||||||
Fields:
|
Fields:
|
||||||
* event.tfinger.touchId - the Id of the touch device.
|
* event.tfinger.touchId - the Id of the touch device.
|
||||||
* event.tfinger.fingerId - the Id of the finger which just went down.
|
* event.tfinger.fingerId - the Id of the finger which just went down.
|
||||||
* event.tfinger.x - the x coordinate of the touch (0..1)
|
* event.tfinger.x - the x coordinate of the touch (0..1)
|
||||||
* event.tfinger.y - the y coordinate of the touch (0..1)
|
* event.tfinger.y - the y coordinate of the touch (0..1)
|
||||||
* event.tfinger.pressure - the pressure of the touch (0..1)
|
* event.tfinger.pressure - the pressure of the touch (0..1)
|
||||||
|
|
||||||
SDL_FINGERMOTION:
|
SDL_FINGERMOTION:
|
||||||
Sent when a finger (or stylus) is moved on the touch device.
|
Sent when a finger (or stylus) is moved on the touch device.
|
||||||
Fields:
|
Fields:
|
||||||
Same as SDL_FINGERDOWN but with additional:
|
Same as SDL_FINGERDOWN but with additional:
|
||||||
* event.tfinger.dx - change in x coordinate during this motion event.
|
* event.tfinger.dx - change in x coordinate during this motion event.
|
||||||
* event.tfinger.dy - change in y coordinate during this motion event.
|
* event.tfinger.dy - change in y coordinate during this motion event.
|
||||||
|
|
||||||
SDL_FINGERUP:
|
SDL_FINGERUP:
|
||||||
Sent when a finger (or stylus) is lifted from the touch device.
|
Sent when a finger (or stylus) is lifted from the touch device.
|
||||||
Fields:
|
Fields:
|
||||||
Same as SDL_FINGERDOWN.
|
Same as SDL_FINGERDOWN.
|
||||||
|
|
||||||
|
|
||||||
===========================================================================
|
===========================================================================
|
||||||
Functions
|
Functions
|
||||||
===========================================================================
|
===========================================================================
|
||||||
SDL provides the ability to access the underlying SDL_Finger structures.
|
SDL provides the ability to access the underlying SDL_Finger structures.
|
||||||
These structures should _never_ be modified.
|
These structures should _never_ be modified.
|
||||||
|
|
||||||
The following functions are included from SDL_touch.h
|
The following functions are included from SDL_touch.h
|
||||||
|
|
||||||
To get a SDL_TouchID call SDL_GetTouchDevice(int index).
|
To get a SDL_TouchID call SDL_GetTouchDevice(int index).
|
||||||
This returns a SDL_TouchID.
|
This returns a SDL_TouchID.
|
||||||
IMPORTANT: If the touch has been removed, or there is no touch with the given index, SDL_GetTouchDevice() will return 0. Be sure to check for this!
|
IMPORTANT: If the touch has been removed, or there is no touch with the given index, SDL_GetTouchDevice() will return 0. Be sure to check for this!
|
||||||
|
|
||||||
The number of touch devices can be queried with SDL_GetNumTouchDevices().
|
The number of touch devices can be queried with SDL_GetNumTouchDevices().
|
||||||
|
|
||||||
A SDL_TouchID may be used to get pointers to SDL_Finger.
|
A SDL_TouchID may be used to get pointers to SDL_Finger.
|
||||||
|
|
||||||
SDL_GetNumTouchFingers(touchID) may be used to get the number of fingers currently down on the device.
|
SDL_GetNumTouchFingers(touchID) may be used to get the number of fingers currently down on the device.
|
||||||
|
|
||||||
The most common reason to access SDL_Finger is to query the fingers outside the event. In most cases accessing the fingers is using the event. This would be accomplished by code like the following:
|
The most common reason to access SDL_Finger is to query the fingers outside the event. In most cases accessing the fingers is using the event. This would be accomplished by code like the following:
|
||||||
|
|
||||||
float x = event.tfinger.x;
|
float x = event.tfinger.x;
|
||||||
float y = event.tfinger.y;
|
float y = event.tfinger.y;
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
To get a SDL_Finger, call SDL_GetTouchFinger(SDL_TouchID touchID, int index), where touchID is a SDL_TouchID, and index is the requested finger.
|
To get a SDL_Finger, call SDL_GetTouchFinger(SDL_TouchID touchID, int index), where touchID is a SDL_TouchID, and index is the requested finger.
|
||||||
This returns a SDL_Finger *, or NULL if the finger does not exist, or has been removed.
|
This returns a SDL_Finger *, or NULL if the finger does not exist, or has been removed.
|
||||||
A SDL_Finger is guaranteed to be persistent for the duration of a touch, but it will be de-allocated as soon as the finger is removed. This occurs when the SDL_FINGERUP event is _added_ to the event queue, and thus _before_ the SDL_FINGERUP event is polled.
|
A SDL_Finger is guaranteed to be persistent for the duration of a touch, but it will be de-allocated as soon as the finger is removed. This occurs when the SDL_FINGERUP event is _added_ to the event queue, and thus _before_ the SDL_FINGERUP event is polled.
|
||||||
As a result, be very careful to check for NULL return values.
|
As a result, be very careful to check for NULL return values.
|
||||||
|
|
||||||
A SDL_Finger has the following fields:
|
A SDL_Finger has the following fields:
|
||||||
* x, y:
|
* x, y:
|
||||||
The current coordinates of the touch.
|
The current coordinates of the touch.
|
||||||
* pressure:
|
* pressure:
|
||||||
The pressure of the touch.
|
The pressure of the touch.
|
||||||
|
|
||||||
|
|
||||||
===========================================================================
|
===========================================================================
|
||||||
Notes
|
Notes
|
||||||
===========================================================================
|
===========================================================================
|
||||||
For a complete example see test/testgesture.c
|
For a complete example see test/testgesture.c
|
||||||
|
|
||||||
Please direct questions/comments to:
|
Please direct questions/comments to:
|
||||||
jim.tla+sdl_touch@gmail.com
|
jim.tla+sdl_touch@gmail.com
|
||||||
(original author, API was changed since)
|
(original author, API was changed since)
|
||||||
@@ -1,60 +1,60 @@
|
|||||||
# Versioning
|
# Versioning
|
||||||
|
|
||||||
## Since 2.23.0
|
## Since 2.23.0
|
||||||
|
|
||||||
SDL follows an "odd/even" versioning policy, similar to GLib, GTK, Flatpak
|
SDL follows an "odd/even" versioning policy, similar to GLib, GTK, Flatpak
|
||||||
and older versions of the Linux kernel:
|
and older versions of the Linux kernel:
|
||||||
|
|
||||||
* The major version (first part) increases when backwards compatibility
|
* The major version (first part) increases when backwards compatibility
|
||||||
is broken, which will happen infrequently.
|
is broken, which will happen infrequently.
|
||||||
|
|
||||||
* If the minor version (second part) is divisible by 2
|
* If the minor version (second part) is divisible by 2
|
||||||
(for example 2.24.x, 2.26.x), this indicates a version of SDL that
|
(for example 2.24.x, 2.26.x), this indicates a version of SDL that
|
||||||
is believed to be stable and suitable for production use.
|
is believed to be stable and suitable for production use.
|
||||||
|
|
||||||
* In stable releases, the patchlevel or micro version (third part)
|
* In stable releases, the patchlevel or micro version (third part)
|
||||||
indicates bugfix releases. Bugfix releases should not add or
|
indicates bugfix releases. Bugfix releases should not add or
|
||||||
remove ABI, so the ".0" release (for example 2.24.0) should be
|
remove ABI, so the ".0" release (for example 2.24.0) should be
|
||||||
forwards-compatible with all the bugfix releases from the
|
forwards-compatible with all the bugfix releases from the
|
||||||
same cycle (for example 2.24.1).
|
same cycle (for example 2.24.1).
|
||||||
|
|
||||||
* The minor version increases when new API or ABI is added, or when
|
* The minor version increases when new API or ABI is added, or when
|
||||||
other significant changes are made. Newer minor versions are
|
other significant changes are made. Newer minor versions are
|
||||||
backwards-compatible, but not fully forwards-compatible.
|
backwards-compatible, but not fully forwards-compatible.
|
||||||
For example, programs built against SDL 2.24.x should work fine
|
For example, programs built against SDL 2.24.x should work fine
|
||||||
with SDL 2.26.x, but programs built against SDL 2.26.x will not
|
with SDL 2.26.x, but programs built against SDL 2.26.x will not
|
||||||
necessarily work with 2.24.x.
|
necessarily work with 2.24.x.
|
||||||
|
|
||||||
* If the minor version (second part) is not divisible by 2
|
* If the minor version (second part) is not divisible by 2
|
||||||
(for example 2.23.x, 2.25.x), this indicates a development prerelease
|
(for example 2.23.x, 2.25.x), this indicates a development prerelease
|
||||||
of SDL that is not suitable for stable software distributions.
|
of SDL that is not suitable for stable software distributions.
|
||||||
Use with caution.
|
Use with caution.
|
||||||
|
|
||||||
* The patchlevel or micro version (third part) increases with
|
* The patchlevel or micro version (third part) increases with
|
||||||
each prerelease.
|
each prerelease.
|
||||||
|
|
||||||
* Each prerelease might add new API and/or ABI.
|
* Each prerelease might add new API and/or ABI.
|
||||||
|
|
||||||
* Prereleases are backwards-compatible with older stable branches.
|
* Prereleases are backwards-compatible with older stable branches.
|
||||||
For example, 2.25.x will be backwards-compatible with 2.24.x.
|
For example, 2.25.x will be backwards-compatible with 2.24.x.
|
||||||
|
|
||||||
* Prereleases are not guaranteed to be backwards-compatible with
|
* Prereleases are not guaranteed to be backwards-compatible with
|
||||||
each other. For example, new API or ABI added in 2.25.1
|
each other. For example, new API or ABI added in 2.25.1
|
||||||
might be removed or changed in 2.25.2.
|
might be removed or changed in 2.25.2.
|
||||||
If this would be a problem for you, please do not use prereleases.
|
If this would be a problem for you, please do not use prereleases.
|
||||||
|
|
||||||
* Only upgrade to a prerelease if you can guarantee that you will
|
* Only upgrade to a prerelease if you can guarantee that you will
|
||||||
promptly upgrade to the stable release that follows it.
|
promptly upgrade to the stable release that follows it.
|
||||||
For example, do not upgrade to 2.23.x unless you will be able to
|
For example, do not upgrade to 2.23.x unless you will be able to
|
||||||
upgrade to 2.24.0 when it becomes available.
|
upgrade to 2.24.0 when it becomes available.
|
||||||
|
|
||||||
* Software distributions that have a freeze policy (in particular Linux
|
* Software distributions that have a freeze policy (in particular Linux
|
||||||
distributions with a release cycle, such as Debian and Fedora)
|
distributions with a release cycle, such as Debian and Fedora)
|
||||||
should usually only package stable releases, and not prereleases.
|
should usually only package stable releases, and not prereleases.
|
||||||
|
|
||||||
## Before 2.23.0
|
## Before 2.23.0
|
||||||
|
|
||||||
Older versions of SDL followed a similar policy, but instead of the
|
Older versions of SDL followed a similar policy, but instead of the
|
||||||
odd/even rule applying to the minor version, it applied to the patchlevel
|
odd/even rule applying to the minor version, it applied to the patchlevel
|
||||||
(micro version, third part). For example, 2.0.22 was a stable release
|
(micro version, third part). For example, 2.0.22 was a stable release
|
||||||
and 2.0.21 was a prerelease.
|
and 2.0.21 was a prerelease.
|
||||||
+114
-114
@@ -1,114 +1,114 @@
|
|||||||
Using SDL with Microsoft Visual C++
|
Using SDL with Microsoft Visual C++
|
||||||
===================================
|
===================================
|
||||||
|
|
||||||
### by Lion Kimbro with additions by James Turk
|
### by Lion Kimbro with additions by James Turk
|
||||||
|
|
||||||
You can either use the precompiled libraries from the [SDL](https://www.libsdl.org/download.php) web site, or you can build SDL
|
You can either use the precompiled libraries from the [SDL](https://www.libsdl.org/download.php) web site, or you can build SDL
|
||||||
yourself.
|
yourself.
|
||||||
|
|
||||||
### Building SDL
|
### Building SDL
|
||||||
|
|
||||||
0. To build SDL, your machine must, at a minimum, have the DirectX9.0c SDK installed. It may or may not be retrievable from
|
0. To build SDL, your machine must, at a minimum, have the DirectX9.0c SDK installed. It may or may not be retrievable from
|
||||||
the [Microsoft](https://www.microsoft.com) website, so you might need to locate it [online](https://duckduckgo.com/?q=directx9.0c+sdk+download&t=h_&ia=web).
|
the [Microsoft](https://www.microsoft.com) website, so you might need to locate it [online](https://duckduckgo.com/?q=directx9.0c+sdk+download&t=h_&ia=web).
|
||||||
_Editor's note: I've been able to successfully build SDL using Visual Studio 2019 **without** the DX9.0c SDK_
|
_Editor's note: I've been able to successfully build SDL using Visual Studio 2019 **without** the DX9.0c SDK_
|
||||||
|
|
||||||
1. Open the Visual Studio solution file at `./VisualC/SDL.sln`.
|
1. Open the Visual Studio solution file at `./VisualC/SDL.sln`.
|
||||||
|
|
||||||
2. Your IDE will likely prompt you to upgrade this solution file to whatever later version of the IDE you're using. In the `Retarget Projects` dialog,
|
2. Your IDE will likely prompt you to upgrade this solution file to whatever later version of the IDE you're using. In the `Retarget Projects` dialog,
|
||||||
all of the affected project files should be checked allowing you to use the latest `Windows SDK Version` you have installed, along with
|
all of the affected project files should be checked allowing you to use the latest `Windows SDK Version` you have installed, along with
|
||||||
the `Platform Toolset`.
|
the `Platform Toolset`.
|
||||||
|
|
||||||
If you choose *NOT* to upgrade to use the latest `Windows SDK Version` or `Platform Toolset`, then you'll need the `Visual Studio 2010 Platform Toolset`.
|
If you choose *NOT* to upgrade to use the latest `Windows SDK Version` or `Platform Toolset`, then you'll need the `Visual Studio 2010 Platform Toolset`.
|
||||||
|
|
||||||
3. Build the `.dll` and `.lib` files by right clicking on each project in turn (Projects are listed in the _Workspace_
|
3. Build the `.dll` and `.lib` files by right clicking on each project in turn (Projects are listed in the _Workspace_
|
||||||
panel in the _FileView_ tab), and selecting `Build`.
|
panel in the _FileView_ tab), and selecting `Build`.
|
||||||
|
|
||||||
You may get a few warnings, but you should not get any errors.
|
You may get a few warnings, but you should not get any errors.
|
||||||
|
|
||||||
Later, we will refer to the following `.lib` and `.dll` files that have just been generated:
|
Later, we will refer to the following `.lib` and `.dll` files that have just been generated:
|
||||||
|
|
||||||
- `./VisualC/Win32/Debug/SDL2.dll` or `./VisualC/Win32/Release/SDL2.dll`
|
- `./VisualC/Win32/Debug/SDL2.dll` or `./VisualC/Win32/Release/SDL2.dll`
|
||||||
- `./VisualC/Win32/Debug/SDL2.lib` or `./VisualC/Win32/Release/SDL2.lib`
|
- `./VisualC/Win32/Debug/SDL2.lib` or `./VisualC/Win32/Release/SDL2.lib`
|
||||||
- `./VisualC/Win32/Debug/SDL2main.lib` or `./VisualC/Win32/Release/SDL2main.lib`
|
- `./VisualC/Win32/Debug/SDL2main.lib` or `./VisualC/Win32/Release/SDL2main.lib`
|
||||||
|
|
||||||
_Note for the `x64` versions, just replace `Win32` in the path with `x64`_
|
_Note for the `x64` versions, just replace `Win32` in the path with `x64`_
|
||||||
|
|
||||||
### Creating a Project with SDL
|
### Creating a Project with SDL
|
||||||
|
|
||||||
- Create a project as a `Win32 Application`.
|
- Create a project as a `Win32 Application`.
|
||||||
|
|
||||||
- Create a C++ file for your project.
|
- Create a C++ file for your project.
|
||||||
|
|
||||||
- Set the C runtime to `Multi-threaded DLL` in the menu:
|
- Set the C runtime to `Multi-threaded DLL` in the menu:
|
||||||
`Project|Settings|C/C++ tab|Code Generation|Runtime Library `.
|
`Project|Settings|C/C++ tab|Code Generation|Runtime Library `.
|
||||||
|
|
||||||
- Add the SDL `include` directory to your list of includes in the menu:
|
- Add the SDL `include` directory to your list of includes in the menu:
|
||||||
`Project|Settings|C/C++ tab|Preprocessor|Additional include directories `
|
`Project|Settings|C/C++ tab|Preprocessor|Additional include directories `
|
||||||
|
|
||||||
*VC7 Specific: Instead of doing this, I find it easier to add the
|
*VC7 Specific: Instead of doing this, I find it easier to add the
|
||||||
include and library directories to the list that VC7 keeps. Do this by
|
include and library directories to the list that VC7 keeps. Do this by
|
||||||
selecting Tools|Options|Projects|VC++ Directories and under the "Show
|
selecting Tools|Options|Projects|VC++ Directories and under the "Show
|
||||||
Directories For:" dropbox select "Include Files", and click the "New
|
Directories For:" dropbox select "Include Files", and click the "New
|
||||||
Directory Icon" and add the [SDLROOT]\\include directory (e.g. If you
|
Directory Icon" and add the [SDLROOT]\\include directory (e.g. If you
|
||||||
installed to c:\\SDL\\ add c:\\SDL\\include). Proceed to change the
|
installed to c:\\SDL\\ add c:\\SDL\\include). Proceed to change the
|
||||||
dropbox selection to "Library Files" and add [SDLROOT]\\lib.*
|
dropbox selection to "Library Files" and add [SDLROOT]\\lib.*
|
||||||
|
|
||||||
The "include directory" I am referring to is the `./include` folder.
|
The "include directory" I am referring to is the `./include` folder.
|
||||||
|
|
||||||
Now we're going to use the files that we had created earlier in the *Build SDL* step.
|
Now we're going to use the files that we had created earlier in the *Build SDL* step.
|
||||||
|
|
||||||
Copy the following file into your Project directory:
|
Copy the following file into your Project directory:
|
||||||
|
|
||||||
- `SDL2.dll`
|
- `SDL2.dll`
|
||||||
|
|
||||||
Add the following files to your project (It is not necessary to copy them to your project directory):
|
Add the following files to your project (It is not necessary to copy them to your project directory):
|
||||||
|
|
||||||
- `SDL2.lib`
|
- `SDL2.lib`
|
||||||
- `SDL2main.lib`
|
- `SDL2main.lib`
|
||||||
|
|
||||||
To add them to your project, right click on your project, and select
|
To add them to your project, right click on your project, and select
|
||||||
`Add files to project`.
|
`Add files to project`.
|
||||||
|
|
||||||
**Instead of adding the files to your project, it is more desirable to add them to the linker options: Project|Properties|Linker|Command Line
|
**Instead of adding the files to your project, it is more desirable to add them to the linker options: Project|Properties|Linker|Command Line
|
||||||
and type the names of the libraries to link with in the "Additional Options:" box. Note: This must be done for each build configuration
|
and type the names of the libraries to link with in the "Additional Options:" box. Note: This must be done for each build configuration
|
||||||
(e.g. Release,Debug).**
|
(e.g. Release,Debug).**
|
||||||
|
|
||||||
### Hello SDL2
|
### Hello SDL2
|
||||||
|
|
||||||
Here's a sample SDL snippet to verify everything is setup in your IDE:
|
Here's a sample SDL snippet to verify everything is setup in your IDE:
|
||||||
|
|
||||||
```
|
```
|
||||||
#include "SDL.h"
|
#include "SDL.h"
|
||||||
|
|
||||||
int main( int argc, char* argv[] )
|
int main( int argc, char* argv[] )
|
||||||
{
|
{
|
||||||
const int WIDTH = 640;
|
const int WIDTH = 640;
|
||||||
const int HEIGHT = 480;
|
const int HEIGHT = 480;
|
||||||
SDL_Window* window = NULL;
|
SDL_Window* window = NULL;
|
||||||
SDL_Renderer* renderer = NULL;
|
SDL_Renderer* renderer = NULL;
|
||||||
|
|
||||||
SDL_Init(SDL_INIT_VIDEO);
|
SDL_Init(SDL_INIT_VIDEO);
|
||||||
window = SDL_CreateWindow("SDL2 Test", SDL_WINDOWPOS_UNDEFINED, SDL_WINDOWPOS_UNDEFINED, WIDTH, HEIGHT, SDL_WINDOW_SHOWN);
|
window = SDL_CreateWindow("SDL2 Test", SDL_WINDOWPOS_UNDEFINED, SDL_WINDOWPOS_UNDEFINED, WIDTH, HEIGHT, SDL_WINDOW_SHOWN);
|
||||||
renderer = SDL_CreateRenderer(window, -1, SDL_RENDERER_ACCELERATED | SDL_RENDERER_PRESENTVSYNC);
|
renderer = SDL_CreateRenderer(window, -1, SDL_RENDERER_ACCELERATED | SDL_RENDERER_PRESENTVSYNC);
|
||||||
|
|
||||||
SDL_DestroyRenderer(renderer);
|
SDL_DestroyRenderer(renderer);
|
||||||
SDL_DestroyWindow(window);
|
SDL_DestroyWindow(window);
|
||||||
SDL_Quit();
|
SDL_Quit();
|
||||||
return 0;
|
return 0;
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
### That's it!
|
### That's it!
|
||||||
|
|
||||||
I hope that this document has helped you get through the most difficult part of using the SDL: installing it.
|
I hope that this document has helped you get through the most difficult part of using the SDL: installing it.
|
||||||
Suggestions for improvements should be posted to the [Github Issues](https://github.com/libsdl-org/SDL/issues).
|
Suggestions for improvements should be posted to the [Github Issues](https://github.com/libsdl-org/SDL/issues).
|
||||||
|
|
||||||
### Credits
|
### Credits
|
||||||
|
|
||||||
Thanks to [Paulus Esterhazy](mailto:pesterhazy@gmx.net), for the work on VC++ port.
|
Thanks to [Paulus Esterhazy](mailto:pesterhazy@gmx.net), for the work on VC++ port.
|
||||||
|
|
||||||
This document was originally called "VisualC.txt", and was written by [Sam Lantinga](mailto:slouken@libsdl.org).
|
This document was originally called "VisualC.txt", and was written by [Sam Lantinga](mailto:slouken@libsdl.org).
|
||||||
|
|
||||||
Later, it was converted to HTML and expanded into the document that you see today by [Lion Kimbro](mailto:snowlion@sprynet.com).
|
Later, it was converted to HTML and expanded into the document that you see today by [Lion Kimbro](mailto:snowlion@sprynet.com).
|
||||||
|
|
||||||
Minor Fixes and Visual C++ 7 Information (In Green) was added by [James Turk](mailto:james@conceptofzero.net)
|
Minor Fixes and Visual C++ 7 Information (In Green) was added by [James Turk](mailto:james@conceptofzero.net)
|
||||||
@@ -1,33 +1,33 @@
|
|||||||
PS Vita
|
PS Vita
|
||||||
=======
|
=======
|
||||||
SDL port for the Sony Playstation Vita and Sony Playstation TV
|
SDL port for the Sony Playstation Vita and Sony Playstation TV
|
||||||
|
|
||||||
Credit to
|
Credit to
|
||||||
* xerpi, cpasjuste and rsn8887 for initial (vita2d) port
|
* xerpi, cpasjuste and rsn8887 for initial (vita2d) port
|
||||||
* vitasdk/dolcesdk devs
|
* vitasdk/dolcesdk devs
|
||||||
* CBPS discord (Namely Graphene and SonicMastr)
|
* CBPS discord (Namely Graphene and SonicMastr)
|
||||||
|
|
||||||
Building
|
Building
|
||||||
--------
|
--------
|
||||||
To build for the PSVita, make sure you have vitasdk and cmake installed and run:
|
To build for the PSVita, make sure you have vitasdk and cmake installed and run:
|
||||||
```
|
```
|
||||||
cmake -S. -Bbuild -DCMAKE_TOOLCHAIN_FILE=${VITASDK}/share/vita.toolchain.cmake -DCMAKE_BUILD_TYPE=Release
|
cmake -S. -Bbuild -DCMAKE_TOOLCHAIN_FILE=${VITASDK}/share/vita.toolchain.cmake -DCMAKE_BUILD_TYPE=Release
|
||||||
cmake --build build
|
cmake --build build
|
||||||
cmake --install build
|
cmake --install build
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
Notes
|
Notes
|
||||||
-----
|
-----
|
||||||
* gles1/gles2 support and renderers are disabled by default and can be enabled by configuring with `-DVIDEO_VITA_PVR=ON`
|
* gles1/gles2 support and renderers are disabled by default and can be enabled by configuring with `-DVIDEO_VITA_PVR=ON`
|
||||||
These renderers support 720p and 1080i resolutions. These can be specified with:
|
These renderers support 720p and 1080i resolutions. These can be specified with:
|
||||||
`SDL_setenv("VITA_RESOLUTION", "720", 1);` and `SDL_setenv("VITA_RESOLUTION", "1080", 1);`
|
`SDL_setenv("VITA_RESOLUTION", "720", 1);` and `SDL_setenv("VITA_RESOLUTION", "1080", 1);`
|
||||||
* Desktop GL 1.X and 2.X support and renderers are also disabled by default and also can be enabled with `-DVIDEO_VITA_PVR=ON` as long as gl4es4vita is present in your SDK.
|
* Desktop GL 1.X and 2.X support and renderers are also disabled by default and also can be enabled with `-DVIDEO_VITA_PVR=ON` as long as gl4es4vita is present in your SDK.
|
||||||
They support the same resolutions as the gles1/gles2 backends and require specifying `SDL_setenv("VITA_PVR_OGL", "1", 1);`
|
They support the same resolutions as the gles1/gles2 backends and require specifying `SDL_setenv("VITA_PVR_OGL", "1", 1);`
|
||||||
anytime before video subsystem initialization.
|
anytime before video subsystem initialization.
|
||||||
* gles2 support via PIB is disabled by default and can be enabled by configuring with `-DVIDEO_VITA_PIB=ON`
|
* gles2 support via PIB is disabled by default and can be enabled by configuring with `-DVIDEO_VITA_PIB=ON`
|
||||||
* By default SDL emits mouse events for touch events on every touchscreen.
|
* By default SDL emits mouse events for touch events on every touchscreen.
|
||||||
Vita has two touchscreens, so it's recommended to use `SDL_SetHint(SDL_HINT_TOUCH_MOUSE_EVENTS, "0");` and handle touch events instead.
|
Vita has two touchscreens, so it's recommended to use `SDL_SetHint(SDL_HINT_TOUCH_MOUSE_EVENTS, "0");` and handle touch events instead.
|
||||||
Individual touchscreens can be disabled with:
|
Individual touchscreens can be disabled with:
|
||||||
`SDL_setenv("VITA_DISABLE_TOUCH_FRONT", "1", 1);` and `SDL_setenv("VITA_DISABLE_TOUCH_BACK", "1", 1);`
|
`SDL_setenv("VITA_DISABLE_TOUCH_FRONT", "1", 1);` and `SDL_setenv("VITA_DISABLE_TOUCH_BACK", "1", 1);`
|
||||||
* Support for L2/R2/R3/R3 buttons, haptic feedback and gamepad led only available on PSTV, or when using external ds4 gamepad on vita.
|
* Support for L2/R2/R3/R3 buttons, haptic feedback and gamepad led only available on PSTV, or when using external ds4 gamepad on vita.
|
||||||
@@ -1,10 +1,10 @@
|
|||||||
WinCE
|
WinCE
|
||||||
=====
|
=====
|
||||||
|
|
||||||
Windows CE is no longer supported by SDL.
|
Windows CE is no longer supported by SDL.
|
||||||
|
|
||||||
We have left the CE support in SDL 1.2 for those that must have it, and we
|
We have left the CE support in SDL 1.2 for those that must have it, and we
|
||||||
have support for Windows Phone 8 and WinRT in SDL2, as of SDL 2.0.3.
|
have support for Windows Phone 8 and WinRT in SDL2, as of SDL 2.0.3.
|
||||||
|
|
||||||
--ryan.
|
--ryan.
|
||||||
|
|
||||||
@@ -1,58 +1,58 @@
|
|||||||
# Windows
|
# Windows
|
||||||
|
|
||||||
## LLVM and Intel C++ compiler support
|
## LLVM and Intel C++ compiler support
|
||||||
|
|
||||||
SDL will build with the Visual Studio project files with LLVM-based compilers, such as the Intel oneAPI C++
|
SDL will build with the Visual Studio project files with LLVM-based compilers, such as the Intel oneAPI C++
|
||||||
compiler, but you'll have to manually add the "-msse3" command line option
|
compiler, but you'll have to manually add the "-msse3" command line option
|
||||||
to at least the SDL_audiocvt.c source file, and possibly others. This may
|
to at least the SDL_audiocvt.c source file, and possibly others. This may
|
||||||
not be necessary if you build SDL with CMake instead of the included Visual
|
not be necessary if you build SDL with CMake instead of the included Visual
|
||||||
Studio solution.
|
Studio solution.
|
||||||
|
|
||||||
Details are here: https://github.com/libsdl-org/SDL/issues/5186
|
Details are here: https://github.com/libsdl-org/SDL/issues/5186
|
||||||
|
|
||||||
|
|
||||||
## OpenGL ES 2.x support
|
## OpenGL ES 2.x support
|
||||||
|
|
||||||
SDL has support for OpenGL ES 2.x under Windows via two alternative
|
SDL has support for OpenGL ES 2.x under Windows via two alternative
|
||||||
implementations.
|
implementations.
|
||||||
|
|
||||||
The most straightforward method consists in running your app in a system with
|
The most straightforward method consists in running your app in a system with
|
||||||
a graphic card paired with a relatively recent (as of November of 2013) driver
|
a graphic card paired with a relatively recent (as of November of 2013) driver
|
||||||
which supports the WGL_EXT_create_context_es2_profile extension. Vendors known
|
which supports the WGL_EXT_create_context_es2_profile extension. Vendors known
|
||||||
to ship said extension on Windows currently include nVidia and Intel.
|
to ship said extension on Windows currently include nVidia and Intel.
|
||||||
|
|
||||||
The other method involves using the
|
The other method involves using the
|
||||||
[ANGLE library](https://code.google.com/p/angleproject/). If an OpenGL ES 2.x
|
[ANGLE library](https://code.google.com/p/angleproject/). If an OpenGL ES 2.x
|
||||||
context is requested and no WGL_EXT_create_context_es2_profile extension is
|
context is requested and no WGL_EXT_create_context_es2_profile extension is
|
||||||
found, SDL will try to load the libEGL.dll library provided by ANGLE.
|
found, SDL will try to load the libEGL.dll library provided by ANGLE.
|
||||||
|
|
||||||
To obtain the ANGLE binaries, you can either compile from source from
|
To obtain the ANGLE binaries, you can either compile from source from
|
||||||
https://chromium.googlesource.com/angle/angle or copy the relevant binaries
|
https://chromium.googlesource.com/angle/angle or copy the relevant binaries
|
||||||
from a recent Chrome/Chromium install for Windows. The files you need are:
|
from a recent Chrome/Chromium install for Windows. The files you need are:
|
||||||
|
|
||||||
- libEGL.dll
|
- libEGL.dll
|
||||||
- libGLESv2.dll
|
- libGLESv2.dll
|
||||||
- d3dcompiler_46.dll (supports Windows Vista or later, better shader
|
- d3dcompiler_46.dll (supports Windows Vista or later, better shader
|
||||||
compiler) *or* d3dcompiler_43.dll (supports Windows XP or later)
|
compiler) *or* d3dcompiler_43.dll (supports Windows XP or later)
|
||||||
|
|
||||||
If you compile ANGLE from source, you can configure it so it does not need the
|
If you compile ANGLE from source, you can configure it so it does not need the
|
||||||
d3dcompiler_* DLL at all (for details on this, see their documentation).
|
d3dcompiler_* DLL at all (for details on this, see their documentation).
|
||||||
However, by default SDL will try to preload the d3dcompiler_46.dll to
|
However, by default SDL will try to preload the d3dcompiler_46.dll to
|
||||||
comply with ANGLE's requirements. If you wish SDL to preload
|
comply with ANGLE's requirements. If you wish SDL to preload
|
||||||
d3dcompiler_43.dll (to support Windows XP) or to skip this step at all, you
|
d3dcompiler_43.dll (to support Windows XP) or to skip this step at all, you
|
||||||
can use the SDL_HINT_VIDEO_WIN_D3DCOMPILER hint (see SDL_hints.h for more
|
can use the SDL_HINT_VIDEO_WIN_D3DCOMPILER hint (see SDL_hints.h for more
|
||||||
details).
|
details).
|
||||||
|
|
||||||
Known Bugs:
|
Known Bugs:
|
||||||
|
|
||||||
- SDL_GL_SetSwapInterval is currently a no op when using ANGLE. It appears
|
- SDL_GL_SetSwapInterval is currently a no op when using ANGLE. It appears
|
||||||
that there's a bug in the library which prevents the window contents from
|
that there's a bug in the library which prevents the window contents from
|
||||||
refreshing if this is set to anything other than the default value.
|
refreshing if this is set to anything other than the default value.
|
||||||
|
|
||||||
## Vulkan Surface Support
|
## Vulkan Surface Support
|
||||||
|
|
||||||
Support for creating Vulkan surfaces is configured on by default. To disable
|
Support for creating Vulkan surfaces is configured on by default. To disable
|
||||||
it change the value of `SDL_VIDEO_VULKAN` to 0 in `SDL_config_windows.h`. You
|
it change the value of `SDL_VIDEO_VULKAN` to 0 in `SDL_config_windows.h`. You
|
||||||
must install the [Vulkan SDK](https://www.lunarg.com/vulkan-sdk/) in order to
|
must install the [Vulkan SDK](https://www.lunarg.com/vulkan-sdk/) in order to
|
||||||
use Vulkan graphics in your application.
|
use Vulkan graphics in your application.
|
||||||
|
|
||||||
+519
-519
File diff suppressed because it is too large.
Load diff
+1561
-1561
File diff suppressed because it is too large.
Load diff
@@ -1,49 +1,49 @@
|
|||||||
# Release checklist
|
# Release checklist
|
||||||
|
|
||||||
When changing the version, run `build-scripts/update-version.sh X Y Z`,
|
When changing the version, run `build-scripts/update-version.sh X Y Z`,
|
||||||
where `X Y Z` are the major version, minor version, and patch level. So
|
where `X Y Z` are the major version, minor version, and patch level. So
|
||||||
`2 28 1` means "change the version to 2.28.1". This script does much of the
|
`2 28 1` means "change the version to 2.28.1". This script does much of the
|
||||||
mechanical work.
|
mechanical work.
|
||||||
|
|
||||||
|
|
||||||
## New feature release
|
## New feature release
|
||||||
|
|
||||||
* Update `WhatsNew.txt`
|
* Update `WhatsNew.txt`
|
||||||
|
|
||||||
* Bump version number to 2.EVEN.0:
|
* Bump version number to 2.EVEN.0:
|
||||||
|
|
||||||
* `./build-scripts/update-version.sh 2 EVEN 0`
|
* `./build-scripts/update-version.sh 2 EVEN 0`
|
||||||
|
|
||||||
* Do the release
|
* Do the release
|
||||||
|
|
||||||
* Update the website file include/header.inc.php to reflect the new version
|
* Update the website file include/header.inc.php to reflect the new version
|
||||||
|
|
||||||
## New bugfix release
|
## New bugfix release
|
||||||
|
|
||||||
* Check that no new API/ABI was added
|
* Check that no new API/ABI was added
|
||||||
|
|
||||||
* If it was, do a new feature release (see above) instead
|
* If it was, do a new feature release (see above) instead
|
||||||
|
|
||||||
* Bump version number from 2.Y.Z to 2.Y.(Z+1) (Y is even)
|
* Bump version number from 2.Y.Z to 2.Y.(Z+1) (Y is even)
|
||||||
|
|
||||||
* `./build-scripts/update-version.sh 2 Y Z+1`
|
* `./build-scripts/update-version.sh 2 Y Z+1`
|
||||||
|
|
||||||
* Do the release
|
* Do the release
|
||||||
|
|
||||||
* Update the website file include/header.inc.php to reflect the new version
|
* Update the website file include/header.inc.php to reflect the new version
|
||||||
|
|
||||||
## After a feature release
|
## After a feature release
|
||||||
|
|
||||||
* Create a branch like `release-2.24.x`
|
* Create a branch like `release-2.24.x`
|
||||||
|
|
||||||
* Bump version number to 2.ODD.0 for next development branch
|
* Bump version number to 2.ODD.0 for next development branch
|
||||||
|
|
||||||
* `./build-scripts/update-version.sh 2 ODD 0`
|
* `./build-scripts/update-version.sh 2 ODD 0`
|
||||||
|
|
||||||
## New development prerelease
|
## New development prerelease
|
||||||
|
|
||||||
* Bump version number from 2.Y.Z to 2.Y.(Z+1) (Y is odd)
|
* Bump version number from 2.Y.Z to 2.Y.(Z+1) (Y is odd)
|
||||||
|
|
||||||
* `./build-scripts/update-version.sh 2 Y Z+1`
|
* `./build-scripts/update-version.sh 2 Y Z+1`
|
||||||
|
|
||||||
* Do the release
|
* Do the release
|
||||||
Binary file not shown.
@@ -1,65 +1,65 @@
|
|||||||
#!/bin/sh
|
#!/bin/sh
|
||||||
|
|
||||||
# Get the canonical path of the folder containing this script
|
# Get the canonical path of the folder containing this script
|
||||||
bindir=`cd -P -- "\`dirname -- "$0"\`" && printf '%s\n' "\`pwd -P\`"`
|
bindir=$(cd -P -- "$(dirname -- "$0")" && printf '%s\n' "$(pwd -P)")
|
||||||
|
|
||||||
# Calculate the canonical path of the prefix, relative to the folder of this script
|
# Calculate the canonical path of the prefix, relative to the folder of this script
|
||||||
prefix=`cd -P -- "$bindir/.." && printf '%s\n' "\`pwd -P\`"`
|
prefix=$(cd -P -- "$bindir/.." && printf '%s\n' "$(pwd -P)")
|
||||||
exec_prefix=${prefix}/bin
|
exec_prefix=${prefix}
|
||||||
exec_prefix_set=no
|
exec_prefix_set=no
|
||||||
libdir=${prefix}/lib
|
libdir=${exec_prefix}/lib
|
||||||
|
|
||||||
#usage="\
|
#usage="\
|
||||||
#Usage: $0 [--prefix[=DIR]] [--exec-prefix[=DIR]] [--version] [--cflags] [--libs]"
|
#Usage: $0 [--prefix[=DIR]] [--exec-prefix[=DIR]] [--version] [--cflags] [--libs]"
|
||||||
usage="\
|
usage="\
|
||||||
Usage: $0 [--prefix[=DIR]] [--exec-prefix[=DIR]] [--version] [--cflags] [--libs] [--static-libs]"
|
Usage: $0 [--prefix[=DIR]] [--exec-prefix[=DIR]] [--version] [--cflags] [--libs] [--static-libs]"
|
||||||
|
|
||||||
if test $# -eq 0; then
|
if test $# -eq 0; then
|
||||||
echo "${usage}" 1>&2
|
echo "${usage}" 1>&2
|
||||||
exit 1
|
exit 1
|
||||||
fi
|
fi
|
||||||
|
|
||||||
while test $# -gt 0; do
|
while test $# -gt 0; do
|
||||||
case "$1" in
|
case "$1" in
|
||||||
-*=*) optarg=`echo "$1" | sed 's/[-_a-zA-Z0-9]*=//'` ;;
|
-*=*) optarg=`echo "$1" | sed 's/[-_a-zA-Z0-9]*=//'` ;;
|
||||||
*) optarg= ;;
|
*) optarg= ;;
|
||||||
esac
|
esac
|
||||||
|
|
||||||
case $1 in
|
case $1 in
|
||||||
--prefix=*)
|
--prefix=*)
|
||||||
prefix=$optarg
|
prefix=$optarg
|
||||||
if test $exec_prefix_set = no ; then
|
if test $exec_prefix_set = no ; then
|
||||||
exec_prefix=$optarg
|
exec_prefix=$optarg
|
||||||
fi
|
fi
|
||||||
;;
|
;;
|
||||||
--prefix)
|
--prefix)
|
||||||
echo $prefix
|
echo $prefix
|
||||||
;;
|
;;
|
||||||
--exec-prefix=*)
|
--exec-prefix=*)
|
||||||
exec_prefix=$optarg
|
exec_prefix=$optarg
|
||||||
exec_prefix_set=yes
|
exec_prefix_set=yes
|
||||||
;;
|
;;
|
||||||
--exec-prefix)
|
--exec-prefix)
|
||||||
echo $exec_prefix
|
echo $exec_prefix
|
||||||
;;
|
;;
|
||||||
--version)
|
--version)
|
||||||
echo 2.32.10
|
echo 2.28.5
|
||||||
;;
|
;;
|
||||||
--cflags)
|
--cflags)
|
||||||
echo -I${prefix}/include/SDL2 -Dmain=SDL_main
|
echo -I${prefix}/include/SDL2 -Dmain=SDL_main
|
||||||
;;
|
;;
|
||||||
--libs)
|
--libs)
|
||||||
echo -L${prefix}/lib -lmingw32 -lSDL2main -lSDL2 -mwindows
|
echo -L${exec_prefix}/lib -lmingw32 -lSDL2main -lSDL2 -mwindows
|
||||||
;;
|
;;
|
||||||
--static-libs)
|
--static-libs)
|
||||||
# --libs|--static-libs)
|
# --libs|--static-libs)
|
||||||
sdl_static_libs=$(echo "-lmingw32 -lSDL2main -lSDL2 -mwindows -Wl,--dynamicbase -Wl,--nxcompat -lm -ldinput8 -ldxguid -ldxerr8 -luser32 -lgdi32 -lwinmm -limm32 -lole32 -loleaut32 -lshell32 -lsetupapi -lversion -luuid" | sed -E "s#-lSDL2[ $]#$libdir/libSDL2.a #g")
|
sdl_static_libs=$(echo "-lmingw32 -lSDL2main -lSDL2 -mwindows -Wl,--dynamicbase -Wl,--nxcompat -lm -ldinput8 -ldxguid -ldxerr8 -luser32 -lgdi32 -lwinmm -limm32 -lole32 -loleaut32 -lshell32 -lsetupapi -lversion -luuid" | sed -E "s#-lSDL2[ $]#$libdir/libSDL2.a #g")
|
||||||
echo -L${prefix}/lib $sdl_static_libs
|
echo -L${exec_prefix}/lib $sdl_static_libs
|
||||||
;;
|
;;
|
||||||
*)
|
*)
|
||||||
echo "${usage}" 1>&2
|
echo "${usage}" 1>&2
|
||||||
exit 1
|
exit 1
|
||||||
;;
|
;;
|
||||||
esac
|
esac
|
||||||
shift
|
shift
|
||||||
done
|
done
|
||||||
@@ -1,6 +1,6 @@
|
|||||||
/*
|
/*
|
||||||
Simple DirectMedia Layer
|
Simple DirectMedia Layer
|
||||||
Copyright (C) 1997-2025 Sam Lantinga <slouken@libsdl.org>
|
Copyright (C) 1997-2023 Sam Lantinga <slouken@libsdl.org>
|
||||||
|
|
||||||
This software is provided 'as-is', without any express or implied
|
This software is provided 'as-is', without any express or implied
|
||||||
warranty. In no event will the authors be held liable for any damages
|
warranty. In no event will the authors be held liable for any damages
|
||||||
@@ -25,6 +25,7 @@
|
|||||||
* Main include header for the SDL library
|
* Main include header for the SDL library
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
|
||||||
#ifndef SDL_h_
|
#ifndef SDL_h_
|
||||||
#define SDL_h_
|
#define SDL_h_
|
||||||
|
|
||||||
@@ -69,8 +70,6 @@
|
|||||||
extern "C" {
|
extern "C" {
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
/* WIKI CATEGORY: Init */
|
|
||||||
|
|
||||||
/* As of version 0.5, SDL is loaded dynamically into the application */
|
/* As of version 0.5, SDL is loaded dynamically into the application */
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -131,7 +130,7 @@ extern "C" {
|
|||||||
* call SDL_Quit() to force shutdown). If a subsystem is already loaded then
|
* call SDL_Quit() to force shutdown). If a subsystem is already loaded then
|
||||||
* this call will increase the ref-count and return.
|
* this call will increase the ref-count and return.
|
||||||
*
|
*
|
||||||
* \param flags subsystem initialization flags.
|
* \param flags subsystem initialization flags
|
||||||
* \returns 0 on success or a negative error code on failure; call
|
* \returns 0 on success or a negative error code on failure; call
|
||||||
* SDL_GetError() for more information.
|
* SDL_GetError() for more information.
|
||||||
*
|
*
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
/*
|
/*
|
||||||
Simple DirectMedia Layer
|
Simple DirectMedia Layer
|
||||||
Copyright (C) 1997-2025 Sam Lantinga <slouken@libsdl.org>
|
Copyright (C) 1997-2023 Sam Lantinga <slouken@libsdl.org>
|
||||||
|
|
||||||
This software is provided 'as-is', without any express or implied
|
This software is provided 'as-is', without any express or implied
|
||||||
warranty. In no event will the authors be held liable for any damages
|
warranty. In no event will the authors be held liable for any damages
|
||||||
@@ -61,8 +61,6 @@ assert can have unique static variables associated with it.
|
|||||||
#define SDL_TriggerBreakpoint() __asm__ __volatile__ ( "brk #22\n\t" )
|
#define SDL_TriggerBreakpoint() __asm__ __volatile__ ( "brk #22\n\t" )
|
||||||
#elif defined(__APPLE__) && defined(__arm__)
|
#elif defined(__APPLE__) && defined(__arm__)
|
||||||
#define SDL_TriggerBreakpoint() __asm__ __volatile__ ( "bkpt #22\n\t" )
|
#define SDL_TriggerBreakpoint() __asm__ __volatile__ ( "bkpt #22\n\t" )
|
||||||
#elif defined(_WIN32) && ((defined(__GNUC__) || defined(__clang__)) && (defined(__arm64__) || defined(__aarch64__)) )
|
|
||||||
#define SDL_TriggerBreakpoint() __asm__ __volatile__ ( "brk #0xF000\n\t" )
|
|
||||||
#elif defined(__386__) && defined(__WATCOMC__)
|
#elif defined(__386__) && defined(__WATCOMC__)
|
||||||
#define SDL_TriggerBreakpoint() { _asm { int 0x03 } }
|
#define SDL_TriggerBreakpoint() { _asm { int 0x03 } }
|
||||||
#elif defined(HAVE_SIGNAL_H) && !defined(__WATCOMC__)
|
#elif defined(HAVE_SIGNAL_H) && !defined(__WATCOMC__)
|
||||||
@@ -153,7 +151,7 @@ extern DECLSPEC SDL_AssertState SDLCALL SDL_ReportAssertion(SDL_AssertData *,
|
|||||||
#define SDL_enabled_assert(condition) \
|
#define SDL_enabled_assert(condition) \
|
||||||
do { \
|
do { \
|
||||||
while ( !(condition) ) { \
|
while ( !(condition) ) { \
|
||||||
static struct SDL_AssertData sdl_assert_data = { 0, 0, #condition, NULL, 0, NULL, NULL }; \
|
static struct SDL_AssertData sdl_assert_data = { 0, 0, #condition, 0, 0, 0, 0 }; \
|
||||||
const SDL_AssertState sdl_assert_state = SDL_ReportAssertion(&sdl_assert_data, SDL_FUNCTION, SDL_FILE, SDL_LINE); \
|
const SDL_AssertState sdl_assert_state = SDL_ReportAssertion(&sdl_assert_data, SDL_FUNCTION, SDL_FILE, SDL_LINE); \
|
||||||
if (sdl_assert_state == SDL_ASSERTION_RETRY) { \
|
if (sdl_assert_state == SDL_ASSERTION_RETRY) { \
|
||||||
continue; /* go again. */ \
|
continue; /* go again. */ \
|
||||||
@@ -193,8 +191,8 @@ extern DECLSPEC SDL_AssertState SDLCALL SDL_ReportAssertion(SDL_AssertData *,
|
|||||||
* A callback that fires when an SDL assertion fails.
|
* A callback that fires when an SDL assertion fails.
|
||||||
*
|
*
|
||||||
* \param data a pointer to the SDL_AssertData structure corresponding to the
|
* \param data a pointer to the SDL_AssertData structure corresponding to the
|
||||||
* current assertion.
|
* current assertion
|
||||||
* \param userdata what was passed as `userdata` to SDL_SetAssertionHandler().
|
* \param userdata what was passed as `userdata` to SDL_SetAssertionHandler()
|
||||||
* \returns an SDL_AssertState value indicating how to handle the failure.
|
* \returns an SDL_AssertState value indicating how to handle the failure.
|
||||||
*/
|
*/
|
||||||
typedef SDL_AssertState (SDLCALL *SDL_AssertionHandler)(
|
typedef SDL_AssertState (SDLCALL *SDL_AssertionHandler)(
|
||||||
@@ -214,8 +212,8 @@ typedef SDL_AssertState (SDLCALL *SDL_AssertionHandler)(
|
|||||||
* This callback is NOT reset to SDL's internal handler upon SDL_Quit()!
|
* This callback is NOT reset to SDL's internal handler upon SDL_Quit()!
|
||||||
*
|
*
|
||||||
* \param handler the SDL_AssertionHandler function to call when an assertion
|
* \param handler the SDL_AssertionHandler function to call when an assertion
|
||||||
* fails or NULL for the default handler.
|
* fails or NULL for the default handler
|
||||||
* \param userdata a pointer that is passed to `handler`.
|
* \param userdata a pointer that is passed to `handler`
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.0.
|
* \since This function is available since SDL 2.0.0.
|
||||||
*
|
*
|
||||||
@@ -256,7 +254,7 @@ extern DECLSPEC SDL_AssertionHandler SDLCALL SDL_GetDefaultAssertionHandler(void
|
|||||||
* data, it is safe to pass a NULL pointer to this function to ignore it.
|
* data, it is safe to pass a NULL pointer to this function to ignore it.
|
||||||
*
|
*
|
||||||
* \param puserdata pointer which is filled with the "userdata" pointer that
|
* \param puserdata pointer which is filled with the "userdata" pointer that
|
||||||
* was passed to SDL_SetAssertionHandler().
|
* was passed to SDL_SetAssertionHandler()
|
||||||
* \returns the SDL_AssertionHandler that is called when an assert triggers.
|
* \returns the SDL_AssertionHandler that is called when an assert triggers.
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.2.
|
* \since This function is available since SDL 2.0.2.
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
/*
|
/*
|
||||||
Simple DirectMedia Layer
|
Simple DirectMedia Layer
|
||||||
Copyright (C) 1997-2025 Sam Lantinga <slouken@libsdl.org>
|
Copyright (C) 1997-2023 Sam Lantinga <slouken@libsdl.org>
|
||||||
|
|
||||||
This software is provided 'as-is', without any express or implied
|
This software is provided 'as-is', without any express or implied
|
||||||
warranty. In no event will the authors be held liable for any damages
|
warranty. In no event will the authors be held liable for any damages
|
||||||
@@ -20,29 +20,38 @@
|
|||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* # CategoryAtomic
|
* \file SDL_atomic.h
|
||||||
*
|
*
|
||||||
* Atomic operations.
|
* Atomic operations.
|
||||||
*
|
*
|
||||||
* IMPORTANT: If you are not an expert in concurrent lockless programming, you
|
* IMPORTANT:
|
||||||
* should not be using any functions in this file. You should be protecting
|
* If you are not an expert in concurrent lockless programming, you should
|
||||||
* your data structures with full mutexes instead.
|
* only be using the atomic lock and reference counting functions in this
|
||||||
|
* file. In all other cases you should be protecting your data structures
|
||||||
|
* with full mutexes.
|
||||||
*
|
*
|
||||||
* ***Seriously, here be dragons!***
|
* The list of "safe" functions to use are:
|
||||||
|
* SDL_AtomicLock()
|
||||||
|
* SDL_AtomicUnlock()
|
||||||
|
* SDL_AtomicIncRef()
|
||||||
|
* SDL_AtomicDecRef()
|
||||||
*
|
*
|
||||||
* You can find out a little more about lockless programming and the subtle
|
* Seriously, here be dragons!
|
||||||
* issues that can arise here:
|
* ^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||||
* https://learn.microsoft.com/en-us/windows/win32/dxtecharts/lockless-programming
|
*
|
||||||
|
* You can find out a little more about lockless programming and the
|
||||||
|
* subtle issues that can arise here:
|
||||||
|
* http://msdn.microsoft.com/en-us/library/ee418650%28v=vs.85%29.aspx
|
||||||
*
|
*
|
||||||
* There's also lots of good information here:
|
* There's also lots of good information here:
|
||||||
|
* http://www.1024cores.net/home/lock-free-algorithms
|
||||||
|
* http://preshing.com/
|
||||||
*
|
*
|
||||||
* - https://www.1024cores.net/home/lock-free-algorithms
|
* These operations may or may not actually be implemented using
|
||||||
* - https://preshing.com/
|
* processor specific atomic operations. When possible they are
|
||||||
*
|
* implemented as true processor specific atomic operations. When that
|
||||||
* These operations may or may not actually be implemented using processor
|
* is not possible the are implemented using locks that *do* use the
|
||||||
* specific atomic operations. When possible they are implemented as true
|
* available atomic operations.
|
||||||
* processor specific atomic operations. When that is not possible the are
|
|
||||||
* implemented using locks that *do* use the available atomic operations.
|
|
||||||
*
|
*
|
||||||
* All of the atomic operations that modify memory are full memory barriers.
|
* All of the atomic operations that modify memory are full memory barriers.
|
||||||
*/
|
*/
|
||||||
@@ -85,7 +94,7 @@ typedef int SDL_SpinLock;
|
|||||||
* ***Please note that spinlocks are dangerous if you don't know what you're
|
* ***Please note that spinlocks are dangerous if you don't know what you're
|
||||||
* doing. Please be careful using any sort of spinlock!***
|
* doing. Please be careful using any sort of spinlock!***
|
||||||
*
|
*
|
||||||
* \param lock a pointer to a lock variable.
|
* \param lock a pointer to a lock variable
|
||||||
* \returns SDL_TRUE if the lock succeeded, SDL_FALSE if the lock is already
|
* \returns SDL_TRUE if the lock succeeded, SDL_FALSE if the lock is already
|
||||||
* held.
|
* held.
|
||||||
*
|
*
|
||||||
@@ -102,7 +111,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_AtomicTryLock(SDL_SpinLock *lock);
|
|||||||
* ***Please note that spinlocks are dangerous if you don't know what you're
|
* ***Please note that spinlocks are dangerous if you don't know what you're
|
||||||
* doing. Please be careful using any sort of spinlock!***
|
* doing. Please be careful using any sort of spinlock!***
|
||||||
*
|
*
|
||||||
* \param lock a pointer to a lock variable.
|
* \param lock a pointer to a lock variable
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.0.
|
* \since This function is available since SDL 2.0.0.
|
||||||
*
|
*
|
||||||
@@ -119,7 +128,7 @@ extern DECLSPEC void SDLCALL SDL_AtomicLock(SDL_SpinLock *lock);
|
|||||||
* ***Please note that spinlocks are dangerous if you don't know what you're
|
* ***Please note that spinlocks are dangerous if you don't know what you're
|
||||||
* doing. Please be careful using any sort of spinlock!***
|
* doing. Please be careful using any sort of spinlock!***
|
||||||
*
|
*
|
||||||
* \param lock a pointer to a lock variable.
|
* \param lock a pointer to a lock variable
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.0.
|
* \since This function is available since SDL 2.0.0.
|
||||||
*
|
*
|
||||||
@@ -200,7 +209,7 @@ typedef void (*SDL_KernelMemoryBarrierFunc)();
|
|||||||
#if defined(__ARM_ARCH_7__) || defined(__ARM_ARCH_7A__) || defined(__ARM_ARCH_7EM__) || defined(__ARM_ARCH_7R__) || defined(__ARM_ARCH_7M__) || defined(__ARM_ARCH_7S__) || defined(__ARM_ARCH_8A__)
|
#if defined(__ARM_ARCH_7__) || defined(__ARM_ARCH_7A__) || defined(__ARM_ARCH_7EM__) || defined(__ARM_ARCH_7R__) || defined(__ARM_ARCH_7M__) || defined(__ARM_ARCH_7S__) || defined(__ARM_ARCH_8A__)
|
||||||
#define SDL_MemoryBarrierRelease() __asm__ __volatile__ ("dmb ish" : : : "memory")
|
#define SDL_MemoryBarrierRelease() __asm__ __volatile__ ("dmb ish" : : : "memory")
|
||||||
#define SDL_MemoryBarrierAcquire() __asm__ __volatile__ ("dmb ish" : : : "memory")
|
#define SDL_MemoryBarrierAcquire() __asm__ __volatile__ ("dmb ish" : : : "memory")
|
||||||
#elif defined(__ARM_ARCH_6__) || defined(__ARM_ARCH_6J__) || defined(__ARM_ARCH_6K__) || defined(__ARM_ARCH_6T2__) || defined(__ARM_ARCH_6Z__) || defined(__ARM_ARCH_6ZK__)
|
#elif defined(__ARM_ARCH_6__) || defined(__ARM_ARCH_6J__) || defined(__ARM_ARCH_6K__) || defined(__ARM_ARCH_6T2__) || defined(__ARM_ARCH_6Z__) || defined(__ARM_ARCH_6ZK__) || defined(__ARM_ARCH_5TE__)
|
||||||
#ifdef __thumb__
|
#ifdef __thumb__
|
||||||
/* The mcr instruction isn't available in thumb mode, use real functions */
|
/* The mcr instruction isn't available in thumb mode, use real functions */
|
||||||
#define SDL_MEMORY_BARRIER_USES_FUNCTION
|
#define SDL_MEMORY_BARRIER_USES_FUNCTION
|
||||||
@@ -248,13 +257,10 @@ typedef void (*SDL_KernelMemoryBarrierFunc)();
|
|||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* A type representing an atomic integer value.
|
* \brief A type representing an atomic integer value. It is a struct
|
||||||
*
|
* so people don't accidentally use numeric operations on it.
|
||||||
* It is a struct so people don't accidentally use numeric operations on it.
|
|
||||||
*/
|
*/
|
||||||
typedef struct SDL_atomic_t {
|
typedef struct { int value; } SDL_atomic_t;
|
||||||
int value;
|
|
||||||
} SDL_atomic_t;
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Set an atomic variable to a new value if it is currently an old value.
|
* Set an atomic variable to a new value if it is currently an old value.
|
||||||
@@ -262,9 +268,9 @@ typedef struct SDL_atomic_t {
|
|||||||
* ***Note: If you don't know what this function is for, you shouldn't use
|
* ***Note: If you don't know what this function is for, you shouldn't use
|
||||||
* it!***
|
* it!***
|
||||||
*
|
*
|
||||||
* \param a a pointer to an SDL_atomic_t variable to be modified.
|
* \param a a pointer to an SDL_atomic_t variable to be modified
|
||||||
* \param oldval the old value.
|
* \param oldval the old value
|
||||||
* \param newval the new value.
|
* \param newval the new value
|
||||||
* \returns SDL_TRUE if the atomic variable was set, SDL_FALSE otherwise.
|
* \returns SDL_TRUE if the atomic variable was set, SDL_FALSE otherwise.
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.0.
|
* \since This function is available since SDL 2.0.0.
|
||||||
@@ -283,8 +289,8 @@ extern DECLSPEC SDL_bool SDLCALL SDL_AtomicCAS(SDL_atomic_t *a, int oldval, int
|
|||||||
* ***Note: If you don't know what this function is for, you shouldn't use
|
* ***Note: If you don't know what this function is for, you shouldn't use
|
||||||
* it!***
|
* it!***
|
||||||
*
|
*
|
||||||
* \param a a pointer to an SDL_atomic_t variable to be modified.
|
* \param a a pointer to an SDL_atomic_t variable to be modified
|
||||||
* \param v the desired value.
|
* \param v the desired value
|
||||||
* \returns the previous value of the atomic variable.
|
* \returns the previous value of the atomic variable.
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.2.
|
* \since This function is available since SDL 2.0.2.
|
||||||
@@ -299,7 +305,7 @@ extern DECLSPEC int SDLCALL SDL_AtomicSet(SDL_atomic_t *a, int v);
|
|||||||
* ***Note: If you don't know what this function is for, you shouldn't use
|
* ***Note: If you don't know what this function is for, you shouldn't use
|
||||||
* it!***
|
* it!***
|
||||||
*
|
*
|
||||||
* \param a a pointer to an SDL_atomic_t variable.
|
* \param a a pointer to an SDL_atomic_t variable
|
||||||
* \returns the current value of an atomic variable.
|
* \returns the current value of an atomic variable.
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.2.
|
* \since This function is available since SDL 2.0.2.
|
||||||
@@ -316,8 +322,8 @@ extern DECLSPEC int SDLCALL SDL_AtomicGet(SDL_atomic_t *a);
|
|||||||
* ***Note: If you don't know what this function is for, you shouldn't use
|
* ***Note: If you don't know what this function is for, you shouldn't use
|
||||||
* it!***
|
* it!***
|
||||||
*
|
*
|
||||||
* \param a a pointer to an SDL_atomic_t variable to be modified.
|
* \param a a pointer to an SDL_atomic_t variable to be modified
|
||||||
* \param v the desired value to add.
|
* \param v the desired value to add
|
||||||
* \returns the previous value of the atomic variable.
|
* \returns the previous value of the atomic variable.
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.2.
|
* \since This function is available since SDL 2.0.2.
|
||||||
@@ -350,9 +356,9 @@ extern DECLSPEC int SDLCALL SDL_AtomicAdd(SDL_atomic_t *a, int v);
|
|||||||
* ***Note: If you don't know what this function is for, you shouldn't use
|
* ***Note: If you don't know what this function is for, you shouldn't use
|
||||||
* it!***
|
* it!***
|
||||||
*
|
*
|
||||||
* \param a a pointer to a pointer.
|
* \param a a pointer to a pointer
|
||||||
* \param oldval the old pointer value.
|
* \param oldval the old pointer value
|
||||||
* \param newval the new pointer value.
|
* \param newval the new pointer value
|
||||||
* \returns SDL_TRUE if the pointer was set, SDL_FALSE otherwise.
|
* \returns SDL_TRUE if the pointer was set, SDL_FALSE otherwise.
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.0.
|
* \since This function is available since SDL 2.0.0.
|
||||||
@@ -369,8 +375,8 @@ extern DECLSPEC SDL_bool SDLCALL SDL_AtomicCASPtr(void **a, void *oldval, void *
|
|||||||
* ***Note: If you don't know what this function is for, you shouldn't use
|
* ***Note: If you don't know what this function is for, you shouldn't use
|
||||||
* it!***
|
* it!***
|
||||||
*
|
*
|
||||||
* \param a a pointer to a pointer.
|
* \param a a pointer to a pointer
|
||||||
* \param v the desired pointer value.
|
* \param v the desired pointer value
|
||||||
* \returns the previous value of the pointer.
|
* \returns the previous value of the pointer.
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.2.
|
* \since This function is available since SDL 2.0.2.
|
||||||
@@ -386,7 +392,7 @@ extern DECLSPEC void* SDLCALL SDL_AtomicSetPtr(void **a, void* v);
|
|||||||
* ***Note: If you don't know what this function is for, you shouldn't use
|
* ***Note: If you don't know what this function is for, you shouldn't use
|
||||||
* it!***
|
* it!***
|
||||||
*
|
*
|
||||||
* \param a a pointer to a pointer.
|
* \param a a pointer to a pointer
|
||||||
* \returns the current value of a pointer.
|
* \returns the current value of a pointer.
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.2.
|
* \since This function is available since SDL 2.0.2.
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
/*
|
/*
|
||||||
Simple DirectMedia Layer
|
Simple DirectMedia Layer
|
||||||
Copyright (C) 1997-2025 Sam Lantinga <slouken@libsdl.org>
|
Copyright (C) 1997-2023 Sam Lantinga <slouken@libsdl.org>
|
||||||
|
|
||||||
This software is provided 'as-is', without any express or implied
|
This software is provided 'as-is', without any express or implied
|
||||||
warranty. In no event will the authors be held liable for any damages
|
warranty. In no event will the authors be held liable for any damages
|
||||||
@@ -22,9 +22,9 @@
|
|||||||
/* !!! FIXME: several functions in here need Doxygen comments. */
|
/* !!! FIXME: several functions in here need Doxygen comments. */
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* # CategoryAudio
|
* \file SDL_audio.h
|
||||||
*
|
*
|
||||||
* Access to the raw audio mixing buffer for the SDL library.
|
* Access to the raw audio mixing buffer for the SDL library.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#ifndef SDL_audio_h_
|
#ifndef SDL_audio_h_
|
||||||
@@ -44,24 +44,24 @@ extern "C" {
|
|||||||
#endif
|
#endif
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Audio format flags.
|
* \brief Audio format flags.
|
||||||
*
|
*
|
||||||
* These are what the 16 bits in SDL_AudioFormat currently mean...
|
* These are what the 16 bits in SDL_AudioFormat currently mean...
|
||||||
* (Unspecified bits are always zero).
|
* (Unspecified bits are always zero).
|
||||||
*
|
*
|
||||||
* ```
|
* \verbatim
|
||||||
* ++-----------------------sample is signed if set
|
++-----------------------sample is signed if set
|
||||||
* ||
|
||
|
||||||
* || ++-----------sample is bigendian if set
|
|| ++-----------sample is bigendian if set
|
||||||
* || ||
|
|| ||
|
||||||
* || || ++---sample is float if set
|
|| || ++---sample is float if set
|
||||||
* || || ||
|
|| || ||
|
||||||
* || || || +---sample bit size---+
|
|| || || +---sample bit size---+
|
||||||
* || || || | |
|
|| || || | |
|
||||||
* 15 14 13 12 11 10 09 08 07 06 05 04 03 02 01 00
|
15 14 13 12 11 10 09 08 07 06 05 04 03 02 01 00
|
||||||
* ```
|
\endverbatim
|
||||||
*
|
*
|
||||||
* There are macros in SDL 2.0 and later to query these bits.
|
* There are macros in SDL 2.0 and later to query these bits.
|
||||||
*/
|
*/
|
||||||
typedef Uint16 SDL_AudioFormat;
|
typedef Uint16 SDL_AudioFormat;
|
||||||
|
|
||||||
@@ -149,30 +149,33 @@ typedef Uint16 SDL_AudioFormat;
|
|||||||
/* @} *//* Audio flags */
|
/* @} *//* Audio flags */
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* This function is called when the audio device needs more data.
|
* This function is called when the audio device needs more data.
|
||||||
*
|
*
|
||||||
* \param userdata An application-specific parameter saved in the
|
* \param userdata An application-specific parameter saved in
|
||||||
* SDL_AudioSpec structure.
|
* the SDL_AudioSpec structure
|
||||||
* \param stream A pointer to the audio data buffer.
|
* \param stream A pointer to the audio data buffer.
|
||||||
* \param len Length of **stream** in bytes.
|
* \param len The length of that buffer in bytes.
|
||||||
|
*
|
||||||
|
* Once the callback returns, the buffer will no longer be valid.
|
||||||
|
* Stereo samples are stored in a LRLRLR ordering.
|
||||||
|
*
|
||||||
|
* You can choose to avoid callbacks and use SDL_QueueAudio() instead, if
|
||||||
|
* you like. Just open your audio device with a NULL callback.
|
||||||
*/
|
*/
|
||||||
typedef void (SDLCALL * SDL_AudioCallback) (void *userdata, Uint8 * stream,
|
typedef void (SDLCALL * SDL_AudioCallback) (void *userdata, Uint8 * stream,
|
||||||
int len);
|
int len);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The calculated values in this structure are calculated by SDL_OpenAudio().
|
* The calculated values in this structure are calculated by SDL_OpenAudio().
|
||||||
*
|
*
|
||||||
* For multi-channel audio, the default SDL channel mapping is:
|
* For multi-channel audio, the default SDL channel mapping is:
|
||||||
*
|
* 2: FL FR (stereo)
|
||||||
* ```
|
* 3: FL FR LFE (2.1 surround)
|
||||||
* 2: FL FR (stereo)
|
* 4: FL FR BL BR (quad)
|
||||||
* 3: FL FR LFE (2.1 surround)
|
* 5: FL FR LFE BL BR (4.1 surround)
|
||||||
* 4: FL FR BL BR (quad)
|
* 6: FL FR FC LFE SL SR (5.1 surround - last two can also be BL BR)
|
||||||
* 5: FL FR LFE BL BR (4.1 surround)
|
* 7: FL FR FC LFE BC SL SR (6.1 surround)
|
||||||
* 6: FL FR FC LFE SL SR (5.1 surround - last two can also be BL BR)
|
* 8: FL FR FC LFE BL BR SL SR (7.1 surround)
|
||||||
* 7: FL FR FC LFE BC SL SR (6.1 surround)
|
|
||||||
* 8: FL FR FC LFE BL BR SL SR (7.1 surround)
|
|
||||||
* ```
|
|
||||||
*/
|
*/
|
||||||
typedef struct SDL_AudioSpec
|
typedef struct SDL_AudioSpec
|
||||||
{
|
{
|
||||||
@@ -193,11 +196,11 @@ typedef void (SDLCALL * SDL_AudioFilter) (struct SDL_AudioCVT * cvt,
|
|||||||
SDL_AudioFormat format);
|
SDL_AudioFormat format);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Upper limit of filters in SDL_AudioCVT
|
* \brief Upper limit of filters in SDL_AudioCVT
|
||||||
*
|
*
|
||||||
* The maximum number of SDL_AudioFilter functions in SDL_AudioCVT is
|
* The maximum number of SDL_AudioFilter functions in SDL_AudioCVT is
|
||||||
* currently limited to 9. The SDL_AudioCVT.filters array has 10 pointers, one
|
* currently limited to 9. The SDL_AudioCVT.filters array has 10 pointers,
|
||||||
* of which is the terminating NULL pointer.
|
* one of which is the terminating NULL pointer.
|
||||||
*/
|
*/
|
||||||
#define SDL_AUDIOCVT_MAX_FILTERS 9
|
#define SDL_AUDIOCVT_MAX_FILTERS 9
|
||||||
|
|
||||||
@@ -284,7 +287,7 @@ extern DECLSPEC int SDLCALL SDL_GetNumAudioDrivers(void);
|
|||||||
* meant to be proper names.
|
* meant to be proper names.
|
||||||
*
|
*
|
||||||
* \param index the index of the audio driver; the value ranges from 0 to
|
* \param index the index of the audio driver; the value ranges from 0 to
|
||||||
* SDL_GetNumAudioDrivers() - 1.
|
* SDL_GetNumAudioDrivers() - 1
|
||||||
* \returns the name of the audio driver at the requested index, or NULL if an
|
* \returns the name of the audio driver at the requested index, or NULL if an
|
||||||
* invalid index was specified.
|
* invalid index was specified.
|
||||||
*
|
*
|
||||||
@@ -311,7 +314,7 @@ extern DECLSPEC const char *SDLCALL SDL_GetAudioDriver(int index);
|
|||||||
* specific need to designate the audio driver you want to use. You should
|
* specific need to designate the audio driver you want to use. You should
|
||||||
* normally use SDL_Init() or SDL_InitSubSystem().
|
* normally use SDL_Init() or SDL_InitSubSystem().
|
||||||
*
|
*
|
||||||
* \param driver_name the name of the desired audio driver.
|
* \param driver_name the name of the desired audio driver
|
||||||
* \returns 0 on success or a negative error code on failure; call
|
* \returns 0 on success or a negative error code on failure; call
|
||||||
* SDL_GetError() for more information.
|
* SDL_GetError() for more information.
|
||||||
*
|
*
|
||||||
@@ -405,13 +408,13 @@ extern DECLSPEC int SDLCALL SDL_OpenAudio(SDL_AudioSpec * desired,
|
|||||||
SDL_AudioSpec * obtained);
|
SDL_AudioSpec * obtained);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* SDL Audio Device IDs.
|
* SDL Audio Device IDs.
|
||||||
*
|
*
|
||||||
* A successful call to SDL_OpenAudio() is always device id 1, and legacy SDL
|
* A successful call to SDL_OpenAudio() is always device id 1, and legacy
|
||||||
* audio APIs assume you want this device ID. SDL_OpenAudioDevice() calls
|
* SDL audio APIs assume you want this device ID. SDL_OpenAudioDevice() calls
|
||||||
* always returns devices >= 2 on success. The legacy calls are good both for
|
* always returns devices >= 2 on success. The legacy calls are good both
|
||||||
* backwards compatibility and when you don't care about multiple, specific,
|
* for backwards compatibility and when you don't care about multiple,
|
||||||
* or capture devices.
|
* specific, or capture devices.
|
||||||
*/
|
*/
|
||||||
typedef Uint32 SDL_AudioDeviceID;
|
typedef Uint32 SDL_AudioDeviceID;
|
||||||
|
|
||||||
@@ -449,7 +452,7 @@ typedef Uint32 SDL_AudioDeviceID;
|
|||||||
* ```
|
* ```
|
||||||
*
|
*
|
||||||
* \param iscapture zero to request playback devices, non-zero to request
|
* \param iscapture zero to request playback devices, non-zero to request
|
||||||
* recording devices.
|
* recording devices
|
||||||
* \returns the number of available devices exposed by the current driver or
|
* \returns the number of available devices exposed by the current driver or
|
||||||
* -1 if an explicit list of devices can't be determined. A return
|
* -1 if an explicit list of devices can't be determined. A return
|
||||||
* value of -1 does not necessarily mean an error condition.
|
* value of -1 does not necessarily mean an error condition.
|
||||||
@@ -475,7 +478,7 @@ extern DECLSPEC int SDLCALL SDL_GetNumAudioDevices(int iscapture);
|
|||||||
* invalid next time any of several other SDL functions are called.
|
* invalid next time any of several other SDL functions are called.
|
||||||
*
|
*
|
||||||
* \param index the index of the audio device; valid values range from 0 to
|
* \param index the index of the audio device; valid values range from 0 to
|
||||||
* SDL_GetNumAudioDevices() - 1.
|
* SDL_GetNumAudioDevices() - 1
|
||||||
* \param iscapture non-zero to query the list of recording devices, zero to
|
* \param iscapture non-zero to query the list of recording devices, zero to
|
||||||
* query the list of output devices.
|
* query the list of output devices.
|
||||||
* \returns the name of the audio device at the requested index, or NULL on
|
* \returns the name of the audio device at the requested index, or NULL on
|
||||||
@@ -501,11 +504,11 @@ extern DECLSPEC const char *SDLCALL SDL_GetAudioDeviceName(int index,
|
|||||||
* count.
|
* count.
|
||||||
*
|
*
|
||||||
* \param index the index of the audio device; valid values range from 0 to
|
* \param index the index of the audio device; valid values range from 0 to
|
||||||
* SDL_GetNumAudioDevices() - 1.
|
* SDL_GetNumAudioDevices() - 1
|
||||||
* \param iscapture non-zero to query the list of recording devices, zero to
|
* \param iscapture non-zero to query the list of recording devices, zero to
|
||||||
* query the list of output devices.
|
* query the list of output devices.
|
||||||
* \param spec The SDL_AudioSpec to be initialized by this function.
|
* \param spec The SDL_AudioSpec to be initialized by this function.
|
||||||
* \returns 0 on success, nonzero on error.
|
* \returns 0 on success, nonzero on error
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.16.
|
* \since This function is available since SDL 2.0.16.
|
||||||
*
|
*
|
||||||
@@ -539,7 +542,7 @@ extern DECLSPEC int SDLCALL SDL_GetAudioDeviceSpec(int index,
|
|||||||
* \param spec The SDL_AudioSpec to be initialized by this function.
|
* \param spec The SDL_AudioSpec to be initialized by this function.
|
||||||
* \param iscapture non-zero to query the default recording device, zero to
|
* \param iscapture non-zero to query the default recording device, zero to
|
||||||
* query the default output device.
|
* query the default output device.
|
||||||
* \returns 0 on success, nonzero on error.
|
* \returns 0 on success, nonzero on error
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.24.0.
|
* \since This function is available since SDL 2.24.0.
|
||||||
*
|
*
|
||||||
@@ -591,7 +594,7 @@ extern DECLSPEC int SDLCALL SDL_GetDefaultAudioInfo(char **name,
|
|||||||
* frames_ (with stereo output, two samples--left and right--would make a
|
* frames_ (with stereo output, two samples--left and right--would make a
|
||||||
* single sample frame). This number should be a power of two, and may be
|
* single sample frame). This number should be a power of two, and may be
|
||||||
* adjusted by the audio driver to a value more suitable for the hardware.
|
* adjusted by the audio driver to a value more suitable for the hardware.
|
||||||
* Good values seem to range between 512 and 4096 inclusive, depending on
|
* Good values seem to range between 512 and 8096 inclusive, depending on
|
||||||
* the application and CPU speed. Smaller values reduce latency, but can
|
* the application and CPU speed. Smaller values reduce latency, but can
|
||||||
* lead to underflow if the application is doing heavy processing and cannot
|
* lead to underflow if the application is doing heavy processing and cannot
|
||||||
* fill the audio buffer in time. Note that the number of sample frames is
|
* fill the audio buffer in time. Note that the number of sample frames is
|
||||||
@@ -642,12 +645,12 @@ extern DECLSPEC int SDLCALL SDL_GetDefaultAudioInfo(char **name,
|
|||||||
* driver-specific name as appropriate. NULL requests the most
|
* driver-specific name as appropriate. NULL requests the most
|
||||||
* reasonable default device.
|
* reasonable default device.
|
||||||
* \param iscapture non-zero to specify a device should be opened for
|
* \param iscapture non-zero to specify a device should be opened for
|
||||||
* recording, not playback.
|
* recording, not playback
|
||||||
* \param desired an SDL_AudioSpec structure representing the desired output
|
* \param desired an SDL_AudioSpec structure representing the desired output
|
||||||
* format; see SDL_OpenAudio() for more information.
|
* format; see SDL_OpenAudio() for more information
|
||||||
* \param obtained an SDL_AudioSpec structure filled in with the actual output
|
* \param obtained an SDL_AudioSpec structure filled in with the actual output
|
||||||
* format; see SDL_OpenAudio() for more information.
|
* format; see SDL_OpenAudio() for more information
|
||||||
* \param allowed_changes 0, or one or more flags OR'd together.
|
* \param allowed_changes 0, or one or more flags OR'd together
|
||||||
* \returns a valid device ID that is > 0 on success or 0 on failure; call
|
* \returns a valid device ID that is > 0 on success or 0 on failure; call
|
||||||
* SDL_GetError() for more information.
|
* SDL_GetError() for more information.
|
||||||
*
|
*
|
||||||
@@ -709,7 +712,7 @@ extern DECLSPEC SDL_AudioStatus SDLCALL SDL_GetAudioStatus(void);
|
|||||||
* Use this function to get the current audio state of an audio device.
|
* Use this function to get the current audio state of an audio device.
|
||||||
*
|
*
|
||||||
* \param dev the ID of an audio device previously opened with
|
* \param dev the ID of an audio device previously opened with
|
||||||
* SDL_OpenAudioDevice().
|
* SDL_OpenAudioDevice()
|
||||||
* \returns the SDL_AudioStatus of the specified audio device.
|
* \returns the SDL_AudioStatus of the specified audio device.
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.0.
|
* \since This function is available since SDL 2.0.0.
|
||||||
@@ -742,7 +745,7 @@ extern DECLSPEC SDL_AudioStatus SDLCALL SDL_GetAudioDeviceStatus(SDL_AudioDevice
|
|||||||
*
|
*
|
||||||
* ...and is only useful if you used the legacy SDL_OpenAudio() function.
|
* ...and is only useful if you used the legacy SDL_OpenAudio() function.
|
||||||
*
|
*
|
||||||
* \param pause_on non-zero to pause, 0 to unpause.
|
* \param pause_on non-zero to pause, 0 to unpause
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.0.
|
* \since This function is available since SDL 2.0.0.
|
||||||
*
|
*
|
||||||
@@ -772,8 +775,8 @@ extern DECLSPEC void SDLCALL SDL_PauseAudio(int pause_on);
|
|||||||
* callback, you shouldn't pause the audio device, as it will lead to dropouts
|
* callback, you shouldn't pause the audio device, as it will lead to dropouts
|
||||||
* in the audio playback. Instead, you should use SDL_LockAudioDevice().
|
* in the audio playback. Instead, you should use SDL_LockAudioDevice().
|
||||||
*
|
*
|
||||||
* \param dev a device opened by SDL_OpenAudioDevice().
|
* \param dev a device opened by SDL_OpenAudioDevice()
|
||||||
* \param pause_on non-zero to pause, 0 to unpause.
|
* \param pause_on non-zero to pause, 0 to unpause
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.0.
|
* \since This function is available since SDL 2.0.0.
|
||||||
*
|
*
|
||||||
@@ -838,14 +841,14 @@ extern DECLSPEC void SDLCALL SDL_PauseAudioDevice(SDL_AudioDeviceID dev,
|
|||||||
* SDL_LoadWAV("sample.wav", &spec, &buf, &len);
|
* SDL_LoadWAV("sample.wav", &spec, &buf, &len);
|
||||||
* ```
|
* ```
|
||||||
*
|
*
|
||||||
* \param src The data source for the WAVE data.
|
* \param src The data source for the WAVE data
|
||||||
* \param freesrc If non-zero, SDL will _always_ free the data source.
|
* \param freesrc If non-zero, SDL will _always_ free the data source
|
||||||
* \param spec An SDL_AudioSpec that will be filled in with the wave file's
|
* \param spec An SDL_AudioSpec that will be filled in with the wave file's
|
||||||
* format details.
|
* format details
|
||||||
* \param audio_buf A pointer filled with the audio data, allocated by the
|
* \param audio_buf A pointer filled with the audio data, allocated by the
|
||||||
* function.
|
* function.
|
||||||
* \param audio_len A pointer filled with the length of the audio data buffer
|
* \param audio_len A pointer filled with the length of the audio data buffer
|
||||||
* in bytes.
|
* in bytes
|
||||||
* \returns This function, if successfully called, returns `spec`, which will
|
* \returns This function, if successfully called, returns `spec`, which will
|
||||||
* be filled with the audio data format of the wave source data.
|
* be filled with the audio data format of the wave source data.
|
||||||
* `audio_buf` will be filled with a pointer to an allocated buffer
|
* `audio_buf` will be filled with a pointer to an allocated buffer
|
||||||
@@ -871,9 +874,8 @@ extern DECLSPEC SDL_AudioSpec *SDLCALL SDL_LoadWAV_RW(SDL_RWops * src,
|
|||||||
Uint32 * audio_len);
|
Uint32 * audio_len);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Loads a WAV from a file.
|
* Loads a WAV from a file.
|
||||||
*
|
* Compatibility convenience function.
|
||||||
* Compatibility convenience function.
|
|
||||||
*/
|
*/
|
||||||
#define SDL_LoadWAV(file, spec, audio_buf, audio_len) \
|
#define SDL_LoadWAV(file, spec, audio_buf, audio_len) \
|
||||||
SDL_LoadWAV_RW(SDL_RWFromFile(file, "rb"),1, spec,audio_buf,audio_len)
|
SDL_LoadWAV_RW(SDL_RWFromFile(file, "rb"),1, spec,audio_buf,audio_len)
|
||||||
@@ -886,7 +888,7 @@ extern DECLSPEC SDL_AudioSpec *SDLCALL SDL_LoadWAV_RW(SDL_RWops * src,
|
|||||||
* this function with a NULL pointer.
|
* this function with a NULL pointer.
|
||||||
*
|
*
|
||||||
* \param audio_buf a pointer to the buffer created by SDL_LoadWAV() or
|
* \param audio_buf a pointer to the buffer created by SDL_LoadWAV() or
|
||||||
* SDL_LoadWAV_RW().
|
* SDL_LoadWAV_RW()
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.0.
|
* \since This function is available since SDL 2.0.0.
|
||||||
*
|
*
|
||||||
@@ -910,16 +912,15 @@ extern DECLSPEC void SDLCALL SDL_FreeWAV(Uint8 * audio_buf);
|
|||||||
* and then can call SDL_ConvertAudio() to complete the conversion.
|
* and then can call SDL_ConvertAudio() to complete the conversion.
|
||||||
*
|
*
|
||||||
* \param cvt an SDL_AudioCVT structure filled in with audio conversion
|
* \param cvt an SDL_AudioCVT structure filled in with audio conversion
|
||||||
* information.
|
* information
|
||||||
* \param src_format the source format of the audio data; for more info see
|
* \param src_format the source format of the audio data; for more info see
|
||||||
* SDL_AudioFormat.
|
* SDL_AudioFormat
|
||||||
* \param src_channels the number of channels in the source.
|
* \param src_channels the number of channels in the source
|
||||||
* \param src_rate the frequency (sample-frames-per-second) of the source.
|
* \param src_rate the frequency (sample-frames-per-second) of the source
|
||||||
* \param dst_format the destination format of the audio data; for more info
|
* \param dst_format the destination format of the audio data; for more info
|
||||||
* see SDL_AudioFormat.
|
* see SDL_AudioFormat
|
||||||
* \param dst_channels the number of channels in the destination.
|
* \param dst_channels the number of channels in the destination
|
||||||
* \param dst_rate the frequency (sample-frames-per-second) of the
|
* \param dst_rate the frequency (sample-frames-per-second) of the destination
|
||||||
* destination.
|
|
||||||
* \returns 1 if the audio filter is prepared, 0 if no conversion is needed,
|
* \returns 1 if the audio filter is prepared, 0 if no conversion is needed,
|
||||||
* or a negative error code on failure; call SDL_GetError() for more
|
* or a negative error code on failure; call SDL_GetError() for more
|
||||||
* information.
|
* information.
|
||||||
@@ -990,12 +991,12 @@ typedef struct _SDL_AudioStream SDL_AudioStream;
|
|||||||
/**
|
/**
|
||||||
* Create a new audio stream.
|
* Create a new audio stream.
|
||||||
*
|
*
|
||||||
* \param src_format The format of the source audio.
|
* \param src_format The format of the source audio
|
||||||
* \param src_channels The number of channels of the source audio.
|
* \param src_channels The number of channels of the source audio
|
||||||
* \param src_rate The sampling rate of the source audio.
|
* \param src_rate The sampling rate of the source audio
|
||||||
* \param dst_format The format of the desired audio output.
|
* \param dst_format The format of the desired audio output
|
||||||
* \param dst_channels The number of channels of the desired audio output.
|
* \param dst_channels The number of channels of the desired audio output
|
||||||
* \param dst_rate The sampling rate of the desired audio output.
|
* \param dst_rate The sampling rate of the desired audio output
|
||||||
* \returns 0 on success, or -1 on error.
|
* \returns 0 on success, or -1 on error.
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.7.
|
* \since This function is available since SDL 2.0.7.
|
||||||
@@ -1017,9 +1018,9 @@ extern DECLSPEC SDL_AudioStream * SDLCALL SDL_NewAudioStream(const SDL_AudioForm
|
|||||||
/**
|
/**
|
||||||
* Add data to be converted/resampled to the stream.
|
* Add data to be converted/resampled to the stream.
|
||||||
*
|
*
|
||||||
* \param stream The stream the audio data is being added to.
|
* \param stream The stream the audio data is being added to
|
||||||
* \param buf A pointer to the audio data to add.
|
* \param buf A pointer to the audio data to add
|
||||||
* \param len The number of bytes to write to the stream.
|
* \param len The number of bytes to write to the stream
|
||||||
* \returns 0 on success, or -1 on error.
|
* \returns 0 on success, or -1 on error.
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.7.
|
* \since This function is available since SDL 2.0.7.
|
||||||
@@ -1036,10 +1037,10 @@ extern DECLSPEC int SDLCALL SDL_AudioStreamPut(SDL_AudioStream *stream, const vo
|
|||||||
/**
|
/**
|
||||||
* Get converted/resampled data from the stream
|
* Get converted/resampled data from the stream
|
||||||
*
|
*
|
||||||
* \param stream The stream the audio is being requested from.
|
* \param stream The stream the audio is being requested from
|
||||||
* \param buf A buffer to fill with audio data.
|
* \param buf A buffer to fill with audio data
|
||||||
* \param len The maximum number of bytes to fill.
|
* \param len The maximum number of bytes to fill
|
||||||
* \returns the number of bytes read from the stream, or -1 on error.
|
* \returns the number of bytes read from the stream, or -1 on error
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.7.
|
* \since This function is available since SDL 2.0.7.
|
||||||
*
|
*
|
||||||
@@ -1117,9 +1118,6 @@ extern DECLSPEC void SDLCALL SDL_AudioStreamClear(SDL_AudioStream *stream);
|
|||||||
*/
|
*/
|
||||||
extern DECLSPEC void SDLCALL SDL_FreeAudioStream(SDL_AudioStream *stream);
|
extern DECLSPEC void SDLCALL SDL_FreeAudioStream(SDL_AudioStream *stream);
|
||||||
|
|
||||||
/**
|
|
||||||
* Maximum volume allowed in calls to SDL_MixAudio and SDL_MixAudioFormat.
|
|
||||||
*/
|
|
||||||
#define SDL_MIX_MAXVOLUME 128
|
#define SDL_MIX_MAXVOLUME 128
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -1134,11 +1132,11 @@ extern DECLSPEC void SDLCALL SDL_FreeAudioStream(SDL_AudioStream *stream);
|
|||||||
* ...where `format` is the obtained format of the audio device from the
|
* ...where `format` is the obtained format of the audio device from the
|
||||||
* legacy SDL_OpenAudio() function.
|
* legacy SDL_OpenAudio() function.
|
||||||
*
|
*
|
||||||
* \param dst the destination for the mixed audio.
|
* \param dst the destination for the mixed audio
|
||||||
* \param src the source audio buffer to be mixed.
|
* \param src the source audio buffer to be mixed
|
||||||
* \param len the length of the audio buffer in bytes.
|
* \param len the length of the audio buffer in bytes
|
||||||
* \param volume ranges from 0 - 128, and should be set to SDL_MIX_MAXVOLUME
|
* \param volume ranges from 0 - 128, and should be set to SDL_MIX_MAXVOLUME
|
||||||
* for full audio volume.
|
* for full audio volume
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.0.
|
* \since This function is available since SDL 2.0.0.
|
||||||
*
|
*
|
||||||
@@ -1167,13 +1165,13 @@ extern DECLSPEC void SDLCALL SDL_MixAudio(Uint8 * dst, const Uint8 * src,
|
|||||||
* SDL_MixAudioFormat() is really only needed when you're mixing a single
|
* SDL_MixAudioFormat() is really only needed when you're mixing a single
|
||||||
* audio stream with a volume adjustment.
|
* audio stream with a volume adjustment.
|
||||||
*
|
*
|
||||||
* \param dst the destination for the mixed audio.
|
* \param dst the destination for the mixed audio
|
||||||
* \param src the source audio buffer to be mixed.
|
* \param src the source audio buffer to be mixed
|
||||||
* \param format the SDL_AudioFormat structure representing the desired audio
|
* \param format the SDL_AudioFormat structure representing the desired audio
|
||||||
* format.
|
* format
|
||||||
* \param len the length of the audio buffer in bytes.
|
* \param len the length of the audio buffer in bytes
|
||||||
* \param volume ranges from 0 - 128, and should be set to SDL_MIX_MAXVOLUME
|
* \param volume ranges from 0 - 128, and should be set to SDL_MIX_MAXVOLUME
|
||||||
* for full audio volume.
|
* for full audio volume
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.0.
|
* \since This function is available since SDL 2.0.0.
|
||||||
*/
|
*/
|
||||||
@@ -1217,9 +1215,9 @@ extern DECLSPEC void SDLCALL SDL_MixAudioFormat(Uint8 * dst,
|
|||||||
* from planar audio formats into a non-planar one (see SDL_AudioFormat)
|
* from planar audio formats into a non-planar one (see SDL_AudioFormat)
|
||||||
* before queuing audio.
|
* before queuing audio.
|
||||||
*
|
*
|
||||||
* \param dev the device ID to which we will queue audio.
|
* \param dev the device ID to which we will queue audio
|
||||||
* \param data the data to queue to the device for later playback.
|
* \param data the data to queue to the device for later playback
|
||||||
* \param len the number of bytes (not samples!) to which `data` points.
|
* \param len the number of bytes (not samples!) to which `data` points
|
||||||
* \returns 0 on success or a negative error code on failure; call
|
* \returns 0 on success or a negative error code on failure; call
|
||||||
* SDL_GetError() for more information.
|
* SDL_GetError() for more information.
|
||||||
*
|
*
|
||||||
@@ -1265,9 +1263,9 @@ extern DECLSPEC int SDLCALL SDL_QueueAudio(SDL_AudioDeviceID dev, const void *da
|
|||||||
* You should not call SDL_LockAudio() on the device before dequeueing; SDL
|
* You should not call SDL_LockAudio() on the device before dequeueing; SDL
|
||||||
* handles locking internally for this function.
|
* handles locking internally for this function.
|
||||||
*
|
*
|
||||||
* \param dev the device ID from which we will dequeue audio.
|
* \param dev the device ID from which we will dequeue audio
|
||||||
* \param data a pointer into where audio data should be copied.
|
* \param data a pointer into where audio data should be copied
|
||||||
* \param len the number of bytes (not samples!) to which (data) points.
|
* \param len the number of bytes (not samples!) to which (data) points
|
||||||
* \returns the number of bytes dequeued, which could be less than requested;
|
* \returns the number of bytes dequeued, which could be less than requested;
|
||||||
* call SDL_GetError() for more information.
|
* call SDL_GetError() for more information.
|
||||||
*
|
*
|
||||||
@@ -1301,7 +1299,7 @@ extern DECLSPEC Uint32 SDLCALL SDL_DequeueAudio(SDL_AudioDeviceID dev, void *dat
|
|||||||
* You should not call SDL_LockAudio() on the device before querying; SDL
|
* You should not call SDL_LockAudio() on the device before querying; SDL
|
||||||
* handles locking internally for this function.
|
* handles locking internally for this function.
|
||||||
*
|
*
|
||||||
* \param dev the device ID of which we will query queued audio size.
|
* \param dev the device ID of which we will query queued audio size
|
||||||
* \returns the number of bytes (not samples!) of queued audio.
|
* \returns the number of bytes (not samples!) of queued audio.
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.4.
|
* \since This function is available since SDL 2.0.4.
|
||||||
@@ -1336,7 +1334,7 @@ extern DECLSPEC Uint32 SDLCALL SDL_GetQueuedAudioSize(SDL_AudioDeviceID dev);
|
|||||||
*
|
*
|
||||||
* This function always succeeds and thus returns void.
|
* This function always succeeds and thus returns void.
|
||||||
*
|
*
|
||||||
* \param dev the device ID of which to clear the audio queue.
|
* \param dev the device ID of which to clear the audio queue
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.4.
|
* \since This function is available since SDL 2.0.4.
|
||||||
*
|
*
|
||||||
@@ -1408,7 +1406,7 @@ extern DECLSPEC void SDLCALL SDL_LockAudio(void);
|
|||||||
* at once, not only will you block the audio callback, you'll block the other
|
* at once, not only will you block the audio callback, you'll block the other
|
||||||
* thread.
|
* thread.
|
||||||
*
|
*
|
||||||
* \param dev the ID of the device to be locked.
|
* \param dev the ID of the device to be locked
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.0.
|
* \since This function is available since SDL 2.0.0.
|
||||||
*
|
*
|
||||||
@@ -1441,7 +1439,7 @@ extern DECLSPEC void SDLCALL SDL_UnlockAudio(void);
|
|||||||
*
|
*
|
||||||
* This function should be paired with a previous SDL_LockAudioDevice() call.
|
* This function should be paired with a previous SDL_LockAudioDevice() call.
|
||||||
*
|
*
|
||||||
* \param dev the ID of the device to be unlocked.
|
* \param dev the ID of the device to be unlocked
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.0.
|
* \since This function is available since SDL 2.0.0.
|
||||||
*
|
*
|
||||||
@@ -1483,7 +1481,7 @@ extern DECLSPEC void SDLCALL SDL_CloseAudio(void);
|
|||||||
* The device ID is invalid as soon as the device is closed, and is eligible
|
* The device ID is invalid as soon as the device is closed, and is eligible
|
||||||
* for reuse in a new SDL_OpenAudioDevice() call immediately.
|
* for reuse in a new SDL_OpenAudioDevice() call immediately.
|
||||||
*
|
*
|
||||||
* \param dev an audio device previously opened with SDL_OpenAudioDevice().
|
* \param dev an audio device previously opened with SDL_OpenAudioDevice()
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.0.
|
* \since This function is available since SDL 2.0.0.
|
||||||
*
|
*
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
/*
|
/*
|
||||||
Simple DirectMedia Layer
|
Simple DirectMedia Layer
|
||||||
Copyright (C) 1997-2025 Sam Lantinga <slouken@libsdl.org>
|
Copyright (C) 1997-2023 Sam Lantinga <slouken@libsdl.org>
|
||||||
|
|
||||||
This software is provided 'as-is', without any express or implied
|
This software is provided 'as-is', without any express or implied
|
||||||
warranty. In no event will the authors be held liable for any damages
|
warranty. In no event will the authors be held liable for any damages
|
||||||
@@ -20,9 +20,9 @@
|
|||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* # CategoryBits
|
* \file SDL_bits.h
|
||||||
*
|
*
|
||||||
* Functions for fiddling with bits and bitmasks.
|
* Functions for fiddling with bits and bitmasks.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#ifndef SDL_bits_h_
|
#ifndef SDL_bits_h_
|
||||||
@@ -56,12 +56,6 @@ extern __inline int _SDL_bsr_watcom(Uint32);
|
|||||||
modify exact [eax] nomemory;
|
modify exact [eax] nomemory;
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
/**
|
|
||||||
* Use this function to get the index of the most significant (set) bit in a
|
|
||||||
*
|
|
||||||
* \param x the number to find the MSB of.
|
|
||||||
* \returns the index of the most significant bit of x, or -1 if x is 0.
|
|
||||||
*/
|
|
||||||
SDL_FORCE_INLINE int
|
SDL_FORCE_INLINE int
|
||||||
SDL_MostSignificantBitIndex32(Uint32 x)
|
SDL_MostSignificantBitIndex32(Uint32 x)
|
||||||
{
|
{
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
/*
|
/*
|
||||||
Simple DirectMedia Layer
|
Simple DirectMedia Layer
|
||||||
Copyright (C) 1997-2025 Sam Lantinga <slouken@libsdl.org>
|
Copyright (C) 1997-2023 Sam Lantinga <slouken@libsdl.org>
|
||||||
|
|
||||||
This software is provided 'as-is', without any express or implied
|
This software is provided 'as-is', without any express or implied
|
||||||
warranty. In no event will the authors be held liable for any damages
|
warranty. In no event will the authors be held liable for any damages
|
||||||
@@ -20,9 +20,9 @@
|
|||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* # CategoryBlendmode
|
* \file SDL_blendmode.h
|
||||||
*
|
*
|
||||||
* Header file declaring the SDL_BlendMode enumeration
|
* Header file declaring the SDL_BlendMode enumeration
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#ifndef SDL_blendmode_h_
|
#ifndef SDL_blendmode_h_
|
||||||
@@ -35,9 +35,9 @@ extern "C" {
|
|||||||
#endif
|
#endif
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The blend mode used in SDL_RenderCopy() and drawing operations.
|
* \brief The blend mode used in SDL_RenderCopy() and drawing operations.
|
||||||
*/
|
*/
|
||||||
typedef enum SDL_BlendMode
|
typedef enum
|
||||||
{
|
{
|
||||||
SDL_BLENDMODE_NONE = 0x00000000, /**< no blending
|
SDL_BLENDMODE_NONE = 0x00000000, /**< no blending
|
||||||
dstRGBA = srcRGBA */
|
dstRGBA = srcRGBA */
|
||||||
@@ -60,22 +60,21 @@ typedef enum SDL_BlendMode
|
|||||||
} SDL_BlendMode;
|
} SDL_BlendMode;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The blend operation used when combining source and destination pixel
|
* \brief The blend operation used when combining source and destination pixel components
|
||||||
* components
|
|
||||||
*/
|
*/
|
||||||
typedef enum SDL_BlendOperation
|
typedef enum
|
||||||
{
|
{
|
||||||
SDL_BLENDOPERATION_ADD = 0x1, /**< dst + src: supported by all renderers */
|
SDL_BLENDOPERATION_ADD = 0x1, /**< dst + src: supported by all renderers */
|
||||||
SDL_BLENDOPERATION_SUBTRACT = 0x2, /**< src - dst : supported by D3D9, D3D11, OpenGL, OpenGLES */
|
SDL_BLENDOPERATION_SUBTRACT = 0x2, /**< dst - src : supported by D3D9, D3D11, OpenGL, OpenGLES */
|
||||||
SDL_BLENDOPERATION_REV_SUBTRACT = 0x3, /**< dst - src : supported by D3D9, D3D11, OpenGL, OpenGLES */
|
SDL_BLENDOPERATION_REV_SUBTRACT = 0x3, /**< src - dst : supported by D3D9, D3D11, OpenGL, OpenGLES */
|
||||||
SDL_BLENDOPERATION_MINIMUM = 0x4, /**< min(dst, src) : supported by D3D9, D3D11 */
|
SDL_BLENDOPERATION_MINIMUM = 0x4, /**< min(dst, src) : supported by D3D9, D3D11 */
|
||||||
SDL_BLENDOPERATION_MAXIMUM = 0x5 /**< max(dst, src) : supported by D3D9, D3D11 */
|
SDL_BLENDOPERATION_MAXIMUM = 0x5 /**< max(dst, src) : supported by D3D9, D3D11 */
|
||||||
} SDL_BlendOperation;
|
} SDL_BlendOperation;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The normalized factor used to multiply pixel components
|
* \brief The normalized factor used to multiply pixel components
|
||||||
*/
|
*/
|
||||||
typedef enum SDL_BlendFactor
|
typedef enum
|
||||||
{
|
{
|
||||||
SDL_BLENDFACTOR_ZERO = 0x1, /**< 0, 0, 0, 0 */
|
SDL_BLENDFACTOR_ZERO = 0x1, /**< 0, 0, 0, 0 */
|
||||||
SDL_BLENDFACTOR_ONE = 0x2, /**< 1, 1, 1, 1 */
|
SDL_BLENDFACTOR_ONE = 0x2, /**< 1, 1, 1, 1 */
|
||||||
@@ -159,18 +158,18 @@ typedef enum SDL_BlendFactor
|
|||||||
* case.
|
* case.
|
||||||
*
|
*
|
||||||
* \param srcColorFactor the SDL_BlendFactor applied to the red, green, and
|
* \param srcColorFactor the SDL_BlendFactor applied to the red, green, and
|
||||||
* blue components of the source pixels.
|
* blue components of the source pixels
|
||||||
* \param dstColorFactor the SDL_BlendFactor applied to the red, green, and
|
* \param dstColorFactor the SDL_BlendFactor applied to the red, green, and
|
||||||
* blue components of the destination pixels.
|
* blue components of the destination pixels
|
||||||
* \param colorOperation the SDL_BlendOperation used to combine the red,
|
* \param colorOperation the SDL_BlendOperation used to combine the red,
|
||||||
* green, and blue components of the source and
|
* green, and blue components of the source and
|
||||||
* destination pixels.
|
* destination pixels
|
||||||
* \param srcAlphaFactor the SDL_BlendFactor applied to the alpha component of
|
* \param srcAlphaFactor the SDL_BlendFactor applied to the alpha component of
|
||||||
* the source pixels.
|
* the source pixels
|
||||||
* \param dstAlphaFactor the SDL_BlendFactor applied to the alpha component of
|
* \param dstAlphaFactor the SDL_BlendFactor applied to the alpha component of
|
||||||
* the destination pixels.
|
* the destination pixels
|
||||||
* \param alphaOperation the SDL_BlendOperation used to combine the alpha
|
* \param alphaOperation the SDL_BlendOperation used to combine the alpha
|
||||||
* component of the source and destination pixels.
|
* component of the source and destination pixels
|
||||||
* \returns an SDL_BlendMode that represents the chosen factors and
|
* \returns an SDL_BlendMode that represents the chosen factors and
|
||||||
* operations.
|
* operations.
|
||||||
*
|
*
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
/*
|
/*
|
||||||
Simple DirectMedia Layer
|
Simple DirectMedia Layer
|
||||||
Copyright (C) 1997-2025 Sam Lantinga <slouken@libsdl.org>
|
Copyright (C) 1997-2023 Sam Lantinga <slouken@libsdl.org>
|
||||||
|
|
||||||
This software is provided 'as-is', without any express or implied
|
This software is provided 'as-is', without any express or implied
|
||||||
warranty. In no event will the authors be held liable for any damages
|
warranty. In no event will the authors be held liable for any damages
|
||||||
@@ -20,7 +20,7 @@
|
|||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* # CategoryClipboard
|
* \file SDL_clipboard.h
|
||||||
*
|
*
|
||||||
* Include file for SDL clipboard handling
|
* Include file for SDL clipboard handling
|
||||||
*/
|
*/
|
||||||
@@ -41,7 +41,7 @@ extern "C" {
|
|||||||
/**
|
/**
|
||||||
* Put UTF-8 text into the clipboard.
|
* Put UTF-8 text into the clipboard.
|
||||||
*
|
*
|
||||||
* \param text the text to store in the clipboard.
|
* \param text the text to store in the clipboard
|
||||||
* \returns 0 on success or a negative error code on failure; call
|
* \returns 0 on success or a negative error code on failure; call
|
||||||
* SDL_GetError() for more information.
|
* SDL_GetError() for more information.
|
||||||
*
|
*
|
||||||
@@ -85,7 +85,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_HasClipboardText(void);
|
|||||||
/**
|
/**
|
||||||
* Put UTF-8 text into the primary selection.
|
* Put UTF-8 text into the primary selection.
|
||||||
*
|
*
|
||||||
* \param text the text to store in the primary selection.
|
* \param text the text to store in the primary selection
|
||||||
* \returns 0 on success or a negative error code on failure; call
|
* \returns 0 on success or a negative error code on failure; call
|
||||||
* SDL_GetError() for more information.
|
* SDL_GetError() for more information.
|
||||||
*
|
*
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
/*
|
/*
|
||||||
Simple DirectMedia Layer
|
Simple DirectMedia Layer
|
||||||
Copyright (C) 1997-2025 Sam Lantinga <slouken@libsdl.org>
|
Copyright (C) 1997-2023 Sam Lantinga <slouken@libsdl.org>
|
||||||
|
|
||||||
This software is provided 'as-is', without any express or implied
|
This software is provided 'as-is', without any express or implied
|
||||||
warranty. In no event will the authors be held liable for any damages
|
warranty. In no event will the authors be held liable for any damages
|
||||||
@@ -19,41 +19,313 @@
|
|||||||
3. This notice may not be removed or altered from any source distribution.
|
3. This notice may not be removed or altered from any source distribution.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#ifndef SDL_config_h_
|
#ifndef SDL_config_windows_h_
|
||||||
|
#define SDL_config_windows_h_
|
||||||
#define SDL_config_h_
|
#define SDL_config_h_
|
||||||
|
|
||||||
#include "SDL_platform.h"
|
#include "SDL_platform.h"
|
||||||
|
|
||||||
/* WIKI CATEGORY: - */
|
/* winsdkver.h defines _WIN32_MAXVER for SDK version detection. It is present since at least the Windows 7 SDK,
|
||||||
|
* but out of caution we'll only use it if the compiler supports __has_include() to confirm its presence.
|
||||||
/* Add any platform that doesn't build using the configure system. */
|
* If your compiler doesn't support __has_include() but you have winsdkver.h, define HAVE_WINSDKVER_H. */
|
||||||
#if defined(__WIN32__)
|
#if !defined(HAVE_WINSDKVER_H) && defined(__has_include)
|
||||||
#include "SDL_config_windows.h"
|
#if __has_include(<winsdkver.h>)
|
||||||
#elif defined(__WINRT__)
|
#define HAVE_WINSDKVER_H 1
|
||||||
#include "SDL_config_winrt.h"
|
#endif
|
||||||
#elif defined(__WINGDK__)
|
|
||||||
#include "SDL_config_wingdk.h"
|
|
||||||
#elif defined(__XBOXONE__) || defined(__XBOXSERIES__)
|
|
||||||
#include "SDL_config_xbox.h"
|
|
||||||
#elif defined(__MACOSX__)
|
|
||||||
#include "SDL_config_macosx.h"
|
|
||||||
#elif defined(__IPHONEOS__)
|
|
||||||
#include "SDL_config_iphoneos.h"
|
|
||||||
#elif defined(__ANDROID__)
|
|
||||||
#include "SDL_config_android.h"
|
|
||||||
#elif defined(__OS2__)
|
|
||||||
#include "SDL_config_os2.h"
|
|
||||||
#elif defined(__EMSCRIPTEN__)
|
|
||||||
#include "SDL_config_emscripten.h"
|
|
||||||
#elif defined(__NGAGE__)
|
|
||||||
#include "SDL_config_ngage.h"
|
|
||||||
#else
|
|
||||||
/* This is a minimal configuration just to get SDL running on new platforms. */
|
|
||||||
#include "SDL_config_minimal.h"
|
|
||||||
#endif /* platform config */
|
|
||||||
|
|
||||||
#ifdef USING_GENERATED_CONFIG_H
|
|
||||||
#error Wrong SDL_config.h, check your include path?
|
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
#endif /* SDL_config_h_ */
|
#ifdef HAVE_WINSDKVER_H
|
||||||
|
#include <winsdkver.h>
|
||||||
|
#endif
|
||||||
|
|
||||||
|
/* sdkddkver.h defines more specific SDK version numbers. This is needed because older versions of the
|
||||||
|
* Windows 10 SDK have broken declarations for the C API for DirectX 12. */
|
||||||
|
#if !defined(HAVE_SDKDDKVER_H) && defined(__has_include)
|
||||||
|
#if __has_include(<sdkddkver.h>)
|
||||||
|
#define HAVE_SDKDDKVER_H 1
|
||||||
|
#endif
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#ifdef HAVE_SDKDDKVER_H
|
||||||
|
#include <sdkddkver.h>
|
||||||
|
#endif
|
||||||
|
|
||||||
|
/* This is a set of defines to configure the SDL features */
|
||||||
|
|
||||||
|
#if !defined(HAVE_STDINT_H) && !defined(_STDINT_H_)
|
||||||
|
/* Most everything except Visual Studio 2008 and earlier has stdint.h now */
|
||||||
|
#if defined(_MSC_VER) && (_MSC_VER < 1600)
|
||||||
|
typedef signed __int8 int8_t;
|
||||||
|
typedef unsigned __int8 uint8_t;
|
||||||
|
typedef signed __int16 int16_t;
|
||||||
|
typedef unsigned __int16 uint16_t;
|
||||||
|
typedef signed __int32 int32_t;
|
||||||
|
typedef unsigned __int32 uint32_t;
|
||||||
|
typedef signed __int64 int64_t;
|
||||||
|
typedef unsigned __int64 uint64_t;
|
||||||
|
#ifndef _UINTPTR_T_DEFINED
|
||||||
|
#ifdef _WIN64
|
||||||
|
typedef unsigned __int64 uintptr_t;
|
||||||
|
#else
|
||||||
|
typedef unsigned int uintptr_t;
|
||||||
|
#endif
|
||||||
|
#define _UINTPTR_T_DEFINED
|
||||||
|
#endif
|
||||||
|
#else
|
||||||
|
#define HAVE_STDINT_H 1
|
||||||
|
#endif /* Visual Studio 2008 */
|
||||||
|
#endif /* !_STDINT_H_ && !HAVE_STDINT_H */
|
||||||
|
|
||||||
|
#ifdef _WIN64
|
||||||
|
# define SIZEOF_VOIDP 8
|
||||||
|
#else
|
||||||
|
# define SIZEOF_VOIDP 4
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#ifdef __clang__
|
||||||
|
# define HAVE_GCC_ATOMICS 1
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#define HAVE_DDRAW_H 1
|
||||||
|
#define HAVE_DINPUT_H 1
|
||||||
|
#define HAVE_DSOUND_H 1
|
||||||
|
#ifndef __WATCOMC__
|
||||||
|
#define HAVE_DXGI_H 1
|
||||||
|
#define HAVE_XINPUT_H 1
|
||||||
|
#if defined(_WIN32_MAXVER) && _WIN32_MAXVER >= 0x0A00 /* Windows 10 SDK */
|
||||||
|
#define HAVE_WINDOWS_GAMING_INPUT_H 1
|
||||||
|
#endif
|
||||||
|
#if defined(_WIN32_MAXVER) && _WIN32_MAXVER >= 0x0602 /* Windows 8 SDK */
|
||||||
|
#define HAVE_D3D11_H 1
|
||||||
|
#define HAVE_ROAPI_H 1
|
||||||
|
#endif
|
||||||
|
#if defined(WDK_NTDDI_VERSION) && WDK_NTDDI_VERSION > 0x0A000008 /* 10.0.19041.0 */
|
||||||
|
#define HAVE_D3D12_H 1
|
||||||
|
#endif
|
||||||
|
#if defined(_WIN32_MAXVER) && _WIN32_MAXVER >= 0x0603 /* Windows 8.1 SDK */
|
||||||
|
#define HAVE_SHELLSCALINGAPI_H 1
|
||||||
|
#endif
|
||||||
|
#define HAVE_MMDEVICEAPI_H 1
|
||||||
|
#define HAVE_AUDIOCLIENT_H 1
|
||||||
|
#define HAVE_TPCSHRD_H 1
|
||||||
|
#define HAVE_SENSORSAPI_H 1
|
||||||
|
#endif
|
||||||
|
#if (defined(_M_IX86) || defined(_M_X64) || defined(_M_AMD64)) && (defined(_MSC_VER) && _MSC_VER >= 1600)
|
||||||
|
#define HAVE_IMMINTRIN_H 1
|
||||||
|
#elif defined(__has_include) && (defined(__i386__) || defined(__x86_64))
|
||||||
|
# if __has_include(<immintrin.h>)
|
||||||
|
# define HAVE_IMMINTRIN_H 1
|
||||||
|
# endif
|
||||||
|
#endif
|
||||||
|
|
||||||
|
/* This is disabled by default to avoid C runtime dependencies and manifest requirements */
|
||||||
|
#ifdef HAVE_LIBC
|
||||||
|
/* Useful headers */
|
||||||
|
#define STDC_HEADERS 1
|
||||||
|
#define HAVE_CTYPE_H 1
|
||||||
|
#define HAVE_FLOAT_H 1
|
||||||
|
#define HAVE_LIMITS_H 1
|
||||||
|
#define HAVE_MATH_H 1
|
||||||
|
#define HAVE_SIGNAL_H 1
|
||||||
|
#define HAVE_STDIO_H 1
|
||||||
|
#define HAVE_STRING_H 1
|
||||||
|
|
||||||
|
/* C library functions */
|
||||||
|
#define HAVE_MALLOC 1
|
||||||
|
#define HAVE_CALLOC 1
|
||||||
|
#define HAVE_REALLOC 1
|
||||||
|
#define HAVE_FREE 1
|
||||||
|
#define HAVE_ALLOCA 1
|
||||||
|
/* OpenWatcom requires specific calling conventions for qsort and bsearch */
|
||||||
|
#ifndef __WATCOMC__
|
||||||
|
#define HAVE_QSORT 1
|
||||||
|
#define HAVE_BSEARCH 1
|
||||||
|
#endif
|
||||||
|
#define HAVE_ABS 1
|
||||||
|
#define HAVE_MEMSET 1
|
||||||
|
#define HAVE_MEMCPY 1
|
||||||
|
#define HAVE_MEMMOVE 1
|
||||||
|
#define HAVE_MEMCMP 1
|
||||||
|
#define HAVE_STRLEN 1
|
||||||
|
#define HAVE__STRREV 1
|
||||||
|
/* These functions have security warnings, so we won't use them */
|
||||||
|
/* #undef HAVE__STRUPR */
|
||||||
|
/* #undef HAVE__STRLWR */
|
||||||
|
#define HAVE_STRCHR 1
|
||||||
|
#define HAVE_STRRCHR 1
|
||||||
|
#define HAVE_STRSTR 1
|
||||||
|
/* #undef HAVE_STRTOK_R */
|
||||||
|
/* These functions have security warnings, so we won't use them */
|
||||||
|
/* #undef HAVE__LTOA */
|
||||||
|
/* #undef HAVE__ULTOA */
|
||||||
|
#define HAVE_STRTOL 1
|
||||||
|
#define HAVE_STRTOUL 1
|
||||||
|
#define HAVE_STRTOD 1
|
||||||
|
#define HAVE_ATOI 1
|
||||||
|
#define HAVE_ATOF 1
|
||||||
|
#define HAVE_STRCMP 1
|
||||||
|
#define HAVE_STRNCMP 1
|
||||||
|
#define HAVE__STRICMP 1
|
||||||
|
#define HAVE__STRNICMP 1
|
||||||
|
#define HAVE__WCSICMP 1
|
||||||
|
#define HAVE__WCSNICMP 1
|
||||||
|
#define HAVE__WCSDUP 1
|
||||||
|
#define HAVE_ACOS 1
|
||||||
|
#define HAVE_ASIN 1
|
||||||
|
#define HAVE_ATAN 1
|
||||||
|
#define HAVE_ATAN2 1
|
||||||
|
#define HAVE_CEIL 1
|
||||||
|
#define HAVE_COS 1
|
||||||
|
#define HAVE_EXP 1
|
||||||
|
#define HAVE_FABS 1
|
||||||
|
#define HAVE_FLOOR 1
|
||||||
|
#define HAVE_FMOD 1
|
||||||
|
#define HAVE_LOG 1
|
||||||
|
#define HAVE_LOG10 1
|
||||||
|
#define HAVE_POW 1
|
||||||
|
#define HAVE_SIN 1
|
||||||
|
#define HAVE_SQRT 1
|
||||||
|
#define HAVE_TAN 1
|
||||||
|
#ifndef __WATCOMC__
|
||||||
|
#define HAVE_ACOSF 1
|
||||||
|
#define HAVE_ASINF 1
|
||||||
|
#define HAVE_ATANF 1
|
||||||
|
#define HAVE_ATAN2F 1
|
||||||
|
#define HAVE_CEILF 1
|
||||||
|
#define HAVE__COPYSIGN 1
|
||||||
|
#define HAVE_COSF 1
|
||||||
|
#define HAVE_EXPF 1
|
||||||
|
#define HAVE_FABSF 1
|
||||||
|
#define HAVE_FLOORF 1
|
||||||
|
#define HAVE_FMODF 1
|
||||||
|
#define HAVE_LOGF 1
|
||||||
|
#define HAVE_LOG10F 1
|
||||||
|
#define HAVE_POWF 1
|
||||||
|
#define HAVE_SINF 1
|
||||||
|
#define HAVE_SQRTF 1
|
||||||
|
#define HAVE_TANF 1
|
||||||
|
#endif
|
||||||
|
#if defined(_MSC_VER)
|
||||||
|
/* These functions were added with the VC++ 2013 C runtime library */
|
||||||
|
#if _MSC_VER >= 1800
|
||||||
|
#define HAVE_STRTOLL 1
|
||||||
|
#define HAVE_STRTOULL 1
|
||||||
|
#define HAVE_VSSCANF 1
|
||||||
|
#define HAVE_LROUND 1
|
||||||
|
#define HAVE_LROUNDF 1
|
||||||
|
#define HAVE_ROUND 1
|
||||||
|
#define HAVE_ROUNDF 1
|
||||||
|
#define HAVE_SCALBN 1
|
||||||
|
#define HAVE_SCALBNF 1
|
||||||
|
#define HAVE_TRUNC 1
|
||||||
|
#define HAVE_TRUNCF 1
|
||||||
|
#endif
|
||||||
|
/* This function is available with at least the VC++ 2008 C runtime library */
|
||||||
|
#if _MSC_VER >= 1400
|
||||||
|
#define HAVE__FSEEKI64 1
|
||||||
|
#endif
|
||||||
|
#ifdef _USE_MATH_DEFINES
|
||||||
|
#define HAVE_M_PI 1
|
||||||
|
#endif
|
||||||
|
#elif defined(__WATCOMC__)
|
||||||
|
#define HAVE__FSEEKI64 1
|
||||||
|
#define HAVE_STRTOLL 1
|
||||||
|
#define HAVE_STRTOULL 1
|
||||||
|
#define HAVE_VSSCANF 1
|
||||||
|
#define HAVE_ROUND 1
|
||||||
|
#define HAVE_SCALBN 1
|
||||||
|
#define HAVE_TRUNC 1
|
||||||
|
#else
|
||||||
|
#define HAVE_M_PI 1
|
||||||
|
#endif
|
||||||
|
#else
|
||||||
|
#define HAVE_STDARG_H 1
|
||||||
|
#define HAVE_STDDEF_H 1
|
||||||
|
#endif
|
||||||
|
|
||||||
|
/* Enable various audio drivers */
|
||||||
|
#if defined(HAVE_MMDEVICEAPI_H) && defined(HAVE_AUDIOCLIENT_H)
|
||||||
|
#define SDL_AUDIO_DRIVER_WASAPI 1
|
||||||
|
#endif
|
||||||
|
#define SDL_AUDIO_DRIVER_DSOUND 1
|
||||||
|
#define SDL_AUDIO_DRIVER_WINMM 1
|
||||||
|
#define SDL_AUDIO_DRIVER_DISK 1
|
||||||
|
#define SDL_AUDIO_DRIVER_DUMMY 1
|
||||||
|
|
||||||
|
/* Enable various input drivers */
|
||||||
|
#define SDL_JOYSTICK_DINPUT 1
|
||||||
|
#define SDL_JOYSTICK_HIDAPI 1
|
||||||
|
#ifndef __WINRT__
|
||||||
|
#define SDL_JOYSTICK_RAWINPUT 1
|
||||||
|
#endif
|
||||||
|
#define SDL_JOYSTICK_VIRTUAL 1
|
||||||
|
#ifdef HAVE_WINDOWS_GAMING_INPUT_H
|
||||||
|
#define SDL_JOYSTICK_WGI 1
|
||||||
|
#endif
|
||||||
|
#define SDL_JOYSTICK_XINPUT 1
|
||||||
|
#define SDL_HAPTIC_DINPUT 1
|
||||||
|
#define SDL_HAPTIC_XINPUT 1
|
||||||
|
|
||||||
|
/* Enable the sensor driver */
|
||||||
|
#ifdef HAVE_SENSORSAPI_H
|
||||||
|
#define SDL_SENSOR_WINDOWS 1
|
||||||
|
#else
|
||||||
|
#define SDL_SENSOR_DUMMY 1
|
||||||
|
#endif
|
||||||
|
|
||||||
|
/* Enable various shared object loading systems */
|
||||||
|
#define SDL_LOADSO_WINDOWS 1
|
||||||
|
|
||||||
|
/* Enable various threading systems */
|
||||||
|
#define SDL_THREAD_GENERIC_COND_SUFFIX 1
|
||||||
|
#define SDL_THREAD_WINDOWS 1
|
||||||
|
|
||||||
|
/* Enable various timer systems */
|
||||||
|
#define SDL_TIMER_WINDOWS 1
|
||||||
|
|
||||||
|
/* Enable various video drivers */
|
||||||
|
#define SDL_VIDEO_DRIVER_DUMMY 1
|
||||||
|
#define SDL_VIDEO_DRIVER_WINDOWS 1
|
||||||
|
|
||||||
|
#ifndef SDL_VIDEO_RENDER_D3D
|
||||||
|
#define SDL_VIDEO_RENDER_D3D 1
|
||||||
|
#endif
|
||||||
|
#if !defined(SDL_VIDEO_RENDER_D3D11) && defined(HAVE_D3D11_H)
|
||||||
|
#define SDL_VIDEO_RENDER_D3D11 1
|
||||||
|
#endif
|
||||||
|
#if !defined(SDL_VIDEO_RENDER_D3D12) && defined(HAVE_D3D12_H)
|
||||||
|
#define SDL_VIDEO_RENDER_D3D12 1
|
||||||
|
#endif
|
||||||
|
|
||||||
|
/* Enable OpenGL support */
|
||||||
|
#ifndef SDL_VIDEO_OPENGL
|
||||||
|
#define SDL_VIDEO_OPENGL 1
|
||||||
|
#endif
|
||||||
|
#ifndef SDL_VIDEO_OPENGL_WGL
|
||||||
|
#define SDL_VIDEO_OPENGL_WGL 1
|
||||||
|
#endif
|
||||||
|
#ifndef SDL_VIDEO_RENDER_OGL
|
||||||
|
#define SDL_VIDEO_RENDER_OGL 1
|
||||||
|
#endif
|
||||||
|
#ifndef SDL_VIDEO_RENDER_OGL_ES2
|
||||||
|
#define SDL_VIDEO_RENDER_OGL_ES2 1
|
||||||
|
#endif
|
||||||
|
#ifndef SDL_VIDEO_OPENGL_ES2
|
||||||
|
#define SDL_VIDEO_OPENGL_ES2 1
|
||||||
|
#endif
|
||||||
|
#ifndef SDL_VIDEO_OPENGL_EGL
|
||||||
|
#define SDL_VIDEO_OPENGL_EGL 1
|
||||||
|
#endif
|
||||||
|
|
||||||
|
/* Enable Vulkan support */
|
||||||
|
#define SDL_VIDEO_VULKAN 1
|
||||||
|
|
||||||
|
/* Enable system power support */
|
||||||
|
#define SDL_POWER_WINDOWS 1
|
||||||
|
|
||||||
|
/* Enable filesystem support */
|
||||||
|
#define SDL_FILESYSTEM_WINDOWS 1
|
||||||
|
|
||||||
|
#endif /* SDL_config_windows_h_ */
|
||||||
|
|
||||||
|
/* vi: set ts=4 sw=4 expandtab: */
|
||||||
@@ -1,194 +0,0 @@
|
|||||||
/*
|
|
||||||
Simple DirectMedia Layer
|
|
||||||
Copyright (C) 1997-2025 Sam Lantinga <slouken@libsdl.org>
|
|
||||||
|
|
||||||
This software is provided 'as-is', without any express or implied
|
|
||||||
warranty. In no event will the authors be held liable for any damages
|
|
||||||
arising from the use of this software.
|
|
||||||
|
|
||||||
Permission is granted to anyone to use this software for any purpose,
|
|
||||||
including commercial applications, and to alter it and redistribute it
|
|
||||||
freely, subject to the following restrictions:
|
|
||||||
|
|
||||||
1. The origin of this software must not be misrepresented; you must not
|
|
||||||
claim that you wrote the original software. If you use this software
|
|
||||||
in a product, an acknowledgment in the product documentation would be
|
|
||||||
appreciated but is not required.
|
|
||||||
2. Altered source versions must be plainly marked as such, and must not be
|
|
||||||
misrepresented as being the original software.
|
|
||||||
3. This notice may not be removed or altered from any source distribution.
|
|
||||||
*/
|
|
||||||
|
|
||||||
#ifndef SDL_config_android_h_
|
|
||||||
#define SDL_config_android_h_
|
|
||||||
#define SDL_config_h_
|
|
||||||
|
|
||||||
#include "SDL_platform.h"
|
|
||||||
|
|
||||||
/**
|
|
||||||
* \file SDL_config_android.h
|
|
||||||
*
|
|
||||||
* This is a configuration that can be used to build SDL for Android
|
|
||||||
*/
|
|
||||||
|
|
||||||
#include <stdarg.h>
|
|
||||||
|
|
||||||
#define HAVE_GCC_ATOMICS 1
|
|
||||||
|
|
||||||
#define STDC_HEADERS 1
|
|
||||||
#define HAVE_ALLOCA_H 1
|
|
||||||
#define HAVE_CTYPE_H 1
|
|
||||||
#define HAVE_INTTYPES_H 1
|
|
||||||
#define HAVE_LIMITS_H 1
|
|
||||||
#define HAVE_MATH_H 1
|
|
||||||
#define HAVE_SIGNAL_H 1
|
|
||||||
#define HAVE_STDINT_H 1
|
|
||||||
#define HAVE_STDIO_H 1
|
|
||||||
#define HAVE_STRING_H 1
|
|
||||||
#define HAVE_SYS_TYPES_H 1
|
|
||||||
|
|
||||||
/* C library functions */
|
|
||||||
#define HAVE_DLOPEN 1
|
|
||||||
#define HAVE_MALLOC 1
|
|
||||||
#define HAVE_CALLOC 1
|
|
||||||
#define HAVE_REALLOC 1
|
|
||||||
#define HAVE_FREE 1
|
|
||||||
#define HAVE_ALLOCA 1
|
|
||||||
#define HAVE_GETENV 1
|
|
||||||
#define HAVE_SETENV 1
|
|
||||||
#define HAVE_PUTENV 1
|
|
||||||
#define HAVE_SETENV 1
|
|
||||||
#define HAVE_UNSETENV 1
|
|
||||||
#define HAVE_QSORT 1
|
|
||||||
#define HAVE_BSEARCH 1
|
|
||||||
#define HAVE_ABS 1
|
|
||||||
#define HAVE_BCOPY 1
|
|
||||||
#define HAVE_MEMSET 1
|
|
||||||
#define HAVE_MEMCPY 1
|
|
||||||
#define HAVE_MEMMOVE 1
|
|
||||||
#define HAVE_MEMCMP 1
|
|
||||||
#define HAVE_STRLEN 1
|
|
||||||
#define HAVE_STRLCPY 1
|
|
||||||
#define HAVE_STRLCAT 1
|
|
||||||
#define HAVE_STRCHR 1
|
|
||||||
#define HAVE_STRRCHR 1
|
|
||||||
#define HAVE_STRSTR 1
|
|
||||||
#define HAVE_STRTOK_R 1
|
|
||||||
#define HAVE_STRTOL 1
|
|
||||||
#define HAVE_STRTOUL 1
|
|
||||||
#define HAVE_STRTOLL 1
|
|
||||||
#define HAVE_STRTOULL 1
|
|
||||||
#define HAVE_STRTOD 1
|
|
||||||
#define HAVE_ATOI 1
|
|
||||||
#define HAVE_ATOF 1
|
|
||||||
#define HAVE_STRCMP 1
|
|
||||||
#define HAVE_STRNCMP 1
|
|
||||||
#define HAVE_STRCASECMP 1
|
|
||||||
#define HAVE_STRNCASECMP 1
|
|
||||||
#define HAVE_STRCASESTR 1
|
|
||||||
#define HAVE_VSSCANF 1
|
|
||||||
#define HAVE_VSNPRINTF 1
|
|
||||||
#define HAVE_ACOS 1
|
|
||||||
#define HAVE_ACOSF 1
|
|
||||||
#define HAVE_ASIN 1
|
|
||||||
#define HAVE_ASINF 1
|
|
||||||
#define HAVE_ATAN 1
|
|
||||||
#define HAVE_ATANF 1
|
|
||||||
#define HAVE_ATAN2 1
|
|
||||||
#define HAVE_ATAN2F 1
|
|
||||||
#define HAVE_CEIL 1
|
|
||||||
#define HAVE_CEILF 1
|
|
||||||
#define HAVE_COPYSIGN 1
|
|
||||||
#define HAVE_COPYSIGNF 1
|
|
||||||
#define HAVE_COS 1
|
|
||||||
#define HAVE_COSF 1
|
|
||||||
#define HAVE_EXP 1
|
|
||||||
#define HAVE_EXPF 1
|
|
||||||
#define HAVE_FABS 1
|
|
||||||
#define HAVE_FABSF 1
|
|
||||||
#define HAVE_FLOOR 1
|
|
||||||
#define HAVE_FLOORF 1
|
|
||||||
#define HAVE_FMOD 1
|
|
||||||
#define HAVE_FMODF 1
|
|
||||||
#define HAVE_LOG 1
|
|
||||||
#define HAVE_LOGF 1
|
|
||||||
#define HAVE_LOG10 1
|
|
||||||
#define HAVE_LOG10F 1
|
|
||||||
#define HAVE_LROUND 1
|
|
||||||
#define HAVE_LROUNDF 1
|
|
||||||
#define HAVE_POW 1
|
|
||||||
#define HAVE_POWF 1
|
|
||||||
#define HAVE_ROUND 1
|
|
||||||
#define HAVE_ROUNDF 1
|
|
||||||
#define HAVE_SCALBN 1
|
|
||||||
#define HAVE_SCALBNF 1
|
|
||||||
#define HAVE_SIN 1
|
|
||||||
#define HAVE_SINF 1
|
|
||||||
#define HAVE_SQRT 1
|
|
||||||
#define HAVE_SQRTF 1
|
|
||||||
#define HAVE_TAN 1
|
|
||||||
#define HAVE_TANF 1
|
|
||||||
#define HAVE_TRUNC 1
|
|
||||||
#define HAVE_TRUNCF 1
|
|
||||||
#define HAVE_SIGACTION 1
|
|
||||||
#define HAVE_SETJMP 1
|
|
||||||
#define HAVE_NANOSLEEP 1
|
|
||||||
#define HAVE_SYSCONF 1
|
|
||||||
#define HAVE_CLOCK_GETTIME 1
|
|
||||||
|
|
||||||
#ifdef __LP64__
|
|
||||||
#define SIZEOF_VOIDP 8
|
|
||||||
#else
|
|
||||||
#define SIZEOF_VOIDP 4
|
|
||||||
#endif
|
|
||||||
|
|
||||||
/* Enable various audio drivers */
|
|
||||||
#define SDL_AUDIO_DRIVER_ANDROID 1
|
|
||||||
#define SDL_AUDIO_DRIVER_OPENSLES 1
|
|
||||||
#define SDL_AUDIO_DRIVER_AAUDIO 1
|
|
||||||
#define SDL_AUDIO_DRIVER_DUMMY 1
|
|
||||||
|
|
||||||
/* Enable various input drivers */
|
|
||||||
#define SDL_JOYSTICK_ANDROID 1
|
|
||||||
#define SDL_JOYSTICK_HIDAPI 1
|
|
||||||
#define SDL_JOYSTICK_VIRTUAL 1
|
|
||||||
#define SDL_HAPTIC_ANDROID 1
|
|
||||||
|
|
||||||
/* Enable sensor driver */
|
|
||||||
#define SDL_SENSOR_ANDROID 1
|
|
||||||
|
|
||||||
/* Enable various shared object loading systems */
|
|
||||||
#define SDL_LOADSO_DLOPEN 1
|
|
||||||
|
|
||||||
/* Enable various threading systems */
|
|
||||||
#define SDL_THREAD_PTHREAD 1
|
|
||||||
#define SDL_THREAD_PTHREAD_RECURSIVE_MUTEX 1
|
|
||||||
|
|
||||||
/* Enable various timer systems */
|
|
||||||
#define SDL_TIMER_UNIX 1
|
|
||||||
|
|
||||||
/* Enable various video drivers */
|
|
||||||
#define SDL_VIDEO_DRIVER_ANDROID 1
|
|
||||||
|
|
||||||
/* Enable OpenGL ES */
|
|
||||||
#define SDL_VIDEO_OPENGL_ES 1
|
|
||||||
#define SDL_VIDEO_OPENGL_ES2 1
|
|
||||||
#define SDL_VIDEO_OPENGL_EGL 1
|
|
||||||
#define SDL_VIDEO_RENDER_OGL_ES 1
|
|
||||||
#define SDL_VIDEO_RENDER_OGL_ES2 1
|
|
||||||
|
|
||||||
/* Enable Vulkan support */
|
|
||||||
/* Android does not support Vulkan in native code using the "armeabi" ABI. */
|
|
||||||
#if defined(__ARM_ARCH) && __ARM_ARCH < 7
|
|
||||||
#define SDL_VIDEO_VULKAN 0
|
|
||||||
#else
|
|
||||||
#define SDL_VIDEO_VULKAN 1
|
|
||||||
#endif
|
|
||||||
|
|
||||||
/* Enable system power support */
|
|
||||||
#define SDL_POWER_ANDROID 1
|
|
||||||
|
|
||||||
/* Enable the filesystem driver */
|
|
||||||
#define SDL_FILESYSTEM_ANDROID 1
|
|
||||||
|
|
||||||
#endif /* SDL_config_android_h_ */
|
|
||||||
@@ -1,218 +0,0 @@
|
|||||||
/*
|
|
||||||
Simple DirectMedia Layer
|
|
||||||
Copyright (C) 1997-2025 Sam Lantinga <slouken@libsdl.org>
|
|
||||||
|
|
||||||
This software is provided 'as-is', without any express or implied
|
|
||||||
warranty. In no event will the authors be held liable for any damages
|
|
||||||
arising from the use of this software.
|
|
||||||
|
|
||||||
Permission is granted to anyone to use this software for any purpose,
|
|
||||||
including commercial applications, and to alter it and redistribute it
|
|
||||||
freely, subject to the following restrictions:
|
|
||||||
|
|
||||||
1. The origin of this software must not be misrepresented; you must not
|
|
||||||
claim that you wrote the original software. If you use this software
|
|
||||||
in a product, an acknowledgment in the product documentation would be
|
|
||||||
appreciated but is not required.
|
|
||||||
2. Altered source versions must be plainly marked as such, and must not be
|
|
||||||
misrepresented as being the original software.
|
|
||||||
3. This notice may not be removed or altered from any source distribution.
|
|
||||||
*/
|
|
||||||
|
|
||||||
#ifndef _SDL_config_emscripten_h_
|
|
||||||
#define _SDL_config_emscripten_h_
|
|
||||||
|
|
||||||
#include "SDL_platform.h"
|
|
||||||
|
|
||||||
/**
|
|
||||||
* \file SDL_config_emscripten.h
|
|
||||||
*
|
|
||||||
* This is a configuration that can be used to build SDL for Emscripten.
|
|
||||||
*/
|
|
||||||
|
|
||||||
#ifdef __LP64__
|
|
||||||
#define SIZEOF_VOIDP 8
|
|
||||||
#else
|
|
||||||
#define SIZEOF_VOIDP 4
|
|
||||||
#endif
|
|
||||||
#define HAVE_GCC_ATOMICS 1
|
|
||||||
|
|
||||||
/* Useful headers */
|
|
||||||
#define STDC_HEADERS 1
|
|
||||||
#define HAVE_ALLOCA_H 1
|
|
||||||
#define HAVE_CTYPE_H 1
|
|
||||||
#define HAVE_ICONV_H 1
|
|
||||||
#define HAVE_INTTYPES_H 1
|
|
||||||
#define HAVE_LIMITS_H 1
|
|
||||||
#define HAVE_MALLOC_H 1
|
|
||||||
#define HAVE_MATH_H 1
|
|
||||||
#define HAVE_MEMORY_H 1
|
|
||||||
#define HAVE_SIGNAL_H 1
|
|
||||||
#define HAVE_STDARG_H 1
|
|
||||||
#define HAVE_STDINT_H 1
|
|
||||||
#define HAVE_STDIO_H 1
|
|
||||||
#define HAVE_STDLIB_H 1
|
|
||||||
#define HAVE_STRINGS_H 1
|
|
||||||
#define HAVE_STRING_H 1
|
|
||||||
#define HAVE_SYS_TYPES_H 1
|
|
||||||
#define HAVE_WCHAR_H 1
|
|
||||||
|
|
||||||
/* C library functions */
|
|
||||||
#define HAVE_DLOPEN 1
|
|
||||||
#define HAVE_MALLOC 1
|
|
||||||
#define HAVE_CALLOC 1
|
|
||||||
#define HAVE_REALLOC 1
|
|
||||||
#define HAVE_FREE 1
|
|
||||||
#define HAVE_ALLOCA 1
|
|
||||||
#define HAVE_GETENV 1
|
|
||||||
#define HAVE_SETENV 1
|
|
||||||
#define HAVE_PUTENV 1
|
|
||||||
#define HAVE_UNSETENV 1
|
|
||||||
#define HAVE_QSORT 1
|
|
||||||
#define HAVE_BSEARCH 1
|
|
||||||
#define HAVE_ABS 1
|
|
||||||
#define HAVE_BCOPY 1
|
|
||||||
#define HAVE_MEMSET 1
|
|
||||||
#define HAVE_MEMCPY 1
|
|
||||||
#define HAVE_MEMMOVE 1
|
|
||||||
#define HAVE_MEMCMP 1
|
|
||||||
#define HAVE_WCSLEN 1
|
|
||||||
#define HAVE_WCSDUP 1
|
|
||||||
#define HAVE_WCSSTR 1
|
|
||||||
#define HAVE_WCSCMP 1
|
|
||||||
#define HAVE_WCSNCMP 1
|
|
||||||
#define HAVE_WCSCASECMP 1
|
|
||||||
#define HAVE_WCSNCASECMP 1
|
|
||||||
#define HAVE_STRLEN 1
|
|
||||||
#define HAVE_STRLCPY 1
|
|
||||||
#define HAVE_STRLCAT 1
|
|
||||||
#define HAVE_STRCHR 1
|
|
||||||
#define HAVE_STRRCHR 1
|
|
||||||
#define HAVE_STRSTR 1
|
|
||||||
#define HAVE_STRTOK_R 1
|
|
||||||
#define HAVE_STRTOL 1
|
|
||||||
#define HAVE_STRTOUL 1
|
|
||||||
#define HAVE_STRTOLL 1
|
|
||||||
#define HAVE_STRTOULL 1
|
|
||||||
#define HAVE_STRTOD 1
|
|
||||||
#define HAVE_ATOI 1
|
|
||||||
#define HAVE_ATOF 1
|
|
||||||
#define HAVE_STRCMP 1
|
|
||||||
#define HAVE_STRNCMP 1
|
|
||||||
#define HAVE_STRCASECMP 1
|
|
||||||
#define HAVE_STRNCASECMP 1
|
|
||||||
#define HAVE_SSCANF 1
|
|
||||||
#define HAVE_VSSCANF 1
|
|
||||||
#define HAVE_VSNPRINTF 1
|
|
||||||
#define HAVE_M_PI 1
|
|
||||||
#define HAVE_ACOS 1
|
|
||||||
#define HAVE_ACOSF 1
|
|
||||||
#define HAVE_ASIN 1
|
|
||||||
#define HAVE_ASINF 1
|
|
||||||
#define HAVE_ATAN 1
|
|
||||||
#define HAVE_ATANF 1
|
|
||||||
#define HAVE_ATAN2 1
|
|
||||||
#define HAVE_ATAN2F 1
|
|
||||||
#define HAVE_CEIL 1
|
|
||||||
#define HAVE_CEILF 1
|
|
||||||
#define HAVE_COPYSIGN 1
|
|
||||||
#define HAVE_COPYSIGNF 1
|
|
||||||
#define HAVE_COS 1
|
|
||||||
#define HAVE_COSF 1
|
|
||||||
#define HAVE_EXP 1
|
|
||||||
#define HAVE_EXPF 1
|
|
||||||
#define HAVE_FABS 1
|
|
||||||
#define HAVE_FABSF 1
|
|
||||||
#define HAVE_FLOOR 1
|
|
||||||
#define HAVE_FLOORF 1
|
|
||||||
#define HAVE_FMOD 1
|
|
||||||
#define HAVE_FMODF 1
|
|
||||||
#define HAVE_LOG 1
|
|
||||||
#define HAVE_LOGF 1
|
|
||||||
#define HAVE_LOG10 1
|
|
||||||
#define HAVE_LOG10F 1
|
|
||||||
#define HAVE_LROUND 1
|
|
||||||
#define HAVE_LROUNDF 1
|
|
||||||
#define HAVE_POW 1
|
|
||||||
#define HAVE_POWF 1
|
|
||||||
#define HAVE_ROUND 1
|
|
||||||
#define HAVE_ROUNDF 1
|
|
||||||
#define HAVE_SCALBN 1
|
|
||||||
#define HAVE_SCALBNF 1
|
|
||||||
#define HAVE_SIN 1
|
|
||||||
#define HAVE_SINF 1
|
|
||||||
#define HAVE_SQRT 1
|
|
||||||
#define HAVE_SQRTF 1
|
|
||||||
#define HAVE_TAN 1
|
|
||||||
#define HAVE_TANF 1
|
|
||||||
#define HAVE_TRUNC 1
|
|
||||||
#define HAVE_TRUNCF 1
|
|
||||||
#define HAVE_FSEEKO 1
|
|
||||||
#define HAVE_FSEEKO64 1
|
|
||||||
#define HAVE_SIGACTION 1
|
|
||||||
#define HAVE_SA_SIGACTION 1
|
|
||||||
#define HAVE_SETJMP 1
|
|
||||||
#define HAVE_NANOSLEEP 1
|
|
||||||
#define HAVE_SYSCONF 1
|
|
||||||
#define HAVE_CLOCK_GETTIME 1
|
|
||||||
/* #undef HAVE_GETPAGESIZE */
|
|
||||||
#define HAVE_MPROTECT 1
|
|
||||||
#define HAVE_ICONV 1
|
|
||||||
|
|
||||||
/* SDL internal assertion support */
|
|
||||||
/* #undef SDL_DEFAULT_ASSERT_LEVEL */
|
|
||||||
|
|
||||||
#define SDL_CPUINFO_DISABLED 1
|
|
||||||
#define SDL_HAPTIC_DISABLED 1
|
|
||||||
#define SDL_HIDAPI_DISABLED 1
|
|
||||||
#ifndef __EMSCRIPTEN_PTHREADS__
|
|
||||||
#define SDL_THREADS_DISABLED 1
|
|
||||||
#endif
|
|
||||||
|
|
||||||
/* Enable various audio drivers */
|
|
||||||
#define SDL_AUDIO_DRIVER_DISK 1
|
|
||||||
#define SDL_AUDIO_DRIVER_DUMMY 1
|
|
||||||
#define SDL_AUDIO_DRIVER_EMSCRIPTEN 1
|
|
||||||
|
|
||||||
/* Enable various input drivers */
|
|
||||||
#define SDL_JOYSTICK_EMSCRIPTEN 1
|
|
||||||
|
|
||||||
/* Enable various sensor drivers */
|
|
||||||
#define SDL_SENSOR_DUMMY 1
|
|
||||||
|
|
||||||
/* Enable various shared object loading systems */
|
|
||||||
#define SDL_LOADSO_DLOPEN 1
|
|
||||||
|
|
||||||
/* Enable various threading systems */
|
|
||||||
#ifdef __EMSCRIPTEN_PTHREADS__
|
|
||||||
#define SDL_THREAD_PTHREAD 1
|
|
||||||
#define SDL_THREAD_PTHREAD_RECURSIVE_MUTEX 1
|
|
||||||
#endif
|
|
||||||
|
|
||||||
/* Enable various timer systems */
|
|
||||||
#define SDL_TIMER_UNIX 1
|
|
||||||
|
|
||||||
/* Enable various video drivers */
|
|
||||||
#define SDL_VIDEO_DRIVER_EMSCRIPTEN 1
|
|
||||||
|
|
||||||
#define SDL_VIDEO_RENDER_OGL_ES2 1
|
|
||||||
|
|
||||||
/* Enable OpenGL support */
|
|
||||||
/* #undef SDL_VIDEO_OPENGL */
|
|
||||||
/* #undef SDL_VIDEO_OPENGL_ES */
|
|
||||||
#define SDL_VIDEO_OPENGL_ES2 1
|
|
||||||
/* #undef SDL_VIDEO_OPENGL_BGL */
|
|
||||||
/* #undef SDL_VIDEO_OPENGL_CGL */
|
|
||||||
/* #undef SDL_VIDEO_OPENGL_GLX */
|
|
||||||
/* #undef SDL_VIDEO_OPENGL_WGL */
|
|
||||||
#define SDL_VIDEO_OPENGL_EGL 1
|
|
||||||
/* #undef SDL_VIDEO_OPENGL_OSMESA */
|
|
||||||
/* #undef SDL_VIDEO_OPENGL_OSMESA_DYNAMIC */
|
|
||||||
|
|
||||||
/* Enable system power support */
|
|
||||||
#define SDL_POWER_EMSCRIPTEN 1
|
|
||||||
|
|
||||||
/* Enable system filesystem support */
|
|
||||||
#define SDL_FILESYSTEM_EMSCRIPTEN 1
|
|
||||||
|
|
||||||
#endif /* _SDL_config_emscripten_h_ */
|
|
||||||
@@ -1,217 +0,0 @@
|
|||||||
/*
|
|
||||||
Simple DirectMedia Layer
|
|
||||||
Copyright (C) 1997-2025 Sam Lantinga <slouken@libsdl.org>
|
|
||||||
|
|
||||||
This software is provided 'as-is', without any express or implied
|
|
||||||
warranty. In no event will the authors be held liable for any damages
|
|
||||||
arising from the use of this software.
|
|
||||||
|
|
||||||
Permission is granted to anyone to use this software for any purpose,
|
|
||||||
including commercial applications, and to alter it and redistribute it
|
|
||||||
freely, subject to the following restrictions:
|
|
||||||
|
|
||||||
1. The origin of this software must not be misrepresented; you must not
|
|
||||||
claim that you wrote the original software. If you use this software
|
|
||||||
in a product, an acknowledgment in the product documentation would be
|
|
||||||
appreciated but is not required.
|
|
||||||
2. Altered source versions must be plainly marked as such, and must not be
|
|
||||||
misrepresented as being the original software.
|
|
||||||
3. This notice may not be removed or altered from any source distribution.
|
|
||||||
*/
|
|
||||||
|
|
||||||
#ifndef SDL_config_iphoneos_h_
|
|
||||||
#define SDL_config_iphoneos_h_
|
|
||||||
#define SDL_config_h_
|
|
||||||
|
|
||||||
#include "SDL_platform.h"
|
|
||||||
|
|
||||||
#ifdef __LP64__
|
|
||||||
#define SIZEOF_VOIDP 8
|
|
||||||
#else
|
|
||||||
#define SIZEOF_VOIDP 4
|
|
||||||
#endif
|
|
||||||
|
|
||||||
#define HAVE_GCC_ATOMICS 1
|
|
||||||
|
|
||||||
#define STDC_HEADERS 1
|
|
||||||
#define HAVE_ALLOCA_H 1
|
|
||||||
#define HAVE_CTYPE_H 1
|
|
||||||
#define HAVE_INTTYPES_H 1
|
|
||||||
#define HAVE_LIMITS_H 1
|
|
||||||
#define HAVE_MATH_H 1
|
|
||||||
#define HAVE_SIGNAL_H 1
|
|
||||||
#define HAVE_STDINT_H 1
|
|
||||||
#define HAVE_STDIO_H 1
|
|
||||||
#define HAVE_STRING_H 1
|
|
||||||
#define HAVE_SYS_TYPES_H 1
|
|
||||||
/* The libunwind functions are only available on x86 */
|
|
||||||
/* #undef HAVE_LIBUNWIND_H */
|
|
||||||
|
|
||||||
/* C library functions */
|
|
||||||
#define HAVE_DLOPEN 1
|
|
||||||
#define HAVE_MALLOC 1
|
|
||||||
#define HAVE_CALLOC 1
|
|
||||||
#define HAVE_REALLOC 1
|
|
||||||
#define HAVE_FREE 1
|
|
||||||
#define HAVE_ALLOCA 1
|
|
||||||
#define HAVE_GETENV 1
|
|
||||||
#define HAVE_SETENV 1
|
|
||||||
#define HAVE_PUTENV 1
|
|
||||||
#define HAVE_SETENV 1
|
|
||||||
#define HAVE_UNSETENV 1
|
|
||||||
#define HAVE_QSORT 1
|
|
||||||
#define HAVE_BSEARCH 1
|
|
||||||
#define HAVE_ABS 1
|
|
||||||
#define HAVE_BCOPY 1
|
|
||||||
#define HAVE_MEMSET 1
|
|
||||||
#define HAVE_MEMCPY 1
|
|
||||||
#define HAVE_MEMMOVE 1
|
|
||||||
#define HAVE_MEMCMP 1
|
|
||||||
#define HAVE_STRLEN 1
|
|
||||||
#define HAVE_STRLCPY 1
|
|
||||||
#define HAVE_STRLCAT 1
|
|
||||||
#define HAVE_STRCHR 1
|
|
||||||
#define HAVE_STRRCHR 1
|
|
||||||
#define HAVE_STRSTR 1
|
|
||||||
#define HAVE_STRTOK_R 1
|
|
||||||
#define HAVE_STRTOL 1
|
|
||||||
#define HAVE_STRTOUL 1
|
|
||||||
#define HAVE_STRTOLL 1
|
|
||||||
#define HAVE_STRTOULL 1
|
|
||||||
#define HAVE_STRTOD 1
|
|
||||||
#define HAVE_ATOI 1
|
|
||||||
#define HAVE_ATOF 1
|
|
||||||
#define HAVE_STRCMP 1
|
|
||||||
#define HAVE_STRNCMP 1
|
|
||||||
#define HAVE_STRCASECMP 1
|
|
||||||
#define HAVE_STRNCASECMP 1
|
|
||||||
#define HAVE_STRCASESTR 1
|
|
||||||
#define HAVE_VSSCANF 1
|
|
||||||
#define HAVE_VSNPRINTF 1
|
|
||||||
#define HAVE_M_PI 1
|
|
||||||
#define HAVE_ACOS 1
|
|
||||||
#define HAVE_ACOSF 1
|
|
||||||
#define HAVE_ASIN 1
|
|
||||||
#define HAVE_ASINF 1
|
|
||||||
#define HAVE_ATAN 1
|
|
||||||
#define HAVE_ATANF 1
|
|
||||||
#define HAVE_ATAN2 1
|
|
||||||
#define HAVE_ATAN2F 1
|
|
||||||
#define HAVE_CEIL 1
|
|
||||||
#define HAVE_CEILF 1
|
|
||||||
#define HAVE_COPYSIGN 1
|
|
||||||
#define HAVE_COPYSIGNF 1
|
|
||||||
#define HAVE_COS 1
|
|
||||||
#define HAVE_COSF 1
|
|
||||||
#define HAVE_EXP 1
|
|
||||||
#define HAVE_EXPF 1
|
|
||||||
#define HAVE_FABS 1
|
|
||||||
#define HAVE_FABSF 1
|
|
||||||
#define HAVE_FLOOR 1
|
|
||||||
#define HAVE_FLOORF 1
|
|
||||||
#define HAVE_FMOD 1
|
|
||||||
#define HAVE_FMODF 1
|
|
||||||
#define HAVE_LOG 1
|
|
||||||
#define HAVE_LOGF 1
|
|
||||||
#define HAVE_LOG10 1
|
|
||||||
#define HAVE_LOG10F 1
|
|
||||||
#define HAVE_LROUND 1
|
|
||||||
#define HAVE_LROUNDF 1
|
|
||||||
#define HAVE_POW 1
|
|
||||||
#define HAVE_POWF 1
|
|
||||||
#define HAVE_ROUND 1
|
|
||||||
#define HAVE_ROUNDF 1
|
|
||||||
#define HAVE_SCALBN 1
|
|
||||||
#define HAVE_SCALBNF 1
|
|
||||||
#define HAVE_SIN 1
|
|
||||||
#define HAVE_SINF 1
|
|
||||||
#define HAVE_SQRT 1
|
|
||||||
#define HAVE_SQRTF 1
|
|
||||||
#define HAVE_TAN 1
|
|
||||||
#define HAVE_TANF 1
|
|
||||||
#define HAVE_TRUNC 1
|
|
||||||
#define HAVE_TRUNCF 1
|
|
||||||
#define HAVE_SIGACTION 1
|
|
||||||
#define HAVE_SETJMP 1
|
|
||||||
#define HAVE_NANOSLEEP 1
|
|
||||||
#define HAVE_SYSCONF 1
|
|
||||||
#define HAVE_SYSCTLBYNAME 1
|
|
||||||
#define HAVE_O_CLOEXEC 1
|
|
||||||
|
|
||||||
/* enable iPhone version of Core Audio driver */
|
|
||||||
#define SDL_AUDIO_DRIVER_COREAUDIO 1
|
|
||||||
/* Enable the dummy audio driver (src/audio/dummy/\*.c) */
|
|
||||||
#define SDL_AUDIO_DRIVER_DUMMY 1
|
|
||||||
|
|
||||||
/* Enable the stub haptic driver (src/haptic/dummy/\*.c) */
|
|
||||||
#define SDL_HAPTIC_DUMMY 1
|
|
||||||
|
|
||||||
/* Enable joystick support */
|
|
||||||
/* Only enable HIDAPI support if you want to support Steam Controllers on iOS and tvOS */
|
|
||||||
/*#define SDL_JOYSTICK_HIDAPI 1*/
|
|
||||||
#define SDL_JOYSTICK_MFI 1
|
|
||||||
#define SDL_JOYSTICK_VIRTUAL 1
|
|
||||||
|
|
||||||
#ifdef __TVOS__
|
|
||||||
#define SDL_SENSOR_DUMMY 1
|
|
||||||
#else
|
|
||||||
/* Enable the CoreMotion sensor driver */
|
|
||||||
#define SDL_SENSOR_COREMOTION 1
|
|
||||||
#endif
|
|
||||||
|
|
||||||
/* Enable Unix style SO loading */
|
|
||||||
#define SDL_LOADSO_DLOPEN 1
|
|
||||||
|
|
||||||
/* Enable various threading systems */
|
|
||||||
#define SDL_THREAD_PTHREAD 1
|
|
||||||
#define SDL_THREAD_PTHREAD_RECURSIVE_MUTEX 1
|
|
||||||
|
|
||||||
/* Enable various timer systems */
|
|
||||||
#define SDL_TIMER_UNIX 1
|
|
||||||
|
|
||||||
/* Supported video drivers */
|
|
||||||
#define SDL_VIDEO_DRIVER_UIKIT 1
|
|
||||||
#define SDL_VIDEO_DRIVER_DUMMY 1
|
|
||||||
|
|
||||||
/* Enable OpenGL ES */
|
|
||||||
#if !TARGET_OS_MACCATALYST
|
|
||||||
#define SDL_VIDEO_OPENGL_ES2 1
|
|
||||||
#define SDL_VIDEO_OPENGL_ES 1
|
|
||||||
#define SDL_VIDEO_RENDER_OGL_ES 1
|
|
||||||
#define SDL_VIDEO_RENDER_OGL_ES2 1
|
|
||||||
#endif
|
|
||||||
|
|
||||||
/* Metal supported on 64-bit devices running iOS 8.0 and tvOS 9.0 and newer
|
|
||||||
Also supported in simulator from iOS 13.0 and tvOS 13.0
|
|
||||||
*/
|
|
||||||
#if (TARGET_OS_SIMULATOR && ((__IPHONE_OS_VERSION_MIN_REQUIRED >= 130000) || (__TV_OS_VERSION_MIN_REQUIRED >= 130000))) || (!TARGET_CPU_ARM && ((__IPHONE_OS_VERSION_MIN_REQUIRED >= 80000) || (__TV_OS_VERSION_MIN_REQUIRED >= 90000)))
|
|
||||||
#define SDL_PLATFORM_SUPPORTS_METAL 1
|
|
||||||
#else
|
|
||||||
#define SDL_PLATFORM_SUPPORTS_METAL 0
|
|
||||||
#endif
|
|
||||||
|
|
||||||
#if SDL_PLATFORM_SUPPORTS_METAL
|
|
||||||
#define SDL_VIDEO_RENDER_METAL 1
|
|
||||||
#endif
|
|
||||||
|
|
||||||
#if SDL_PLATFORM_SUPPORTS_METAL
|
|
||||||
#define SDL_VIDEO_VULKAN 1
|
|
||||||
#endif
|
|
||||||
|
|
||||||
#if SDL_PLATFORM_SUPPORTS_METAL
|
|
||||||
#define SDL_VIDEO_METAL 1
|
|
||||||
#endif
|
|
||||||
|
|
||||||
/* Enable system power support */
|
|
||||||
#define SDL_POWER_UIKIT 1
|
|
||||||
|
|
||||||
/* enable iPhone keyboard support */
|
|
||||||
#define SDL_IPHONE_KEYBOARD 1
|
|
||||||
|
|
||||||
/* enable iOS extended launch screen */
|
|
||||||
#define SDL_IPHONE_LAUNCHSCREEN 1
|
|
||||||
|
|
||||||
/* enable filesystem support */
|
|
||||||
#define SDL_FILESYSTEM_COCOA 1
|
|
||||||
|
|
||||||
#endif /* SDL_config_iphoneos_h_ */
|
|
||||||
@@ -1,277 +0,0 @@
|
|||||||
/*
|
|
||||||
Simple DirectMedia Layer
|
|
||||||
Copyright (C) 1997-2025 Sam Lantinga <slouken@libsdl.org>
|
|
||||||
|
|
||||||
This software is provided 'as-is', without any express or implied
|
|
||||||
warranty. In no event will the authors be held liable for any damages
|
|
||||||
arising from the use of this software.
|
|
||||||
|
|
||||||
Permission is granted to anyone to use this software for any purpose,
|
|
||||||
including commercial applications, and to alter it and redistribute it
|
|
||||||
freely, subject to the following restrictions:
|
|
||||||
|
|
||||||
1. The origin of this software must not be misrepresented; you must not
|
|
||||||
claim that you wrote the original software. If you use this software
|
|
||||||
in a product, an acknowledgment in the product documentation would be
|
|
||||||
appreciated but is not required.
|
|
||||||
2. Altered source versions must be plainly marked as such, and must not be
|
|
||||||
misrepresented as being the original software.
|
|
||||||
3. This notice may not be removed or altered from any source distribution.
|
|
||||||
*/
|
|
||||||
|
|
||||||
#ifndef SDL_config_macosx_h_
|
|
||||||
#define SDL_config_macosx_h_
|
|
||||||
#define SDL_config_h_
|
|
||||||
|
|
||||||
#include "SDL_platform.h"
|
|
||||||
|
|
||||||
/* This gets us MAC_OS_X_VERSION_MIN_REQUIRED... */
|
|
||||||
#include <AvailabilityMacros.h>
|
|
||||||
|
|
||||||
/* This is a set of defines to configure the SDL features */
|
|
||||||
|
|
||||||
#ifdef __LP64__
|
|
||||||
#define SIZEOF_VOIDP 8
|
|
||||||
#else
|
|
||||||
#define SIZEOF_VOIDP 4
|
|
||||||
#endif
|
|
||||||
|
|
||||||
/* Useful headers */
|
|
||||||
#define STDC_HEADERS 1
|
|
||||||
#define HAVE_ALLOCA_H 1
|
|
||||||
#define HAVE_CTYPE_H 1
|
|
||||||
#define HAVE_FLOAT_H 1
|
|
||||||
#define HAVE_INTTYPES_H 1
|
|
||||||
#define HAVE_LIMITS_H 1
|
|
||||||
#define HAVE_MATH_H 1
|
|
||||||
#define HAVE_SIGNAL_H 1
|
|
||||||
#define HAVE_STDINT_H 1
|
|
||||||
#define HAVE_STDIO_H 1
|
|
||||||
#define HAVE_STRING_H 1
|
|
||||||
#define HAVE_SYS_TYPES_H 1
|
|
||||||
#define HAVE_LIBUNWIND_H 1
|
|
||||||
|
|
||||||
/* C library functions */
|
|
||||||
#define HAVE_DLOPEN 1
|
|
||||||
#define HAVE_MALLOC 1
|
|
||||||
#define HAVE_CALLOC 1
|
|
||||||
#define HAVE_REALLOC 1
|
|
||||||
#define HAVE_FREE 1
|
|
||||||
#define HAVE_ALLOCA 1
|
|
||||||
#define HAVE_GETENV 1
|
|
||||||
#define HAVE_SETENV 1
|
|
||||||
#define HAVE_PUTENV 1
|
|
||||||
#define HAVE_UNSETENV 1
|
|
||||||
#define HAVE_QSORT 1
|
|
||||||
#define HAVE_BSEARCH 1
|
|
||||||
#define HAVE_ABS 1
|
|
||||||
#define HAVE_BCOPY 1
|
|
||||||
#define HAVE_MEMSET 1
|
|
||||||
#define HAVE_MEMCPY 1
|
|
||||||
#define HAVE_MEMMOVE 1
|
|
||||||
#define HAVE_MEMCMP 1
|
|
||||||
#define HAVE_STRLEN 1
|
|
||||||
#define HAVE_STRLCPY 1
|
|
||||||
#define HAVE_STRLCAT 1
|
|
||||||
#define HAVE_STRCHR 1
|
|
||||||
#define HAVE_STRRCHR 1
|
|
||||||
#define HAVE_STRSTR 1
|
|
||||||
#define HAVE_STRTOK_R 1
|
|
||||||
#define HAVE_STRTOL 1
|
|
||||||
#define HAVE_STRTOUL 1
|
|
||||||
#define HAVE_STRTOLL 1
|
|
||||||
#define HAVE_STRTOULL 1
|
|
||||||
#define HAVE_STRTOD 1
|
|
||||||
#define HAVE_ATOI 1
|
|
||||||
#define HAVE_ATOF 1
|
|
||||||
#define HAVE_STRCMP 1
|
|
||||||
#define HAVE_STRNCMP 1
|
|
||||||
#define HAVE_STRCASECMP 1
|
|
||||||
#define HAVE_STRNCASECMP 1
|
|
||||||
#define HAVE_STRCASESTR 1
|
|
||||||
#define HAVE_VSSCANF 1
|
|
||||||
#define HAVE_VSNPRINTF 1
|
|
||||||
#define HAVE_M_PI 1
|
|
||||||
#define HAVE_ACOS 1
|
|
||||||
#define HAVE_ACOSF 1
|
|
||||||
#define HAVE_ASIN 1
|
|
||||||
#define HAVE_ASINF 1
|
|
||||||
#define HAVE_ATAN 1
|
|
||||||
#define HAVE_ATANF 1
|
|
||||||
#define HAVE_ATAN2 1
|
|
||||||
#define HAVE_ATAN2F 1
|
|
||||||
#define HAVE_CEIL 1
|
|
||||||
#define HAVE_CEILF 1
|
|
||||||
#define HAVE_COPYSIGN 1
|
|
||||||
#define HAVE_COPYSIGNF 1
|
|
||||||
#define HAVE_COS 1
|
|
||||||
#define HAVE_COSF 1
|
|
||||||
#define HAVE_EXP 1
|
|
||||||
#define HAVE_EXPF 1
|
|
||||||
#define HAVE_FABS 1
|
|
||||||
#define HAVE_FABSF 1
|
|
||||||
#define HAVE_FLOOR 1
|
|
||||||
#define HAVE_FLOORF 1
|
|
||||||
#define HAVE_FMOD 1
|
|
||||||
#define HAVE_FMODF 1
|
|
||||||
#define HAVE_LOG 1
|
|
||||||
#define HAVE_LOGF 1
|
|
||||||
#define HAVE_LOG10 1
|
|
||||||
#define HAVE_LOG10F 1
|
|
||||||
#define HAVE_LROUND 1
|
|
||||||
#define HAVE_LROUNDF 1
|
|
||||||
#define HAVE_POW 1
|
|
||||||
#define HAVE_POWF 1
|
|
||||||
#define HAVE_ROUND 1
|
|
||||||
#define HAVE_ROUNDF 1
|
|
||||||
#define HAVE_SCALBN 1
|
|
||||||
#define HAVE_SCALBNF 1
|
|
||||||
#define HAVE_SIN 1
|
|
||||||
#define HAVE_SINF 1
|
|
||||||
#define HAVE_SQRT 1
|
|
||||||
#define HAVE_SQRTF 1
|
|
||||||
#define HAVE_TAN 1
|
|
||||||
#define HAVE_TANF 1
|
|
||||||
#define HAVE_TRUNC 1
|
|
||||||
#define HAVE_TRUNCF 1
|
|
||||||
#define HAVE_SIGACTION 1
|
|
||||||
#define HAVE_SETJMP 1
|
|
||||||
#define HAVE_NANOSLEEP 1
|
|
||||||
#define HAVE_SYSCONF 1
|
|
||||||
#define HAVE_SYSCTLBYNAME 1
|
|
||||||
|
|
||||||
#if defined(__has_include) && (defined(__i386__) || defined(__x86_64))
|
|
||||||
# if __has_include(<immintrin.h>)
|
|
||||||
# define HAVE_IMMINTRIN_H 1
|
|
||||||
# endif
|
|
||||||
#endif
|
|
||||||
|
|
||||||
#if (MAC_OS_X_VERSION_MAX_ALLOWED >= 1070)
|
|
||||||
#define HAVE_O_CLOEXEC 1
|
|
||||||
#endif
|
|
||||||
|
|
||||||
#define HAVE_GCC_ATOMICS 1
|
|
||||||
|
|
||||||
/* Enable various audio drivers */
|
|
||||||
#define SDL_AUDIO_DRIVER_COREAUDIO 1
|
|
||||||
#define SDL_AUDIO_DRIVER_DISK 1
|
|
||||||
#define SDL_AUDIO_DRIVER_DUMMY 1
|
|
||||||
|
|
||||||
/* Enable various input drivers */
|
|
||||||
#define SDL_JOYSTICK_HIDAPI 1
|
|
||||||
#define SDL_JOYSTICK_IOKIT 1
|
|
||||||
#define SDL_JOYSTICK_VIRTUAL 1
|
|
||||||
#define SDL_HAPTIC_IOKIT 1
|
|
||||||
|
|
||||||
/* The MFI controller support requires ARC Objective C runtime */
|
|
||||||
#if MAC_OS_X_VERSION_MIN_REQUIRED >= 1080 && !defined(__i386__)
|
|
||||||
#define SDL_JOYSTICK_MFI 1
|
|
||||||
#endif
|
|
||||||
|
|
||||||
/* Enable the dummy sensor driver */
|
|
||||||
#define SDL_SENSOR_DUMMY 1
|
|
||||||
|
|
||||||
/* Enable various shared object loading systems */
|
|
||||||
#define SDL_LOADSO_DLOPEN 1
|
|
||||||
|
|
||||||
/* Enable various threading systems */
|
|
||||||
#define SDL_THREAD_PTHREAD 1
|
|
||||||
#define SDL_THREAD_PTHREAD_RECURSIVE_MUTEX 1
|
|
||||||
|
|
||||||
/* Enable various timer systems */
|
|
||||||
#define SDL_TIMER_UNIX 1
|
|
||||||
|
|
||||||
/* Enable various video drivers */
|
|
||||||
#define SDL_VIDEO_DRIVER_COCOA 1
|
|
||||||
#define SDL_VIDEO_DRIVER_DUMMY 1
|
|
||||||
#undef SDL_VIDEO_DRIVER_X11
|
|
||||||
#define SDL_VIDEO_DRIVER_X11_DYNAMIC "/opt/X11/lib/libX11.6.dylib"
|
|
||||||
#define SDL_VIDEO_DRIVER_X11_DYNAMIC_XEXT "/opt/X11/lib/libXext.6.dylib"
|
|
||||||
#define SDL_VIDEO_DRIVER_X11_DYNAMIC_XINPUT2 "/opt/X11/lib/libXi.6.dylib"
|
|
||||||
#define SDL_VIDEO_DRIVER_X11_DYNAMIC_XRANDR "/opt/X11/lib/libXrandr.2.dylib"
|
|
||||||
#define SDL_VIDEO_DRIVER_X11_DYNAMIC_XSS "/opt/X11/lib/libXss.1.dylib"
|
|
||||||
#define SDL_VIDEO_DRIVER_X11_XDBE 1
|
|
||||||
#define SDL_VIDEO_DRIVER_X11_XRANDR 1
|
|
||||||
#define SDL_VIDEO_DRIVER_X11_XSCRNSAVER 1
|
|
||||||
#define SDL_VIDEO_DRIVER_X11_XSHAPE 1
|
|
||||||
#define SDL_VIDEO_DRIVER_X11_HAS_XKBKEYCODETOKEYSYM 1
|
|
||||||
|
|
||||||
#ifdef MAC_OS_X_VERSION_10_8
|
|
||||||
/*
|
|
||||||
* No matter the versions targeted, this is the 10.8 or later SDK, so you have
|
|
||||||
* to use the external Xquartz, which is a more modern Xlib. Previous SDKs
|
|
||||||
* used an older Xlib.
|
|
||||||
*/
|
|
||||||
#define SDL_VIDEO_DRIVER_X11_XINPUT2 1
|
|
||||||
#define SDL_VIDEO_DRIVER_X11_SUPPORTS_GENERIC_EVENTS 1
|
|
||||||
#endif
|
|
||||||
|
|
||||||
#ifndef SDL_VIDEO_RENDER_OGL
|
|
||||||
#define SDL_VIDEO_RENDER_OGL 1
|
|
||||||
#endif
|
|
||||||
|
|
||||||
#ifndef SDL_VIDEO_RENDER_OGL_ES2
|
|
||||||
#define SDL_VIDEO_RENDER_OGL_ES2 1
|
|
||||||
#endif
|
|
||||||
|
|
||||||
/* Metal only supported on 64-bit architectures with 10.11+ */
|
|
||||||
#if TARGET_RT_64_BIT && (MAC_OS_X_VERSION_MAX_ALLOWED >= 101100)
|
|
||||||
#define SDL_PLATFORM_SUPPORTS_METAL 1
|
|
||||||
#else
|
|
||||||
#define SDL_PLATFORM_SUPPORTS_METAL 0
|
|
||||||
#endif
|
|
||||||
|
|
||||||
#ifndef SDL_VIDEO_RENDER_METAL
|
|
||||||
#if SDL_PLATFORM_SUPPORTS_METAL
|
|
||||||
#define SDL_VIDEO_RENDER_METAL 1
|
|
||||||
#else
|
|
||||||
#define SDL_VIDEO_RENDER_METAL 0
|
|
||||||
#endif
|
|
||||||
#endif
|
|
||||||
|
|
||||||
/* Enable OpenGL support */
|
|
||||||
#ifndef SDL_VIDEO_OPENGL
|
|
||||||
#define SDL_VIDEO_OPENGL 1
|
|
||||||
#endif
|
|
||||||
#ifndef SDL_VIDEO_OPENGL_ES2
|
|
||||||
#define SDL_VIDEO_OPENGL_ES2 1
|
|
||||||
#endif
|
|
||||||
#ifndef SDL_VIDEO_OPENGL_EGL
|
|
||||||
#define SDL_VIDEO_OPENGL_EGL 1
|
|
||||||
#endif
|
|
||||||
#ifndef SDL_VIDEO_OPENGL_CGL
|
|
||||||
#define SDL_VIDEO_OPENGL_CGL 1
|
|
||||||
#endif
|
|
||||||
#ifndef SDL_VIDEO_OPENGL_GLX
|
|
||||||
#define SDL_VIDEO_OPENGL_GLX 1
|
|
||||||
#endif
|
|
||||||
|
|
||||||
/* Enable Vulkan and Metal support */
|
|
||||||
#ifndef SDL_VIDEO_VULKAN
|
|
||||||
#if SDL_PLATFORM_SUPPORTS_METAL
|
|
||||||
#define SDL_VIDEO_VULKAN 1
|
|
||||||
#else
|
|
||||||
#define SDL_VIDEO_VULKAN 0
|
|
||||||
#endif
|
|
||||||
#endif
|
|
||||||
|
|
||||||
#ifndef SDL_VIDEO_METAL
|
|
||||||
#if SDL_PLATFORM_SUPPORTS_METAL
|
|
||||||
#define SDL_VIDEO_METAL 1
|
|
||||||
#else
|
|
||||||
#define SDL_VIDEO_METAL 0
|
|
||||||
#endif
|
|
||||||
#endif
|
|
||||||
|
|
||||||
/* Enable system power support */
|
|
||||||
#define SDL_POWER_MACOSX 1
|
|
||||||
|
|
||||||
/* enable filesystem support */
|
|
||||||
#define SDL_FILESYSTEM_COCOA 1
|
|
||||||
|
|
||||||
/* Enable assembly routines */
|
|
||||||
#ifdef __ppc__
|
|
||||||
#define SDL_ALTIVEC_BLITTERS 1
|
|
||||||
#endif
|
|
||||||
|
|
||||||
#endif /* SDL_config_macosx_h_ */
|
|
||||||
@@ -1,95 +0,0 @@
|
|||||||
/*
|
|
||||||
Simple DirectMedia Layer
|
|
||||||
Copyright (C) 1997-2025 Sam Lantinga <slouken@libsdl.org>
|
|
||||||
|
|
||||||
This software is provided 'as-is', without any express or implied
|
|
||||||
warranty. In no event will the authors be held liable for any damages
|
|
||||||
arising from the use of this software.
|
|
||||||
|
|
||||||
Permission is granted to anyone to use this software for any purpose,
|
|
||||||
including commercial applications, and to alter it and redistribute it
|
|
||||||
freely, subject to the following restrictions:
|
|
||||||
|
|
||||||
1. The origin of this software must not be misrepresented; you must not
|
|
||||||
claim that you wrote the original software. If you use this software
|
|
||||||
in a product, an acknowledgment in the product documentation would be
|
|
||||||
appreciated but is not required.
|
|
||||||
2. Altered source versions must be plainly marked as such, and must not be
|
|
||||||
misrepresented as being the original software.
|
|
||||||
3. This notice may not be removed or altered from any source distribution.
|
|
||||||
*/
|
|
||||||
|
|
||||||
#ifndef SDL_config_minimal_h_
|
|
||||||
#define SDL_config_minimal_h_
|
|
||||||
#define SDL_config_h_
|
|
||||||
|
|
||||||
#include "SDL_platform.h"
|
|
||||||
|
|
||||||
/**
|
|
||||||
* \file SDL_config_minimal.h
|
|
||||||
*
|
|
||||||
* This is the minimal configuration that can be used to build SDL.
|
|
||||||
*/
|
|
||||||
|
|
||||||
#define HAVE_STDARG_H 1
|
|
||||||
#define HAVE_STDDEF_H 1
|
|
||||||
|
|
||||||
#if !defined(HAVE_STDINT_H) && !defined(_STDINT_H_)
|
|
||||||
/* Most everything except Visual Studio 2008 and earlier has stdint.h now */
|
|
||||||
#if defined(_MSC_VER) && (_MSC_VER < 1600)
|
|
||||||
typedef signed __int8 int8_t;
|
|
||||||
typedef unsigned __int8 uint8_t;
|
|
||||||
typedef signed __int16 int16_t;
|
|
||||||
typedef unsigned __int16 uint16_t;
|
|
||||||
typedef signed __int32 int32_t;
|
|
||||||
typedef unsigned __int32 uint32_t;
|
|
||||||
typedef signed __int64 int64_t;
|
|
||||||
typedef unsigned __int64 uint64_t;
|
|
||||||
#ifndef _UINTPTR_T_DEFINED
|
|
||||||
#ifdef _WIN64
|
|
||||||
typedef unsigned __int64 uintptr_t;
|
|
||||||
#else
|
|
||||||
typedef unsigned int uintptr_t;
|
|
||||||
#endif
|
|
||||||
#define _UINTPTR_T_DEFINED
|
|
||||||
#endif
|
|
||||||
#else
|
|
||||||
#define HAVE_STDINT_H 1
|
|
||||||
#endif /* Visual Studio 2008 */
|
|
||||||
#endif /* !_STDINT_H_ && !HAVE_STDINT_H */
|
|
||||||
|
|
||||||
#ifdef __GNUC__
|
|
||||||
#define HAVE_GCC_SYNC_LOCK_TEST_AND_SET 1
|
|
||||||
#endif
|
|
||||||
|
|
||||||
/* Enable the dummy audio driver (src/audio/dummy/\*.c) */
|
|
||||||
#define SDL_AUDIO_DRIVER_DUMMY 1
|
|
||||||
|
|
||||||
/* Enable the stub joystick driver (src/joystick/dummy/\*.c) */
|
|
||||||
#define SDL_JOYSTICK_DISABLED 1
|
|
||||||
|
|
||||||
/* Enable the stub haptic driver (src/haptic/dummy/\*.c) */
|
|
||||||
#define SDL_HAPTIC_DISABLED 1
|
|
||||||
|
|
||||||
/* Enable the stub HIDAPI */
|
|
||||||
#define SDL_HIDAPI_DISABLED 1
|
|
||||||
|
|
||||||
/* Enable the stub sensor driver (src/sensor/dummy/\*.c) */
|
|
||||||
#define SDL_SENSOR_DISABLED 1
|
|
||||||
|
|
||||||
/* Enable the stub shared object loader (src/loadso/dummy/\*.c) */
|
|
||||||
#define SDL_LOADSO_DISABLED 1
|
|
||||||
|
|
||||||
/* Enable the stub thread support (src/thread/generic/\*.c) */
|
|
||||||
#define SDL_THREADS_DISABLED 1
|
|
||||||
|
|
||||||
/* Enable the stub timer support (src/timer/dummy/\*.c) */
|
|
||||||
#define SDL_TIMERS_DISABLED 1
|
|
||||||
|
|
||||||
/* Enable the dummy video driver (src/video/dummy/\*.c) */
|
|
||||||
#define SDL_VIDEO_DRIVER_DUMMY 1
|
|
||||||
|
|
||||||
/* Enable the dummy filesystem driver (src/filesystem/dummy/\*.c) */
|
|
||||||
#define SDL_FILESYSTEM_DUMMY 1
|
|
||||||
|
|
||||||
#endif /* SDL_config_minimal_h_ */
|
|
||||||
@@ -1,89 +0,0 @@
|
|||||||
/*
|
|
||||||
Simple DirectMedia Layer
|
|
||||||
Copyright (C) 1997-2025 Sam Lantinga <slouken@libsdl.org>
|
|
||||||
|
|
||||||
This software is provided 'as-is', without any express or implied
|
|
||||||
warranty. In no event will the authors be held liable for any damages
|
|
||||||
arising from the use of this software.
|
|
||||||
|
|
||||||
Permission is granted to anyone to use this software for any purpose,
|
|
||||||
including commercial applications, and to alter it and redistribute it
|
|
||||||
freely, subject to the following restrictions:
|
|
||||||
|
|
||||||
1. The origin of this software must not be misrepresented; you must not
|
|
||||||
claim that you wrote the original software. If you use this software
|
|
||||||
in a product, an acknowledgment in the product documentation would be
|
|
||||||
appreciated but is not required.
|
|
||||||
2. Altered source versions must be plainly marked as such, and must not be
|
|
||||||
misrepresented as being the original software.
|
|
||||||
3. This notice may not be removed or altered from any source distribution.
|
|
||||||
*/
|
|
||||||
|
|
||||||
#ifndef SDL_config_ngage_h_
|
|
||||||
#define SDL_config_ngage_h_
|
|
||||||
#define SDL_config_h_
|
|
||||||
|
|
||||||
#include "SDL_platform.h"
|
|
||||||
|
|
||||||
typedef signed char int8_t;
|
|
||||||
typedef unsigned char uint8_t;
|
|
||||||
typedef signed short int16_t;
|
|
||||||
typedef unsigned short uint16_t;
|
|
||||||
typedef signed int int32_t;
|
|
||||||
typedef unsigned int uint32_t;
|
|
||||||
typedef signed long long int64_t;
|
|
||||||
typedef unsigned long long uint64_t;
|
|
||||||
typedef unsigned long uintptr_t;
|
|
||||||
|
|
||||||
#define HAVE_STDARG_H 1
|
|
||||||
#define HAVE_STDDEF_H 1
|
|
||||||
#define HAVE_STDIO_H 1
|
|
||||||
#define HAVE_STDLIB_H 1
|
|
||||||
#define HAVE_MATH_H 1
|
|
||||||
#define HAVE_CEIL 1
|
|
||||||
#define HAVE_COPYSIGN 1
|
|
||||||
#define HAVE_COS 1
|
|
||||||
#define HAVE_EXP 1
|
|
||||||
#define HAVE_FABS 1
|
|
||||||
#define HAVE_FLOOR 1
|
|
||||||
#define HAVE_LOG 1
|
|
||||||
#define HAVE_LOG10 1
|
|
||||||
#define HAVE_SCALBN 1
|
|
||||||
#define HAVE_SIN 1
|
|
||||||
#define HAVE_SQRT 1
|
|
||||||
#define HAVE_TAN 1
|
|
||||||
#define HAVE_MALLOC 1
|
|
||||||
#define SDL_MAIN_NEEDED 1
|
|
||||||
#define LACKS_SYS_MMAN_H 1
|
|
||||||
|
|
||||||
/* Enable the N-Gage thread support (src/thread/ngage/\*.c) */
|
|
||||||
#define SDL_THREAD_NGAGE 1
|
|
||||||
|
|
||||||
/* Enable the N-Gage timer support (src/timer/ngage/\*.c) */
|
|
||||||
#define SDL_TIMER_NGAGE 1
|
|
||||||
|
|
||||||
/* Enable the N-Gage video driver (src/video/ngage/\*.c) */
|
|
||||||
#define SDL_VIDEO_DRIVER_NGAGE 1
|
|
||||||
|
|
||||||
/* Enable the dummy audio driver (src/audio/dummy/\*.c) */
|
|
||||||
#define SDL_AUDIO_DRIVER_DUMMY 1
|
|
||||||
|
|
||||||
/* Enable the stub joystick driver (src/joystick/dummy/\*.c) */
|
|
||||||
#define SDL_JOYSTICK_DISABLED 1
|
|
||||||
|
|
||||||
/* Enable the stub haptic driver (src/haptic/dummy/\*.c) */
|
|
||||||
#define SDL_HAPTIC_DISABLED 1
|
|
||||||
|
|
||||||
/* Enable the stub HIDAPI */
|
|
||||||
#define SDL_HIDAPI_DISABLED 1
|
|
||||||
|
|
||||||
/* Enable the stub sensor driver (src/sensor/dummy/\*.c) */
|
|
||||||
#define SDL_SENSOR_DISABLED 1
|
|
||||||
|
|
||||||
/* Enable the stub shared object loader (src/loadso/dummy/\*.c) */
|
|
||||||
#define SDL_LOADSO_DISABLED 1
|
|
||||||
|
|
||||||
/* Enable the dummy filesystem driver (src/filesystem/dummy/\*.c) */
|
|
||||||
#define SDL_FILESYSTEM_DUMMY 1
|
|
||||||
|
|
||||||
#endif /* SDL_config_ngage_h_ */
|
|
||||||
@@ -1,204 +0,0 @@
|
|||||||
/*
|
|
||||||
Simple DirectMedia Layer
|
|
||||||
Copyright (C) 1997-2025 Sam Lantinga <slouken@libsdl.org>
|
|
||||||
|
|
||||||
This software is provided 'as-is', without any express or implied
|
|
||||||
warranty. In no event will the authors be held liable for any damages
|
|
||||||
arising from the use of this software.
|
|
||||||
|
|
||||||
Permission is granted to anyone to use this software for any purpose,
|
|
||||||
including commercial applications, and to alter it and redistribute it
|
|
||||||
freely, subject to the following restrictions:
|
|
||||||
|
|
||||||
1. The origin of this software must not be misrepresented; you must not
|
|
||||||
claim that you wrote the original software. If you use this software
|
|
||||||
in a product, an acknowledgment in the product documentation would be
|
|
||||||
appreciated but is not required.
|
|
||||||
2. Altered source versions must be plainly marked as such, and must not be
|
|
||||||
misrepresented as being the original software.
|
|
||||||
3. This notice may not be removed or altered from any source distribution.
|
|
||||||
*/
|
|
||||||
|
|
||||||
#ifndef SDL_config_os2_h_
|
|
||||||
#define SDL_config_os2_h_
|
|
||||||
#define SDL_config_h_
|
|
||||||
|
|
||||||
#include "SDL_platform.h"
|
|
||||||
|
|
||||||
#define SIZEOF_VOIDP 4
|
|
||||||
|
|
||||||
#define SDL_AUDIO_DRIVER_DUMMY 1
|
|
||||||
#define SDL_AUDIO_DRIVER_DISK 1
|
|
||||||
#define SDL_AUDIO_DRIVER_OS2 1
|
|
||||||
|
|
||||||
#define SDL_POWER_DISABLED 1
|
|
||||||
#define SDL_HAPTIC_DISABLED 1
|
|
||||||
|
|
||||||
#define SDL_SENSOR_DUMMY 1
|
|
||||||
#define SDL_VIDEO_DRIVER_DUMMY 1
|
|
||||||
#define SDL_VIDEO_DRIVER_OS2 1
|
|
||||||
#define SDL_JOYSTICK_OS2 1
|
|
||||||
#ifndef HAVE_LIBUSB_H /* see Makefile */
|
|
||||||
#define SDL_HIDAPI_DISABLED 1
|
|
||||||
/*#undef SDL_JOYSTICK_HIDAPI */
|
|
||||||
#else
|
|
||||||
#define SDL_JOYSTICK_HIDAPI 1
|
|
||||||
#define HAVE_LIBUSB 1
|
|
||||||
/* dynamically loaded libusb-1.0 dll: */
|
|
||||||
#define SDL_LIBUSB_DYNAMIC "usb100.dll"
|
|
||||||
#endif
|
|
||||||
#define SDL_JOYSTICK_VIRTUAL 1
|
|
||||||
|
|
||||||
/* Enable OpenGL support */
|
|
||||||
/* #undef SDL_VIDEO_OPENGL */
|
|
||||||
|
|
||||||
#define SDL_THREAD_OS2 1
|
|
||||||
#define SDL_LOADSO_OS2 1
|
|
||||||
#define SDL_TIMER_OS2 1
|
|
||||||
#define SDL_FILESYSTEM_OS2 1
|
|
||||||
|
|
||||||
/* use libsamplerate for audio rate conversion. */
|
|
||||||
/*#define HAVE_LIBSAMPLERATE_H 1 */
|
|
||||||
|
|
||||||
/* Enable dynamic libsamplerate support */
|
|
||||||
#define SDL_LIBSAMPLERATE_DYNAMIC "SAMPRATE.DLL"
|
|
||||||
|
|
||||||
#define HAVE_LIBC 1
|
|
||||||
|
|
||||||
#define HAVE_STDARG_H 1
|
|
||||||
#define HAVE_STDDEF_H 1
|
|
||||||
#define HAVE_STDINT_H 1
|
|
||||||
|
|
||||||
#define HAVE_SYS_TYPES_H 1
|
|
||||||
#define HAVE_STDIO_H 1
|
|
||||||
#define STDC_HEADERS 1
|
|
||||||
#define HAVE_STDLIB_H 1
|
|
||||||
#define HAVE_MALLOC_H 1
|
|
||||||
#define HAVE_MEMORY_H 1
|
|
||||||
#define HAVE_STRING_H 1
|
|
||||||
#define HAVE_STRINGS_H 1
|
|
||||||
#define HAVE_WCHAR_H 1
|
|
||||||
#define HAVE_INTTYPES_H 1
|
|
||||||
#define HAVE_LIMITS_H 1
|
|
||||||
#define HAVE_CTYPE_H 1
|
|
||||||
#define HAVE_MATH_H 1
|
|
||||||
#define HAVE_FLOAT_H 1
|
|
||||||
#define HAVE_SIGNAL_H 1
|
|
||||||
|
|
||||||
#if 0 /* see Makefile */
|
|
||||||
#define HAVE_ICONV 1
|
|
||||||
#define HAVE_ICONV_H 1
|
|
||||||
#endif
|
|
||||||
|
|
||||||
/* #undef HAVE_DLOPEN */
|
|
||||||
#define HAVE_MALLOC 1
|
|
||||||
#define HAVE_CALLOC 1
|
|
||||||
#define HAVE_REALLOC 1
|
|
||||||
#define HAVE_FREE 1
|
|
||||||
#if defined(__WATCOMC__)
|
|
||||||
#define HAVE__FSEEKI64 1
|
|
||||||
#define HAVE__FTELLI64 1
|
|
||||||
#endif
|
|
||||||
#define HAVE_ALLOCA 1
|
|
||||||
#define HAVE_GETENV 1
|
|
||||||
#define HAVE_SETENV 1
|
|
||||||
#define HAVE_PUTENV 1
|
|
||||||
/* OpenWatcom requires specific calling conventions for qsort and bsearch */
|
|
||||||
#ifndef __WATCOMC__
|
|
||||||
#define HAVE_QSORT 1
|
|
||||||
#define HAVE_BSEARCH 1
|
|
||||||
#endif
|
|
||||||
#define HAVE_ABS 1
|
|
||||||
#define HAVE_BCOPY 1
|
|
||||||
#define HAVE_MEMSET 1
|
|
||||||
#define HAVE_MEMCPY 1
|
|
||||||
#define HAVE_MEMMOVE 1
|
|
||||||
#define HAVE_MEMCMP 1
|
|
||||||
#define HAVE_WCSCMP 1
|
|
||||||
#define HAVE__WCSICMP 1
|
|
||||||
#define HAVE__WCSNICMP 1
|
|
||||||
#define HAVE_WCSLEN 1
|
|
||||||
#define HAVE_WCSLCPY 1
|
|
||||||
#define HAVE_WCSLCAT 1
|
|
||||||
/* #undef HAVE_WCSDUP */
|
|
||||||
#define HAVE__WCSDUP 1
|
|
||||||
#define HAVE_WCSSTR 1
|
|
||||||
#define HAVE_WCSCMP 1
|
|
||||||
#define HAVE_WCSNCMP 1
|
|
||||||
#define HAVE_STRLEN 1
|
|
||||||
#define HAVE_STRLCPY 1
|
|
||||||
#define HAVE_STRLCAT 1
|
|
||||||
#define HAVE__STRREV 1
|
|
||||||
#define HAVE__STRUPR 1
|
|
||||||
#define HAVE__STRLWR 1
|
|
||||||
/* #undef HAVE_INDEX */
|
|
||||||
/* #undef HAVE_RINDEX */
|
|
||||||
#define HAVE_STRCHR 1
|
|
||||||
#define HAVE_STRRCHR 1
|
|
||||||
#define HAVE_STRSTR 1
|
|
||||||
/* #undef HAVE_STRTOK_R */
|
|
||||||
#define HAVE_ITOA 1
|
|
||||||
#define HAVE__LTOA 1
|
|
||||||
#define HAVE__ULTOA 1
|
|
||||||
#define HAVE_STRTOL 1
|
|
||||||
#define HAVE_STRTOUL 1
|
|
||||||
#define HAVE__I64TOA 1
|
|
||||||
#define HAVE__UI64TOA 1
|
|
||||||
#define HAVE_STRTOLL 1
|
|
||||||
#define HAVE_STRTOULL 1
|
|
||||||
#define HAVE_STRTOD 1
|
|
||||||
#define HAVE_ATOI 1
|
|
||||||
#define HAVE_ATOF 1
|
|
||||||
#define HAVE_STRCMP 1
|
|
||||||
#define HAVE_STRNCMP 1
|
|
||||||
#define HAVE_STRICMP 1
|
|
||||||
#define HAVE_STRCASECMP 1
|
|
||||||
#define HAVE_STRNCASECMP 1
|
|
||||||
#define HAVE_SSCANF 1
|
|
||||||
#define HAVE_VSSCANF 1
|
|
||||||
#define HAVE_SNPRINTF 1
|
|
||||||
#define HAVE_VSNPRINTF 1
|
|
||||||
#define HAVE_SETJMP 1
|
|
||||||
#define HAVE_ACOS 1
|
|
||||||
/* #undef HAVE_ACOSF */
|
|
||||||
#define HAVE_ASIN 1
|
|
||||||
/* #undef HAVE_ASINF */
|
|
||||||
#define HAVE_ATAN 1
|
|
||||||
#define HAVE_ATAN2 1
|
|
||||||
/* #undef HAVE_ATAN2F */
|
|
||||||
#define HAVE_CEIL 1
|
|
||||||
/* #undef HAVE_CEILF */
|
|
||||||
/* #undef HAVE_COPYSIGN */
|
|
||||||
/* #undef HAVE_COPYSIGNF */
|
|
||||||
#define HAVE_COS 1
|
|
||||||
/* #undef HAVE_COSF */
|
|
||||||
#define HAVE_EXP 1
|
|
||||||
/* #undef HAVE_EXPF */
|
|
||||||
#define HAVE_FABS 1
|
|
||||||
/* #undef HAVE_FABSF */
|
|
||||||
#define HAVE_FLOOR 1
|
|
||||||
/* #undef HAVE_FLOORF */
|
|
||||||
#define HAVE_FMOD 1
|
|
||||||
/* #undef HAVE_FMODF */
|
|
||||||
#define HAVE_LOG 1
|
|
||||||
/* #undef HAVE_LOGF */
|
|
||||||
#define HAVE_LOG10 1
|
|
||||||
/* #undef HAVE_LOG10F */
|
|
||||||
#define HAVE_POW 1
|
|
||||||
/* #undef HAVE_POWF */
|
|
||||||
#define HAVE_SIN 1
|
|
||||||
/* #undef HAVE_SINF */
|
|
||||||
/* #undef HAVE_SCALBN */
|
|
||||||
/* #undef HAVE_SCALBNF */
|
|
||||||
#define HAVE_SQRT 1
|
|
||||||
/* #undef HAVE_SQRTF */
|
|
||||||
#define HAVE_TAN 1
|
|
||||||
/* #undef HAVE_TANF */
|
|
||||||
/* #undef HAVE_TRUNC */
|
|
||||||
/* #undef HAVE_TRUNCF */
|
|
||||||
/* #undef HAVE_LROUND */
|
|
||||||
/* #undef HAVE_LROUNDF */
|
|
||||||
/* #undef HAVE_ROUND */
|
|
||||||
/* #undef HAVE_ROUNDF */
|
|
||||||
|
|
||||||
#endif /* SDL_config_os2_h_ */
|
|
||||||
@@ -1,141 +0,0 @@
|
|||||||
/*
|
|
||||||
Simple DirectMedia Layer
|
|
||||||
Copyright (C) 1997-2025 Sam Lantinga <slouken@libsdl.org>
|
|
||||||
|
|
||||||
This software is provided 'as-is', without any express or implied
|
|
||||||
warranty. In no event will the authors be held liable for any damages
|
|
||||||
arising from the use of this software.
|
|
||||||
|
|
||||||
Permission is granted to anyone to use this software for any purpose,
|
|
||||||
including commercial applications, and to alter it and redistribute it
|
|
||||||
freely, subject to the following restrictions:
|
|
||||||
|
|
||||||
1. The origin of this software must not be misrepresented; you must not
|
|
||||||
claim that you wrote the original software. If you use this software
|
|
||||||
in a product, an acknowledgment in the product documentation would be
|
|
||||||
appreciated but is not required.
|
|
||||||
2. Altered source versions must be plainly marked as such, and must not be
|
|
||||||
misrepresented as being the original software.
|
|
||||||
3. This notice may not be removed or altered from any source distribution.
|
|
||||||
*/
|
|
||||||
|
|
||||||
#ifndef SDL_config_pandora_h_
|
|
||||||
#define SDL_config_pandora_h_
|
|
||||||
#define SDL_config_h_
|
|
||||||
|
|
||||||
/* This is a set of defines to configure the SDL features */
|
|
||||||
|
|
||||||
/* General platform specific identifiers */
|
|
||||||
#include "SDL_platform.h"
|
|
||||||
|
|
||||||
#ifdef __LP64__
|
|
||||||
#define SIZEOF_VOIDP 8
|
|
||||||
#else
|
|
||||||
#define SIZEOF_VOIDP 4
|
|
||||||
#endif
|
|
||||||
|
|
||||||
#define SDL_BYTEORDER 1234
|
|
||||||
|
|
||||||
#define STDC_HEADERS 1
|
|
||||||
#define HAVE_ALLOCA_H 1
|
|
||||||
#define HAVE_CTYPE_H 1
|
|
||||||
#define HAVE_ICONV_H 1
|
|
||||||
#define HAVE_INTTYPES_H 1
|
|
||||||
#define HAVE_LIMITS_H 1
|
|
||||||
#define HAVE_MALLOC_H 1
|
|
||||||
#define HAVE_MATH_H 1
|
|
||||||
#define HAVE_MEMORY_H 1
|
|
||||||
#define HAVE_SIGNAL_H 1
|
|
||||||
#define HAVE_STDARG_H 1
|
|
||||||
#define HAVE_STDINT_H 1
|
|
||||||
#define HAVE_STDIO_H 1
|
|
||||||
#define HAVE_STDLIB_H 1
|
|
||||||
#define HAVE_STRINGS_H 1
|
|
||||||
#define HAVE_STRING_H 1
|
|
||||||
#define HAVE_SYS_TYPES_H 1
|
|
||||||
|
|
||||||
#define HAVE_DLOPEN 1
|
|
||||||
#define HAVE_MALLOC 1
|
|
||||||
#define HAVE_CALLOC 1
|
|
||||||
#define HAVE_REALLOC 1
|
|
||||||
#define HAVE_FREE 1
|
|
||||||
#define HAVE_ALLOCA 1
|
|
||||||
#define HAVE_GETENV 1
|
|
||||||
#define HAVE_SETENV 1
|
|
||||||
#define HAVE_PUTENV 1
|
|
||||||
#define HAVE_UNSETENV 1
|
|
||||||
#define HAVE_QSORT 1
|
|
||||||
#define HAVE_BSEARCH 1
|
|
||||||
#define HAVE_ABS 1
|
|
||||||
#define HAVE_BCOPY 1
|
|
||||||
#define HAVE_MEMSET 1
|
|
||||||
#define HAVE_MEMCPY 1
|
|
||||||
#define HAVE_MEMMOVE 1
|
|
||||||
#define HAVE_STRLEN 1
|
|
||||||
#define HAVE_STRCHR 1
|
|
||||||
#define HAVE_STRRCHR 1
|
|
||||||
#define HAVE_STRSTR 1
|
|
||||||
#define HAVE_STRTOL 1
|
|
||||||
#define HAVE_STRTOUL 1
|
|
||||||
#define HAVE_STRTOLL 1
|
|
||||||
#define HAVE_STRTOULL 1
|
|
||||||
#define HAVE_ATOI 1
|
|
||||||
#define HAVE_ATOF 1
|
|
||||||
#define HAVE_STRCMP 1
|
|
||||||
#define HAVE_STRNCMP 1
|
|
||||||
#define HAVE_STRCASECMP 1
|
|
||||||
#define HAVE_STRNCASECMP 1
|
|
||||||
#define HAVE_VSSCANF 1
|
|
||||||
#define HAVE_VSNPRINTF 1
|
|
||||||
#define HAVE_M_PI 1
|
|
||||||
#define HAVE_CEIL 1
|
|
||||||
#define HAVE_COPYSIGN 1
|
|
||||||
#define HAVE_COS 1
|
|
||||||
#define HAVE_COSF 1
|
|
||||||
#define HAVE_EXP 1
|
|
||||||
#define HAVE_FABS 1
|
|
||||||
#define HAVE_FLOOR 1
|
|
||||||
#define HAVE_LOG 1
|
|
||||||
#define HAVE_LOG10 1
|
|
||||||
#define HAVE_LROUND 1
|
|
||||||
#define HAVE_LROUNDF 1
|
|
||||||
#define HAVE_ROUND 1
|
|
||||||
#define HAVE_ROUNDF 1
|
|
||||||
#define HAVE_SCALBN 1
|
|
||||||
#define HAVE_SIN 1
|
|
||||||
#define HAVE_SINF 1
|
|
||||||
#define HAVE_SQRT 1
|
|
||||||
#define HAVE_SQRTF 1
|
|
||||||
#define HAVE_TAN 1
|
|
||||||
#define HAVE_TANF 1
|
|
||||||
#define HAVE_TRUNC 1
|
|
||||||
#define HAVE_TRUNCF 1
|
|
||||||
#define HAVE_SIGACTION 1
|
|
||||||
#define HAVE_SETJMP 1
|
|
||||||
#define HAVE_NANOSLEEP 1
|
|
||||||
|
|
||||||
#define SDL_AUDIO_DRIVER_DUMMY 1
|
|
||||||
#define SDL_AUDIO_DRIVER_OSS 1
|
|
||||||
|
|
||||||
#define SDL_INPUT_LINUXEV 1
|
|
||||||
#define SDL_JOYSTICK_LINUX 1
|
|
||||||
#define SDL_JOYSTICK_VIRTUAL 1
|
|
||||||
#define SDL_HAPTIC_LINUX 1
|
|
||||||
|
|
||||||
#define SDL_SENSOR_DUMMY 1
|
|
||||||
|
|
||||||
#define SDL_LOADSO_DLOPEN 1
|
|
||||||
|
|
||||||
#define SDL_THREAD_PTHREAD 1
|
|
||||||
#define SDL_THREAD_PTHREAD_RECURSIVE_MUTEX_NP 1
|
|
||||||
|
|
||||||
#define SDL_TIMER_UNIX 1
|
|
||||||
#define SDL_FILESYSTEM_UNIX 1
|
|
||||||
|
|
||||||
#define SDL_VIDEO_DRIVER_DUMMY 1
|
|
||||||
#define SDL_VIDEO_DRIVER_X11 1
|
|
||||||
#define SDL_VIDEO_DRIVER_PANDORA 1
|
|
||||||
#define SDL_VIDEO_RENDER_OGL_ES 1
|
|
||||||
#define SDL_VIDEO_OPENGL_ES 1
|
|
||||||
|
|
||||||
#endif /* SDL_config_pandora_h_ */
|
|
||||||
@@ -1,333 +0,0 @@
|
|||||||
/*
|
|
||||||
Simple DirectMedia Layer
|
|
||||||
Copyright (C) 1997-2025 Sam Lantinga <slouken@libsdl.org>
|
|
||||||
|
|
||||||
This software is provided 'as-is', without any express or implied
|
|
||||||
warranty. In no event will the authors be held liable for any damages
|
|
||||||
arising from the use of this software.
|
|
||||||
|
|
||||||
Permission is granted to anyone to use this software for any purpose,
|
|
||||||
including commercial applications, and to alter it and redistribute it
|
|
||||||
freely, subject to the following restrictions:
|
|
||||||
|
|
||||||
1. The origin of this software must not be misrepresented; you must not
|
|
||||||
claim that you wrote the original software. If you use this software
|
|
||||||
in a product, an acknowledgment in the product documentation would be
|
|
||||||
appreciated but is not required.
|
|
||||||
2. Altered source versions must be plainly marked as such, and must not be
|
|
||||||
misrepresented as being the original software.
|
|
||||||
3. This notice may not be removed or altered from any source distribution.
|
|
||||||
*/
|
|
||||||
|
|
||||||
#ifndef SDL_config_windows_h_
|
|
||||||
#define SDL_config_windows_h_
|
|
||||||
#define SDL_config_h_
|
|
||||||
|
|
||||||
#include "SDL_platform.h"
|
|
||||||
|
|
||||||
/* winsdkver.h defines _WIN32_MAXVER for SDK version detection. It is present since at least the Windows 7 SDK,
|
|
||||||
* but out of caution we'll only use it if the compiler supports __has_include() to confirm its presence.
|
|
||||||
* If your compiler doesn't support __has_include() but you have winsdkver.h, define HAVE_WINSDKVER_H. */
|
|
||||||
#if !defined(HAVE_WINSDKVER_H) && defined(__has_include)
|
|
||||||
#if __has_include(<winsdkver.h>)
|
|
||||||
#define HAVE_WINSDKVER_H 1
|
|
||||||
#endif
|
|
||||||
#endif
|
|
||||||
|
|
||||||
#ifdef HAVE_WINSDKVER_H
|
|
||||||
#include <winsdkver.h>
|
|
||||||
#endif
|
|
||||||
|
|
||||||
/* sdkddkver.h defines more specific SDK version numbers. This is needed because older versions of the
|
|
||||||
* Windows 10 SDK have broken declarations for the C API for DirectX 12. */
|
|
||||||
#if !defined(HAVE_SDKDDKVER_H) && defined(__has_include)
|
|
||||||
#if __has_include(<sdkddkver.h>)
|
|
||||||
#define HAVE_SDKDDKVER_H 1
|
|
||||||
#endif
|
|
||||||
#endif
|
|
||||||
|
|
||||||
#ifdef HAVE_SDKDDKVER_H
|
|
||||||
#include <sdkddkver.h>
|
|
||||||
#endif
|
|
||||||
|
|
||||||
/* This is a set of defines to configure the SDL features */
|
|
||||||
|
|
||||||
#if !defined(HAVE_STDINT_H) && !defined(_STDINT_H_)
|
|
||||||
/* Most everything except Visual Studio 2008 and earlier has stdint.h now */
|
|
||||||
#if defined(_MSC_VER) && (_MSC_VER < 1600)
|
|
||||||
typedef signed __int8 int8_t;
|
|
||||||
typedef unsigned __int8 uint8_t;
|
|
||||||
typedef signed __int16 int16_t;
|
|
||||||
typedef unsigned __int16 uint16_t;
|
|
||||||
typedef signed __int32 int32_t;
|
|
||||||
typedef unsigned __int32 uint32_t;
|
|
||||||
typedef signed __int64 int64_t;
|
|
||||||
typedef unsigned __int64 uint64_t;
|
|
||||||
#ifndef _UINTPTR_T_DEFINED
|
|
||||||
#ifdef _WIN64
|
|
||||||
typedef unsigned __int64 uintptr_t;
|
|
||||||
#else
|
|
||||||
typedef unsigned int uintptr_t;
|
|
||||||
#endif
|
|
||||||
#define _UINTPTR_T_DEFINED
|
|
||||||
#endif
|
|
||||||
#else
|
|
||||||
#define HAVE_STDINT_H 1
|
|
||||||
#endif /* Visual Studio 2008 */
|
|
||||||
#endif /* !_STDINT_H_ && !HAVE_STDINT_H */
|
|
||||||
|
|
||||||
#ifdef _WIN64
|
|
||||||
# define SIZEOF_VOIDP 8
|
|
||||||
#else
|
|
||||||
# define SIZEOF_VOIDP 4
|
|
||||||
#endif
|
|
||||||
|
|
||||||
#ifdef __clang__
|
|
||||||
# define HAVE_GCC_ATOMICS 1
|
|
||||||
#endif
|
|
||||||
|
|
||||||
#define HAVE_DDRAW_H 1
|
|
||||||
#define HAVE_DINPUT_H 1
|
|
||||||
#define HAVE_DSOUND_H 1
|
|
||||||
#ifndef __WATCOMC__
|
|
||||||
#define HAVE_DXGI_H 1
|
|
||||||
#define HAVE_XINPUT_H 1
|
|
||||||
#if defined(_WIN32_MAXVER) && _WIN32_MAXVER >= 0x0A00 /* Windows 10 SDK */
|
|
||||||
#define HAVE_WINDOWS_GAMING_INPUT_H 1
|
|
||||||
#endif
|
|
||||||
#if defined(_WIN32_MAXVER) && _WIN32_MAXVER >= 0x0602 /* Windows 8 SDK */
|
|
||||||
#define HAVE_D3D11_H 1
|
|
||||||
#define HAVE_ROAPI_H 1
|
|
||||||
#endif
|
|
||||||
#if defined(__has_include)
|
|
||||||
#if __has_include(<d3d12.h>) && __has_include(<d3d12sdklayers.h>)
|
|
||||||
#define HAVE_D3D12_H 1
|
|
||||||
#endif
|
|
||||||
#endif
|
|
||||||
#if defined(_WIN32_MAXVER) && _WIN32_MAXVER >= 0x0603 /* Windows 8.1 SDK */
|
|
||||||
#define HAVE_SHELLSCALINGAPI_H 1
|
|
||||||
#endif
|
|
||||||
#define HAVE_MMDEVICEAPI_H 1
|
|
||||||
#define HAVE_AUDIOCLIENT_H 1
|
|
||||||
#define HAVE_TPCSHRD_H 1
|
|
||||||
#define HAVE_SENSORSAPI_H 1
|
|
||||||
#endif
|
|
||||||
#if (defined(_M_IX86) || defined(_M_X64) || defined(_M_AMD64)) && (defined(_MSC_VER) && _MSC_VER >= 1600)
|
|
||||||
#define HAVE_IMMINTRIN_H 1
|
|
||||||
#elif defined(__has_include) && (defined(__i386__) || defined(__x86_64))
|
|
||||||
# if __has_include(<immintrin.h>)
|
|
||||||
# define HAVE_IMMINTRIN_H 1
|
|
||||||
# endif
|
|
||||||
#endif
|
|
||||||
|
|
||||||
/* This is disabled by default to avoid C runtime dependencies and manifest requirements */
|
|
||||||
#ifdef HAVE_LIBC
|
|
||||||
/* Useful headers */
|
|
||||||
#define STDC_HEADERS 1
|
|
||||||
#define HAVE_CTYPE_H 1
|
|
||||||
#define HAVE_FLOAT_H 1
|
|
||||||
#define HAVE_LIMITS_H 1
|
|
||||||
#define HAVE_MATH_H 1
|
|
||||||
#define HAVE_SIGNAL_H 1
|
|
||||||
#define HAVE_STDIO_H 1
|
|
||||||
#define HAVE_STRING_H 1
|
|
||||||
|
|
||||||
/* C library functions */
|
|
||||||
#define HAVE_MALLOC 1
|
|
||||||
#define HAVE_CALLOC 1
|
|
||||||
#define HAVE_REALLOC 1
|
|
||||||
#define HAVE_FREE 1
|
|
||||||
#define HAVE_ALLOCA 1
|
|
||||||
/* OpenWatcom requires specific calling conventions for qsort and bsearch */
|
|
||||||
#ifndef __WATCOMC__
|
|
||||||
#define HAVE_QSORT 1
|
|
||||||
#define HAVE_BSEARCH 1
|
|
||||||
#endif
|
|
||||||
#define HAVE_ABS 1
|
|
||||||
#define HAVE_MEMSET 1
|
|
||||||
#define HAVE_MEMCPY 1
|
|
||||||
#define HAVE_MEMMOVE 1
|
|
||||||
#define HAVE_MEMCMP 1
|
|
||||||
#define HAVE_STRLEN 1
|
|
||||||
#define HAVE__STRREV 1
|
|
||||||
/* These functions have security warnings, so we won't use them */
|
|
||||||
/* #undef HAVE__STRUPR */
|
|
||||||
/* #undef HAVE__STRLWR */
|
|
||||||
#define HAVE_STRCHR 1
|
|
||||||
#define HAVE_STRRCHR 1
|
|
||||||
#define HAVE_STRSTR 1
|
|
||||||
/* #undef HAVE_STRTOK_R */
|
|
||||||
/* These functions have security warnings, so we won't use them */
|
|
||||||
/* #undef HAVE__LTOA */
|
|
||||||
/* #undef HAVE__ULTOA */
|
|
||||||
#define HAVE_STRTOL 1
|
|
||||||
#define HAVE_STRTOUL 1
|
|
||||||
#define HAVE_STRTOD 1
|
|
||||||
#define HAVE_ATOI 1
|
|
||||||
#define HAVE_ATOF 1
|
|
||||||
#define HAVE_STRCMP 1
|
|
||||||
#define HAVE_STRNCMP 1
|
|
||||||
#define HAVE__STRICMP 1
|
|
||||||
#define HAVE__STRNICMP 1
|
|
||||||
#define HAVE__WCSICMP 1
|
|
||||||
#define HAVE__WCSNICMP 1
|
|
||||||
#define HAVE__WCSDUP 1
|
|
||||||
#define HAVE_ACOS 1
|
|
||||||
#define HAVE_ASIN 1
|
|
||||||
#define HAVE_ATAN 1
|
|
||||||
#define HAVE_ATAN2 1
|
|
||||||
#define HAVE_CEIL 1
|
|
||||||
#define HAVE_COS 1
|
|
||||||
#define HAVE_EXP 1
|
|
||||||
#define HAVE_FABS 1
|
|
||||||
#define HAVE_FLOOR 1
|
|
||||||
#define HAVE_FMOD 1
|
|
||||||
#define HAVE_LOG 1
|
|
||||||
#define HAVE_LOG10 1
|
|
||||||
#define HAVE_POW 1
|
|
||||||
#define HAVE_SIN 1
|
|
||||||
#define HAVE_SQRT 1
|
|
||||||
#define HAVE_TAN 1
|
|
||||||
#ifndef __WATCOMC__
|
|
||||||
#define HAVE_ACOSF 1
|
|
||||||
#define HAVE_ASINF 1
|
|
||||||
#define HAVE_ATANF 1
|
|
||||||
#define HAVE_ATAN2F 1
|
|
||||||
#define HAVE_CEILF 1
|
|
||||||
#define HAVE__COPYSIGN 1
|
|
||||||
#define HAVE_COSF 1
|
|
||||||
#define HAVE_EXPF 1
|
|
||||||
#define HAVE_FABSF 1
|
|
||||||
#define HAVE_FLOORF 1
|
|
||||||
#define HAVE_FMODF 1
|
|
||||||
#define HAVE_LOGF 1
|
|
||||||
#define HAVE_LOG10F 1
|
|
||||||
#define HAVE_POWF 1
|
|
||||||
#define HAVE_SINF 1
|
|
||||||
#define HAVE_SQRTF 1
|
|
||||||
#define HAVE_TANF 1
|
|
||||||
#endif
|
|
||||||
#if defined(_MSC_VER)
|
|
||||||
/* These functions were added with the VC++ 2013 C runtime library */
|
|
||||||
#if _MSC_VER >= 1800
|
|
||||||
#define HAVE_STRTOLL 1
|
|
||||||
#define HAVE_STRTOULL 1
|
|
||||||
#define HAVE_VSSCANF 1
|
|
||||||
#define HAVE_LROUND 1
|
|
||||||
#define HAVE_LROUNDF 1
|
|
||||||
#define HAVE_ROUND 1
|
|
||||||
#define HAVE_ROUNDF 1
|
|
||||||
#define HAVE_SCALBN 1
|
|
||||||
#define HAVE_SCALBNF 1
|
|
||||||
#define HAVE_TRUNC 1
|
|
||||||
#define HAVE_TRUNCF 1
|
|
||||||
#endif
|
|
||||||
/* This function is available with at least the VC++ 2008 C runtime library */
|
|
||||||
#if _MSC_VER >= 1400
|
|
||||||
#define HAVE__FSEEKI64 1
|
|
||||||
#endif
|
|
||||||
#ifdef _USE_MATH_DEFINES
|
|
||||||
#define HAVE_M_PI 1
|
|
||||||
#endif
|
|
||||||
#elif defined(__WATCOMC__)
|
|
||||||
#define HAVE__FSEEKI64 1
|
|
||||||
#define HAVE_STRTOLL 1
|
|
||||||
#define HAVE_STRTOULL 1
|
|
||||||
#define HAVE_VSSCANF 1
|
|
||||||
#define HAVE_ROUND 1
|
|
||||||
#define HAVE_SCALBN 1
|
|
||||||
#define HAVE_TRUNC 1
|
|
||||||
#else
|
|
||||||
#define HAVE_M_PI 1
|
|
||||||
#endif
|
|
||||||
#else
|
|
||||||
#define HAVE_STDARG_H 1
|
|
||||||
#define HAVE_STDDEF_H 1
|
|
||||||
#endif
|
|
||||||
|
|
||||||
/* Enable various audio drivers */
|
|
||||||
#if defined(HAVE_MMDEVICEAPI_H) && defined(HAVE_AUDIOCLIENT_H)
|
|
||||||
#define SDL_AUDIO_DRIVER_WASAPI 1
|
|
||||||
#endif
|
|
||||||
#define SDL_AUDIO_DRIVER_DSOUND 1
|
|
||||||
#define SDL_AUDIO_DRIVER_WINMM 1
|
|
||||||
#define SDL_AUDIO_DRIVER_DISK 1
|
|
||||||
#define SDL_AUDIO_DRIVER_DUMMY 1
|
|
||||||
|
|
||||||
/* Enable various input drivers */
|
|
||||||
#define SDL_JOYSTICK_DINPUT 1
|
|
||||||
#define SDL_JOYSTICK_HIDAPI 1
|
|
||||||
#ifndef __WINRT__
|
|
||||||
#define SDL_JOYSTICK_RAWINPUT 1
|
|
||||||
#endif
|
|
||||||
#define SDL_JOYSTICK_VIRTUAL 1
|
|
||||||
#ifdef HAVE_WINDOWS_GAMING_INPUT_H
|
|
||||||
#define SDL_JOYSTICK_WGI 1
|
|
||||||
#endif
|
|
||||||
#define SDL_JOYSTICK_XINPUT 1
|
|
||||||
#define SDL_HAPTIC_DINPUT 1
|
|
||||||
#define SDL_HAPTIC_XINPUT 1
|
|
||||||
|
|
||||||
/* Enable the sensor driver */
|
|
||||||
#ifdef HAVE_SENSORSAPI_H
|
|
||||||
#define SDL_SENSOR_WINDOWS 1
|
|
||||||
#else
|
|
||||||
#define SDL_SENSOR_DUMMY 1
|
|
||||||
#endif
|
|
||||||
|
|
||||||
/* Enable various shared object loading systems */
|
|
||||||
#define SDL_LOADSO_WINDOWS 1
|
|
||||||
|
|
||||||
/* Enable various threading systems */
|
|
||||||
#define SDL_THREAD_GENERIC_COND_SUFFIX 1
|
|
||||||
#define SDL_THREAD_WINDOWS 1
|
|
||||||
|
|
||||||
/* Enable various timer systems */
|
|
||||||
#define SDL_TIMER_WINDOWS 1
|
|
||||||
|
|
||||||
/* Enable various video drivers */
|
|
||||||
#define SDL_VIDEO_DRIVER_DUMMY 1
|
|
||||||
#define SDL_VIDEO_DRIVER_WINDOWS 1
|
|
||||||
|
|
||||||
#ifndef SDL_VIDEO_RENDER_D3D
|
|
||||||
#define SDL_VIDEO_RENDER_D3D 1
|
|
||||||
#endif
|
|
||||||
#if !defined(SDL_VIDEO_RENDER_D3D11) && defined(HAVE_D3D11_H)
|
|
||||||
#define SDL_VIDEO_RENDER_D3D11 1
|
|
||||||
#endif
|
|
||||||
#if !defined(SDL_VIDEO_RENDER_D3D12) && defined(HAVE_D3D12_H)
|
|
||||||
#define SDL_VIDEO_RENDER_D3D12 1
|
|
||||||
#endif
|
|
||||||
|
|
||||||
/* Enable OpenGL support */
|
|
||||||
#ifndef SDL_VIDEO_OPENGL
|
|
||||||
#define SDL_VIDEO_OPENGL 1
|
|
||||||
#endif
|
|
||||||
#ifndef SDL_VIDEO_OPENGL_WGL
|
|
||||||
#define SDL_VIDEO_OPENGL_WGL 1
|
|
||||||
#endif
|
|
||||||
#ifndef SDL_VIDEO_RENDER_OGL
|
|
||||||
#define SDL_VIDEO_RENDER_OGL 1
|
|
||||||
#endif
|
|
||||||
#ifndef SDL_VIDEO_RENDER_OGL_ES2
|
|
||||||
#define SDL_VIDEO_RENDER_OGL_ES2 1
|
|
||||||
#endif
|
|
||||||
#ifndef SDL_VIDEO_OPENGL_ES2
|
|
||||||
#define SDL_VIDEO_OPENGL_ES2 1
|
|
||||||
#endif
|
|
||||||
#ifndef SDL_VIDEO_OPENGL_EGL
|
|
||||||
#define SDL_VIDEO_OPENGL_EGL 1
|
|
||||||
#endif
|
|
||||||
|
|
||||||
/* Enable Vulkan support */
|
|
||||||
#define SDL_VIDEO_VULKAN 1
|
|
||||||
|
|
||||||
/* Enable system power support */
|
|
||||||
#define SDL_POWER_WINDOWS 1
|
|
||||||
|
|
||||||
/* Enable filesystem support */
|
|
||||||
#define SDL_FILESYSTEM_WINDOWS 1
|
|
||||||
|
|
||||||
#endif /* SDL_config_windows_h_ */
|
|
||||||
|
|
||||||
/* vi: set ts=4 sw=4 expandtab: */
|
|
||||||
@@ -1,253 +0,0 @@
|
|||||||
/*
|
|
||||||
Simple DirectMedia Layer
|
|
||||||
Copyright (C) 1997-2025 Sam Lantinga <slouken@libsdl.org>
|
|
||||||
|
|
||||||
This software is provided 'as-is', without any express or implied
|
|
||||||
warranty. In no event will the authors be held liable for any damages
|
|
||||||
arising from the use of this software.
|
|
||||||
|
|
||||||
Permission is granted to anyone to use this software for any purpose,
|
|
||||||
including commercial applications, and to alter it and redistribute it
|
|
||||||
freely, subject to the following restrictions:
|
|
||||||
|
|
||||||
1. The origin of this software must not be misrepresented; you must not
|
|
||||||
claim that you wrote the original software. If you use this software
|
|
||||||
in a product, an acknowledgment in the product documentation would be
|
|
||||||
appreciated but is not required.
|
|
||||||
2. Altered source versions must be plainly marked as such, and must not be
|
|
||||||
misrepresented as being the original software.
|
|
||||||
3. This notice may not be removed or altered from any source distribution.
|
|
||||||
*/
|
|
||||||
|
|
||||||
#ifndef SDL_config_wingdk_h_
|
|
||||||
#define SDL_config_wingdk_h_
|
|
||||||
#define SDL_config_h_
|
|
||||||
|
|
||||||
#include "SDL_platform.h"
|
|
||||||
|
|
||||||
/* Windows GDK does not need Windows SDK version checks because it requires
|
|
||||||
* a recent version of the Windows 10 SDK. */
|
|
||||||
|
|
||||||
/* GDK only supports 64-bit */
|
|
||||||
# define SIZEOF_VOIDP 8
|
|
||||||
|
|
||||||
#ifdef __clang__
|
|
||||||
# define HAVE_GCC_ATOMICS 1
|
|
||||||
#endif
|
|
||||||
|
|
||||||
#define HAVE_DDRAW_H 1
|
|
||||||
#define HAVE_DINPUT_H 1
|
|
||||||
#define HAVE_DSOUND_H 1
|
|
||||||
/* No SDK version checks needed for these because the SDK has to be new. */
|
|
||||||
#define HAVE_DXGI_H 1
|
|
||||||
#define HAVE_XINPUT_H 1
|
|
||||||
#define HAVE_WINDOWS_GAMING_INPUT_H 1
|
|
||||||
#define HAVE_D3D11_H 1
|
|
||||||
#define HAVE_ROAPI_H 1
|
|
||||||
#define HAVE_D3D12_H 1
|
|
||||||
#define HAVE_SHELLSCALINGAPI_H 1
|
|
||||||
#define HAVE_MMDEVICEAPI_H 1
|
|
||||||
#define HAVE_AUDIOCLIENT_H 1
|
|
||||||
#define HAVE_TPCSHRD_H 1
|
|
||||||
#define HAVE_SENSORSAPI_H 1
|
|
||||||
#if (defined(_M_IX86) || defined(_M_X64) || defined(_M_AMD64)) && (defined(_MSC_VER) && _MSC_VER >= 1600)
|
|
||||||
#define HAVE_IMMINTRIN_H 1
|
|
||||||
#elif defined(__has_include) && (defined(__i386__) || defined(__x86_64))
|
|
||||||
# if __has_include(<immintrin.h>)
|
|
||||||
# define HAVE_IMMINTRIN_H 1
|
|
||||||
# endif
|
|
||||||
#endif
|
|
||||||
|
|
||||||
/* This is disabled by default to avoid C runtime dependencies and manifest requirements */
|
|
||||||
#ifdef HAVE_LIBC
|
|
||||||
/* Useful headers */
|
|
||||||
#define STDC_HEADERS 1
|
|
||||||
#define HAVE_CTYPE_H 1
|
|
||||||
#define HAVE_FLOAT_H 1
|
|
||||||
#define HAVE_LIMITS_H 1
|
|
||||||
#define HAVE_MATH_H 1
|
|
||||||
#define HAVE_SIGNAL_H 1
|
|
||||||
#define HAVE_STDINT_H 1
|
|
||||||
#define HAVE_STDIO_H 1
|
|
||||||
#define HAVE_STRING_H 1
|
|
||||||
|
|
||||||
/* C library functions */
|
|
||||||
#define HAVE_MALLOC 1
|
|
||||||
#define HAVE_CALLOC 1
|
|
||||||
#define HAVE_REALLOC 1
|
|
||||||
#define HAVE_FREE 1
|
|
||||||
#define HAVE_ALLOCA 1
|
|
||||||
#define HAVE_QSORT 1
|
|
||||||
#define HAVE_BSEARCH 1
|
|
||||||
#define HAVE_ABS 1
|
|
||||||
#define HAVE_MEMSET 1
|
|
||||||
#define HAVE_MEMCPY 1
|
|
||||||
#define HAVE_MEMMOVE 1
|
|
||||||
#define HAVE_MEMCMP 1
|
|
||||||
#define HAVE_STRLEN 1
|
|
||||||
#define HAVE__STRREV 1
|
|
||||||
/* These functions have security warnings, so we won't use them */
|
|
||||||
/* #undef HAVE__STRUPR */
|
|
||||||
/* #undef HAVE__STRLWR */
|
|
||||||
#define HAVE_STRCHR 1
|
|
||||||
#define HAVE_STRRCHR 1
|
|
||||||
#define HAVE_STRSTR 1
|
|
||||||
/* #undef HAVE_STRTOK_R */
|
|
||||||
/* These functions have security warnings, so we won't use them */
|
|
||||||
/* #undef HAVE__LTOA */
|
|
||||||
/* #undef HAVE__ULTOA */
|
|
||||||
#define HAVE_STRTOL 1
|
|
||||||
#define HAVE_STRTOUL 1
|
|
||||||
#define HAVE_STRTOD 1
|
|
||||||
#define HAVE_ATOI 1
|
|
||||||
#define HAVE_ATOF 1
|
|
||||||
#define HAVE_STRCMP 1
|
|
||||||
#define HAVE_STRNCMP 1
|
|
||||||
#define HAVE__STRICMP 1
|
|
||||||
#define HAVE__STRNICMP 1
|
|
||||||
#define HAVE__WCSICMP 1
|
|
||||||
#define HAVE__WCSNICMP 1
|
|
||||||
#define HAVE__WCSDUP 1
|
|
||||||
#define HAVE_ACOS 1
|
|
||||||
#define HAVE_ASIN 1
|
|
||||||
#define HAVE_ATAN 1
|
|
||||||
#define HAVE_ATAN2 1
|
|
||||||
#define HAVE_CEIL 1
|
|
||||||
#define HAVE_COS 1
|
|
||||||
#define HAVE_EXP 1
|
|
||||||
#define HAVE_FABS 1
|
|
||||||
#define HAVE_FLOOR 1
|
|
||||||
#define HAVE_FMOD 1
|
|
||||||
#define HAVE_LOG 1
|
|
||||||
#define HAVE_LOG10 1
|
|
||||||
#define HAVE_POW 1
|
|
||||||
#define HAVE_SIN 1
|
|
||||||
#define HAVE_SQRT 1
|
|
||||||
#define HAVE_TAN 1
|
|
||||||
#define HAVE_ACOSF 1
|
|
||||||
#define HAVE_ASINF 1
|
|
||||||
#define HAVE_ATANF 1
|
|
||||||
#define HAVE_ATAN2F 1
|
|
||||||
#define HAVE_CEILF 1
|
|
||||||
#define HAVE__COPYSIGN 1
|
|
||||||
#define HAVE_COSF 1
|
|
||||||
#define HAVE_EXPF 1
|
|
||||||
#define HAVE_FABSF 1
|
|
||||||
#define HAVE_FLOORF 1
|
|
||||||
#define HAVE_FMODF 1
|
|
||||||
#define HAVE_LOGF 1
|
|
||||||
#define HAVE_LOG10F 1
|
|
||||||
#define HAVE_POWF 1
|
|
||||||
#define HAVE_SINF 1
|
|
||||||
#define HAVE_SQRTF 1
|
|
||||||
#define HAVE_TANF 1
|
|
||||||
#if defined(_MSC_VER)
|
|
||||||
/* These functions were added with the VC++ 2013 C runtime library */
|
|
||||||
#define HAVE_STRTOLL 1
|
|
||||||
#define HAVE_STRTOULL 1
|
|
||||||
#define HAVE_VSSCANF 1
|
|
||||||
#define HAVE_LROUND 1
|
|
||||||
#define HAVE_LROUNDF 1
|
|
||||||
#define HAVE_ROUND 1
|
|
||||||
#define HAVE_ROUNDF 1
|
|
||||||
#define HAVE_SCALBN 1
|
|
||||||
#define HAVE_SCALBNF 1
|
|
||||||
#define HAVE_TRUNC 1
|
|
||||||
#define HAVE_TRUNCF 1
|
|
||||||
#define HAVE__FSEEKI64 1
|
|
||||||
#ifdef _USE_MATH_DEFINES
|
|
||||||
#define HAVE_M_PI 1
|
|
||||||
#endif
|
|
||||||
#else
|
|
||||||
#define HAVE_M_PI 1
|
|
||||||
#endif
|
|
||||||
#else
|
|
||||||
#define HAVE_STDARG_H 1
|
|
||||||
#define HAVE_STDDEF_H 1
|
|
||||||
#define HAVE_STDINT_H 1
|
|
||||||
#endif
|
|
||||||
|
|
||||||
/* Enable various audio drivers */
|
|
||||||
#if defined(HAVE_MMDEVICEAPI_H) && defined(HAVE_AUDIOCLIENT_H)
|
|
||||||
#define SDL_AUDIO_DRIVER_WASAPI 1
|
|
||||||
#endif
|
|
||||||
#define SDL_AUDIO_DRIVER_DSOUND 1
|
|
||||||
#define SDL_AUDIO_DRIVER_WINMM 1
|
|
||||||
#define SDL_AUDIO_DRIVER_DISK 1
|
|
||||||
#define SDL_AUDIO_DRIVER_DUMMY 1
|
|
||||||
|
|
||||||
/* Enable various input drivers */
|
|
||||||
#define SDL_JOYSTICK_DINPUT 1
|
|
||||||
#define SDL_JOYSTICK_HIDAPI 1
|
|
||||||
#define SDL_JOYSTICK_RAWINPUT 1
|
|
||||||
#define SDL_JOYSTICK_VIRTUAL 1
|
|
||||||
#ifdef HAVE_WINDOWS_GAMING_INPUT_H
|
|
||||||
#define SDL_JOYSTICK_WGI 1
|
|
||||||
#endif
|
|
||||||
#define SDL_JOYSTICK_XINPUT 1
|
|
||||||
#define SDL_HAPTIC_DINPUT 1
|
|
||||||
#define SDL_HAPTIC_XINPUT 1
|
|
||||||
|
|
||||||
/* Enable the sensor driver */
|
|
||||||
#ifdef HAVE_SENSORSAPI_H
|
|
||||||
#define SDL_SENSOR_WINDOWS 1
|
|
||||||
#else
|
|
||||||
#define SDL_SENSOR_DUMMY 1
|
|
||||||
#endif
|
|
||||||
|
|
||||||
/* Enable various shared object loading systems */
|
|
||||||
#define SDL_LOADSO_WINDOWS 1
|
|
||||||
|
|
||||||
/* Enable various threading systems */
|
|
||||||
#define SDL_THREAD_GENERIC_COND_SUFFIX 1
|
|
||||||
#define SDL_THREAD_WINDOWS 1
|
|
||||||
|
|
||||||
/* Enable various timer systems */
|
|
||||||
#define SDL_TIMER_WINDOWS 1
|
|
||||||
|
|
||||||
/* Enable various video drivers */
|
|
||||||
#define SDL_VIDEO_DRIVER_DUMMY 1
|
|
||||||
#define SDL_VIDEO_DRIVER_WINDOWS 1
|
|
||||||
|
|
||||||
#ifndef SDL_VIDEO_RENDER_D3D
|
|
||||||
#define SDL_VIDEO_RENDER_D3D 1
|
|
||||||
#endif
|
|
||||||
#if !defined(SDL_VIDEO_RENDER_D3D11) && defined(HAVE_D3D11_H)
|
|
||||||
#define SDL_VIDEO_RENDER_D3D11 1
|
|
||||||
#endif
|
|
||||||
#if !defined(SDL_VIDEO_RENDER_D3D12) && defined(HAVE_D3D12_H)
|
|
||||||
#define SDL_VIDEO_RENDER_D3D12 1
|
|
||||||
#endif
|
|
||||||
|
|
||||||
/* Enable OpenGL support */
|
|
||||||
#ifndef SDL_VIDEO_OPENGL
|
|
||||||
#define SDL_VIDEO_OPENGL 1
|
|
||||||
#endif
|
|
||||||
#ifndef SDL_VIDEO_OPENGL_WGL
|
|
||||||
#define SDL_VIDEO_OPENGL_WGL 1
|
|
||||||
#endif
|
|
||||||
#ifndef SDL_VIDEO_RENDER_OGL
|
|
||||||
#define SDL_VIDEO_RENDER_OGL 1
|
|
||||||
#endif
|
|
||||||
#ifndef SDL_VIDEO_RENDER_OGL_ES2
|
|
||||||
#define SDL_VIDEO_RENDER_OGL_ES2 1
|
|
||||||
#endif
|
|
||||||
#ifndef SDL_VIDEO_OPENGL_ES2
|
|
||||||
#define SDL_VIDEO_OPENGL_ES2 1
|
|
||||||
#endif
|
|
||||||
#ifndef SDL_VIDEO_OPENGL_EGL
|
|
||||||
#define SDL_VIDEO_OPENGL_EGL 1
|
|
||||||
#endif
|
|
||||||
|
|
||||||
/* Enable Vulkan support */
|
|
||||||
#define SDL_VIDEO_VULKAN 1
|
|
||||||
|
|
||||||
/* Enable system power support */
|
|
||||||
#define SDL_POWER_WINDOWS 1
|
|
||||||
|
|
||||||
/* Enable filesystem support */
|
|
||||||
#define SDL_FILESYSTEM_WINDOWS 1
|
|
||||||
|
|
||||||
#endif /* SDL_config_wingdk_h_ */
|
|
||||||
|
|
||||||
/* vi: set ts=4 sw=4 expandtab: */
|
|
||||||
@@ -1,220 +0,0 @@
|
|||||||
/*
|
|
||||||
Simple DirectMedia Layer
|
|
||||||
Copyright (C) 1997-2025 Sam Lantinga <slouken@libsdl.org>
|
|
||||||
|
|
||||||
This software is provided 'as-is', without any express or implied
|
|
||||||
warranty. In no event will the authors be held liable for any damages
|
|
||||||
arising from the use of this software.
|
|
||||||
|
|
||||||
Permission is granted to anyone to use this software for any purpose,
|
|
||||||
including commercial applications, and to alter it and redistribute it
|
|
||||||
freely, subject to the following restrictions:
|
|
||||||
|
|
||||||
1. The origin of this software must not be misrepresented; you must not
|
|
||||||
claim that you wrote the original software. If you use this software
|
|
||||||
in a product, an acknowledgment in the product documentation would be
|
|
||||||
appreciated but is not required.
|
|
||||||
2. Altered source versions must be plainly marked as such, and must not be
|
|
||||||
misrepresented as being the original software.
|
|
||||||
3. This notice may not be removed or altered from any source distribution.
|
|
||||||
*/
|
|
||||||
|
|
||||||
#ifndef SDL_config_winrt_h_
|
|
||||||
#define SDL_config_winrt_h_
|
|
||||||
#define SDL_config_h_
|
|
||||||
|
|
||||||
#include "SDL_platform.h"
|
|
||||||
|
|
||||||
/* Make sure the Windows SDK's NTDDI_VERSION macro gets defined. This is used
|
|
||||||
by SDL to determine which version of the Windows SDK is being used.
|
|
||||||
*/
|
|
||||||
#include <sdkddkver.h>
|
|
||||||
|
|
||||||
/* Define possibly-undefined NTDDI values (used when compiling SDL against
|
|
||||||
older versions of the Windows SDK.
|
|
||||||
*/
|
|
||||||
#ifndef NTDDI_WINBLUE
|
|
||||||
#define NTDDI_WINBLUE 0x06030000
|
|
||||||
#endif
|
|
||||||
#ifndef NTDDI_WIN10
|
|
||||||
#define NTDDI_WIN10 0x0A000000
|
|
||||||
#endif
|
|
||||||
|
|
||||||
/* This is a set of defines to configure the SDL features */
|
|
||||||
|
|
||||||
#ifdef _WIN64
|
|
||||||
# define SIZEOF_VOIDP 8
|
|
||||||
#else
|
|
||||||
# define SIZEOF_VOIDP 4
|
|
||||||
#endif
|
|
||||||
|
|
||||||
#ifdef __clang__
|
|
||||||
# define HAVE_GCC_ATOMICS 1
|
|
||||||
#endif
|
|
||||||
|
|
||||||
/* Useful headers */
|
|
||||||
#define HAVE_DXGI_H 1
|
|
||||||
#if !SDL_WINAPI_FAMILY_PHONE
|
|
||||||
#define HAVE_XINPUT_H 1
|
|
||||||
#endif
|
|
||||||
|
|
||||||
#define HAVE_MMDEVICEAPI_H 1
|
|
||||||
#define HAVE_AUDIOCLIENT_H 1
|
|
||||||
#define HAVE_TPCSHRD_H 1
|
|
||||||
|
|
||||||
#define HAVE_LIBC 1
|
|
||||||
#define STDC_HEADERS 1
|
|
||||||
#define HAVE_CTYPE_H 1
|
|
||||||
#define HAVE_FLOAT_H 1
|
|
||||||
#define HAVE_LIMITS_H 1
|
|
||||||
#define HAVE_MATH_H 1
|
|
||||||
#define HAVE_SIGNAL_H 1
|
|
||||||
#define HAVE_STDINT_H 1
|
|
||||||
#define HAVE_STDIO_H 1
|
|
||||||
#define HAVE_STRING_H 1
|
|
||||||
|
|
||||||
/* C library functions */
|
|
||||||
#define HAVE_MALLOC 1
|
|
||||||
#define HAVE_CALLOC 1
|
|
||||||
#define HAVE_REALLOC 1
|
|
||||||
#define HAVE_FREE 1
|
|
||||||
#define HAVE_ALLOCA 1
|
|
||||||
#define HAVE_QSORT 1
|
|
||||||
#define HAVE_BSEARCH 1
|
|
||||||
#define HAVE_ABS 1
|
|
||||||
#define HAVE_MEMSET 1
|
|
||||||
#define HAVE_MEMCPY 1
|
|
||||||
#define HAVE_MEMMOVE 1
|
|
||||||
#define HAVE_MEMCMP 1
|
|
||||||
#define HAVE_STRLEN 1
|
|
||||||
#define HAVE__STRREV 1
|
|
||||||
#define HAVE__STRUPR 1
|
|
||||||
#define HAVE_STRCHR 1
|
|
||||||
#define HAVE_STRRCHR 1
|
|
||||||
#define HAVE_STRSTR 1
|
|
||||||
#define HAVE_STRTOL 1
|
|
||||||
#define HAVE_STRTOUL 1
|
|
||||||
/* #undef HAVE_STRTOLL */
|
|
||||||
/* #undef HAVE_STRTOULL */
|
|
||||||
#define HAVE_STRTOD 1
|
|
||||||
#define HAVE_ATOI 1
|
|
||||||
#define HAVE_ATOF 1
|
|
||||||
#define HAVE_STRCMP 1
|
|
||||||
#define HAVE_STRNCMP 1
|
|
||||||
#define HAVE__STRICMP 1
|
|
||||||
#define HAVE__STRNICMP 1
|
|
||||||
#define HAVE_VSNPRINTF 1
|
|
||||||
/* TODO, WinRT: consider using ??_s versions of the following */
|
|
||||||
/* #undef HAVE__STRLWR */
|
|
||||||
/* #undef HAVE_ITOA */
|
|
||||||
/* #undef HAVE__LTOA */
|
|
||||||
/* #undef HAVE__ULTOA */
|
|
||||||
/* #undef HAVE_SSCANF */
|
|
||||||
#define HAVE_M_PI 1
|
|
||||||
#define HAVE_ACOS 1
|
|
||||||
#define HAVE_ACOSF 1
|
|
||||||
#define HAVE_ASIN 1
|
|
||||||
#define HAVE_ASINF 1
|
|
||||||
#define HAVE_ATAN 1
|
|
||||||
#define HAVE_ATANF 1
|
|
||||||
#define HAVE_ATAN2 1
|
|
||||||
#define HAVE_ATAN2F 1
|
|
||||||
#define HAVE_CEIL 1
|
|
||||||
#define HAVE_CEILF 1
|
|
||||||
#define HAVE__COPYSIGN 1
|
|
||||||
#define HAVE_COS 1
|
|
||||||
#define HAVE_COSF 1
|
|
||||||
#define HAVE_EXP 1
|
|
||||||
#define HAVE_EXPF 1
|
|
||||||
#define HAVE_FABS 1
|
|
||||||
#define HAVE_FABSF 1
|
|
||||||
#define HAVE_FLOOR 1
|
|
||||||
#define HAVE_FLOORF 1
|
|
||||||
#define HAVE_FMOD 1
|
|
||||||
#define HAVE_FMODF 1
|
|
||||||
#define HAVE_LOG 1
|
|
||||||
#define HAVE_LOGF 1
|
|
||||||
#define HAVE_LOG10 1
|
|
||||||
#define HAVE_LOG10F 1
|
|
||||||
#define HAVE_LROUND 1
|
|
||||||
#define HAVE_LROUNDF 1
|
|
||||||
#define HAVE_POW 1
|
|
||||||
#define HAVE_POWF 1
|
|
||||||
#define HAVE_ROUND 1
|
|
||||||
#define HAVE_ROUNDF 1
|
|
||||||
#define HAVE__SCALB 1
|
|
||||||
#define HAVE_SIN 1
|
|
||||||
#define HAVE_SINF 1
|
|
||||||
#define HAVE_SQRT 1
|
|
||||||
#define HAVE_SQRTF 1
|
|
||||||
#define HAVE_TAN 1
|
|
||||||
#define HAVE_TANF 1
|
|
||||||
#define HAVE_TRUNC 1
|
|
||||||
#define HAVE_TRUNCF 1
|
|
||||||
#define HAVE__FSEEKI64 1
|
|
||||||
|
|
||||||
#define HAVE_ROAPI_H 1
|
|
||||||
|
|
||||||
/* Enable various audio drivers */
|
|
||||||
#define SDL_AUDIO_DRIVER_WASAPI 1
|
|
||||||
#define SDL_AUDIO_DRIVER_DISK 1
|
|
||||||
#define SDL_AUDIO_DRIVER_DUMMY 1
|
|
||||||
|
|
||||||
/* Enable various input drivers */
|
|
||||||
#if SDL_WINAPI_FAMILY_PHONE
|
|
||||||
#define SDL_JOYSTICK_DISABLED 1
|
|
||||||
#define SDL_HAPTIC_DISABLED 1
|
|
||||||
#else
|
|
||||||
#define SDL_JOYSTICK_VIRTUAL 1
|
|
||||||
#if (NTDDI_VERSION >= NTDDI_WIN10)
|
|
||||||
#define SDL_JOYSTICK_WGI 1
|
|
||||||
#define SDL_HAPTIC_DISABLED 1
|
|
||||||
#else
|
|
||||||
#define SDL_JOYSTICK_XINPUT 1
|
|
||||||
#define SDL_HAPTIC_XINPUT 1
|
|
||||||
#endif /* WIN10 */
|
|
||||||
#endif
|
|
||||||
|
|
||||||
/* WinRT doesn't have HIDAPI available */
|
|
||||||
#define SDL_HIDAPI_DISABLED 1
|
|
||||||
|
|
||||||
/* Enable the dummy sensor driver */
|
|
||||||
#define SDL_SENSOR_DUMMY 1
|
|
||||||
|
|
||||||
/* Enable various shared object loading systems */
|
|
||||||
#define SDL_LOADSO_WINDOWS 1
|
|
||||||
|
|
||||||
/* Enable various threading systems */
|
|
||||||
#if (NTDDI_VERSION >= NTDDI_WINBLUE)
|
|
||||||
#define SDL_THREAD_GENERIC_COND_SUFFIX 1
|
|
||||||
#define SDL_THREAD_WINDOWS 1
|
|
||||||
#else
|
|
||||||
/* WinRT on Windows 8.0 and Windows Phone 8.0 don't support CreateThread() */
|
|
||||||
#define SDL_THREAD_STDCPP 1
|
|
||||||
#endif
|
|
||||||
|
|
||||||
/* Enable various timer systems */
|
|
||||||
#define SDL_TIMER_WINDOWS 1
|
|
||||||
|
|
||||||
/* Enable various video drivers */
|
|
||||||
#define SDL_VIDEO_DRIVER_WINRT 1
|
|
||||||
#define SDL_VIDEO_DRIVER_DUMMY 1
|
|
||||||
|
|
||||||
/* Enable OpenGL ES 2.0 (via a modified ANGLE library) */
|
|
||||||
#define SDL_VIDEO_OPENGL_ES2 1
|
|
||||||
#define SDL_VIDEO_OPENGL_EGL 1
|
|
||||||
|
|
||||||
/* Enable appropriate renderer(s) */
|
|
||||||
#define SDL_VIDEO_RENDER_D3D11 1
|
|
||||||
|
|
||||||
/* Disable D3D12 as it's not implemented for WinRT */
|
|
||||||
/* #undef SDL_VIDEO_RENDER_D3D12 */
|
|
||||||
|
|
||||||
#ifdef SDL_VIDEO_OPENGL_ES2
|
|
||||||
#define SDL_VIDEO_RENDER_OGL_ES2 1
|
|
||||||
#endif
|
|
||||||
|
|
||||||
/* Enable system power support */
|
|
||||||
#define SDL_POWER_WINRT 1
|
|
||||||
|
|
||||||
#endif /* SDL_config_winrt_h_ */
|
|
||||||
@@ -1,240 +0,0 @@
|
|||||||
/*
|
|
||||||
Simple DirectMedia Layer
|
|
||||||
Copyright (C) 1997-2025 Sam Lantinga <slouken@libsdl.org>
|
|
||||||
|
|
||||||
This software is provided 'as-is', without any express or implied
|
|
||||||
warranty. In no event will the authors be held liable for any damages
|
|
||||||
arising from the use of this software.
|
|
||||||
|
|
||||||
Permission is granted to anyone to use this software for any purpose,
|
|
||||||
including commercial applications, and to alter it and redistribute it
|
|
||||||
freely, subject to the following restrictions:
|
|
||||||
|
|
||||||
1. The origin of this software must not be misrepresented; you must not
|
|
||||||
claim that you wrote the original software. If you use this software
|
|
||||||
in a product, an acknowledgment in the product documentation would be
|
|
||||||
appreciated but is not required.
|
|
||||||
2. Altered source versions must be plainly marked as such, and must not be
|
|
||||||
misrepresented as being the original software.
|
|
||||||
3. This notice may not be removed or altered from any source distribution.
|
|
||||||
*/
|
|
||||||
|
|
||||||
#ifndef SDL_config_wingdk_h_
|
|
||||||
#define SDL_config_wingdk_h_
|
|
||||||
#define SDL_config_h_
|
|
||||||
|
|
||||||
#include "SDL_platform.h"
|
|
||||||
|
|
||||||
/* Windows GDK does not need Windows SDK version checks because it requires
|
|
||||||
* a recent version of the Windows 10 SDK. */
|
|
||||||
|
|
||||||
/* GDK only supports 64-bit */
|
|
||||||
# define SIZEOF_VOIDP 8
|
|
||||||
|
|
||||||
#ifdef __clang__
|
|
||||||
# define HAVE_GCC_ATOMICS 1
|
|
||||||
#endif
|
|
||||||
|
|
||||||
/*#define HAVE_DDRAW_H 1*/
|
|
||||||
/*#define HAVE_DINPUT_H 1*/
|
|
||||||
/*#define HAVE_DSOUND_H 1*/
|
|
||||||
/* No SDK version checks needed for these because the SDK has to be new. */
|
|
||||||
/* #define HAVE_DXGI_H 1 */
|
|
||||||
#define HAVE_XINPUT_H 1
|
|
||||||
/*#define HAVE_WINDOWS_GAMING_INPUT_H 1*/
|
|
||||||
/*#define HAVE_D3D11_H 1*/
|
|
||||||
/*#define HAVE_ROAPI_H 1*/
|
|
||||||
#define HAVE_D3D12_H 1
|
|
||||||
/*#define HAVE_SHELLSCALINGAPI_H 1*/
|
|
||||||
#define HAVE_MMDEVICEAPI_H 1
|
|
||||||
#define HAVE_AUDIOCLIENT_H 1
|
|
||||||
/*#define HAVE_TPCSHRD_H 1*/
|
|
||||||
/*#define HAVE_SENSORSAPI_H 1*/
|
|
||||||
#if (defined(_M_IX86) || defined(_M_X64) || defined(_M_AMD64)) && (defined(_MSC_VER) && _MSC_VER >= 1600)
|
|
||||||
#define HAVE_IMMINTRIN_H 1
|
|
||||||
#elif defined(__has_include) && (defined(__i386__) || defined(__x86_64))
|
|
||||||
# if __has_include(<immintrin.h>)
|
|
||||||
# define HAVE_IMMINTRIN_H 1
|
|
||||||
# endif
|
|
||||||
#endif
|
|
||||||
|
|
||||||
/* This is disabled by default to avoid C runtime dependencies and manifest requirements */
|
|
||||||
#ifdef HAVE_LIBC
|
|
||||||
/* Useful headers */
|
|
||||||
#define STDC_HEADERS 1
|
|
||||||
#define HAVE_CTYPE_H 1
|
|
||||||
#define HAVE_FLOAT_H 1
|
|
||||||
#define HAVE_LIMITS_H 1
|
|
||||||
#define HAVE_MATH_H 1
|
|
||||||
#define HAVE_SIGNAL_H 1
|
|
||||||
#define HAVE_STDINT_H 1
|
|
||||||
#define HAVE_STDIO_H 1
|
|
||||||
#define HAVE_STRING_H 1
|
|
||||||
|
|
||||||
/* C library functions */
|
|
||||||
#define HAVE_MALLOC 1
|
|
||||||
#define HAVE_CALLOC 1
|
|
||||||
#define HAVE_REALLOC 1
|
|
||||||
#define HAVE_FREE 1
|
|
||||||
#define HAVE_ALLOCA 1
|
|
||||||
#define HAVE_QSORT 1
|
|
||||||
#define HAVE_BSEARCH 1
|
|
||||||
#define HAVE_ABS 1
|
|
||||||
#define HAVE_MEMSET 1
|
|
||||||
#define HAVE_MEMCPY 1
|
|
||||||
#define HAVE_MEMMOVE 1
|
|
||||||
#define HAVE_MEMCMP 1
|
|
||||||
#define HAVE_STRLEN 1
|
|
||||||
#define HAVE__STRREV 1
|
|
||||||
/* These functions have security warnings, so we won't use them */
|
|
||||||
/* #undef HAVE__STRUPR */
|
|
||||||
/* #undef HAVE__STRLWR */
|
|
||||||
#define HAVE_STRCHR 1
|
|
||||||
#define HAVE_STRRCHR 1
|
|
||||||
#define HAVE_STRSTR 1
|
|
||||||
/* #undef HAVE_STRTOK_R */
|
|
||||||
/* These functions have security warnings, so we won't use them */
|
|
||||||
/* #undef HAVE__LTOA */
|
|
||||||
/* #undef HAVE__ULTOA */
|
|
||||||
#define HAVE_STRTOL 1
|
|
||||||
#define HAVE_STRTOUL 1
|
|
||||||
#define HAVE_STRTOD 1
|
|
||||||
#define HAVE_ATOI 1
|
|
||||||
#define HAVE_ATOF 1
|
|
||||||
#define HAVE_STRCMP 1
|
|
||||||
#define HAVE_STRNCMP 1
|
|
||||||
#define HAVE__STRICMP 1
|
|
||||||
#define HAVE__STRNICMP 1
|
|
||||||
#define HAVE__WCSICMP 1
|
|
||||||
#define HAVE__WCSNICMP 1
|
|
||||||
#define HAVE__WCSDUP 1
|
|
||||||
#define HAVE_ACOS 1
|
|
||||||
#define HAVE_ASIN 1
|
|
||||||
#define HAVE_ATAN 1
|
|
||||||
#define HAVE_ATAN2 1
|
|
||||||
#define HAVE_CEIL 1
|
|
||||||
#define HAVE_COS 1
|
|
||||||
#define HAVE_EXP 1
|
|
||||||
#define HAVE_FABS 1
|
|
||||||
#define HAVE_FLOOR 1
|
|
||||||
#define HAVE_FMOD 1
|
|
||||||
#define HAVE_LOG 1
|
|
||||||
#define HAVE_LOG10 1
|
|
||||||
#define HAVE_POW 1
|
|
||||||
#define HAVE_SIN 1
|
|
||||||
#define HAVE_SQRT 1
|
|
||||||
#define HAVE_TAN 1
|
|
||||||
#define HAVE_ACOSF 1
|
|
||||||
#define HAVE_ASINF 1
|
|
||||||
#define HAVE_ATANF 1
|
|
||||||
#define HAVE_ATAN2F 1
|
|
||||||
#define HAVE_CEILF 1
|
|
||||||
#define HAVE__COPYSIGN 1
|
|
||||||
#define HAVE_COSF 1
|
|
||||||
#define HAVE_EXPF 1
|
|
||||||
#define HAVE_FABSF 1
|
|
||||||
#define HAVE_FLOORF 1
|
|
||||||
#define HAVE_FMODF 1
|
|
||||||
#define HAVE_LOGF 1
|
|
||||||
#define HAVE_LOG10F 1
|
|
||||||
#define HAVE_POWF 1
|
|
||||||
#define HAVE_SINF 1
|
|
||||||
#define HAVE_SQRTF 1
|
|
||||||
#define HAVE_TANF 1
|
|
||||||
#if defined(_MSC_VER)
|
|
||||||
/* These functions were added with the VC++ 2013 C runtime library */
|
|
||||||
#define HAVE_STRTOLL 1
|
|
||||||
#define HAVE_STRTOULL 1
|
|
||||||
#define HAVE_VSSCANF 1
|
|
||||||
#define HAVE_LROUND 1
|
|
||||||
#define HAVE_LROUNDF 1
|
|
||||||
#define HAVE_ROUND 1
|
|
||||||
#define HAVE_ROUNDF 1
|
|
||||||
#define HAVE_SCALBN 1
|
|
||||||
#define HAVE_SCALBNF 1
|
|
||||||
#define HAVE_TRUNC 1
|
|
||||||
#define HAVE_TRUNCF 1
|
|
||||||
#define HAVE__FSEEKI64 1
|
|
||||||
#ifdef _USE_MATH_DEFINES
|
|
||||||
#define HAVE_M_PI 1
|
|
||||||
#endif
|
|
||||||
#else
|
|
||||||
#define HAVE_M_PI 1
|
|
||||||
#endif
|
|
||||||
#else
|
|
||||||
#define HAVE_STDARG_H 1
|
|
||||||
#define HAVE_STDDEF_H 1
|
|
||||||
#define HAVE_STDINT_H 1
|
|
||||||
#endif
|
|
||||||
|
|
||||||
/* Enable various audio drivers */
|
|
||||||
#if defined(HAVE_MMDEVICEAPI_H) && defined(HAVE_AUDIOCLIENT_H)
|
|
||||||
#define SDL_AUDIO_DRIVER_WASAPI 1
|
|
||||||
#endif
|
|
||||||
/*#define SDL_AUDIO_DRIVER_DSOUND 1*/
|
|
||||||
/*#define SDL_AUDIO_DRIVER_WINMM 1*/
|
|
||||||
#define SDL_AUDIO_DRIVER_DISK 1
|
|
||||||
#define SDL_AUDIO_DRIVER_DUMMY 1
|
|
||||||
|
|
||||||
/* Enable various input drivers */
|
|
||||||
/*#define SDL_JOYSTICK_DINPUT 1*/
|
|
||||||
/*#define SDL_JOYSTICK_HIDAPI 1*/
|
|
||||||
/*#define SDL_JOYSTICK_RAWINPUT 1*/
|
|
||||||
#define SDL_JOYSTICK_VIRTUAL 1
|
|
||||||
#ifdef HAVE_WINDOWS_GAMING_INPUT_H
|
|
||||||
#define SDL_JOYSTICK_WGI 1
|
|
||||||
#endif
|
|
||||||
#define SDL_JOYSTICK_XINPUT 1
|
|
||||||
/*#define SDL_HAPTIC_DINPUT 1*/
|
|
||||||
#define SDL_HAPTIC_XINPUT 1
|
|
||||||
|
|
||||||
/* Enable the sensor driver */
|
|
||||||
#ifdef HAVE_SENSORSAPI_H
|
|
||||||
#define SDL_SENSOR_WINDOWS 1
|
|
||||||
#else
|
|
||||||
#define SDL_SENSOR_DUMMY 1
|
|
||||||
#endif
|
|
||||||
|
|
||||||
/* Enable various shared object loading systems */
|
|
||||||
#define SDL_LOADSO_WINDOWS 1
|
|
||||||
|
|
||||||
/* Enable various threading systems */
|
|
||||||
#define SDL_THREAD_GENERIC_COND_SUFFIX 1
|
|
||||||
#define SDL_THREAD_WINDOWS 1
|
|
||||||
|
|
||||||
/* Enable various timer systems */
|
|
||||||
#define SDL_TIMER_WINDOWS 1
|
|
||||||
|
|
||||||
/* Enable various video drivers */
|
|
||||||
#define SDL_VIDEO_DRIVER_DUMMY 1
|
|
||||||
#define SDL_VIDEO_DRIVER_WINDOWS 1
|
|
||||||
|
|
||||||
#if !defined(SDL_VIDEO_RENDER_D3D12) && defined(HAVE_D3D12_H)
|
|
||||||
#define SDL_VIDEO_RENDER_D3D12 1
|
|
||||||
#endif
|
|
||||||
|
|
||||||
/* Enable OpenGL support */
|
|
||||||
#ifndef SDL_VIDEO_OPENGL
|
|
||||||
#define SDL_VIDEO_OPENGL 1
|
|
||||||
#endif
|
|
||||||
#ifndef SDL_VIDEO_OPENGL_WGL
|
|
||||||
#define SDL_VIDEO_OPENGL_WGL 1
|
|
||||||
#endif
|
|
||||||
#ifndef SDL_VIDEO_RENDER_OGL
|
|
||||||
#define SDL_VIDEO_RENDER_OGL 1
|
|
||||||
#endif
|
|
||||||
|
|
||||||
/* Enable system power support */
|
|
||||||
/*#define SDL_POWER_WINDOWS 1*/
|
|
||||||
#define SDL_POWER_HARDWIRED 1
|
|
||||||
|
|
||||||
/* Enable filesystem support */
|
|
||||||
/* #define SDL_FILESYSTEM_WINDOWS 1*/
|
|
||||||
#define SDL_FILESYSTEM_XBOX 1
|
|
||||||
|
|
||||||
/* Disable IME as not supported yet (TODO: Xbox IME?) */
|
|
||||||
#define SDL_DISABLE_WINDOWS_IME 1
|
|
||||||
|
|
||||||
#endif /* SDL_config_wingdk_h_ */
|
|
||||||
|
|
||||||
/* vi: set ts=4 sw=4 expandtab: */
|
|
||||||
@@ -1,6 +1,6 @@
|
|||||||
/*
|
/*
|
||||||
Simple DirectMedia Layer
|
Simple DirectMedia Layer
|
||||||
Copyright (C) 1997-2025 Sam Lantinga <slouken@libsdl.org>
|
Copyright (C) 1997-2023 Sam Lantinga <slouken@libsdl.org>
|
||||||
|
|
||||||
This software is provided 'as-is', without any express or implied
|
This software is provided 'as-is', without any express or implied
|
||||||
warranty. In no event will the authors be held liable for any damages
|
warranty. In no event will the authors be held liable for any damages
|
||||||
@@ -19,16 +19,10 @@
|
|||||||
3. This notice may not be removed or altered from any source distribution.
|
3. This notice may not be removed or altered from any source distribution.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/* WIKI CATEGORY: CPUInfo */
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* # CategoryCPUInfo
|
* \file SDL_cpuinfo.h
|
||||||
*
|
*
|
||||||
* CPU feature detection for SDL.
|
* CPU feature detection for SDL.
|
||||||
*
|
|
||||||
* These functions are largely concerned with reporting if the system has
|
|
||||||
* access to various SIMD instruction sets, but also has other important info
|
|
||||||
* to share, such as number of logical CPU cores.
|
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#ifndef SDL_cpuinfo_h_
|
#ifndef SDL_cpuinfo_h_
|
||||||
@@ -59,11 +53,9 @@ _m_prefetch(void *__P)
|
|||||||
#ifndef __MMX__
|
#ifndef __MMX__
|
||||||
#define __MMX__
|
#define __MMX__
|
||||||
#endif
|
#endif
|
||||||
/*
|
|
||||||
#ifndef __3dNOW__
|
#ifndef __3dNOW__
|
||||||
#define __3dNOW__
|
#define __3dNOW__
|
||||||
#endif
|
#endif
|
||||||
*/
|
|
||||||
#endif
|
#endif
|
||||||
#ifndef __SSE__
|
#ifndef __SSE__
|
||||||
#define __SSE__
|
#define __SSE__
|
||||||
@@ -115,8 +107,7 @@ _m_prefetch(void *__P)
|
|||||||
#include <lasxintrin.h>
|
#include <lasxintrin.h>
|
||||||
#define __LASX__
|
#define __LASX__
|
||||||
#endif
|
#endif
|
||||||
#if defined(HAVE_IMMINTRIN_H) && !defined(SDL_DISABLE_IMMINTRIN_H) && \
|
#if defined(HAVE_IMMINTRIN_H) && !defined(SDL_DISABLE_IMMINTRIN_H)
|
||||||
(defined(__x86_64__) || defined(_M_X64) || defined(__i386__) || defined(_M_IX86))
|
|
||||||
#include <immintrin.h>
|
#include <immintrin.h>
|
||||||
#else
|
#else
|
||||||
#if defined(__MMX__) && !defined(SDL_DISABLE_MMINTRIN_H)
|
#if defined(__MMX__) && !defined(SDL_DISABLE_MMINTRIN_H)
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
/*
|
/*
|
||||||
Simple DirectMedia Layer
|
Simple DirectMedia Layer
|
||||||
Copyright (C) 1997-2025 Sam Lantinga <slouken@libsdl.org>
|
Copyright (C) 1997-2023 Sam Lantinga <slouken@libsdl.org>
|
||||||
|
|
||||||
This software is provided 'as-is', without any express or implied
|
This software is provided 'as-is', without any express or implied
|
||||||
warranty. In no event will the authors be held liable for any damages
|
warranty. In no event will the authors be held liable for any damages
|
||||||
@@ -19,10 +19,11 @@
|
|||||||
3. This notice may not be removed or altered from any source distribution.
|
3. This notice may not be removed or altered from any source distribution.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/*
|
/**
|
||||||
* This is a simple file to encapsulate the EGL API headers.
|
* \file SDL_egl.h
|
||||||
|
*
|
||||||
|
* This is a simple file to encapsulate the EGL API headers.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#if !defined(_MSC_VER) && !defined(__ANDROID__) && !defined(SDL_USE_BUILTIN_OPENGL_DEFINITIONS)
|
#if !defined(_MSC_VER) && !defined(__ANDROID__) && !defined(SDL_USE_BUILTIN_OPENGL_DEFINITIONS)
|
||||||
|
|
||||||
#if defined(__vita__) || defined(__psp2__)
|
#if defined(__vita__) || defined(__psp2__)
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
/*
|
/*
|
||||||
Simple DirectMedia Layer
|
Simple DirectMedia Layer
|
||||||
Copyright (C) 1997-2025 Sam Lantinga <slouken@libsdl.org>
|
Copyright (C) 1997-2023 Sam Lantinga <slouken@libsdl.org>
|
||||||
|
|
||||||
This software is provided 'as-is', without any express or implied
|
This software is provided 'as-is', without any express or implied
|
||||||
warranty. In no event will the authors be held liable for any damages
|
warranty. In no event will the authors be held liable for any damages
|
||||||
@@ -20,9 +20,9 @@
|
|||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* # CategoryEndian
|
* \file SDL_endian.h
|
||||||
*
|
*
|
||||||
* Functions for reading and writing endian-specific values
|
* Functions for reading and writing endian-specific values
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#ifndef SDL_endian_h_
|
#ifndef SDL_endian_h_
|
||||||
@@ -59,15 +59,6 @@ _m_prefetch(void *__P)
|
|||||||
#ifdef __linux__
|
#ifdef __linux__
|
||||||
#include <endian.h>
|
#include <endian.h>
|
||||||
#define SDL_BYTEORDER __BYTE_ORDER
|
#define SDL_BYTEORDER __BYTE_ORDER
|
||||||
#elif defined(__sun) && defined(__SVR4) /* Solaris */
|
|
||||||
#include <sys/byteorder.h>
|
|
||||||
#if defined(_LITTLE_ENDIAN)
|
|
||||||
#define SDL_BYTEORDER SDL_LIL_ENDIAN
|
|
||||||
#elif defined(_BIG_ENDIAN)
|
|
||||||
#define SDL_BYTEORDER SDL_BIG_ENDIAN
|
|
||||||
#else
|
|
||||||
#error Unsupported endianness
|
|
||||||
#endif
|
|
||||||
#elif defined(__OpenBSD__) || defined(__DragonFly__)
|
#elif defined(__OpenBSD__) || defined(__DragonFly__)
|
||||||
#include <endian.h>
|
#include <endian.h>
|
||||||
#define SDL_BYTEORDER BYTE_ORDER
|
#define SDL_BYTEORDER BYTE_ORDER
|
||||||
@@ -88,7 +79,7 @@ _m_prefetch(void *__P)
|
|||||||
defined(__m68k__) || defined(mc68000) || defined(_M_M68K) || \
|
defined(__m68k__) || defined(mc68000) || defined(_M_M68K) || \
|
||||||
(defined(__MIPS__) && defined(__MIPSEB__)) || \
|
(defined(__MIPS__) && defined(__MIPSEB__)) || \
|
||||||
defined(__ppc__) || defined(__POWERPC__) || defined(__powerpc__) || defined(__PPC__) || \
|
defined(__ppc__) || defined(__POWERPC__) || defined(__powerpc__) || defined(__PPC__) || \
|
||||||
defined(__sparc__) || defined(__sparc)
|
defined(__sparc__)
|
||||||
#define SDL_BYTEORDER SDL_BIG_ENDIAN
|
#define SDL_BYTEORDER SDL_BIG_ENDIAN
|
||||||
#else
|
#else
|
||||||
#define SDL_BYTEORDER SDL_LIL_ENDIAN
|
#define SDL_BYTEORDER SDL_LIL_ENDIAN
|
||||||
@@ -189,16 +180,6 @@ extern __inline Uint16 SDL_Swap16(Uint16);
|
|||||||
parm [ax] \
|
parm [ax] \
|
||||||
modify [ax];
|
modify [ax];
|
||||||
#else
|
#else
|
||||||
|
|
||||||
/**
|
|
||||||
* Use this function to swap the byte order of a 16-bit value.
|
|
||||||
*
|
|
||||||
* \param x the value to be swapped.
|
|
||||||
* \returns the swapped value.
|
|
||||||
*
|
|
||||||
* \sa SDL_SwapBE16
|
|
||||||
* \sa SDL_SwapLE16
|
|
||||||
*/
|
|
||||||
SDL_FORCE_INLINE Uint16
|
SDL_FORCE_INLINE Uint16
|
||||||
SDL_Swap16(Uint16 x)
|
SDL_Swap16(Uint16 x)
|
||||||
{
|
{
|
||||||
@@ -250,16 +231,6 @@ extern __inline Uint32 SDL_Swap32(Uint32);
|
|||||||
parm [eax] \
|
parm [eax] \
|
||||||
modify [eax];
|
modify [eax];
|
||||||
#else
|
#else
|
||||||
|
|
||||||
/**
|
|
||||||
* Use this function to swap the byte order of a 32-bit value.
|
|
||||||
*
|
|
||||||
* \param x the value to be swapped.
|
|
||||||
* \returns the swapped value.
|
|
||||||
*
|
|
||||||
* \sa SDL_SwapBE32
|
|
||||||
* \sa SDL_SwapLE32
|
|
||||||
*/
|
|
||||||
SDL_FORCE_INLINE Uint32
|
SDL_FORCE_INLINE Uint32
|
||||||
SDL_Swap32(Uint32 x)
|
SDL_Swap32(Uint32 x)
|
||||||
{
|
{
|
||||||
@@ -305,16 +276,6 @@ extern __inline Uint64 SDL_Swap64(Uint64);
|
|||||||
parm [eax edx] \
|
parm [eax edx] \
|
||||||
modify [eax edx];
|
modify [eax edx];
|
||||||
#else
|
#else
|
||||||
|
|
||||||
/**
|
|
||||||
* Use this function to swap the byte order of a 64-bit value.
|
|
||||||
*
|
|
||||||
* \param x the value to be swapped.
|
|
||||||
* \returns the swapped value.
|
|
||||||
*
|
|
||||||
* \sa SDL_SwapBE64
|
|
||||||
* \sa SDL_SwapLE64
|
|
||||||
*/
|
|
||||||
SDL_FORCE_INLINE Uint64
|
SDL_FORCE_INLINE Uint64
|
||||||
SDL_Swap64(Uint64 x)
|
SDL_Swap64(Uint64 x)
|
||||||
{
|
{
|
||||||
@@ -332,15 +293,6 @@ SDL_Swap64(Uint64 x)
|
|||||||
#endif
|
#endif
|
||||||
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Use this function to swap the byte order of a floating point value.
|
|
||||||
*
|
|
||||||
* \param x the value to be swapped.
|
|
||||||
* \returns the swapped value.
|
|
||||||
*
|
|
||||||
* \sa SDL_SwapFloatBE
|
|
||||||
* \sa SDL_SwapFloatLE
|
|
||||||
*/
|
|
||||||
SDL_FORCE_INLINE float
|
SDL_FORCE_INLINE float
|
||||||
SDL_SwapFloat(float x)
|
SDL_SwapFloat(float x)
|
||||||
{
|
{
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
/*
|
/*
|
||||||
Simple DirectMedia Layer
|
Simple DirectMedia Layer
|
||||||
Copyright (C) 1997-2025 Sam Lantinga <slouken@libsdl.org>
|
Copyright (C) 1997-2023 Sam Lantinga <slouken@libsdl.org>
|
||||||
|
|
||||||
This software is provided 'as-is', without any express or implied
|
This software is provided 'as-is', without any express or implied
|
||||||
warranty. In no event will the authors be held liable for any damages
|
warranty. In no event will the authors be held liable for any damages
|
||||||
@@ -20,9 +20,9 @@
|
|||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* # CategoryError
|
* \file SDL_error.h
|
||||||
*
|
*
|
||||||
* Simple error message routines for SDL.
|
* Simple error message routines for SDL.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#ifndef SDL_error_h_
|
#ifndef SDL_error_h_
|
||||||
@@ -53,9 +53,9 @@ extern "C" {
|
|||||||
* }
|
* }
|
||||||
* ```
|
* ```
|
||||||
*
|
*
|
||||||
* \param fmt a printf()-style message format string.
|
* \param fmt a printf()-style message format string
|
||||||
* \param ... additional parameters matching % tokens in the `fmt` string, if
|
* \param ... additional parameters matching % tokens in the `fmt` string, if
|
||||||
* any.
|
* any
|
||||||
* \returns always -1.
|
* \returns always -1.
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.0.
|
* \since This function is available since SDL 2.0.0.
|
||||||
@@ -109,8 +109,8 @@ extern DECLSPEC const char *SDLCALL SDL_GetError(void);
|
|||||||
* otherwise operates exactly the same as SDL_GetError().
|
* otherwise operates exactly the same as SDL_GetError().
|
||||||
*
|
*
|
||||||
* \param errstr A buffer to fill with the last error message that was set for
|
* \param errstr A buffer to fill with the last error message that was set for
|
||||||
* the current thread.
|
* the current thread
|
||||||
* \param maxlen The size of the buffer pointed to by the errstr parameter.
|
* \param maxlen The size of the buffer pointed to by the errstr parameter
|
||||||
* \returns the pointer passed in as the `errstr` parameter.
|
* \returns the pointer passed in as the `errstr` parameter.
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.14.
|
* \since This function is available since SDL 2.0.14.
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
/*
|
/*
|
||||||
Simple DirectMedia Layer
|
Simple DirectMedia Layer
|
||||||
Copyright (C) 1997-2025 Sam Lantinga <slouken@libsdl.org>
|
Copyright (C) 1997-2023 Sam Lantinga <slouken@libsdl.org>
|
||||||
|
|
||||||
This software is provided 'as-is', without any express or implied
|
This software is provided 'as-is', without any express or implied
|
||||||
warranty. In no event will the authors be held liable for any damages
|
warranty. In no event will the authors be held liable for any damages
|
||||||
@@ -20,9 +20,9 @@
|
|||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* # CategoryEvents
|
* \file SDL_events.h
|
||||||
*
|
*
|
||||||
* Include file for SDL event handling.
|
* Include file for SDL event handling.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#ifndef SDL_events_h_
|
#ifndef SDL_events_h_
|
||||||
@@ -52,7 +52,7 @@ extern "C" {
|
|||||||
/**
|
/**
|
||||||
* The types of events that can be delivered.
|
* The types of events that can be delivered.
|
||||||
*/
|
*/
|
||||||
typedef enum SDL_EventType
|
typedef enum
|
||||||
{
|
{
|
||||||
SDL_FIRSTEVENT = 0, /**< Unused (do not remove) */
|
SDL_FIRSTEVENT = 0, /**< Unused (do not remove) */
|
||||||
|
|
||||||
@@ -131,8 +131,6 @@ typedef enum SDL_EventType
|
|||||||
SDL_CONTROLLERTOUCHPADMOTION, /**< Game controller touchpad finger was moved */
|
SDL_CONTROLLERTOUCHPADMOTION, /**< Game controller touchpad finger was moved */
|
||||||
SDL_CONTROLLERTOUCHPADUP, /**< Game controller touchpad finger was lifted */
|
SDL_CONTROLLERTOUCHPADUP, /**< Game controller touchpad finger was lifted */
|
||||||
SDL_CONTROLLERSENSORUPDATE, /**< Game controller sensor was updated */
|
SDL_CONTROLLERSENSORUPDATE, /**< Game controller sensor was updated */
|
||||||
SDL_CONTROLLERUPDATECOMPLETE_RESERVED_FOR_SDL3,
|
|
||||||
SDL_CONTROLLERSTEAMHANDLEUPDATED, /**< Game controller Steam handle has changed */
|
|
||||||
|
|
||||||
/* Touch events */
|
/* Touch events */
|
||||||
SDL_FINGERDOWN = 0x700,
|
SDL_FINGERDOWN = 0x700,
|
||||||
@@ -167,7 +165,7 @@ typedef enum SDL_EventType
|
|||||||
/* Internal events */
|
/* Internal events */
|
||||||
SDL_POLLSENTINEL = 0x7F00, /**< Signals the end of an event poll cycle */
|
SDL_POLLSENTINEL = 0x7F00, /**< Signals the end of an event poll cycle */
|
||||||
|
|
||||||
/** Events SDL_USEREVENT through SDL_LASTEVENT are for your use,
|
/** Events ::SDL_USEREVENT through ::SDL_LASTEVENT are for your use,
|
||||||
* and should be allocated with SDL_RegisterEvents()
|
* and should be allocated with SDL_RegisterEvents()
|
||||||
*/
|
*/
|
||||||
SDL_USEREVENT = 0x8000,
|
SDL_USEREVENT = 0x8000,
|
||||||
@@ -179,7 +177,7 @@ typedef enum SDL_EventType
|
|||||||
} SDL_EventType;
|
} SDL_EventType;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Fields shared by every event
|
* \brief Fields shared by every event
|
||||||
*/
|
*/
|
||||||
typedef struct SDL_CommonEvent
|
typedef struct SDL_CommonEvent
|
||||||
{
|
{
|
||||||
@@ -188,14 +186,14 @@ typedef struct SDL_CommonEvent
|
|||||||
} SDL_CommonEvent;
|
} SDL_CommonEvent;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Display state change event data (event.display.*)
|
* \brief Display state change event data (event.display.*)
|
||||||
*/
|
*/
|
||||||
typedef struct SDL_DisplayEvent
|
typedef struct SDL_DisplayEvent
|
||||||
{
|
{
|
||||||
Uint32 type; /**< SDL_DISPLAYEVENT */
|
Uint32 type; /**< ::SDL_DISPLAYEVENT */
|
||||||
Uint32 timestamp; /**< In milliseconds, populated using SDL_GetTicks() */
|
Uint32 timestamp; /**< In milliseconds, populated using SDL_GetTicks() */
|
||||||
Uint32 display; /**< The associated display index */
|
Uint32 display; /**< The associated display index */
|
||||||
Uint8 event; /**< SDL_DisplayEventID */
|
Uint8 event; /**< ::SDL_DisplayEventID */
|
||||||
Uint8 padding1;
|
Uint8 padding1;
|
||||||
Uint8 padding2;
|
Uint8 padding2;
|
||||||
Uint8 padding3;
|
Uint8 padding3;
|
||||||
@@ -203,14 +201,14 @@ typedef struct SDL_DisplayEvent
|
|||||||
} SDL_DisplayEvent;
|
} SDL_DisplayEvent;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Window state change event data (event.window.*)
|
* \brief Window state change event data (event.window.*)
|
||||||
*/
|
*/
|
||||||
typedef struct SDL_WindowEvent
|
typedef struct SDL_WindowEvent
|
||||||
{
|
{
|
||||||
Uint32 type; /**< SDL_WINDOWEVENT */
|
Uint32 type; /**< ::SDL_WINDOWEVENT */
|
||||||
Uint32 timestamp; /**< In milliseconds, populated using SDL_GetTicks() */
|
Uint32 timestamp; /**< In milliseconds, populated using SDL_GetTicks() */
|
||||||
Uint32 windowID; /**< The associated window */
|
Uint32 windowID; /**< The associated window */
|
||||||
Uint8 event; /**< SDL_WindowEventID */
|
Uint8 event; /**< ::SDL_WindowEventID */
|
||||||
Uint8 padding1;
|
Uint8 padding1;
|
||||||
Uint8 padding2;
|
Uint8 padding2;
|
||||||
Uint8 padding3;
|
Uint8 padding3;
|
||||||
@@ -219,14 +217,14 @@ typedef struct SDL_WindowEvent
|
|||||||
} SDL_WindowEvent;
|
} SDL_WindowEvent;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Keyboard button event structure (event.key.*)
|
* \brief Keyboard button event structure (event.key.*)
|
||||||
*/
|
*/
|
||||||
typedef struct SDL_KeyboardEvent
|
typedef struct SDL_KeyboardEvent
|
||||||
{
|
{
|
||||||
Uint32 type; /**< SDL_KEYDOWN or SDL_KEYUP */
|
Uint32 type; /**< ::SDL_KEYDOWN or ::SDL_KEYUP */
|
||||||
Uint32 timestamp; /**< In milliseconds, populated using SDL_GetTicks() */
|
Uint32 timestamp; /**< In milliseconds, populated using SDL_GetTicks() */
|
||||||
Uint32 windowID; /**< The window with keyboard focus, if any */
|
Uint32 windowID; /**< The window with keyboard focus, if any */
|
||||||
Uint8 state; /**< SDL_PRESSED or SDL_RELEASED */
|
Uint8 state; /**< ::SDL_PRESSED or ::SDL_RELEASED */
|
||||||
Uint8 repeat; /**< Non-zero if this is a key repeat */
|
Uint8 repeat; /**< Non-zero if this is a key repeat */
|
||||||
Uint8 padding2;
|
Uint8 padding2;
|
||||||
Uint8 padding3;
|
Uint8 padding3;
|
||||||
@@ -234,13 +232,12 @@ typedef struct SDL_KeyboardEvent
|
|||||||
} SDL_KeyboardEvent;
|
} SDL_KeyboardEvent;
|
||||||
|
|
||||||
#define SDL_TEXTEDITINGEVENT_TEXT_SIZE (32)
|
#define SDL_TEXTEDITINGEVENT_TEXT_SIZE (32)
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Keyboard text editing event structure (event.edit.*)
|
* \brief Keyboard text editing event structure (event.edit.*)
|
||||||
*/
|
*/
|
||||||
typedef struct SDL_TextEditingEvent
|
typedef struct SDL_TextEditingEvent
|
||||||
{
|
{
|
||||||
Uint32 type; /**< SDL_TEXTEDITING */
|
Uint32 type; /**< ::SDL_TEXTEDITING */
|
||||||
Uint32 timestamp; /**< In milliseconds, populated using SDL_GetTicks() */
|
Uint32 timestamp; /**< In milliseconds, populated using SDL_GetTicks() */
|
||||||
Uint32 windowID; /**< The window with keyboard focus, if any */
|
Uint32 windowID; /**< The window with keyboard focus, if any */
|
||||||
char text[SDL_TEXTEDITINGEVENT_TEXT_SIZE]; /**< The editing text */
|
char text[SDL_TEXTEDITINGEVENT_TEXT_SIZE]; /**< The editing text */
|
||||||
@@ -249,12 +246,12 @@ typedef struct SDL_TextEditingEvent
|
|||||||
} SDL_TextEditingEvent;
|
} SDL_TextEditingEvent;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Extended keyboard text editing event structure (event.editExt.*) when text
|
* \brief Extended keyboard text editing event structure (event.editExt.*) when text would be
|
||||||
* would be truncated if stored in the text buffer SDL_TextEditingEvent
|
* truncated if stored in the text buffer SDL_TextEditingEvent
|
||||||
*/
|
*/
|
||||||
typedef struct SDL_TextEditingExtEvent
|
typedef struct SDL_TextEditingExtEvent
|
||||||
{
|
{
|
||||||
Uint32 type; /**< SDL_TEXTEDITING_EXT */
|
Uint32 type; /**< ::SDL_TEXTEDITING_EXT */
|
||||||
Uint32 timestamp; /**< In milliseconds, populated using SDL_GetTicks() */
|
Uint32 timestamp; /**< In milliseconds, populated using SDL_GetTicks() */
|
||||||
Uint32 windowID; /**< The window with keyboard focus, if any */
|
Uint32 windowID; /**< The window with keyboard focus, if any */
|
||||||
char* text; /**< The editing text, which should be freed with SDL_free(), and will not be NULL */
|
char* text; /**< The editing text, which should be freed with SDL_free(), and will not be NULL */
|
||||||
@@ -262,43 +259,24 @@ typedef struct SDL_TextEditingExtEvent
|
|||||||
Sint32 length; /**< The length of selected editing text */
|
Sint32 length; /**< The length of selected editing text */
|
||||||
} SDL_TextEditingExtEvent;
|
} SDL_TextEditingExtEvent;
|
||||||
|
|
||||||
/**
|
|
||||||
* The maximum bytes of text that can be supplied in an SDL_TextInputEvent.
|
|
||||||
*/
|
|
||||||
#define SDL_TEXTINPUTEVENT_TEXT_SIZE (32)
|
#define SDL_TEXTINPUTEVENT_TEXT_SIZE (32)
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Keyboard text input event structure (event.text.*)
|
* \brief Keyboard text input event structure (event.text.*)
|
||||||
*
|
|
||||||
* `text` is limited to SDL_TEXTINPUTEVENT_TEXT_SIZE bytes. If the incoming
|
|
||||||
* string is larger than this, SDL will split it and send it in pieces, across
|
|
||||||
* multiple events. The string is in UTF-8 format, and if split, SDL
|
|
||||||
* guarantees that it will not split in the middle of a UTF-8 sequence, so any
|
|
||||||
* event will only contain complete codepoints. However, if there are several
|
|
||||||
* codepoints that go together into a single glyph (like an emoji "thumbs up"
|
|
||||||
* followed by a skin color), they may be split between events.
|
|
||||||
*
|
|
||||||
* This event will never be delivered unless text input is enabled by calling
|
|
||||||
* SDL_StartTextInput(). Text input is enabled by default on desktop
|
|
||||||
* platforms, and disabled by default on mobile platforms!
|
|
||||||
*
|
|
||||||
* \sa SDL_StartTextInput
|
|
||||||
* \sa SDL_StopTextInput
|
|
||||||
*/
|
*/
|
||||||
typedef struct SDL_TextInputEvent
|
typedef struct SDL_TextInputEvent
|
||||||
{
|
{
|
||||||
Uint32 type; /**< SDL_TEXTINPUT */
|
Uint32 type; /**< ::SDL_TEXTINPUT */
|
||||||
Uint32 timestamp; /**< In milliseconds, populated using SDL_GetTicks() */
|
Uint32 timestamp; /**< In milliseconds, populated using SDL_GetTicks() */
|
||||||
Uint32 windowID; /**< The window with keyboard focus, if any */
|
Uint32 windowID; /**< The window with keyboard focus, if any */
|
||||||
char text[SDL_TEXTINPUTEVENT_TEXT_SIZE]; /**< The input text; UTF-8 encoded. */
|
char text[SDL_TEXTINPUTEVENT_TEXT_SIZE]; /**< The input text */
|
||||||
} SDL_TextInputEvent;
|
} SDL_TextInputEvent;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Mouse motion event structure (event.motion.*)
|
* \brief Mouse motion event structure (event.motion.*)
|
||||||
*/
|
*/
|
||||||
typedef struct SDL_MouseMotionEvent
|
typedef struct SDL_MouseMotionEvent
|
||||||
{
|
{
|
||||||
Uint32 type; /**< SDL_MOUSEMOTION */
|
Uint32 type; /**< ::SDL_MOUSEMOTION */
|
||||||
Uint32 timestamp; /**< In milliseconds, populated using SDL_GetTicks() */
|
Uint32 timestamp; /**< In milliseconds, populated using SDL_GetTicks() */
|
||||||
Uint32 windowID; /**< The window with mouse focus, if any */
|
Uint32 windowID; /**< The window with mouse focus, if any */
|
||||||
Uint32 which; /**< The mouse instance id, or SDL_TOUCH_MOUSEID */
|
Uint32 which; /**< The mouse instance id, or SDL_TOUCH_MOUSEID */
|
||||||
@@ -310,16 +288,16 @@ typedef struct SDL_MouseMotionEvent
|
|||||||
} SDL_MouseMotionEvent;
|
} SDL_MouseMotionEvent;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Mouse button event structure (event.button.*)
|
* \brief Mouse button event structure (event.button.*)
|
||||||
*/
|
*/
|
||||||
typedef struct SDL_MouseButtonEvent
|
typedef struct SDL_MouseButtonEvent
|
||||||
{
|
{
|
||||||
Uint32 type; /**< SDL_MOUSEBUTTONDOWN or SDL_MOUSEBUTTONUP */
|
Uint32 type; /**< ::SDL_MOUSEBUTTONDOWN or ::SDL_MOUSEBUTTONUP */
|
||||||
Uint32 timestamp; /**< In milliseconds, populated using SDL_GetTicks() */
|
Uint32 timestamp; /**< In milliseconds, populated using SDL_GetTicks() */
|
||||||
Uint32 windowID; /**< The window with mouse focus, if any */
|
Uint32 windowID; /**< The window with mouse focus, if any */
|
||||||
Uint32 which; /**< The mouse instance id, or SDL_TOUCH_MOUSEID */
|
Uint32 which; /**< The mouse instance id, or SDL_TOUCH_MOUSEID */
|
||||||
Uint8 button; /**< The mouse button index */
|
Uint8 button; /**< The mouse button index */
|
||||||
Uint8 state; /**< SDL_PRESSED or SDL_RELEASED */
|
Uint8 state; /**< ::SDL_PRESSED or ::SDL_RELEASED */
|
||||||
Uint8 clicks; /**< 1 for single-click, 2 for double-click, etc. */
|
Uint8 clicks; /**< 1 for single-click, 2 for double-click, etc. */
|
||||||
Uint8 padding1;
|
Uint8 padding1;
|
||||||
Sint32 x; /**< X coordinate, relative to window */
|
Sint32 x; /**< X coordinate, relative to window */
|
||||||
@@ -327,11 +305,11 @@ typedef struct SDL_MouseButtonEvent
|
|||||||
} SDL_MouseButtonEvent;
|
} SDL_MouseButtonEvent;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Mouse wheel event structure (event.wheel.*)
|
* \brief Mouse wheel event structure (event.wheel.*)
|
||||||
*/
|
*/
|
||||||
typedef struct SDL_MouseWheelEvent
|
typedef struct SDL_MouseWheelEvent
|
||||||
{
|
{
|
||||||
Uint32 type; /**< SDL_MOUSEWHEEL */
|
Uint32 type; /**< ::SDL_MOUSEWHEEL */
|
||||||
Uint32 timestamp; /**< In milliseconds, populated using SDL_GetTicks() */
|
Uint32 timestamp; /**< In milliseconds, populated using SDL_GetTicks() */
|
||||||
Uint32 windowID; /**< The window with mouse focus, if any */
|
Uint32 windowID; /**< The window with mouse focus, if any */
|
||||||
Uint32 which; /**< The mouse instance id, or SDL_TOUCH_MOUSEID */
|
Uint32 which; /**< The mouse instance id, or SDL_TOUCH_MOUSEID */
|
||||||
@@ -345,11 +323,11 @@ typedef struct SDL_MouseWheelEvent
|
|||||||
} SDL_MouseWheelEvent;
|
} SDL_MouseWheelEvent;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Joystick axis motion event structure (event.jaxis.*)
|
* \brief Joystick axis motion event structure (event.jaxis.*)
|
||||||
*/
|
*/
|
||||||
typedef struct SDL_JoyAxisEvent
|
typedef struct SDL_JoyAxisEvent
|
||||||
{
|
{
|
||||||
Uint32 type; /**< SDL_JOYAXISMOTION */
|
Uint32 type; /**< ::SDL_JOYAXISMOTION */
|
||||||
Uint32 timestamp; /**< In milliseconds, populated using SDL_GetTicks() */
|
Uint32 timestamp; /**< In milliseconds, populated using SDL_GetTicks() */
|
||||||
SDL_JoystickID which; /**< The joystick instance id */
|
SDL_JoystickID which; /**< The joystick instance id */
|
||||||
Uint8 axis; /**< The joystick axis index */
|
Uint8 axis; /**< The joystick axis index */
|
||||||
@@ -361,11 +339,11 @@ typedef struct SDL_JoyAxisEvent
|
|||||||
} SDL_JoyAxisEvent;
|
} SDL_JoyAxisEvent;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Joystick trackball motion event structure (event.jball.*)
|
* \brief Joystick trackball motion event structure (event.jball.*)
|
||||||
*/
|
*/
|
||||||
typedef struct SDL_JoyBallEvent
|
typedef struct SDL_JoyBallEvent
|
||||||
{
|
{
|
||||||
Uint32 type; /**< SDL_JOYBALLMOTION */
|
Uint32 type; /**< ::SDL_JOYBALLMOTION */
|
||||||
Uint32 timestamp; /**< In milliseconds, populated using SDL_GetTicks() */
|
Uint32 timestamp; /**< In milliseconds, populated using SDL_GetTicks() */
|
||||||
SDL_JoystickID which; /**< The joystick instance id */
|
SDL_JoystickID which; /**< The joystick instance id */
|
||||||
Uint8 ball; /**< The joystick trackball index */
|
Uint8 ball; /**< The joystick trackball index */
|
||||||
@@ -377,18 +355,18 @@ typedef struct SDL_JoyBallEvent
|
|||||||
} SDL_JoyBallEvent;
|
} SDL_JoyBallEvent;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Joystick hat position change event structure (event.jhat.*)
|
* \brief Joystick hat position change event structure (event.jhat.*)
|
||||||
*/
|
*/
|
||||||
typedef struct SDL_JoyHatEvent
|
typedef struct SDL_JoyHatEvent
|
||||||
{
|
{
|
||||||
Uint32 type; /**< SDL_JOYHATMOTION */
|
Uint32 type; /**< ::SDL_JOYHATMOTION */
|
||||||
Uint32 timestamp; /**< In milliseconds, populated using SDL_GetTicks() */
|
Uint32 timestamp; /**< In milliseconds, populated using SDL_GetTicks() */
|
||||||
SDL_JoystickID which; /**< The joystick instance id */
|
SDL_JoystickID which; /**< The joystick instance id */
|
||||||
Uint8 hat; /**< The joystick hat index */
|
Uint8 hat; /**< The joystick hat index */
|
||||||
Uint8 value; /**< The hat position value.
|
Uint8 value; /**< The hat position value.
|
||||||
* \sa SDL_HAT_LEFTUP SDL_HAT_UP SDL_HAT_RIGHTUP
|
* \sa ::SDL_HAT_LEFTUP ::SDL_HAT_UP ::SDL_HAT_RIGHTUP
|
||||||
* \sa SDL_HAT_LEFT SDL_HAT_CENTERED SDL_HAT_RIGHT
|
* \sa ::SDL_HAT_LEFT ::SDL_HAT_CENTERED ::SDL_HAT_RIGHT
|
||||||
* \sa SDL_HAT_LEFTDOWN SDL_HAT_DOWN SDL_HAT_RIGHTDOWN
|
* \sa ::SDL_HAT_LEFTDOWN ::SDL_HAT_DOWN ::SDL_HAT_RIGHTDOWN
|
||||||
*
|
*
|
||||||
* Note that zero means the POV is centered.
|
* Note that zero means the POV is centered.
|
||||||
*/
|
*/
|
||||||
@@ -397,51 +375,46 @@ typedef struct SDL_JoyHatEvent
|
|||||||
} SDL_JoyHatEvent;
|
} SDL_JoyHatEvent;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Joystick button event structure (event.jbutton.*)
|
* \brief Joystick button event structure (event.jbutton.*)
|
||||||
*/
|
*/
|
||||||
typedef struct SDL_JoyButtonEvent
|
typedef struct SDL_JoyButtonEvent
|
||||||
{
|
{
|
||||||
Uint32 type; /**< SDL_JOYBUTTONDOWN or SDL_JOYBUTTONUP */
|
Uint32 type; /**< ::SDL_JOYBUTTONDOWN or ::SDL_JOYBUTTONUP */
|
||||||
Uint32 timestamp; /**< In milliseconds, populated using SDL_GetTicks() */
|
Uint32 timestamp; /**< In milliseconds, populated using SDL_GetTicks() */
|
||||||
SDL_JoystickID which; /**< The joystick instance id */
|
SDL_JoystickID which; /**< The joystick instance id */
|
||||||
Uint8 button; /**< The joystick button index */
|
Uint8 button; /**< The joystick button index */
|
||||||
Uint8 state; /**< SDL_PRESSED or SDL_RELEASED */
|
Uint8 state; /**< ::SDL_PRESSED or ::SDL_RELEASED */
|
||||||
Uint8 padding1;
|
Uint8 padding1;
|
||||||
Uint8 padding2;
|
Uint8 padding2;
|
||||||
} SDL_JoyButtonEvent;
|
} SDL_JoyButtonEvent;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Joystick device event structure (event.jdevice.*)
|
* \brief Joystick device event structure (event.jdevice.*)
|
||||||
*
|
|
||||||
* SDL will send JOYSTICK_ADDED events for devices that are already plugged in
|
|
||||||
* during SDL_Init.
|
|
||||||
*
|
|
||||||
* \sa SDL_ControllerDeviceEvent
|
|
||||||
*/
|
*/
|
||||||
typedef struct SDL_JoyDeviceEvent
|
typedef struct SDL_JoyDeviceEvent
|
||||||
{
|
{
|
||||||
Uint32 type; /**< SDL_JOYDEVICEADDED or SDL_JOYDEVICEREMOVED */
|
Uint32 type; /**< ::SDL_JOYDEVICEADDED or ::SDL_JOYDEVICEREMOVED */
|
||||||
Uint32 timestamp; /**< In milliseconds, populated using SDL_GetTicks() */
|
Uint32 timestamp; /**< In milliseconds, populated using SDL_GetTicks() */
|
||||||
Sint32 which; /**< The joystick device index for the ADDED event, instance id for the REMOVED event */
|
Sint32 which; /**< The joystick device index for the ADDED event, instance id for the REMOVED event */
|
||||||
} SDL_JoyDeviceEvent;
|
} SDL_JoyDeviceEvent;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Joysick battery level change event structure (event.jbattery.*)
|
* \brief Joysick battery level change event structure (event.jbattery.*)
|
||||||
*/
|
*/
|
||||||
typedef struct SDL_JoyBatteryEvent
|
typedef struct SDL_JoyBatteryEvent
|
||||||
{
|
{
|
||||||
Uint32 type; /**< SDL_JOYBATTERYUPDATED */
|
Uint32 type; /**< ::SDL_JOYBATTERYUPDATED */
|
||||||
Uint32 timestamp; /**< In milliseconds, populated using SDL_GetTicks() */
|
Uint32 timestamp; /**< In milliseconds, populated using SDL_GetTicks() */
|
||||||
SDL_JoystickID which; /**< The joystick instance id */
|
SDL_JoystickID which; /**< The joystick instance id */
|
||||||
SDL_JoystickPowerLevel level; /**< The joystick battery level */
|
SDL_JoystickPowerLevel level; /**< The joystick battery level */
|
||||||
} SDL_JoyBatteryEvent;
|
} SDL_JoyBatteryEvent;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Game controller axis motion event structure (event.caxis.*)
|
* \brief Game controller axis motion event structure (event.caxis.*)
|
||||||
*/
|
*/
|
||||||
typedef struct SDL_ControllerAxisEvent
|
typedef struct SDL_ControllerAxisEvent
|
||||||
{
|
{
|
||||||
Uint32 type; /**< SDL_CONTROLLERAXISMOTION */
|
Uint32 type; /**< ::SDL_CONTROLLERAXISMOTION */
|
||||||
Uint32 timestamp; /**< In milliseconds, populated using SDL_GetTicks() */
|
Uint32 timestamp; /**< In milliseconds, populated using SDL_GetTicks() */
|
||||||
SDL_JoystickID which; /**< The joystick instance id */
|
SDL_JoystickID which; /**< The joystick instance id */
|
||||||
Uint8 axis; /**< The controller axis (SDL_GameControllerAxis) */
|
Uint8 axis; /**< The controller axis (SDL_GameControllerAxis) */
|
||||||
@@ -454,42 +427,36 @@ typedef struct SDL_ControllerAxisEvent
|
|||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Game controller button event structure (event.cbutton.*)
|
* \brief Game controller button event structure (event.cbutton.*)
|
||||||
*/
|
*/
|
||||||
typedef struct SDL_ControllerButtonEvent
|
typedef struct SDL_ControllerButtonEvent
|
||||||
{
|
{
|
||||||
Uint32 type; /**< SDL_CONTROLLERBUTTONDOWN or SDL_CONTROLLERBUTTONUP */
|
Uint32 type; /**< ::SDL_CONTROLLERBUTTONDOWN or ::SDL_CONTROLLERBUTTONUP */
|
||||||
Uint32 timestamp; /**< In milliseconds, populated using SDL_GetTicks() */
|
Uint32 timestamp; /**< In milliseconds, populated using SDL_GetTicks() */
|
||||||
SDL_JoystickID which; /**< The joystick instance id */
|
SDL_JoystickID which; /**< The joystick instance id */
|
||||||
Uint8 button; /**< The controller button (SDL_GameControllerButton) */
|
Uint8 button; /**< The controller button (SDL_GameControllerButton) */
|
||||||
Uint8 state; /**< SDL_PRESSED or SDL_RELEASED */
|
Uint8 state; /**< ::SDL_PRESSED or ::SDL_RELEASED */
|
||||||
Uint8 padding1;
|
Uint8 padding1;
|
||||||
Uint8 padding2;
|
Uint8 padding2;
|
||||||
} SDL_ControllerButtonEvent;
|
} SDL_ControllerButtonEvent;
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Controller device event structure (event.cdevice.*)
|
* \brief Controller device event structure (event.cdevice.*)
|
||||||
*
|
|
||||||
* Joysticks that are supported game controllers receive both an
|
|
||||||
* SDL_JoyDeviceEvent and an SDL_ControllerDeviceEvent.
|
|
||||||
*
|
|
||||||
* SDL will send CONTROLLERDEVICEADDED events for joysticks that are already
|
|
||||||
* plugged in during SDL_Init() and are recognized as game controllers.
|
|
||||||
*/
|
*/
|
||||||
typedef struct SDL_ControllerDeviceEvent
|
typedef struct SDL_ControllerDeviceEvent
|
||||||
{
|
{
|
||||||
Uint32 type; /**< SDL_CONTROLLERDEVICEADDED, SDL_CONTROLLERDEVICEREMOVED, SDL_CONTROLLERDEVICEREMAPPED, or SDL_CONTROLLERSTEAMHANDLEUPDATED */
|
Uint32 type; /**< ::SDL_CONTROLLERDEVICEADDED, ::SDL_CONTROLLERDEVICEREMOVED, or ::SDL_CONTROLLERDEVICEREMAPPED */
|
||||||
Uint32 timestamp; /**< In milliseconds, populated using SDL_GetTicks() */
|
Uint32 timestamp; /**< In milliseconds, populated using SDL_GetTicks() */
|
||||||
Sint32 which; /**< The joystick device index for the ADDED event, instance id for the REMOVED or REMAPPED event */
|
Sint32 which; /**< The joystick device index for the ADDED event, instance id for the REMOVED or REMAPPED event */
|
||||||
} SDL_ControllerDeviceEvent;
|
} SDL_ControllerDeviceEvent;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Game controller touchpad event structure (event.ctouchpad.*)
|
* \brief Game controller touchpad event structure (event.ctouchpad.*)
|
||||||
*/
|
*/
|
||||||
typedef struct SDL_ControllerTouchpadEvent
|
typedef struct SDL_ControllerTouchpadEvent
|
||||||
{
|
{
|
||||||
Uint32 type; /**< SDL_CONTROLLERTOUCHPADDOWN or SDL_CONTROLLERTOUCHPADMOTION or SDL_CONTROLLERTOUCHPADUP */
|
Uint32 type; /**< ::SDL_CONTROLLERTOUCHPADDOWN or ::SDL_CONTROLLERTOUCHPADMOTION or ::SDL_CONTROLLERTOUCHPADUP */
|
||||||
Uint32 timestamp; /**< In milliseconds, populated using SDL_GetTicks() */
|
Uint32 timestamp; /**< In milliseconds, populated using SDL_GetTicks() */
|
||||||
SDL_JoystickID which; /**< The joystick instance id */
|
SDL_JoystickID which; /**< The joystick instance id */
|
||||||
Sint32 touchpad; /**< The index of the touchpad */
|
Sint32 touchpad; /**< The index of the touchpad */
|
||||||
@@ -500,24 +467,24 @@ typedef struct SDL_ControllerTouchpadEvent
|
|||||||
} SDL_ControllerTouchpadEvent;
|
} SDL_ControllerTouchpadEvent;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Game controller sensor event structure (event.csensor.*)
|
* \brief Game controller sensor event structure (event.csensor.*)
|
||||||
*/
|
*/
|
||||||
typedef struct SDL_ControllerSensorEvent
|
typedef struct SDL_ControllerSensorEvent
|
||||||
{
|
{
|
||||||
Uint32 type; /**< SDL_CONTROLLERSENSORUPDATE */
|
Uint32 type; /**< ::SDL_CONTROLLERSENSORUPDATE */
|
||||||
Uint32 timestamp; /**< In milliseconds, populated using SDL_GetTicks() */
|
Uint32 timestamp; /**< In milliseconds, populated using SDL_GetTicks() */
|
||||||
SDL_JoystickID which; /**< The joystick instance id */
|
SDL_JoystickID which; /**< The joystick instance id */
|
||||||
Sint32 sensor; /**< The type of the sensor, one of the values of SDL_SensorType */
|
Sint32 sensor; /**< The type of the sensor, one of the values of ::SDL_SensorType */
|
||||||
float data[3]; /**< Up to 3 values from the sensor, as defined in SDL_sensor.h */
|
float data[3]; /**< Up to 3 values from the sensor, as defined in SDL_sensor.h */
|
||||||
Uint64 timestamp_us; /**< The timestamp of the sensor reading in microseconds, if the hardware provides this information. */
|
Uint64 timestamp_us; /**< The timestamp of the sensor reading in microseconds, if the hardware provides this information. */
|
||||||
} SDL_ControllerSensorEvent;
|
} SDL_ControllerSensorEvent;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Audio device event structure (event.adevice.*)
|
* \brief Audio device event structure (event.adevice.*)
|
||||||
*/
|
*/
|
||||||
typedef struct SDL_AudioDeviceEvent
|
typedef struct SDL_AudioDeviceEvent
|
||||||
{
|
{
|
||||||
Uint32 type; /**< SDL_AUDIODEVICEADDED, or SDL_AUDIODEVICEREMOVED */
|
Uint32 type; /**< ::SDL_AUDIODEVICEADDED, or ::SDL_AUDIODEVICEREMOVED */
|
||||||
Uint32 timestamp; /**< In milliseconds, populated using SDL_GetTicks() */
|
Uint32 timestamp; /**< In milliseconds, populated using SDL_GetTicks() */
|
||||||
Uint32 which; /**< The audio device index for the ADDED event (valid until next SDL_GetNumAudioDevices() call), SDL_AudioDeviceID for the REMOVED event */
|
Uint32 which; /**< The audio device index for the ADDED event (valid until next SDL_GetNumAudioDevices() call), SDL_AudioDeviceID for the REMOVED event */
|
||||||
Uint8 iscapture; /**< zero if an output device, non-zero if a capture device. */
|
Uint8 iscapture; /**< zero if an output device, non-zero if a capture device. */
|
||||||
@@ -528,11 +495,11 @@ typedef struct SDL_AudioDeviceEvent
|
|||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Touch finger event structure (event.tfinger.*)
|
* \brief Touch finger event structure (event.tfinger.*)
|
||||||
*/
|
*/
|
||||||
typedef struct SDL_TouchFingerEvent
|
typedef struct SDL_TouchFingerEvent
|
||||||
{
|
{
|
||||||
Uint32 type; /**< SDL_FINGERMOTION or SDL_FINGERDOWN or SDL_FINGERUP */
|
Uint32 type; /**< ::SDL_FINGERMOTION or ::SDL_FINGERDOWN or ::SDL_FINGERUP */
|
||||||
Uint32 timestamp; /**< In milliseconds, populated using SDL_GetTicks() */
|
Uint32 timestamp; /**< In milliseconds, populated using SDL_GetTicks() */
|
||||||
SDL_TouchID touchId; /**< The touch device id */
|
SDL_TouchID touchId; /**< The touch device id */
|
||||||
SDL_FingerID fingerId;
|
SDL_FingerID fingerId;
|
||||||
@@ -546,11 +513,11 @@ typedef struct SDL_TouchFingerEvent
|
|||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Multiple Finger Gesture Event (event.mgesture.*)
|
* \brief Multiple Finger Gesture Event (event.mgesture.*)
|
||||||
*/
|
*/
|
||||||
typedef struct SDL_MultiGestureEvent
|
typedef struct SDL_MultiGestureEvent
|
||||||
{
|
{
|
||||||
Uint32 type; /**< SDL_MULTIGESTURE */
|
Uint32 type; /**< ::SDL_MULTIGESTURE */
|
||||||
Uint32 timestamp; /**< In milliseconds, populated using SDL_GetTicks() */
|
Uint32 timestamp; /**< In milliseconds, populated using SDL_GetTicks() */
|
||||||
SDL_TouchID touchId; /**< The touch device id */
|
SDL_TouchID touchId; /**< The touch device id */
|
||||||
float dTheta;
|
float dTheta;
|
||||||
@@ -563,11 +530,11 @@ typedef struct SDL_MultiGestureEvent
|
|||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Dollar Gesture Event (event.dgesture.*)
|
* \brief Dollar Gesture Event (event.dgesture.*)
|
||||||
*/
|
*/
|
||||||
typedef struct SDL_DollarGestureEvent
|
typedef struct SDL_DollarGestureEvent
|
||||||
{
|
{
|
||||||
Uint32 type; /**< SDL_DOLLARGESTURE or SDL_DOLLARRECORD */
|
Uint32 type; /**< ::SDL_DOLLARGESTURE or ::SDL_DOLLARRECORD */
|
||||||
Uint32 timestamp; /**< In milliseconds, populated using SDL_GetTicks() */
|
Uint32 timestamp; /**< In milliseconds, populated using SDL_GetTicks() */
|
||||||
SDL_TouchID touchId; /**< The touch device id */
|
SDL_TouchID touchId; /**< The touch device id */
|
||||||
SDL_GestureID gestureId;
|
SDL_GestureID gestureId;
|
||||||
@@ -579,15 +546,13 @@ typedef struct SDL_DollarGestureEvent
|
|||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* An event used to request a file open by the system (event.drop.*)
|
* \brief An event used to request a file open by the system (event.drop.*)
|
||||||
*
|
* This event is enabled by default, you can disable it with SDL_EventState().
|
||||||
* This event is enabled by default, you can disable it with SDL_EventState().
|
* \note If this event is enabled, you must free the filename in the event.
|
||||||
*
|
|
||||||
* If this event is enabled, you must free the filename in the event.
|
|
||||||
*/
|
*/
|
||||||
typedef struct SDL_DropEvent
|
typedef struct SDL_DropEvent
|
||||||
{
|
{
|
||||||
Uint32 type; /**< SDL_DROPBEGIN or SDL_DROPFILE or SDL_DROPTEXT or SDL_DROPCOMPLETE */
|
Uint32 type; /**< ::SDL_DROPBEGIN or ::SDL_DROPFILE or ::SDL_DROPTEXT or ::SDL_DROPCOMPLETE */
|
||||||
Uint32 timestamp; /**< In milliseconds, populated using SDL_GetTicks() */
|
Uint32 timestamp; /**< In milliseconds, populated using SDL_GetTicks() */
|
||||||
char *file; /**< The file name, which should be freed with SDL_free(), is NULL on begin/complete */
|
char *file; /**< The file name, which should be freed with SDL_free(), is NULL on begin/complete */
|
||||||
Uint32 windowID; /**< The window that was dropped on, if any */
|
Uint32 windowID; /**< The window that was dropped on, if any */
|
||||||
@@ -595,11 +560,11 @@ typedef struct SDL_DropEvent
|
|||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Sensor event structure (event.sensor.*)
|
* \brief Sensor event structure (event.sensor.*)
|
||||||
*/
|
*/
|
||||||
typedef struct SDL_SensorEvent
|
typedef struct SDL_SensorEvent
|
||||||
{
|
{
|
||||||
Uint32 type; /**< SDL_SENSORUPDATE */
|
Uint32 type; /**< ::SDL_SENSORUPDATE */
|
||||||
Uint32 timestamp; /**< In milliseconds, populated using SDL_GetTicks() */
|
Uint32 timestamp; /**< In milliseconds, populated using SDL_GetTicks() */
|
||||||
Sint32 which; /**< The instance ID of the sensor */
|
Sint32 which; /**< The instance ID of the sensor */
|
||||||
float data[6]; /**< Up to 6 values from the sensor - additional values can be queried using SDL_SensorGetData() */
|
float data[6]; /**< Up to 6 values from the sensor - additional values can be queried using SDL_SensorGetData() */
|
||||||
@@ -607,20 +572,29 @@ typedef struct SDL_SensorEvent
|
|||||||
} SDL_SensorEvent;
|
} SDL_SensorEvent;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The "quit requested" event
|
* \brief The "quit requested" event
|
||||||
*/
|
*/
|
||||||
typedef struct SDL_QuitEvent
|
typedef struct SDL_QuitEvent
|
||||||
{
|
{
|
||||||
Uint32 type; /**< SDL_QUIT */
|
Uint32 type; /**< ::SDL_QUIT */
|
||||||
Uint32 timestamp; /**< In milliseconds, populated using SDL_GetTicks() */
|
Uint32 timestamp; /**< In milliseconds, populated using SDL_GetTicks() */
|
||||||
} SDL_QuitEvent;
|
} SDL_QuitEvent;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* A user-defined event type (event.user.*)
|
* \brief OS Specific event
|
||||||
|
*/
|
||||||
|
typedef struct SDL_OSEvent
|
||||||
|
{
|
||||||
|
Uint32 type; /**< ::SDL_QUIT */
|
||||||
|
Uint32 timestamp; /**< In milliseconds, populated using SDL_GetTicks() */
|
||||||
|
} SDL_OSEvent;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* \brief A user-defined event type (event.user.*)
|
||||||
*/
|
*/
|
||||||
typedef struct SDL_UserEvent
|
typedef struct SDL_UserEvent
|
||||||
{
|
{
|
||||||
Uint32 type; /**< SDL_USEREVENT through SDL_LASTEVENT-1 */
|
Uint32 type; /**< ::SDL_USEREVENT through ::SDL_LASTEVENT-1 */
|
||||||
Uint32 timestamp; /**< In milliseconds, populated using SDL_GetTicks() */
|
Uint32 timestamp; /**< In milliseconds, populated using SDL_GetTicks() */
|
||||||
Uint32 windowID; /**< The associated window if any */
|
Uint32 windowID; /**< The associated window if any */
|
||||||
Sint32 code; /**< User defined event code */
|
Sint32 code; /**< User defined event code */
|
||||||
@@ -633,24 +607,20 @@ struct SDL_SysWMmsg;
|
|||||||
typedef struct SDL_SysWMmsg SDL_SysWMmsg;
|
typedef struct SDL_SysWMmsg SDL_SysWMmsg;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* A video driver dependent system event (event.syswm.*)
|
* \brief A video driver dependent system event (event.syswm.*)
|
||||||
|
* This event is disabled by default, you can enable it with SDL_EventState()
|
||||||
*
|
*
|
||||||
* This event is disabled by default, you can enable it with SDL_EventState()
|
* \note If you want to use this event, you should include SDL_syswm.h.
|
||||||
*
|
|
||||||
* If you want to use this event, you should include SDL_syswm.h.
|
|
||||||
*/
|
*/
|
||||||
typedef struct SDL_SysWMEvent
|
typedef struct SDL_SysWMEvent
|
||||||
{
|
{
|
||||||
Uint32 type; /**< SDL_SYSWMEVENT */
|
Uint32 type; /**< ::SDL_SYSWMEVENT */
|
||||||
Uint32 timestamp; /**< In milliseconds, populated using SDL_GetTicks() */
|
Uint32 timestamp; /**< In milliseconds, populated using SDL_GetTicks() */
|
||||||
SDL_SysWMmsg *msg; /**< driver dependent data, defined in SDL_syswm.h */
|
SDL_SysWMmsg *msg; /**< driver dependent data, defined in SDL_syswm.h */
|
||||||
} SDL_SysWMEvent;
|
} SDL_SysWMEvent;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* General event structure
|
* \brief General event structure
|
||||||
*
|
|
||||||
* The SDL_Event structure is the core of all event handling in SDL. SDL_Event
|
|
||||||
* is a union of all event structures used in SDL.
|
|
||||||
*/
|
*/
|
||||||
typedef union SDL_Event
|
typedef union SDL_Event
|
||||||
{
|
{
|
||||||
@@ -733,7 +703,7 @@ SDL_COMPILE_TIME_ASSERT(SDL_Event, sizeof(SDL_Event) == sizeof(((SDL_Event *)NUL
|
|||||||
extern DECLSPEC void SDLCALL SDL_PumpEvents(void);
|
extern DECLSPEC void SDLCALL SDL_PumpEvents(void);
|
||||||
|
|
||||||
/* @{ */
|
/* @{ */
|
||||||
typedef enum SDL_eventaction
|
typedef enum
|
||||||
{
|
{
|
||||||
SDL_ADDEVENT,
|
SDL_ADDEVENT,
|
||||||
SDL_PEEKEVENT,
|
SDL_PEEKEVENT,
|
||||||
@@ -760,15 +730,15 @@ typedef enum SDL_eventaction
|
|||||||
*
|
*
|
||||||
* This function is thread-safe.
|
* This function is thread-safe.
|
||||||
*
|
*
|
||||||
* \param events destination buffer for the retrieved events.
|
* \param events destination buffer for the retrieved events
|
||||||
* \param numevents if action is SDL_ADDEVENT, the number of events to add
|
* \param numevents if action is SDL_ADDEVENT, the number of events to add
|
||||||
* back to the event queue; if action is SDL_PEEKEVENT or
|
* back to the event queue; if action is SDL_PEEKEVENT or
|
||||||
* SDL_GETEVENT, the maximum number of events to retrieve.
|
* SDL_GETEVENT, the maximum number of events to retrieve
|
||||||
* \param action action to take; see [[#action|Remarks]] for details.
|
* \param action action to take; see [[#action|Remarks]] for details
|
||||||
* \param minType minimum value of the event type to be considered;
|
* \param minType minimum value of the event type to be considered;
|
||||||
* SDL_FIRSTEVENT is a safe choice.
|
* SDL_FIRSTEVENT is a safe choice
|
||||||
* \param maxType maximum value of the event type to be considered;
|
* \param maxType maximum value of the event type to be considered;
|
||||||
* SDL_LASTEVENT is a safe choice.
|
* SDL_LASTEVENT is a safe choice
|
||||||
* \returns the number of events actually stored or a negative error code on
|
* \returns the number of events actually stored or a negative error code on
|
||||||
* failure; call SDL_GetError() for more information.
|
* failure; call SDL_GetError() for more information.
|
||||||
*
|
*
|
||||||
@@ -789,7 +759,7 @@ extern DECLSPEC int SDLCALL SDL_PeepEvents(SDL_Event * events, int numevents,
|
|||||||
* If you need to check for a range of event types, use SDL_HasEvents()
|
* If you need to check for a range of event types, use SDL_HasEvents()
|
||||||
* instead.
|
* instead.
|
||||||
*
|
*
|
||||||
* \param type the type of event to be queried; see SDL_EventType for details.
|
* \param type the type of event to be queried; see SDL_EventType for details
|
||||||
* \returns SDL_TRUE if events matching `type` are present, or SDL_FALSE if
|
* \returns SDL_TRUE if events matching `type` are present, or SDL_FALSE if
|
||||||
* events matching `type` are not present.
|
* events matching `type` are not present.
|
||||||
*
|
*
|
||||||
@@ -806,9 +776,9 @@ extern DECLSPEC SDL_bool SDLCALL SDL_HasEvent(Uint32 type);
|
|||||||
* If you need to check for a single event type, use SDL_HasEvent() instead.
|
* If you need to check for a single event type, use SDL_HasEvent() instead.
|
||||||
*
|
*
|
||||||
* \param minType the low end of event type to be queried, inclusive; see
|
* \param minType the low end of event type to be queried, inclusive; see
|
||||||
* SDL_EventType for details.
|
* SDL_EventType for details
|
||||||
* \param maxType the high end of event type to be queried, inclusive; see
|
* \param maxType the high end of event type to be queried, inclusive; see
|
||||||
* SDL_EventType for details.
|
* SDL_EventType for details
|
||||||
* \returns SDL_TRUE if events with type >= `minType` and <= `maxType` are
|
* \returns SDL_TRUE if events with type >= `minType` and <= `maxType` are
|
||||||
* present, or SDL_FALSE if not.
|
* present, or SDL_FALSE if not.
|
||||||
*
|
*
|
||||||
@@ -832,7 +802,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_HasEvents(Uint32 minType, Uint32 maxType);
|
|||||||
* sure that all pending OS events are flushed, you can call SDL_PumpEvents()
|
* sure that all pending OS events are flushed, you can call SDL_PumpEvents()
|
||||||
* on the main thread immediately before the flush call.
|
* on the main thread immediately before the flush call.
|
||||||
*
|
*
|
||||||
* \param type the type of event to be cleared; see SDL_EventType for details.
|
* \param type the type of event to be cleared; see SDL_EventType for details
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.0.
|
* \since This function is available since SDL 2.0.0.
|
||||||
*
|
*
|
||||||
@@ -855,9 +825,9 @@ extern DECLSPEC void SDLCALL SDL_FlushEvent(Uint32 type);
|
|||||||
* on the main thread immediately before the flush call.
|
* on the main thread immediately before the flush call.
|
||||||
*
|
*
|
||||||
* \param minType the low end of event type to be cleared, inclusive; see
|
* \param minType the low end of event type to be cleared, inclusive; see
|
||||||
* SDL_EventType for details.
|
* SDL_EventType for details
|
||||||
* \param maxType the high end of event type to be cleared, inclusive; see
|
* \param maxType the high end of event type to be cleared, inclusive; see
|
||||||
* SDL_EventType for details.
|
* SDL_EventType for details
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.0.
|
* \since This function is available since SDL 2.0.0.
|
||||||
*
|
*
|
||||||
@@ -898,7 +868,7 @@ extern DECLSPEC void SDLCALL SDL_FlushEvents(Uint32 minType, Uint32 maxType);
|
|||||||
* ```
|
* ```
|
||||||
*
|
*
|
||||||
* \param event the SDL_Event structure to be filled with the next event from
|
* \param event the SDL_Event structure to be filled with the next event from
|
||||||
* the queue, or NULL.
|
* the queue, or NULL
|
||||||
* \returns 1 if there is a pending event or 0 if there are none available.
|
* \returns 1 if there is a pending event or 0 if there are none available.
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.0.
|
* \since This function is available since SDL 2.0.0.
|
||||||
@@ -922,7 +892,7 @@ extern DECLSPEC int SDLCALL SDL_PollEvent(SDL_Event * event);
|
|||||||
* this function in the thread that initialized the video subsystem.
|
* this function in the thread that initialized the video subsystem.
|
||||||
*
|
*
|
||||||
* \param event the SDL_Event structure to be filled in with the next event
|
* \param event the SDL_Event structure to be filled in with the next event
|
||||||
* from the queue, or NULL.
|
* from the queue, or NULL
|
||||||
* \returns 1 on success or 0 if there was an error while waiting for events;
|
* \returns 1 on success or 0 if there was an error while waiting for events;
|
||||||
* call SDL_GetError() for more information.
|
* call SDL_GetError() for more information.
|
||||||
*
|
*
|
||||||
@@ -945,9 +915,9 @@ extern DECLSPEC int SDLCALL SDL_WaitEvent(SDL_Event * event);
|
|||||||
* this function in the thread that initialized the video subsystem.
|
* this function in the thread that initialized the video subsystem.
|
||||||
*
|
*
|
||||||
* \param event the SDL_Event structure to be filled in with the next event
|
* \param event the SDL_Event structure to be filled in with the next event
|
||||||
* from the queue, or NULL.
|
* from the queue, or NULL
|
||||||
* \param timeout the maximum number of milliseconds to wait for the next
|
* \param timeout the maximum number of milliseconds to wait for the next
|
||||||
* available event.
|
* available event
|
||||||
* \returns 1 on success or 0 if there was an error while waiting for events;
|
* \returns 1 on success or 0 if there was an error while waiting for events;
|
||||||
* call SDL_GetError() for more information. This also returns 0 if
|
* call SDL_GetError() for more information. This also returns 0 if
|
||||||
* the timeout elapsed without an event arriving.
|
* the timeout elapsed without an event arriving.
|
||||||
@@ -982,7 +952,7 @@ extern DECLSPEC int SDLCALL SDL_WaitEventTimeout(SDL_Event * event,
|
|||||||
* get an event type that does not conflict with other code that also wants
|
* get an event type that does not conflict with other code that also wants
|
||||||
* its own custom event types.
|
* its own custom event types.
|
||||||
*
|
*
|
||||||
* \param event the SDL_Event to be added to the queue.
|
* \param event the SDL_Event to be added to the queue
|
||||||
* \returns 1 on success, 0 if the event was filtered, or a negative error
|
* \returns 1 on success, 0 if the event was filtered, or a negative error
|
||||||
* code on failure; call SDL_GetError() for more information. A
|
* code on failure; call SDL_GetError() for more information. A
|
||||||
* common reason for error is the event queue being full.
|
* common reason for error is the event queue being full.
|
||||||
@@ -998,11 +968,11 @@ extern DECLSPEC int SDLCALL SDL_PushEvent(SDL_Event * event);
|
|||||||
/**
|
/**
|
||||||
* A function pointer used for callbacks that watch the event queue.
|
* A function pointer used for callbacks that watch the event queue.
|
||||||
*
|
*
|
||||||
* \param userdata what was passed as `userdata` to SDL_SetEventFilter() or
|
* \param userdata what was passed as `userdata` to SDL_SetEventFilter()
|
||||||
* SDL_AddEventWatch, etc.
|
* or SDL_AddEventWatch, etc
|
||||||
* \param event the event that triggered the callback.
|
* \param event the event that triggered the callback
|
||||||
* \returns 1 to permit event to be added to the queue, and 0 to disallow it.
|
* \returns 1 to permit event to be added to the queue, and 0 to disallow
|
||||||
* When used with SDL_AddEventWatch, the return value is ignored.
|
* it. When used with SDL_AddEventWatch, the return value is ignored.
|
||||||
*
|
*
|
||||||
* \sa SDL_SetEventFilter
|
* \sa SDL_SetEventFilter
|
||||||
* \sa SDL_AddEventWatch
|
* \sa SDL_AddEventWatch
|
||||||
@@ -1025,7 +995,7 @@ typedef int (SDLCALL * SDL_EventFilter) (void *userdata, SDL_Event * event);
|
|||||||
* interrupt signal (e.g. pressing Ctrl-C), it will be delivered to the
|
* interrupt signal (e.g. pressing Ctrl-C), it will be delivered to the
|
||||||
* application at the next event poll.
|
* application at the next event poll.
|
||||||
*
|
*
|
||||||
* There is one caveat when dealing with the SDL_QuitEvent event type. The
|
* There is one caveat when dealing with the ::SDL_QuitEvent event type. The
|
||||||
* event filter is only called when the window manager desires to close the
|
* event filter is only called when the window manager desires to close the
|
||||||
* application window. If the event filter returns 1, then the window will be
|
* application window. If the event filter returns 1, then the window will be
|
||||||
* closed, otherwise the window will remain open if possible.
|
* closed, otherwise the window will remain open if possible.
|
||||||
@@ -1040,8 +1010,8 @@ typedef int (SDLCALL * SDL_EventFilter) (void *userdata, SDL_Event * event);
|
|||||||
* the event filter, but events pushed onto the queue with SDL_PeepEvents() do
|
* the event filter, but events pushed onto the queue with SDL_PeepEvents() do
|
||||||
* not.
|
* not.
|
||||||
*
|
*
|
||||||
* \param filter An SDL_EventFilter function to call when an event happens.
|
* \param filter An SDL_EventFilter function to call when an event happens
|
||||||
* \param userdata a pointer that is passed to `filter`.
|
* \param userdata a pointer that is passed to `filter`
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.0.
|
* \since This function is available since SDL 2.0.0.
|
||||||
*
|
*
|
||||||
@@ -1060,9 +1030,9 @@ extern DECLSPEC void SDLCALL SDL_SetEventFilter(SDL_EventFilter filter,
|
|||||||
* This function can be used to "chain" filters, by saving the existing filter
|
* This function can be used to "chain" filters, by saving the existing filter
|
||||||
* before replacing it with a function that will call that saved filter.
|
* before replacing it with a function that will call that saved filter.
|
||||||
*
|
*
|
||||||
* \param filter the current callback function will be stored here.
|
* \param filter the current callback function will be stored here
|
||||||
* \param userdata the pointer that is passed to the current event filter will
|
* \param userdata the pointer that is passed to the current event filter will
|
||||||
* be stored here.
|
* be stored here
|
||||||
* \returns SDL_TRUE on success or SDL_FALSE if there is no event filter set.
|
* \returns SDL_TRUE on success or SDL_FALSE if there is no event filter set.
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.0.
|
* \since This function is available since SDL 2.0.0.
|
||||||
@@ -1091,7 +1061,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_GetEventFilter(SDL_EventFilter * filter,
|
|||||||
* through SDL_PeepEvents().
|
* through SDL_PeepEvents().
|
||||||
*
|
*
|
||||||
* \param filter an SDL_EventFilter function to call when an event happens.
|
* \param filter an SDL_EventFilter function to call when an event happens.
|
||||||
* \param userdata a pointer that is passed to `filter`.
|
* \param userdata a pointer that is passed to `filter`
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.0.
|
* \since This function is available since SDL 2.0.0.
|
||||||
*
|
*
|
||||||
@@ -1107,8 +1077,8 @@ extern DECLSPEC void SDLCALL SDL_AddEventWatch(SDL_EventFilter filter,
|
|||||||
* This function takes the same input as SDL_AddEventWatch() to identify and
|
* This function takes the same input as SDL_AddEventWatch() to identify and
|
||||||
* delete the corresponding callback.
|
* delete the corresponding callback.
|
||||||
*
|
*
|
||||||
* \param filter the function originally passed to SDL_AddEventWatch().
|
* \param filter the function originally passed to SDL_AddEventWatch()
|
||||||
* \param userdata the pointer originally passed to SDL_AddEventWatch().
|
* \param userdata the pointer originally passed to SDL_AddEventWatch()
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.0.
|
* \since This function is available since SDL 2.0.0.
|
||||||
*
|
*
|
||||||
@@ -1125,8 +1095,8 @@ extern DECLSPEC void SDLCALL SDL_DelEventWatch(SDL_EventFilter filter,
|
|||||||
* this function does not change the filter permanently, it only uses the
|
* this function does not change the filter permanently, it only uses the
|
||||||
* supplied filter until this function returns.
|
* supplied filter until this function returns.
|
||||||
*
|
*
|
||||||
* \param filter the SDL_EventFilter function to call when an event happens.
|
* \param filter the SDL_EventFilter function to call when an event happens
|
||||||
* \param userdata a pointer that is passed to `filter`.
|
* \param userdata a pointer that is passed to `filter`
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.0.
|
* \since This function is available since SDL 2.0.0.
|
||||||
*
|
*
|
||||||
@@ -1152,8 +1122,8 @@ extern DECLSPEC void SDLCALL SDL_FilterEvents(SDL_EventFilter filter,
|
|||||||
* from the event queue and will not be filtered
|
* from the event queue and will not be filtered
|
||||||
* - `SDL_ENABLE`: the event will be processed normally
|
* - `SDL_ENABLE`: the event will be processed normally
|
||||||
*
|
*
|
||||||
* \param type the type of event; see SDL_EventType for details.
|
* \param type the type of event; see SDL_EventType for details
|
||||||
* \param state how to process the event.
|
* \param state how to process the event
|
||||||
* \returns `SDL_DISABLE` or `SDL_ENABLE`, representing the processing state
|
* \returns `SDL_DISABLE` or `SDL_ENABLE`, representing the processing state
|
||||||
* of the event before this function makes any changes to it.
|
* of the event before this function makes any changes to it.
|
||||||
*
|
*
|
||||||
@@ -1175,7 +1145,7 @@ extern DECLSPEC Uint8 SDLCALL SDL_EventState(Uint32 type, int state);
|
|||||||
* Note, (Uint32)-1 means the maximum unsigned 32-bit integer value (or
|
* Note, (Uint32)-1 means the maximum unsigned 32-bit integer value (or
|
||||||
* 0xFFFFFFFF), but is clearer to write.
|
* 0xFFFFFFFF), but is clearer to write.
|
||||||
*
|
*
|
||||||
* \param numevents the number of events to be allocated.
|
* \param numevents the number of events to be allocated
|
||||||
* \returns the beginning event number, or (Uint32)-1 if there are not enough
|
* \returns the beginning event number, or (Uint32)-1 if there are not enough
|
||||||
* user-defined events left.
|
* user-defined events left.
|
||||||
*
|
*
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
/*
|
/*
|
||||||
Simple DirectMedia Layer
|
Simple DirectMedia Layer
|
||||||
Copyright (C) 1997-2025 Sam Lantinga <slouken@libsdl.org>
|
Copyright (C) 1997-2023 Sam Lantinga <slouken@libsdl.org>
|
||||||
|
|
||||||
This software is provided 'as-is', without any express or implied
|
This software is provided 'as-is', without any express or implied
|
||||||
warranty. In no event will the authors be held liable for any damages
|
warranty. In no event will the authors be held liable for any damages
|
||||||
@@ -20,9 +20,9 @@
|
|||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* # CategoryFilesystem
|
* \file SDL_filesystem.h
|
||||||
*
|
*
|
||||||
* Include file for filesystem SDL API functions
|
* \brief Include file for filesystem SDL API functions
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#ifndef SDL_filesystem_h_
|
#ifndef SDL_filesystem_h_
|
||||||
@@ -64,7 +64,7 @@ extern "C" {
|
|||||||
* directory of the application as it is uncommon to store resources outside
|
* directory of the application as it is uncommon to store resources outside
|
||||||
* the executable. As such it is not a writable directory.
|
* the executable. As such it is not a writable directory.
|
||||||
*
|
*
|
||||||
* The returned path is guaranteed to end with a path separator ('\\' on
|
* The returned path is guaranteed to end with a path separator ('\' on
|
||||||
* Windows, '/' on most other platforms).
|
* Windows, '/' on most other platforms).
|
||||||
*
|
*
|
||||||
* The pointer returned is owned by the caller. Please call SDL_free() on the
|
* The pointer returned is owned by the caller. Please call SDL_free() on the
|
||||||
@@ -120,14 +120,14 @@ extern DECLSPEC char *SDLCALL SDL_GetBasePath(void);
|
|||||||
* - ...only use letters, numbers, and spaces. Avoid punctuation like "Game
|
* - ...only use letters, numbers, and spaces. Avoid punctuation like "Game
|
||||||
* Name 2: Bad Guy's Revenge!" ... "Game Name 2" is sufficient.
|
* Name 2: Bad Guy's Revenge!" ... "Game Name 2" is sufficient.
|
||||||
*
|
*
|
||||||
* The returned path is guaranteed to end with a path separator ('\\' on
|
* The returned path is guaranteed to end with a path separator ('\' on
|
||||||
* Windows, '/' on most other platforms).
|
* Windows, '/' on most other platforms).
|
||||||
*
|
*
|
||||||
* The pointer returned is owned by the caller. Please call SDL_free() on the
|
* The pointer returned is owned by the caller. Please call SDL_free() on the
|
||||||
* pointer when done with it.
|
* pointer when done with it.
|
||||||
*
|
*
|
||||||
* \param org the name of your organization.
|
* \param org the name of your organization
|
||||||
* \param app the name of your application.
|
* \param app the name of your application
|
||||||
* \returns a UTF-8 string of the user directory in platform-dependent
|
* \returns a UTF-8 string of the user directory in platform-dependent
|
||||||
* notation. NULL if there's a problem (creating directory failed,
|
* notation. NULL if there's a problem (creating directory failed,
|
||||||
* etc.).
|
* etc.).
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
/*
|
/*
|
||||||
Simple DirectMedia Layer
|
Simple DirectMedia Layer
|
||||||
Copyright (C) 1997-2025 Sam Lantinga <slouken@libsdl.org>
|
Copyright (C) 1997-2023 Sam Lantinga <slouken@libsdl.org>
|
||||||
|
|
||||||
This software is provided 'as-is', without any express or implied
|
This software is provided 'as-is', without any express or implied
|
||||||
warranty. In no event will the authors be held liable for any damages
|
warranty. In no event will the authors be held liable for any damages
|
||||||
@@ -19,12 +19,10 @@
|
|||||||
3. This notice may not be removed or altered from any source distribution.
|
3. This notice may not be removed or altered from any source distribution.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/* WIKI CATEGORY: GameController */
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* # CategoryGameController
|
* \file SDL_gamecontroller.h
|
||||||
*
|
*
|
||||||
* Include file for SDL game controller event handling
|
* Include file for SDL game controller event handling
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#ifndef SDL_gamecontroller_h_
|
#ifndef SDL_gamecontroller_h_
|
||||||
@@ -46,7 +44,7 @@ extern "C" {
|
|||||||
* \file SDL_gamecontroller.h
|
* \file SDL_gamecontroller.h
|
||||||
*
|
*
|
||||||
* In order to use these functions, SDL_Init() must have been called
|
* In order to use these functions, SDL_Init() must have been called
|
||||||
* with the SDL_INIT_GAMECONTROLLER flag. This causes SDL to scan the system
|
* with the ::SDL_INIT_GAMECONTROLLER flag. This causes SDL to scan the system
|
||||||
* for game controllers, and load appropriate drivers.
|
* for game controllers, and load appropriate drivers.
|
||||||
*
|
*
|
||||||
* If you would like to receive controller updates while the application
|
* If you would like to receive controller updates while the application
|
||||||
@@ -60,7 +58,7 @@ extern "C" {
|
|||||||
struct _SDL_GameController;
|
struct _SDL_GameController;
|
||||||
typedef struct _SDL_GameController SDL_GameController;
|
typedef struct _SDL_GameController SDL_GameController;
|
||||||
|
|
||||||
typedef enum SDL_GameControllerType
|
typedef enum
|
||||||
{
|
{
|
||||||
SDL_CONTROLLER_TYPE_UNKNOWN = 0,
|
SDL_CONTROLLER_TYPE_UNKNOWN = 0,
|
||||||
SDL_CONTROLLER_TYPE_XBOX360,
|
SDL_CONTROLLER_TYPE_XBOX360,
|
||||||
@@ -75,11 +73,10 @@ typedef enum SDL_GameControllerType
|
|||||||
SDL_CONTROLLER_TYPE_NVIDIA_SHIELD,
|
SDL_CONTROLLER_TYPE_NVIDIA_SHIELD,
|
||||||
SDL_CONTROLLER_TYPE_NINTENDO_SWITCH_JOYCON_LEFT,
|
SDL_CONTROLLER_TYPE_NINTENDO_SWITCH_JOYCON_LEFT,
|
||||||
SDL_CONTROLLER_TYPE_NINTENDO_SWITCH_JOYCON_RIGHT,
|
SDL_CONTROLLER_TYPE_NINTENDO_SWITCH_JOYCON_RIGHT,
|
||||||
SDL_CONTROLLER_TYPE_NINTENDO_SWITCH_JOYCON_PAIR,
|
SDL_CONTROLLER_TYPE_NINTENDO_SWITCH_JOYCON_PAIR
|
||||||
SDL_CONTROLLER_TYPE_MAX
|
|
||||||
} SDL_GameControllerType;
|
} SDL_GameControllerType;
|
||||||
|
|
||||||
typedef enum SDL_GameControllerBindType
|
typedef enum
|
||||||
{
|
{
|
||||||
SDL_CONTROLLER_BINDTYPE_NONE = 0,
|
SDL_CONTROLLER_BINDTYPE_NONE = 0,
|
||||||
SDL_CONTROLLER_BINDTYPE_BUTTON,
|
SDL_CONTROLLER_BINDTYPE_BUTTON,
|
||||||
@@ -88,7 +85,7 @@ typedef enum SDL_GameControllerBindType
|
|||||||
} SDL_GameControllerBindType;
|
} SDL_GameControllerBindType;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Get the SDL joystick layer binding for this controller button/axis mapping
|
* Get the SDL joystick layer binding for this controller button/axis mapping
|
||||||
*/
|
*/
|
||||||
typedef struct SDL_GameControllerButtonBind
|
typedef struct SDL_GameControllerButtonBind
|
||||||
{
|
{
|
||||||
@@ -146,10 +143,6 @@ typedef struct SDL_GameControllerButtonBind
|
|||||||
* If a new mapping is loaded for an already known controller GUID, the later
|
* If a new mapping is loaded for an already known controller GUID, the later
|
||||||
* version will overwrite the one currently loaded.
|
* version will overwrite the one currently loaded.
|
||||||
*
|
*
|
||||||
* If this function is called before SDL_Init, SDL will generate an
|
|
||||||
* SDL_CONTROLLERDEVICEADDED event for matching controllers that are plugged
|
|
||||||
* in at the time that SDL_Init is called.
|
|
||||||
*
|
|
||||||
* Mappings not belonging to the current platform or with no platform field
|
* Mappings not belonging to the current platform or with no platform field
|
||||||
* specified will be ignored (i.e. mappings for Linux will be ignored in
|
* specified will be ignored (i.e. mappings for Linux will be ignored in
|
||||||
* Windows, etc).
|
* Windows, etc).
|
||||||
@@ -158,8 +151,8 @@ typedef struct SDL_GameControllerButtonBind
|
|||||||
* processing it, so take this into consideration if you are in a memory
|
* processing it, so take this into consideration if you are in a memory
|
||||||
* constrained environment.
|
* constrained environment.
|
||||||
*
|
*
|
||||||
* \param rw the data stream for the mappings to be added.
|
* \param rw the data stream for the mappings to be added
|
||||||
* \param freerw non-zero to close the stream after being read.
|
* \param freerw non-zero to close the stream after being read
|
||||||
* \returns the number of mappings added or -1 on error; call SDL_GetError()
|
* \returns the number of mappings added or -1 on error; call SDL_GetError()
|
||||||
* for more information.
|
* for more information.
|
||||||
*
|
*
|
||||||
@@ -168,15 +161,13 @@ typedef struct SDL_GameControllerButtonBind
|
|||||||
* \sa SDL_GameControllerAddMapping
|
* \sa SDL_GameControllerAddMapping
|
||||||
* \sa SDL_GameControllerAddMappingsFromFile
|
* \sa SDL_GameControllerAddMappingsFromFile
|
||||||
* \sa SDL_GameControllerMappingForGUID
|
* \sa SDL_GameControllerMappingForGUID
|
||||||
* \sa SDL_CONTROLLERDEVICEADDED
|
|
||||||
*/
|
*/
|
||||||
extern DECLSPEC int SDLCALL SDL_GameControllerAddMappingsFromRW(SDL_RWops * rw, int freerw);
|
extern DECLSPEC int SDLCALL SDL_GameControllerAddMappingsFromRW(SDL_RWops * rw, int freerw);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Load a set of mappings from a file, filtered by the current
|
* Load a set of mappings from a file, filtered by the current SDL_GetPlatform()
|
||||||
* SDL_GetPlatform()
|
|
||||||
*
|
*
|
||||||
* Convenience macro.
|
* Convenience macro.
|
||||||
*/
|
*/
|
||||||
#define SDL_GameControllerAddMappingsFromFile(file) SDL_GameControllerAddMappingsFromRW(SDL_RWFromFile(file, "rb"), 1)
|
#define SDL_GameControllerAddMappingsFromFile(file) SDL_GameControllerAddMappingsFromRW(SDL_RWFromFile(file, "rb"), 1)
|
||||||
|
|
||||||
@@ -198,11 +189,7 @@ extern DECLSPEC int SDLCALL SDL_GameControllerAddMappingsFromRW(SDL_RWops * rw,
|
|||||||
* "341a3608000000000000504944564944,Afterglow PS3 Controller,a:b1,b:b2,y:b3,x:b0,start:b9,guide:b12,back:b8,dpup:h0.1,dpleft:h0.8,dpdown:h0.4,dpright:h0.2,leftshoulder:b4,rightshoulder:b5,leftstick:b10,rightstick:b11,leftx:a0,lefty:a1,rightx:a2,righty:a3,lefttrigger:b6,righttrigger:b7"
|
* "341a3608000000000000504944564944,Afterglow PS3 Controller,a:b1,b:b2,y:b3,x:b0,start:b9,guide:b12,back:b8,dpup:h0.1,dpleft:h0.8,dpdown:h0.4,dpright:h0.2,leftshoulder:b4,rightshoulder:b5,leftstick:b10,rightstick:b11,leftx:a0,lefty:a1,rightx:a2,righty:a3,lefttrigger:b6,righttrigger:b7"
|
||||||
* ```
|
* ```
|
||||||
*
|
*
|
||||||
* If this function is called before SDL_Init, SDL will generate an
|
* \param mappingString the mapping string
|
||||||
* SDL_CONTROLLERDEVICEADDED event for matching controllers that are plugged
|
|
||||||
* in at the time that SDL_Init is called.
|
|
||||||
*
|
|
||||||
* \param mappingString the mapping string.
|
|
||||||
* \returns 1 if a new mapping is added, 0 if an existing mapping is updated,
|
* \returns 1 if a new mapping is added, 0 if an existing mapping is updated,
|
||||||
* -1 on error; call SDL_GetError() for more information.
|
* -1 on error; call SDL_GetError() for more information.
|
||||||
*
|
*
|
||||||
@@ -210,7 +197,6 @@ extern DECLSPEC int SDLCALL SDL_GameControllerAddMappingsFromRW(SDL_RWops * rw,
|
|||||||
*
|
*
|
||||||
* \sa SDL_GameControllerMapping
|
* \sa SDL_GameControllerMapping
|
||||||
* \sa SDL_GameControllerMappingForGUID
|
* \sa SDL_GameControllerMappingForGUID
|
||||||
* \sa SDL_CONTROLLERDEVICEADDED
|
|
||||||
*/
|
*/
|
||||||
extern DECLSPEC int SDLCALL SDL_GameControllerAddMapping(const char* mappingString);
|
extern DECLSPEC int SDLCALL SDL_GameControllerAddMapping(const char* mappingString);
|
||||||
|
|
||||||
@@ -238,7 +224,7 @@ extern DECLSPEC char * SDLCALL SDL_GameControllerMappingForIndex(int mapping_ind
|
|||||||
*
|
*
|
||||||
* The returned string must be freed with SDL_free().
|
* The returned string must be freed with SDL_free().
|
||||||
*
|
*
|
||||||
* \param guid a structure containing the GUID for which a mapping is desired.
|
* \param guid a structure containing the GUID for which a mapping is desired
|
||||||
* \returns a mapping string or NULL on error; call SDL_GetError() for more
|
* \returns a mapping string or NULL on error; call SDL_GetError() for more
|
||||||
* information.
|
* information.
|
||||||
*
|
*
|
||||||
@@ -257,7 +243,7 @@ extern DECLSPEC char * SDLCALL SDL_GameControllerMappingForGUID(SDL_JoystickGUID
|
|||||||
* Details about mappings are discussed with SDL_GameControllerAddMapping().
|
* Details about mappings are discussed with SDL_GameControllerAddMapping().
|
||||||
*
|
*
|
||||||
* \param gamecontroller the game controller you want to get the current
|
* \param gamecontroller the game controller you want to get the current
|
||||||
* mapping for.
|
* mapping for
|
||||||
* \returns a string that has the controller's mapping or NULL if no mapping
|
* \returns a string that has the controller's mapping or NULL if no mapping
|
||||||
* is available; call SDL_GetError() for more information.
|
* is available; call SDL_GetError() for more information.
|
||||||
*
|
*
|
||||||
@@ -275,7 +261,7 @@ extern DECLSPEC char * SDLCALL SDL_GameControllerMapping(SDL_GameController *gam
|
|||||||
* SDL_JoystickOpen().
|
* SDL_JoystickOpen().
|
||||||
*
|
*
|
||||||
* \param joystick_index the device_index of a device, up to
|
* \param joystick_index the device_index of a device, up to
|
||||||
* SDL_NumJoysticks().
|
* SDL_NumJoysticks()
|
||||||
* \returns SDL_TRUE if the given joystick is supported by the game controller
|
* \returns SDL_TRUE if the given joystick is supported by the game controller
|
||||||
* interface, SDL_FALSE if it isn't or it's an invalid index.
|
* interface, SDL_FALSE if it isn't or it's an invalid index.
|
||||||
*
|
*
|
||||||
@@ -295,7 +281,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_IsGameController(int joystick_index);
|
|||||||
* SDL_JoystickOpen().
|
* SDL_JoystickOpen().
|
||||||
*
|
*
|
||||||
* \param joystick_index the device_index of a device, from zero to
|
* \param joystick_index the device_index of a device, from zero to
|
||||||
* SDL_NumJoysticks()-1.
|
* SDL_NumJoysticks()-1
|
||||||
* \returns the implementation-dependent name for the game controller, or NULL
|
* \returns the implementation-dependent name for the game controller, or NULL
|
||||||
* if there is no name or the index is invalid.
|
* if there is no name or the index is invalid.
|
||||||
*
|
*
|
||||||
@@ -316,7 +302,7 @@ extern DECLSPEC const char *SDLCALL SDL_GameControllerNameForIndex(int joystick_
|
|||||||
* SDL_JoystickOpen().
|
* SDL_JoystickOpen().
|
||||||
*
|
*
|
||||||
* \param joystick_index the device_index of a device, from zero to
|
* \param joystick_index the device_index of a device, from zero to
|
||||||
* SDL_NumJoysticks()-1.
|
* SDL_NumJoysticks()-1
|
||||||
* \returns the implementation-dependent path for the game controller, or NULL
|
* \returns the implementation-dependent path for the game controller, or NULL
|
||||||
* if there is no path or the index is invalid.
|
* if there is no path or the index is invalid.
|
||||||
*
|
*
|
||||||
@@ -332,7 +318,7 @@ extern DECLSPEC const char *SDLCALL SDL_GameControllerPathForIndex(int joystick_
|
|||||||
* This can be called before any controllers are opened.
|
* This can be called before any controllers are opened.
|
||||||
*
|
*
|
||||||
* \param joystick_index the device_index of a device, from zero to
|
* \param joystick_index the device_index of a device, from zero to
|
||||||
* SDL_NumJoysticks()-1.
|
* SDL_NumJoysticks()-1
|
||||||
* \returns the controller type.
|
* \returns the controller type.
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.12.
|
* \since This function is available since SDL 2.0.12.
|
||||||
@@ -345,7 +331,7 @@ extern DECLSPEC SDL_GameControllerType SDLCALL SDL_GameControllerTypeForIndex(in
|
|||||||
* This can be called before any controllers are opened.
|
* This can be called before any controllers are opened.
|
||||||
*
|
*
|
||||||
* \param joystick_index the device_index of a device, from zero to
|
* \param joystick_index the device_index of a device, from zero to
|
||||||
* SDL_NumJoysticks()-1.
|
* SDL_NumJoysticks()-1
|
||||||
* \returns the mapping string. Must be freed with SDL_free(). Returns NULL if
|
* \returns the mapping string. Must be freed with SDL_free(). Returns NULL if
|
||||||
* no mapping is available.
|
* no mapping is available.
|
||||||
*
|
*
|
||||||
@@ -365,7 +351,7 @@ extern DECLSPEC char *SDLCALL SDL_GameControllerMappingForDeviceIndex(int joysti
|
|||||||
* be used there instead.
|
* be used there instead.
|
||||||
*
|
*
|
||||||
* \param joystick_index the device_index of a device, up to
|
* \param joystick_index the device_index of a device, up to
|
||||||
* SDL_NumJoysticks().
|
* SDL_NumJoysticks()
|
||||||
* \returns a gamecontroller identifier or NULL if an error occurred; call
|
* \returns a gamecontroller identifier or NULL if an error occurred; call
|
||||||
* SDL_GetError() for more information.
|
* SDL_GetError() for more information.
|
||||||
*
|
*
|
||||||
@@ -380,7 +366,7 @@ extern DECLSPEC SDL_GameController *SDLCALL SDL_GameControllerOpen(int joystick_
|
|||||||
/**
|
/**
|
||||||
* Get the SDL_GameController associated with an instance id.
|
* Get the SDL_GameController associated with an instance id.
|
||||||
*
|
*
|
||||||
* \param joyid the instance id to get the SDL_GameController for.
|
* \param joyid the instance id to get the SDL_GameController for
|
||||||
* \returns an SDL_GameController on success or NULL on failure; call
|
* \returns an SDL_GameController on success or NULL on failure; call
|
||||||
* SDL_GetError() for more information.
|
* SDL_GetError() for more information.
|
||||||
*
|
*
|
||||||
@@ -412,7 +398,7 @@ extern DECLSPEC SDL_GameController *SDLCALL SDL_GameControllerFromPlayerIndex(in
|
|||||||
* it takes a controller identifier instead of the (unstable) device index.
|
* it takes a controller identifier instead of the (unstable) device index.
|
||||||
*
|
*
|
||||||
* \param gamecontroller a game controller identifier previously returned by
|
* \param gamecontroller a game controller identifier previously returned by
|
||||||
* SDL_GameControllerOpen().
|
* SDL_GameControllerOpen()
|
||||||
* \returns the implementation dependent name for the game controller, or NULL
|
* \returns the implementation dependent name for the game controller, or NULL
|
||||||
* if there is no name or the identifier passed is invalid.
|
* if there is no name or the identifier passed is invalid.
|
||||||
*
|
*
|
||||||
@@ -430,7 +416,7 @@ extern DECLSPEC const char *SDLCALL SDL_GameControllerName(SDL_GameController *g
|
|||||||
* it takes a controller identifier instead of the (unstable) device index.
|
* it takes a controller identifier instead of the (unstable) device index.
|
||||||
*
|
*
|
||||||
* \param gamecontroller a game controller identifier previously returned by
|
* \param gamecontroller a game controller identifier previously returned by
|
||||||
* SDL_GameControllerOpen().
|
* SDL_GameControllerOpen()
|
||||||
* \returns the implementation dependent path for the game controller, or NULL
|
* \returns the implementation dependent path for the game controller, or NULL
|
||||||
* if there is no path or the identifier passed is invalid.
|
* if there is no path or the identifier passed is invalid.
|
||||||
*
|
*
|
||||||
@@ -537,25 +523,11 @@ extern DECLSPEC Uint16 SDLCALL SDL_GameControllerGetFirmwareVersion(SDL_GameCont
|
|||||||
*/
|
*/
|
||||||
extern DECLSPEC const char * SDLCALL SDL_GameControllerGetSerial(SDL_GameController *gamecontroller);
|
extern DECLSPEC const char * SDLCALL SDL_GameControllerGetSerial(SDL_GameController *gamecontroller);
|
||||||
|
|
||||||
/**
|
|
||||||
* Get the Steam Input handle of an opened controller, if available.
|
|
||||||
*
|
|
||||||
* Returns an InputHandle_t for the controller that can be used with Steam
|
|
||||||
* Input API: https://partner.steamgames.com/doc/api/ISteamInput
|
|
||||||
*
|
|
||||||
* \param gamecontroller the game controller object to query.
|
|
||||||
* \returns the gamepad handle, or 0 if unavailable.
|
|
||||||
*
|
|
||||||
* \since This function is available since SDL 2.30.0.
|
|
||||||
*/
|
|
||||||
extern DECLSPEC Uint64 SDLCALL SDL_GameControllerGetSteamHandle(SDL_GameController *gamecontroller);
|
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Check if a controller has been opened and is currently connected.
|
* Check if a controller has been opened and is currently connected.
|
||||||
*
|
*
|
||||||
* \param gamecontroller a game controller identifier previously returned by
|
* \param gamecontroller a game controller identifier previously returned by
|
||||||
* SDL_GameControllerOpen().
|
* SDL_GameControllerOpen()
|
||||||
* \returns SDL_TRUE if the controller has been opened and is currently
|
* \returns SDL_TRUE if the controller has been opened and is currently
|
||||||
* connected, or SDL_FALSE if not.
|
* connected, or SDL_FALSE if not.
|
||||||
*
|
*
|
||||||
@@ -580,7 +552,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_GameControllerGetAttached(SDL_GameControlle
|
|||||||
* cause SDL to crash.
|
* cause SDL to crash.
|
||||||
*
|
*
|
||||||
* \param gamecontroller the game controller object that you want to get a
|
* \param gamecontroller the game controller object that you want to get a
|
||||||
* joystick from.
|
* joystick from
|
||||||
* \returns a SDL_Joystick object; call SDL_GetError() for more information.
|
* \returns a SDL_Joystick object; call SDL_GetError() for more information.
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.0.
|
* \since This function is available since SDL 2.0.0.
|
||||||
@@ -597,7 +569,7 @@ extern DECLSPEC SDL_Joystick *SDLCALL SDL_GameControllerGetJoystick(SDL_GameCont
|
|||||||
* Any number can be passed to SDL_GameControllerEventState(), but only -1, 0,
|
* Any number can be passed to SDL_GameControllerEventState(), but only -1, 0,
|
||||||
* and 1 will have any effect. Other numbers will just be returned.
|
* and 1 will have any effect. Other numbers will just be returned.
|
||||||
*
|
*
|
||||||
* \param state can be one of `SDL_QUERY`, `SDL_IGNORE`, or `SDL_ENABLE`.
|
* \param state can be one of `SDL_QUERY`, `SDL_IGNORE`, or `SDL_ENABLE`
|
||||||
* \returns the same value passed to the function, with exception to -1
|
* \returns the same value passed to the function, with exception to -1
|
||||||
* (SDL_QUERY), which will return the current state.
|
* (SDL_QUERY), which will return the current state.
|
||||||
*
|
*
|
||||||
@@ -620,19 +592,15 @@ extern DECLSPEC void SDLCALL SDL_GameControllerUpdate(void);
|
|||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The list of axes available from a controller
|
* The list of axes available from a controller
|
||||||
*
|
*
|
||||||
* Thumbstick axis values range from SDL_JOYSTICK_AXIS_MIN to
|
* Thumbstick axis values range from SDL_JOYSTICK_AXIS_MIN to SDL_JOYSTICK_AXIS_MAX,
|
||||||
* SDL_JOYSTICK_AXIS_MAX, and are centered within ~8000 of zero, though
|
* and are centered within ~8000 of zero, though advanced UI will allow users to set
|
||||||
* advanced UI will allow users to set or autodetect the dead zone, which
|
* or autodetect the dead zone, which varies between controllers.
|
||||||
* varies between controllers.
|
|
||||||
*
|
*
|
||||||
* Trigger axis values range from 0 (released) to SDL_JOYSTICK_AXIS_MAX (fully
|
* Trigger axis values range from 0 to SDL_JOYSTICK_AXIS_MAX.
|
||||||
* pressed) when reported by SDL_GameControllerGetAxis(). Note that this is
|
|
||||||
* not the same range that will be reported by the lower-level
|
|
||||||
* SDL_GetJoystickAxis().
|
|
||||||
*/
|
*/
|
||||||
typedef enum SDL_GameControllerAxis
|
typedef enum
|
||||||
{
|
{
|
||||||
SDL_CONTROLLER_AXIS_INVALID = -1,
|
SDL_CONTROLLER_AXIS_INVALID = -1,
|
||||||
SDL_CONTROLLER_AXIS_LEFTX,
|
SDL_CONTROLLER_AXIS_LEFTX,
|
||||||
@@ -656,7 +624,7 @@ typedef enum SDL_GameControllerAxis
|
|||||||
* `SDL_CONTROLLER_AXIS_TRIGGERRIGHT` and `SDL_CONTROLLER_AXIS_TRIGGERLEFT`,
|
* `SDL_CONTROLLER_AXIS_TRIGGERRIGHT` and `SDL_CONTROLLER_AXIS_TRIGGERLEFT`,
|
||||||
* respectively.
|
* respectively.
|
||||||
*
|
*
|
||||||
* \param str string representing a SDL_GameController axis.
|
* \param str string representing a SDL_GameController axis
|
||||||
* \returns the SDL_GameControllerAxis enum corresponding to the input string,
|
* \returns the SDL_GameControllerAxis enum corresponding to the input string,
|
||||||
* or `SDL_CONTROLLER_AXIS_INVALID` if no match was found.
|
* or `SDL_CONTROLLER_AXIS_INVALID` if no match was found.
|
||||||
*
|
*
|
||||||
@@ -671,7 +639,7 @@ extern DECLSPEC SDL_GameControllerAxis SDLCALL SDL_GameControllerGetAxisFromStri
|
|||||||
*
|
*
|
||||||
* The caller should not SDL_free() the returned string.
|
* The caller should not SDL_free() the returned string.
|
||||||
*
|
*
|
||||||
* \param axis an enum value for a given SDL_GameControllerAxis.
|
* \param axis an enum value for a given SDL_GameControllerAxis
|
||||||
* \returns a string for the given axis, or NULL if an invalid axis is
|
* \returns a string for the given axis, or NULL if an invalid axis is
|
||||||
* specified. The string returned is of the format used by
|
* specified. The string returned is of the format used by
|
||||||
* SDL_GameController mapping strings.
|
* SDL_GameController mapping strings.
|
||||||
@@ -685,8 +653,8 @@ extern DECLSPEC const char* SDLCALL SDL_GameControllerGetStringForAxis(SDL_GameC
|
|||||||
/**
|
/**
|
||||||
* Get the SDL joystick layer binding for a controller axis mapping.
|
* Get the SDL joystick layer binding for a controller axis mapping.
|
||||||
*
|
*
|
||||||
* \param gamecontroller a game controller.
|
* \param gamecontroller a game controller
|
||||||
* \param axis an axis enum value (one of the SDL_GameControllerAxis values).
|
* \param axis an axis enum value (one of the SDL_GameControllerAxis values)
|
||||||
* \returns a SDL_GameControllerButtonBind describing the bind. On failure
|
* \returns a SDL_GameControllerButtonBind describing the bind. On failure
|
||||||
* (like the given Controller axis doesn't exist on the device), its
|
* (like the given Controller axis doesn't exist on the device), its
|
||||||
* `.bindType` will be `SDL_CONTROLLER_BINDTYPE_NONE`.
|
* `.bindType` will be `SDL_CONTROLLER_BINDTYPE_NONE`.
|
||||||
@@ -705,8 +673,8 @@ SDL_GameControllerGetBindForAxis(SDL_GameController *gamecontroller,
|
|||||||
* This merely reports whether the controller's mapping defined this axis, as
|
* This merely reports whether the controller's mapping defined this axis, as
|
||||||
* that is all the information SDL has about the physical device.
|
* that is all the information SDL has about the physical device.
|
||||||
*
|
*
|
||||||
* \param gamecontroller a game controller.
|
* \param gamecontroller a game controller
|
||||||
* \param axis an axis enum value (an SDL_GameControllerAxis value).
|
* \param axis an axis enum value (an SDL_GameControllerAxis value)
|
||||||
* \returns SDL_TRUE if the controller has this axis, SDL_FALSE otherwise.
|
* \returns SDL_TRUE if the controller has this axis, SDL_FALSE otherwise.
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.14.
|
* \since This function is available since SDL 2.0.14.
|
||||||
@@ -719,15 +687,11 @@ SDL_GameControllerHasAxis(SDL_GameController *gamecontroller, SDL_GameController
|
|||||||
*
|
*
|
||||||
* The axis indices start at index 0.
|
* The axis indices start at index 0.
|
||||||
*
|
*
|
||||||
* For thumbsticks, the state is a value ranging from -32768 (up/left) to
|
* The state is a value ranging from -32768 to 32767. Triggers, however, range
|
||||||
* 32767 (down/right).
|
* from 0 to 32767 (they never return a negative value).
|
||||||
*
|
*
|
||||||
* Triggers range from 0 when released to 32767 when fully pressed, and never
|
* \param gamecontroller a game controller
|
||||||
* return a negative value. Note that this differs from the value reported by
|
* \param axis an axis index (one of the SDL_GameControllerAxis values)
|
||||||
* the lower-level SDL_JoystickGetAxis(), which normally uses the full range.
|
|
||||||
*
|
|
||||||
* \param gamecontroller a game controller.
|
|
||||||
* \param axis an axis index (one of the SDL_GameControllerAxis values).
|
|
||||||
* \returns axis state (including 0) on success or 0 (also) on failure; call
|
* \returns axis state (including 0) on success or 0 (also) on failure; call
|
||||||
* SDL_GetError() for more information.
|
* SDL_GetError() for more information.
|
||||||
*
|
*
|
||||||
@@ -739,9 +703,9 @@ extern DECLSPEC Sint16 SDLCALL
|
|||||||
SDL_GameControllerGetAxis(SDL_GameController *gamecontroller, SDL_GameControllerAxis axis);
|
SDL_GameControllerGetAxis(SDL_GameController *gamecontroller, SDL_GameControllerAxis axis);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The list of buttons available from a controller
|
* The list of buttons available from a controller
|
||||||
*/
|
*/
|
||||||
typedef enum SDL_GameControllerButton
|
typedef enum
|
||||||
{
|
{
|
||||||
SDL_CONTROLLER_BUTTON_INVALID = -1,
|
SDL_CONTROLLER_BUTTON_INVALID = -1,
|
||||||
SDL_CONTROLLER_BUTTON_A,
|
SDL_CONTROLLER_BUTTON_A,
|
||||||
@@ -776,7 +740,7 @@ typedef enum SDL_GameControllerButton
|
|||||||
* SDL_GameController mapping. You do not normally need to call this function
|
* SDL_GameController mapping. You do not normally need to call this function
|
||||||
* unless you are parsing SDL_GameController mappings in your own code.
|
* unless you are parsing SDL_GameController mappings in your own code.
|
||||||
*
|
*
|
||||||
* \param str string representing a SDL_GameController axis.
|
* \param str string representing a SDL_GameController axis
|
||||||
* \returns the SDL_GameControllerButton enum corresponding to the input
|
* \returns the SDL_GameControllerButton enum corresponding to the input
|
||||||
* string, or `SDL_CONTROLLER_AXIS_INVALID` if no match was found.
|
* string, or `SDL_CONTROLLER_AXIS_INVALID` if no match was found.
|
||||||
*
|
*
|
||||||
@@ -789,7 +753,7 @@ extern DECLSPEC SDL_GameControllerButton SDLCALL SDL_GameControllerGetButtonFrom
|
|||||||
*
|
*
|
||||||
* The caller should not SDL_free() the returned string.
|
* The caller should not SDL_free() the returned string.
|
||||||
*
|
*
|
||||||
* \param button an enum value for a given SDL_GameControllerButton.
|
* \param button an enum value for a given SDL_GameControllerButton
|
||||||
* \returns a string for the given button, or NULL if an invalid button is
|
* \returns a string for the given button, or NULL if an invalid button is
|
||||||
* specified. The string returned is of the format used by
|
* specified. The string returned is of the format used by
|
||||||
* SDL_GameController mapping strings.
|
* SDL_GameController mapping strings.
|
||||||
@@ -803,8 +767,8 @@ extern DECLSPEC const char* SDLCALL SDL_GameControllerGetStringForButton(SDL_Gam
|
|||||||
/**
|
/**
|
||||||
* Get the SDL joystick layer binding for a controller button mapping.
|
* Get the SDL joystick layer binding for a controller button mapping.
|
||||||
*
|
*
|
||||||
* \param gamecontroller a game controller.
|
* \param gamecontroller a game controller
|
||||||
* \param button an button enum value (an SDL_GameControllerButton value).
|
* \param button an button enum value (an SDL_GameControllerButton value)
|
||||||
* \returns a SDL_GameControllerButtonBind describing the bind. On failure
|
* \returns a SDL_GameControllerButtonBind describing the bind. On failure
|
||||||
* (like the given Controller button doesn't exist on the device),
|
* (like the given Controller button doesn't exist on the device),
|
||||||
* its `.bindType` will be `SDL_CONTROLLER_BINDTYPE_NONE`.
|
* its `.bindType` will be `SDL_CONTROLLER_BINDTYPE_NONE`.
|
||||||
@@ -823,8 +787,8 @@ SDL_GameControllerGetBindForButton(SDL_GameController *gamecontroller,
|
|||||||
* This merely reports whether the controller's mapping defined this button,
|
* This merely reports whether the controller's mapping defined this button,
|
||||||
* as that is all the information SDL has about the physical device.
|
* as that is all the information SDL has about the physical device.
|
||||||
*
|
*
|
||||||
* \param gamecontroller a game controller.
|
* \param gamecontroller a game controller
|
||||||
* \param button a button enum value (an SDL_GameControllerButton value).
|
* \param button a button enum value (an SDL_GameControllerButton value)
|
||||||
* \returns SDL_TRUE if the controller has this button, SDL_FALSE otherwise.
|
* \returns SDL_TRUE if the controller has this button, SDL_FALSE otherwise.
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.14.
|
* \since This function is available since SDL 2.0.14.
|
||||||
@@ -835,8 +799,8 @@ extern DECLSPEC SDL_bool SDLCALL SDL_GameControllerHasButton(SDL_GameController
|
|||||||
/**
|
/**
|
||||||
* Get the current state of a button on a game controller.
|
* Get the current state of a button on a game controller.
|
||||||
*
|
*
|
||||||
* \param gamecontroller a game controller.
|
* \param gamecontroller a game controller
|
||||||
* \param button a button index (one of the SDL_GameControllerButton values).
|
* \param button a button index (one of the SDL_GameControllerButton values)
|
||||||
* \returns 1 for pressed state or 0 for not pressed state or error; call
|
* \returns 1 for pressed state or 0 for not pressed state or error; call
|
||||||
* SDL_GetError() for more information.
|
* SDL_GetError() for more information.
|
||||||
*
|
*
|
||||||
@@ -872,8 +836,8 @@ extern DECLSPEC int SDLCALL SDL_GameControllerGetTouchpadFinger(SDL_GameControll
|
|||||||
/**
|
/**
|
||||||
* Return whether a game controller has a particular sensor.
|
* Return whether a game controller has a particular sensor.
|
||||||
*
|
*
|
||||||
* \param gamecontroller The controller to query.
|
* \param gamecontroller The controller to query
|
||||||
* \param type The type of sensor to query.
|
* \param type The type of sensor to query
|
||||||
* \returns SDL_TRUE if the sensor exists, SDL_FALSE otherwise.
|
* \returns SDL_TRUE if the sensor exists, SDL_FALSE otherwise.
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.14.
|
* \since This function is available since SDL 2.0.14.
|
||||||
@@ -883,9 +847,9 @@ extern DECLSPEC SDL_bool SDLCALL SDL_GameControllerHasSensor(SDL_GameController
|
|||||||
/**
|
/**
|
||||||
* Set whether data reporting for a game controller sensor is enabled.
|
* Set whether data reporting for a game controller sensor is enabled.
|
||||||
*
|
*
|
||||||
* \param gamecontroller The controller to update.
|
* \param gamecontroller The controller to update
|
||||||
* \param type The type of sensor to enable/disable.
|
* \param type The type of sensor to enable/disable
|
||||||
* \param enabled Whether data reporting should be enabled.
|
* \param enabled Whether data reporting should be enabled
|
||||||
* \returns 0 or -1 if an error occurred.
|
* \returns 0 or -1 if an error occurred.
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.14.
|
* \since This function is available since SDL 2.0.14.
|
||||||
@@ -895,8 +859,8 @@ extern DECLSPEC int SDLCALL SDL_GameControllerSetSensorEnabled(SDL_GameControlle
|
|||||||
/**
|
/**
|
||||||
* Query whether sensor data reporting is enabled for a game controller.
|
* Query whether sensor data reporting is enabled for a game controller.
|
||||||
*
|
*
|
||||||
* \param gamecontroller The controller to query.
|
* \param gamecontroller The controller to query
|
||||||
* \param type The type of sensor to query.
|
* \param type The type of sensor to query
|
||||||
* \returns SDL_TRUE if the sensor is enabled, SDL_FALSE otherwise.
|
* \returns SDL_TRUE if the sensor is enabled, SDL_FALSE otherwise.
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.14.
|
* \since This function is available since SDL 2.0.14.
|
||||||
@@ -907,8 +871,8 @@ extern DECLSPEC SDL_bool SDLCALL SDL_GameControllerIsSensorEnabled(SDL_GameContr
|
|||||||
* Get the data rate (number of events per second) of a game controller
|
* Get the data rate (number of events per second) of a game controller
|
||||||
* sensor.
|
* sensor.
|
||||||
*
|
*
|
||||||
* \param gamecontroller The controller to query.
|
* \param gamecontroller The controller to query
|
||||||
* \param type The type of sensor to query.
|
* \param type The type of sensor to query
|
||||||
* \return the data rate, or 0.0f if the data rate is not available.
|
* \return the data rate, or 0.0f if the data rate is not available.
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.16.
|
* \since This function is available since SDL 2.0.16.
|
||||||
@@ -921,10 +885,10 @@ extern DECLSPEC float SDLCALL SDL_GameControllerGetSensorDataRate(SDL_GameContro
|
|||||||
* The number of values and interpretation of the data is sensor dependent.
|
* The number of values and interpretation of the data is sensor dependent.
|
||||||
* See SDL_sensor.h for the details for each type of sensor.
|
* See SDL_sensor.h for the details for each type of sensor.
|
||||||
*
|
*
|
||||||
* \param gamecontroller The controller to query.
|
* \param gamecontroller The controller to query
|
||||||
* \param type The type of sensor to query.
|
* \param type The type of sensor to query
|
||||||
* \param data A pointer filled with the current sensor state.
|
* \param data A pointer filled with the current sensor state
|
||||||
* \param num_values The number of values to write to data.
|
* \param num_values The number of values to write to data
|
||||||
* \return 0 or -1 if an error occurred.
|
* \return 0 or -1 if an error occurred.
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.14.
|
* \since This function is available since SDL 2.0.14.
|
||||||
@@ -938,12 +902,12 @@ extern DECLSPEC int SDLCALL SDL_GameControllerGetSensorData(SDL_GameController *
|
|||||||
* The number of values and interpretation of the data is sensor dependent.
|
* The number of values and interpretation of the data is sensor dependent.
|
||||||
* See SDL_sensor.h for the details for each type of sensor.
|
* See SDL_sensor.h for the details for each type of sensor.
|
||||||
*
|
*
|
||||||
* \param gamecontroller The controller to query.
|
* \param gamecontroller The controller to query
|
||||||
* \param type The type of sensor to query.
|
* \param type The type of sensor to query
|
||||||
* \param timestamp A pointer filled with the timestamp in microseconds of the
|
* \param timestamp A pointer filled with the timestamp in microseconds of the
|
||||||
* current sensor reading if available, or 0 if not.
|
* current sensor reading if available, or 0 if not
|
||||||
* \param data A pointer filled with the current sensor state.
|
* \param data A pointer filled with the current sensor state
|
||||||
* \param num_values The number of values to write to data.
|
* \param num_values The number of values to write to data
|
||||||
* \return 0 or -1 if an error occurred.
|
* \return 0 or -1 if an error occurred.
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.26.0.
|
* \since This function is available since SDL 2.26.0.
|
||||||
@@ -956,13 +920,13 @@ extern DECLSPEC int SDLCALL SDL_GameControllerGetSensorDataWithTimestamp(SDL_Gam
|
|||||||
* Each call to this function cancels any previous rumble effect, and calling
|
* Each call to this function cancels any previous rumble effect, and calling
|
||||||
* it with 0 intensity stops any rumbling.
|
* it with 0 intensity stops any rumbling.
|
||||||
*
|
*
|
||||||
* \param gamecontroller The controller to vibrate.
|
* \param gamecontroller The controller to vibrate
|
||||||
* \param low_frequency_rumble The intensity of the low frequency (left)
|
* \param low_frequency_rumble The intensity of the low frequency (left)
|
||||||
* rumble motor, from 0 to 0xFFFF.
|
* rumble motor, from 0 to 0xFFFF
|
||||||
* \param high_frequency_rumble The intensity of the high frequency (right)
|
* \param high_frequency_rumble The intensity of the high frequency (right)
|
||||||
* rumble motor, from 0 to 0xFFFF.
|
* rumble motor, from 0 to 0xFFFF
|
||||||
* \param duration_ms The duration of the rumble effect, in milliseconds.
|
* \param duration_ms The duration of the rumble effect, in milliseconds
|
||||||
* \returns 0, or -1 if rumble isn't supported on this controller.
|
* \returns 0, or -1 if rumble isn't supported on this controller
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.9.
|
* \since This function is available since SDL 2.0.9.
|
||||||
*
|
*
|
||||||
@@ -981,13 +945,13 @@ extern DECLSPEC int SDLCALL SDL_GameControllerRumble(SDL_GameController *gamecon
|
|||||||
* want the (more common) whole-controller rumble, use
|
* want the (more common) whole-controller rumble, use
|
||||||
* SDL_GameControllerRumble() instead.
|
* SDL_GameControllerRumble() instead.
|
||||||
*
|
*
|
||||||
* \param gamecontroller The controller to vibrate.
|
* \param gamecontroller The controller to vibrate
|
||||||
* \param left_rumble The intensity of the left trigger rumble motor, from 0
|
* \param left_rumble The intensity of the left trigger rumble motor, from 0
|
||||||
* to 0xFFFF.
|
* to 0xFFFF
|
||||||
* \param right_rumble The intensity of the right trigger rumble motor, from 0
|
* \param right_rumble The intensity of the right trigger rumble motor, from 0
|
||||||
* to 0xFFFF.
|
* to 0xFFFF
|
||||||
* \param duration_ms The duration of the rumble effect, in milliseconds.
|
* \param duration_ms The duration of the rumble effect, in milliseconds
|
||||||
* \returns 0, or -1 if trigger rumble isn't supported on this controller.
|
* \returns 0, or -1 if trigger rumble isn't supported on this controller
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.14.
|
* \since This function is available since SDL 2.0.14.
|
||||||
*
|
*
|
||||||
@@ -998,9 +962,9 @@ extern DECLSPEC int SDLCALL SDL_GameControllerRumbleTriggers(SDL_GameController
|
|||||||
/**
|
/**
|
||||||
* Query whether a game controller has an LED.
|
* Query whether a game controller has an LED.
|
||||||
*
|
*
|
||||||
* \param gamecontroller The controller to query.
|
* \param gamecontroller The controller to query
|
||||||
* \returns SDL_TRUE, or SDL_FALSE if this controller does not have a
|
* \returns SDL_TRUE, or SDL_FALSE if this controller does not have a
|
||||||
* modifiable LED.
|
* modifiable LED
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.14.
|
* \since This function is available since SDL 2.0.14.
|
||||||
*/
|
*/
|
||||||
@@ -1009,9 +973,9 @@ extern DECLSPEC SDL_bool SDLCALL SDL_GameControllerHasLED(SDL_GameController *ga
|
|||||||
/**
|
/**
|
||||||
* Query whether a game controller has rumble support.
|
* Query whether a game controller has rumble support.
|
||||||
*
|
*
|
||||||
* \param gamecontroller The controller to query.
|
* \param gamecontroller The controller to query
|
||||||
* \returns SDL_TRUE, or SDL_FALSE if this controller does not have rumble
|
* \returns SDL_TRUE, or SDL_FALSE if this controller does not have rumble
|
||||||
* support.
|
* support
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.18.
|
* \since This function is available since SDL 2.0.18.
|
||||||
*
|
*
|
||||||
@@ -1022,9 +986,9 @@ extern DECLSPEC SDL_bool SDLCALL SDL_GameControllerHasRumble(SDL_GameController
|
|||||||
/**
|
/**
|
||||||
* Query whether a game controller has rumble support on triggers.
|
* Query whether a game controller has rumble support on triggers.
|
||||||
*
|
*
|
||||||
* \param gamecontroller The controller to query.
|
* \param gamecontroller The controller to query
|
||||||
* \returns SDL_TRUE, or SDL_FALSE if this controller does not have trigger
|
* \returns SDL_TRUE, or SDL_FALSE if this controller does not have trigger
|
||||||
* rumble support.
|
* rumble support
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.18.
|
* \since This function is available since SDL 2.0.18.
|
||||||
*
|
*
|
||||||
@@ -1035,11 +999,11 @@ extern DECLSPEC SDL_bool SDLCALL SDL_GameControllerHasRumbleTriggers(SDL_GameCon
|
|||||||
/**
|
/**
|
||||||
* Update a game controller's LED color.
|
* Update a game controller's LED color.
|
||||||
*
|
*
|
||||||
* \param gamecontroller The controller to update.
|
* \param gamecontroller The controller to update
|
||||||
* \param red The intensity of the red LED.
|
* \param red The intensity of the red LED
|
||||||
* \param green The intensity of the green LED.
|
* \param green The intensity of the green LED
|
||||||
* \param blue The intensity of the blue LED.
|
* \param blue The intensity of the blue LED
|
||||||
* \returns 0, or -1 if this controller does not have a modifiable LED.
|
* \returns 0, or -1 if this controller does not have a modifiable LED
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.14.
|
* \since This function is available since SDL 2.0.14.
|
||||||
*/
|
*/
|
||||||
@@ -1048,11 +1012,11 @@ extern DECLSPEC int SDLCALL SDL_GameControllerSetLED(SDL_GameController *gamecon
|
|||||||
/**
|
/**
|
||||||
* Send a controller specific effect packet
|
* Send a controller specific effect packet
|
||||||
*
|
*
|
||||||
* \param gamecontroller The controller to affect.
|
* \param gamecontroller The controller to affect
|
||||||
* \param data The data to send to the controller.
|
* \param data The data to send to the controller
|
||||||
* \param size The size of the data to send to the controller.
|
* \param size The size of the data to send to the controller
|
||||||
* \returns 0, or -1 if this controller or driver doesn't support effect
|
* \returns 0, or -1 if this controller or driver doesn't support effect
|
||||||
* packets.
|
* packets
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.16.
|
* \since This function is available since SDL 2.0.16.
|
||||||
*/
|
*/
|
||||||
@@ -1062,7 +1026,7 @@ extern DECLSPEC int SDLCALL SDL_GameControllerSendEffect(SDL_GameController *gam
|
|||||||
* Close a game controller previously opened with SDL_GameControllerOpen().
|
* Close a game controller previously opened with SDL_GameControllerOpen().
|
||||||
*
|
*
|
||||||
* \param gamecontroller a game controller identifier previously returned by
|
* \param gamecontroller a game controller identifier previously returned by
|
||||||
* SDL_GameControllerOpen().
|
* SDL_GameControllerOpen()
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.0.
|
* \since This function is available since SDL 2.0.0.
|
||||||
*
|
*
|
||||||
@@ -1074,9 +1038,9 @@ extern DECLSPEC void SDLCALL SDL_GameControllerClose(SDL_GameController *gamecon
|
|||||||
* Return the sfSymbolsName for a given button on a game controller on Apple
|
* Return the sfSymbolsName for a given button on a game controller on Apple
|
||||||
* platforms.
|
* platforms.
|
||||||
*
|
*
|
||||||
* \param gamecontroller the controller to query.
|
* \param gamecontroller the controller to query
|
||||||
* \param button a button on the game controller.
|
* \param button a button on the game controller
|
||||||
* \returns the sfSymbolsName or NULL if the name can't be found.
|
* \returns the sfSymbolsName or NULL if the name can't be found
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.18.
|
* \since This function is available since SDL 2.0.18.
|
||||||
*
|
*
|
||||||
@@ -1088,9 +1052,9 @@ extern DECLSPEC const char* SDLCALL SDL_GameControllerGetAppleSFSymbolsNameForBu
|
|||||||
* Return the sfSymbolsName for a given axis on a game controller on Apple
|
* Return the sfSymbolsName for a given axis on a game controller on Apple
|
||||||
* platforms.
|
* platforms.
|
||||||
*
|
*
|
||||||
* \param gamecontroller the controller to query.
|
* \param gamecontroller the controller to query
|
||||||
* \param axis an axis on the game controller.
|
* \param axis an axis on the game controller
|
||||||
* \returns the sfSymbolsName or NULL if the name can't be found.
|
* \returns the sfSymbolsName or NULL if the name can't be found
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.18.
|
* \since This function is available since SDL 2.0.18.
|
||||||
*
|
*
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
/*
|
/*
|
||||||
Simple DirectMedia Layer
|
Simple DirectMedia Layer
|
||||||
Copyright (C) 1997-2025 Sam Lantinga <slouken@libsdl.org>
|
Copyright (C) 1997-2023 Sam Lantinga <slouken@libsdl.org>
|
||||||
|
|
||||||
This software is provided 'as-is', without any express or implied
|
This software is provided 'as-is', without any express or implied
|
||||||
warranty. In no event will the authors be held liable for any damages
|
warranty. In no event will the authors be held liable for any damages
|
||||||
@@ -20,9 +20,9 @@
|
|||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* # CategoryGesture
|
* \file SDL_gesture.h
|
||||||
*
|
*
|
||||||
* Include file for SDL gesture event handling.
|
* Include file for SDL gesture event handling.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#ifndef SDL_gesture_h_
|
#ifndef SDL_gesture_h_
|
||||||
@@ -51,7 +51,7 @@ typedef Sint64 SDL_GestureID;
|
|||||||
* If the parameter `touchId` is -1 (i.e., all devices), this function will
|
* If the parameter `touchId` is -1 (i.e., all devices), this function will
|
||||||
* always return 1, regardless of whether there actually are any devices.
|
* always return 1, regardless of whether there actually are any devices.
|
||||||
*
|
*
|
||||||
* \param touchId the touch device id, or -1 for all touch devices.
|
* \param touchId the touch device id, or -1 for all touch devices
|
||||||
* \returns 1 on success or 0 if the specified device could not be found.
|
* \returns 1 on success or 0 if the specified device could not be found.
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.0.
|
* \since This function is available since SDL 2.0.0.
|
||||||
@@ -64,7 +64,7 @@ extern DECLSPEC int SDLCALL SDL_RecordGesture(SDL_TouchID touchId);
|
|||||||
/**
|
/**
|
||||||
* Save all currently loaded Dollar Gesture templates.
|
* Save all currently loaded Dollar Gesture templates.
|
||||||
*
|
*
|
||||||
* \param dst a SDL_RWops to save to.
|
* \param dst a SDL_RWops to save to
|
||||||
* \returns the number of saved templates on success or 0 on failure; call
|
* \returns the number of saved templates on success or 0 on failure; call
|
||||||
* SDL_GetError() for more information.
|
* SDL_GetError() for more information.
|
||||||
*
|
*
|
||||||
@@ -78,8 +78,8 @@ extern DECLSPEC int SDLCALL SDL_SaveAllDollarTemplates(SDL_RWops *dst);
|
|||||||
/**
|
/**
|
||||||
* Save a currently loaded Dollar Gesture template.
|
* Save a currently loaded Dollar Gesture template.
|
||||||
*
|
*
|
||||||
* \param gestureId a gesture id.
|
* \param gestureId a gesture id
|
||||||
* \param dst a SDL_RWops to save to.
|
* \param dst a SDL_RWops to save to
|
||||||
* \returns 1 on success or 0 on failure; call SDL_GetError() for more
|
* \returns 1 on success or 0 on failure; call SDL_GetError() for more
|
||||||
* information.
|
* information.
|
||||||
*
|
*
|
||||||
@@ -94,8 +94,8 @@ extern DECLSPEC int SDLCALL SDL_SaveDollarTemplate(SDL_GestureID gestureId,SDL_R
|
|||||||
/**
|
/**
|
||||||
* Load Dollar Gesture templates from a file.
|
* Load Dollar Gesture templates from a file.
|
||||||
*
|
*
|
||||||
* \param touchId a touch id.
|
* \param touchId a touch id
|
||||||
* \param src a SDL_RWops to load from.
|
* \param src a SDL_RWops to load from
|
||||||
* \returns the number of loaded templates on success or a negative error code
|
* \returns the number of loaded templates on success or a negative error code
|
||||||
* (or 0) on failure; call SDL_GetError() for more information.
|
* (or 0) on failure; call SDL_GetError() for more information.
|
||||||
*
|
*
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
/*
|
/*
|
||||||
Simple DirectMedia Layer
|
Simple DirectMedia Layer
|
||||||
Copyright (C) 1997-2025 Sam Lantinga <slouken@libsdl.org>
|
Copyright (C) 1997-2023 Sam Lantinga <slouken@libsdl.org>
|
||||||
|
|
||||||
This software is provided 'as-is', without any express or implied
|
This software is provided 'as-is', without any express or implied
|
||||||
warranty. In no event will the authors be held liable for any damages
|
warranty. In no event will the authors be held liable for any damages
|
||||||
@@ -19,13 +19,10 @@
|
|||||||
3. This notice may not be removed or altered from any source distribution.
|
3. This notice may not be removed or altered from any source distribution.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/* WIKI CATEGORY: GUID */
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* # CategoryGUID
|
* \file SDL_guid.h
|
||||||
*
|
*
|
||||||
* A GUID is a 128-bit value that represents something that is uniquely
|
* Include file for handling ::SDL_GUID values.
|
||||||
* identifiable by this value: "globally unique."
|
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#ifndef SDL_guid_h_
|
#ifndef SDL_guid_h_
|
||||||
@@ -41,38 +38,34 @@ extern "C" {
|
|||||||
#endif
|
#endif
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* An SDL_GUID is a 128-bit identifier.
|
* An SDL_GUID is a 128-bit identifier for an input device that
|
||||||
|
* identifies that device across runs of SDL programs on the same
|
||||||
|
* platform. If the device is detached and then re-attached to a
|
||||||
|
* different port, or if the base system is rebooted, the device
|
||||||
|
* should still report the same GUID.
|
||||||
*
|
*
|
||||||
* This is an acronym for "Globally Unique ID."
|
* GUIDs are as precise as possible but are not guaranteed to
|
||||||
|
* distinguish physically distinct but equivalent devices. For
|
||||||
|
* example, two game controllers from the same vendor with the same
|
||||||
|
* product ID and revision may have the same GUID.
|
||||||
*
|
*
|
||||||
* While a GUID can be used to assign a unique value to almost anything, in
|
* GUIDs may be platform-dependent (i.e., the same device may report
|
||||||
* SDL these are largely used to identify input devices across runs of SDL
|
* different GUIDs on different operating systems).
|
||||||
* programs on the same platform.If the device is detached and then
|
|
||||||
* re-attached to a different port, or if the base system is rebooted, the
|
|
||||||
* device should still report the same GUID.
|
|
||||||
*
|
|
||||||
* GUIDs are as precise as possible but are not guaranteed to distinguish
|
|
||||||
* physically distinct but equivalent devices. For example, two game
|
|
||||||
* controllers from the same vendor with the same product ID and revision may
|
|
||||||
* have the same GUID.
|
|
||||||
*
|
|
||||||
* GUIDs may be platform-dependent (i.e., the same device may report different
|
|
||||||
* GUIDs on different operating systems).
|
|
||||||
*/
|
*/
|
||||||
typedef struct SDL_GUID {
|
typedef struct {
|
||||||
Uint8 data[16];
|
Uint8 data[16];
|
||||||
} SDL_GUID;
|
} SDL_GUID;
|
||||||
|
|
||||||
/* Function prototypes */
|
/* Function prototypes */
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Get an ASCII string representation for a given SDL_GUID.
|
* Get an ASCII string representation for a given ::SDL_GUID.
|
||||||
*
|
*
|
||||||
* You should supply at least 33 bytes for pszGUID.
|
* You should supply at least 33 bytes for pszGUID.
|
||||||
*
|
*
|
||||||
* \param guid the SDL_GUID you wish to convert to string.
|
* \param guid the ::SDL_GUID you wish to convert to string
|
||||||
* \param pszGUID buffer in which to write the ASCII string.
|
* \param pszGUID buffer in which to write the ASCII string
|
||||||
* \param cbGUID the size of pszGUID.
|
* \param cbGUID the size of pszGUID
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.24.0.
|
* \since This function is available since SDL 2.24.0.
|
||||||
*
|
*
|
||||||
@@ -81,14 +74,14 @@ typedef struct SDL_GUID {
|
|||||||
extern DECLSPEC void SDLCALL SDL_GUIDToString(SDL_GUID guid, char *pszGUID, int cbGUID);
|
extern DECLSPEC void SDLCALL SDL_GUIDToString(SDL_GUID guid, char *pszGUID, int cbGUID);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Convert a GUID string into a SDL_GUID structure.
|
* Convert a GUID string into a ::SDL_GUID structure.
|
||||||
*
|
*
|
||||||
* Performs no error checking. If this function is given a string containing
|
* Performs no error checking. If this function is given a string containing
|
||||||
* an invalid GUID, the function will silently succeed, but the GUID generated
|
* an invalid GUID, the function will silently succeed, but the GUID generated
|
||||||
* will not be useful.
|
* will not be useful.
|
||||||
*
|
*
|
||||||
* \param pchGUID string containing an ASCII representation of a GUID.
|
* \param pchGUID string containing an ASCII representation of a GUID
|
||||||
* \returns a SDL_GUID structure.
|
* \returns a ::SDL_GUID structure.
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.24.0.
|
* \since This function is available since SDL 2.24.0.
|
||||||
*
|
*
|
||||||
|
|||||||
File diff suppressed because it is too large.
Load diff
@@ -1,6 +1,6 @@
|
|||||||
/*
|
/*
|
||||||
Simple DirectMedia Layer
|
Simple DirectMedia Layer
|
||||||
Copyright (C) 1997-2025 Sam Lantinga <slouken@libsdl.org>
|
Copyright (C) 1997-2023 Sam Lantinga <slouken@libsdl.org>
|
||||||
|
|
||||||
This software is provided 'as-is', without any express or implied
|
This software is provided 'as-is', without any express or implied
|
||||||
warranty. In no event will the authors be held liable for any damages
|
warranty. In no event will the authors be held liable for any damages
|
||||||
@@ -19,35 +19,44 @@
|
|||||||
3. This notice may not be removed or altered from any source distribution.
|
3. This notice may not be removed or altered from any source distribution.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/* WIKI CATEGORY: HIDAPI */
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* # CategoryHIDAPI
|
* \file SDL_hidapi.h
|
||||||
*
|
*
|
||||||
* Header file for SDL HIDAPI functions.
|
* Header file for SDL HIDAPI functions.
|
||||||
*
|
*
|
||||||
* This is an adaptation of the original HIDAPI interface by Alan Ott, and
|
* This is an adaptation of the original HIDAPI interface by Alan Ott,
|
||||||
* includes source code licensed under the following license:
|
* and includes source code licensed under the following BSD license:
|
||||||
*
|
*
|
||||||
* ```
|
Copyright (c) 2010, Alan Ott, Signal 11 Software
|
||||||
* HIDAPI - Multi-Platform library for
|
All rights reserved.
|
||||||
* communication with HID devices.
|
|
||||||
*
|
Redistribution and use in source and binary forms, with or without
|
||||||
* Copyright 2009, Alan Ott, Signal 11 Software.
|
modification, are permitted provided that the following conditions are met:
|
||||||
* All Rights Reserved.
|
|
||||||
*
|
* Redistributions of source code must retain the above copyright notice,
|
||||||
* This software may be used by anyone for any reason so
|
this list of conditions and the following disclaimer.
|
||||||
* long as the copyright notice in the source files
|
* Redistributions in binary form must reproduce the above copyright
|
||||||
* remains intact.
|
notice, this list of conditions and the following disclaimer in the
|
||||||
* ```
|
documentation and/or other materials provided with the distribution.
|
||||||
*
|
* Neither the name of Signal 11 Software nor the names of its
|
||||||
* (Note that this license is the same as item three of SDL's zlib license, so
|
contributors may be used to endorse or promote products derived from
|
||||||
* it adds no new requirements on the user.)
|
this software without specific prior written permission.
|
||||||
|
|
||||||
|
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
||||||
|
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
||||||
|
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
||||||
|
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
|
||||||
|
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
||||||
|
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
||||||
|
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
||||||
|
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
||||||
|
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
||||||
|
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
||||||
|
POSSIBILITY OF SUCH DAMAGE.
|
||||||
*
|
*
|
||||||
* If you would like a version of SDL without this code, you can build SDL
|
* If you would like a version of SDL without this code, you can build SDL
|
||||||
* with SDL_HIDAPI_DISABLED defined to 1. You might want to do this for
|
* with SDL_HIDAPI_DISABLED defined to 1. You might want to do this for example
|
||||||
* example on iOS or tvOS to avoid a dependency on the CoreBluetooth
|
* on iOS or tvOS to avoid a dependency on the CoreBluetooth framework.
|
||||||
* framework.
|
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#ifndef SDL_hidapi_h_
|
#ifndef SDL_hidapi_h_
|
||||||
@@ -62,15 +71,14 @@ extern "C" {
|
|||||||
#endif
|
#endif
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* A handle representing an open HID device
|
* \brief A handle representing an open HID device
|
||||||
*/
|
*/
|
||||||
struct SDL_hid_device_;
|
struct SDL_hid_device_;
|
||||||
typedef struct SDL_hid_device_ SDL_hid_device; /**< opaque hidapi structure */
|
typedef struct SDL_hid_device_ SDL_hid_device; /**< opaque hidapi structure */
|
||||||
|
|
||||||
/** hidapi info structure */
|
/** hidapi info structure */
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Information about a connected HID device
|
* \brief Information about a connected HID device
|
||||||
*/
|
*/
|
||||||
typedef struct SDL_hid_device_info
|
typedef struct SDL_hid_device_info
|
||||||
{
|
{
|
||||||
@@ -226,13 +234,13 @@ extern DECLSPEC SDL_hid_device * SDLCALL SDL_hid_open(unsigned short vendor_id,
|
|||||||
* The path name be determined by calling SDL_hid_enumerate(), or a
|
* The path name be determined by calling SDL_hid_enumerate(), or a
|
||||||
* platform-specific path name can be used (eg: /dev/hidraw0 on Linux).
|
* platform-specific path name can be used (eg: /dev/hidraw0 on Linux).
|
||||||
*
|
*
|
||||||
* \param path The path name of the device to open.
|
* \param path The path name of the device to open
|
||||||
* \returns a pointer to a SDL_hid_device object on success or NULL on
|
* \returns a pointer to a SDL_hid_device object on success or NULL on
|
||||||
* failure.
|
* failure.
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.18.
|
* \since This function is available since SDL 2.0.18.
|
||||||
*/
|
*/
|
||||||
extern DECLSPEC SDL_hid_device * SDLCALL SDL_hid_open_path(const char *path, int bExclusive);
|
extern DECLSPEC SDL_hid_device * SDLCALL SDL_hid_open_path(const char *path, int bExclusive /* = false */);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Write an Output report to a HID device.
|
* Write an Output report to a HID device.
|
||||||
@@ -426,7 +434,7 @@ extern DECLSPEC int SDLCALL SDL_hid_get_indexed_string(SDL_hid_device *dev, int
|
|||||||
/**
|
/**
|
||||||
* Start or stop a BLE scan on iOS and tvOS to pair Steam Controllers
|
* Start or stop a BLE scan on iOS and tvOS to pair Steam Controllers
|
||||||
*
|
*
|
||||||
* \param active SDL_TRUE to start the scan, SDL_FALSE to stop the scan.
|
* \param active SDL_TRUE to start the scan, SDL_FALSE to stop the scan
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.18.
|
* \since This function is available since SDL 2.0.18.
|
||||||
*/
|
*/
|
||||||
|
|||||||
File diff suppressed because it is too large.
Load diff
@@ -1,6 +1,6 @@
|
|||||||
/*
|
/*
|
||||||
Simple DirectMedia Layer
|
Simple DirectMedia Layer
|
||||||
Copyright (C) 1997-2025 Sam Lantinga <slouken@libsdl.org>
|
Copyright (C) 1997-2023 Sam Lantinga <slouken@libsdl.org>
|
||||||
|
|
||||||
This software is provided 'as-is', without any express or implied
|
This software is provided 'as-is', without any express or implied
|
||||||
warranty. In no event will the authors be held liable for any damages
|
warranty. In no event will the authors be held liable for any damages
|
||||||
@@ -20,26 +20,22 @@
|
|||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* # CategoryJoystick
|
* \file SDL_joystick.h
|
||||||
*
|
*
|
||||||
* Include file for SDL joystick event handling
|
* Include file for SDL joystick event handling
|
||||||
*
|
*
|
||||||
* The term "device_index" identifies currently plugged in joystick devices
|
* The term "device_index" identifies currently plugged in joystick devices between 0 and SDL_NumJoysticks(), with the exact joystick
|
||||||
* between 0 and SDL_NumJoysticks(), with the exact joystick behind a
|
* behind a device_index changing as joysticks are plugged and unplugged.
|
||||||
* device_index changing as joysticks are plugged and unplugged.
|
|
||||||
*
|
*
|
||||||
* The term "instance_id" is the current instantiation of a joystick device in
|
* The term "instance_id" is the current instantiation of a joystick device in the system, if the joystick is removed and then re-inserted
|
||||||
* the system, if the joystick is removed and then re-inserted then it will
|
* then it will get a new instance_id, instance_id's are monotonically increasing identifiers of a joystick plugged in.
|
||||||
* get a new instance_id, instance_id's are monotonically increasing
|
|
||||||
* identifiers of a joystick plugged in.
|
|
||||||
*
|
*
|
||||||
* The term "player_index" is the number assigned to a player on a specific
|
* The term "player_index" is the number assigned to a player on a specific
|
||||||
* controller. For XInput controllers this returns the XInput user index. Many
|
* controller. For XInput controllers this returns the XInput user index.
|
||||||
* joysticks will not be able to supply this information.
|
* Many joysticks will not be able to supply this information.
|
||||||
*
|
*
|
||||||
* The term JoystickGUID is a stable 128-bit identifier for a joystick device
|
* The term JoystickGUID is a stable 128-bit identifier for a joystick device that does not change over time, it identifies class of
|
||||||
* that does not change over time, it identifies class of the device (a X360
|
* the device (a X360 wired controller for example). This identifier is platform dependent.
|
||||||
* wired controller for example). This identifier is platform dependent.
|
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#ifndef SDL_joystick_h_
|
#ifndef SDL_joystick_h_
|
||||||
@@ -60,7 +56,7 @@ extern "C" {
|
|||||||
* \file SDL_joystick.h
|
* \file SDL_joystick.h
|
||||||
*
|
*
|
||||||
* In order to use these functions, SDL_Init() must have been called
|
* In order to use these functions, SDL_Init() must have been called
|
||||||
* with the SDL_INIT_JOYSTICK flag. This causes SDL to scan the system
|
* with the ::SDL_INIT_JOYSTICK flag. This causes SDL to scan the system
|
||||||
* for joysticks, and load appropriate drivers.
|
* for joysticks, and load appropriate drivers.
|
||||||
*
|
*
|
||||||
* If you would like to receive joystick updates while the application
|
* If you would like to receive joystick updates while the application
|
||||||
@@ -77,21 +73,15 @@ extern SDL_mutex *SDL_joystick_lock;
|
|||||||
struct _SDL_Joystick;
|
struct _SDL_Joystick;
|
||||||
typedef struct _SDL_Joystick SDL_Joystick;
|
typedef struct _SDL_Joystick SDL_Joystick;
|
||||||
|
|
||||||
/**
|
/* A structure that encodes the stable unique id for a joystick device */
|
||||||
* A structure that encodes the stable unique id for a joystick device.
|
|
||||||
*
|
|
||||||
* This is just a standard SDL_GUID by a different name.
|
|
||||||
*/
|
|
||||||
typedef SDL_GUID SDL_JoystickGUID;
|
typedef SDL_GUID SDL_JoystickGUID;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* This is a unique ID for a joystick for the time it is connected to the
|
* This is a unique ID for a joystick for the time it is connected to the system,
|
||||||
* system, and is never reused for the lifetime of the application.
|
* and is never reused for the lifetime of the application. If the joystick is
|
||||||
|
* disconnected and reconnected, it will get a new ID.
|
||||||
*
|
*
|
||||||
* If the joystick is disconnected and reconnected, it will get a new ID.
|
* The ID value starts at 0 and increments from there. The value -1 is an invalid ID.
|
||||||
*
|
|
||||||
* The ID value starts at 0 and increments from there. The value -1 is an
|
|
||||||
* invalid ID.
|
|
||||||
*/
|
*/
|
||||||
typedef Sint32 SDL_JoystickID;
|
typedef Sint32 SDL_JoystickID;
|
||||||
|
|
||||||
@@ -182,7 +172,7 @@ extern DECLSPEC int SDLCALL SDL_NumJoysticks(void);
|
|||||||
* This can be called before any joysticks are opened.
|
* This can be called before any joysticks are opened.
|
||||||
*
|
*
|
||||||
* \param device_index the index of the joystick to query (the N'th joystick
|
* \param device_index the index of the joystick to query (the N'th joystick
|
||||||
* on the system).
|
* on the system)
|
||||||
* \returns the name of the selected joystick. If no name can be found, this
|
* \returns the name of the selected joystick. If no name can be found, this
|
||||||
* function returns NULL; call SDL_GetError() for more information.
|
* function returns NULL; call SDL_GetError() for more information.
|
||||||
*
|
*
|
||||||
@@ -199,7 +189,7 @@ extern DECLSPEC const char *SDLCALL SDL_JoystickNameForIndex(int device_index);
|
|||||||
* This can be called before any joysticks are opened.
|
* This can be called before any joysticks are opened.
|
||||||
*
|
*
|
||||||
* \param device_index the index of the joystick to query (the N'th joystick
|
* \param device_index the index of the joystick to query (the N'th joystick
|
||||||
* on the system).
|
* on the system)
|
||||||
* \returns the path of the selected joystick. If no path can be found, this
|
* \returns the path of the selected joystick. If no path can be found, this
|
||||||
* function returns NULL; call SDL_GetError() for more information.
|
* function returns NULL; call SDL_GetError() for more information.
|
||||||
*
|
*
|
||||||
@@ -225,9 +215,9 @@ extern DECLSPEC int SDLCALL SDL_JoystickGetDevicePlayerIndex(int device_index);
|
|||||||
* This function can be called before any joysticks are opened.
|
* This function can be called before any joysticks are opened.
|
||||||
*
|
*
|
||||||
* \param device_index the index of the joystick to query (the N'th joystick
|
* \param device_index the index of the joystick to query (the N'th joystick
|
||||||
* on the system.
|
* on the system
|
||||||
* \returns the GUID of the selected joystick. If called on an invalid index,
|
* \returns the GUID of the selected joystick. If called on an invalid index,
|
||||||
* this function returns a zero GUID.
|
* this function returns a zero GUID
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.0.
|
* \since This function is available since SDL 2.0.0.
|
||||||
*
|
*
|
||||||
@@ -243,9 +233,9 @@ extern DECLSPEC SDL_JoystickGUID SDLCALL SDL_JoystickGetDeviceGUID(int device_in
|
|||||||
* available this function returns 0.
|
* available this function returns 0.
|
||||||
*
|
*
|
||||||
* \param device_index the index of the joystick to query (the N'th joystick
|
* \param device_index the index of the joystick to query (the N'th joystick
|
||||||
* on the system.
|
* on the system
|
||||||
* \returns the USB vendor ID of the selected joystick. If called on an
|
* \returns the USB vendor ID of the selected joystick. If called on an
|
||||||
* invalid index, this function returns zero.
|
* invalid index, this function returns zero
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.6.
|
* \since This function is available since SDL 2.0.6.
|
||||||
*/
|
*/
|
||||||
@@ -258,9 +248,9 @@ extern DECLSPEC Uint16 SDLCALL SDL_JoystickGetDeviceVendor(int device_index);
|
|||||||
* available this function returns 0.
|
* available this function returns 0.
|
||||||
*
|
*
|
||||||
* \param device_index the index of the joystick to query (the N'th joystick
|
* \param device_index the index of the joystick to query (the N'th joystick
|
||||||
* on the system.
|
* on the system
|
||||||
* \returns the USB product ID of the selected joystick. If called on an
|
* \returns the USB product ID of the selected joystick. If called on an
|
||||||
* invalid index, this function returns zero.
|
* invalid index, this function returns zero
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.6.
|
* \since This function is available since SDL 2.0.6.
|
||||||
*/
|
*/
|
||||||
@@ -273,9 +263,9 @@ extern DECLSPEC Uint16 SDLCALL SDL_JoystickGetDeviceProduct(int device_index);
|
|||||||
* isn't available this function returns 0.
|
* isn't available this function returns 0.
|
||||||
*
|
*
|
||||||
* \param device_index the index of the joystick to query (the N'th joystick
|
* \param device_index the index of the joystick to query (the N'th joystick
|
||||||
* on the system.
|
* on the system
|
||||||
* \returns the product version of the selected joystick. If called on an
|
* \returns the product version of the selected joystick. If called on an
|
||||||
* invalid index, this function returns zero.
|
* invalid index, this function returns zero
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.6.
|
* \since This function is available since SDL 2.0.6.
|
||||||
*/
|
*/
|
||||||
@@ -287,9 +277,9 @@ extern DECLSPEC Uint16 SDLCALL SDL_JoystickGetDeviceProductVersion(int device_in
|
|||||||
* This can be called before any joysticks are opened.
|
* This can be called before any joysticks are opened.
|
||||||
*
|
*
|
||||||
* \param device_index the index of the joystick to query (the N'th joystick
|
* \param device_index the index of the joystick to query (the N'th joystick
|
||||||
* on the system.
|
* on the system
|
||||||
* \returns the SDL_JoystickType of the selected joystick. If called on an
|
* \returns the SDL_JoystickType of the selected joystick. If called on an
|
||||||
* invalid index, this function returns `SDL_JOYSTICK_TYPE_UNKNOWN`.
|
* invalid index, this function returns `SDL_JOYSTICK_TYPE_UNKNOWN`
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.6.
|
* \since This function is available since SDL 2.0.6.
|
||||||
*/
|
*/
|
||||||
@@ -301,7 +291,7 @@ extern DECLSPEC SDL_JoystickType SDLCALL SDL_JoystickGetDeviceType(int device_in
|
|||||||
* This can be called before any joysticks are opened.
|
* This can be called before any joysticks are opened.
|
||||||
*
|
*
|
||||||
* \param device_index the index of the joystick to query (the N'th joystick
|
* \param device_index the index of the joystick to query (the N'th joystick
|
||||||
* on the system.
|
* on the system
|
||||||
* \returns the instance id of the selected joystick. If called on an invalid
|
* \returns the instance id of the selected joystick. If called on an invalid
|
||||||
* index, this function returns -1.
|
* index, this function returns -1.
|
||||||
*
|
*
|
||||||
@@ -320,7 +310,7 @@ extern DECLSPEC SDL_JoystickID SDLCALL SDL_JoystickGetDeviceInstanceID(int devic
|
|||||||
* The joystick subsystem must be initialized before a joystick can be opened
|
* The joystick subsystem must be initialized before a joystick can be opened
|
||||||
* for use.
|
* for use.
|
||||||
*
|
*
|
||||||
* \param device_index the index of the joystick to query.
|
* \param device_index the index of the joystick to query
|
||||||
* \returns a joystick identifier or NULL if an error occurred; call
|
* \returns a joystick identifier or NULL if an error occurred; call
|
||||||
* SDL_GetError() for more information.
|
* SDL_GetError() for more information.
|
||||||
*
|
*
|
||||||
@@ -334,7 +324,7 @@ extern DECLSPEC SDL_Joystick *SDLCALL SDL_JoystickOpen(int device_index);
|
|||||||
/**
|
/**
|
||||||
* Get the SDL_Joystick associated with an instance id.
|
* Get the SDL_Joystick associated with an instance id.
|
||||||
*
|
*
|
||||||
* \param instance_id the instance id to get the SDL_Joystick for.
|
* \param instance_id the instance id to get the SDL_Joystick for
|
||||||
* \returns an SDL_Joystick on success or NULL on failure; call SDL_GetError()
|
* \returns an SDL_Joystick on success or NULL on failure; call SDL_GetError()
|
||||||
* for more information.
|
* for more information.
|
||||||
*
|
*
|
||||||
@@ -345,7 +335,7 @@ extern DECLSPEC SDL_Joystick *SDLCALL SDL_JoystickFromInstanceID(SDL_JoystickID
|
|||||||
/**
|
/**
|
||||||
* Get the SDL_Joystick associated with a player index.
|
* Get the SDL_Joystick associated with a player index.
|
||||||
*
|
*
|
||||||
* \param player_index the player index to get the SDL_Joystick for.
|
* \param player_index the player index to get the SDL_Joystick for
|
||||||
* \returns an SDL_Joystick on success or NULL on failure; call SDL_GetError()
|
* \returns an SDL_Joystick on success or NULL on failure; call SDL_GetError()
|
||||||
* for more information.
|
* for more information.
|
||||||
*
|
*
|
||||||
@@ -368,10 +358,8 @@ extern DECLSPEC int SDLCALL SDL_JoystickAttachVirtual(SDL_JoystickType type,
|
|||||||
/**
|
/**
|
||||||
* The structure that defines an extended virtual joystick description
|
* The structure that defines an extended virtual joystick description
|
||||||
*
|
*
|
||||||
* The caller must zero the structure and then initialize the version with
|
* The caller must zero the structure and then initialize the version with `SDL_VIRTUAL_JOYSTICK_DESC_VERSION` before passing it to SDL_JoystickAttachVirtualEx()
|
||||||
* `SDL_VIRTUAL_JOYSTICK_DESC_VERSION` before passing it to
|
* All other elements of this structure are optional and can be left 0.
|
||||||
* SDL_JoystickAttachVirtualEx() All other elements of this structure are
|
|
||||||
* optional and can be left 0.
|
|
||||||
*
|
*
|
||||||
* \sa SDL_JoystickAttachVirtualEx
|
* \sa SDL_JoystickAttachVirtualEx
|
||||||
*/
|
*/
|
||||||
@@ -402,7 +390,7 @@ typedef struct SDL_VirtualJoystickDesc
|
|||||||
} SDL_VirtualJoystickDesc;
|
} SDL_VirtualJoystickDesc;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The current version of the SDL_VirtualJoystickDesc structure
|
* \brief The current version of the SDL_VirtualJoystickDesc structure
|
||||||
*/
|
*/
|
||||||
#define SDL_VIRTUAL_JOYSTICK_DESC_VERSION 1
|
#define SDL_VIRTUAL_JOYSTICK_DESC_VERSION 1
|
||||||
|
|
||||||
@@ -419,7 +407,7 @@ extern DECLSPEC int SDLCALL SDL_JoystickAttachVirtualEx(const SDL_VirtualJoystic
|
|||||||
* Detach a virtual joystick.
|
* Detach a virtual joystick.
|
||||||
*
|
*
|
||||||
* \param device_index a value previously returned from
|
* \param device_index a value previously returned from
|
||||||
* SDL_JoystickAttachVirtual().
|
* SDL_JoystickAttachVirtual()
|
||||||
* \returns 0 on success, or -1 if an error occurred.
|
* \returns 0 on success, or -1 if an error occurred.
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.14.
|
* \since This function is available since SDL 2.0.14.
|
||||||
@@ -497,7 +485,7 @@ extern DECLSPEC int SDLCALL SDL_JoystickSetVirtualHat(SDL_Joystick *joystick, in
|
|||||||
/**
|
/**
|
||||||
* Get the implementation dependent name of a joystick.
|
* Get the implementation dependent name of a joystick.
|
||||||
*
|
*
|
||||||
* \param joystick the SDL_Joystick obtained from SDL_JoystickOpen().
|
* \param joystick the SDL_Joystick obtained from SDL_JoystickOpen()
|
||||||
* \returns the name of the selected joystick. If no name can be found, this
|
* \returns the name of the selected joystick. If no name can be found, this
|
||||||
* function returns NULL; call SDL_GetError() for more information.
|
* function returns NULL; call SDL_GetError() for more information.
|
||||||
*
|
*
|
||||||
@@ -511,7 +499,7 @@ extern DECLSPEC const char *SDLCALL SDL_JoystickName(SDL_Joystick *joystick);
|
|||||||
/**
|
/**
|
||||||
* Get the implementation dependent path of a joystick.
|
* Get the implementation dependent path of a joystick.
|
||||||
*
|
*
|
||||||
* \param joystick the SDL_Joystick obtained from SDL_JoystickOpen().
|
* \param joystick the SDL_Joystick obtained from SDL_JoystickOpen()
|
||||||
* \returns the path of the selected joystick. If no path can be found, this
|
* \returns the path of the selected joystick. If no path can be found, this
|
||||||
* function returns NULL; call SDL_GetError() for more information.
|
* function returns NULL; call SDL_GetError() for more information.
|
||||||
*
|
*
|
||||||
@@ -527,7 +515,7 @@ extern DECLSPEC const char *SDLCALL SDL_JoystickPath(SDL_Joystick *joystick);
|
|||||||
* For XInput controllers this returns the XInput user index. Many joysticks
|
* For XInput controllers this returns the XInput user index. Many joysticks
|
||||||
* will not be able to supply this information.
|
* will not be able to supply this information.
|
||||||
*
|
*
|
||||||
* \param joystick the SDL_Joystick obtained from SDL_JoystickOpen().
|
* \param joystick the SDL_Joystick obtained from SDL_JoystickOpen()
|
||||||
* \returns the player index, or -1 if it's not available.
|
* \returns the player index, or -1 if it's not available.
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.9.
|
* \since This function is available since SDL 2.0.9.
|
||||||
@@ -537,7 +525,7 @@ extern DECLSPEC int SDLCALL SDL_JoystickGetPlayerIndex(SDL_Joystick *joystick);
|
|||||||
/**
|
/**
|
||||||
* Set the player index of an opened joystick.
|
* Set the player index of an opened joystick.
|
||||||
*
|
*
|
||||||
* \param joystick the SDL_Joystick obtained from SDL_JoystickOpen().
|
* \param joystick the SDL_Joystick obtained from SDL_JoystickOpen()
|
||||||
* \param player_index Player index to assign to this joystick, or -1 to clear
|
* \param player_index Player index to assign to this joystick, or -1 to clear
|
||||||
* the player index and turn off player LEDs.
|
* the player index and turn off player LEDs.
|
||||||
*
|
*
|
||||||
@@ -550,7 +538,7 @@ extern DECLSPEC void SDLCALL SDL_JoystickSetPlayerIndex(SDL_Joystick *joystick,
|
|||||||
*
|
*
|
||||||
* This function requires an open joystick.
|
* This function requires an open joystick.
|
||||||
*
|
*
|
||||||
* \param joystick the SDL_Joystick obtained from SDL_JoystickOpen().
|
* \param joystick the SDL_Joystick obtained from SDL_JoystickOpen()
|
||||||
* \returns the GUID of the given joystick. If called on an invalid index,
|
* \returns the GUID of the given joystick. If called on an invalid index,
|
||||||
* this function returns a zero GUID; call SDL_GetError() for more
|
* this function returns a zero GUID; call SDL_GetError() for more
|
||||||
* information.
|
* information.
|
||||||
@@ -567,7 +555,7 @@ extern DECLSPEC SDL_JoystickGUID SDLCALL SDL_JoystickGetGUID(SDL_Joystick *joyst
|
|||||||
*
|
*
|
||||||
* If the vendor ID isn't available this function returns 0.
|
* If the vendor ID isn't available this function returns 0.
|
||||||
*
|
*
|
||||||
* \param joystick the SDL_Joystick obtained from SDL_JoystickOpen().
|
* \param joystick the SDL_Joystick obtained from SDL_JoystickOpen()
|
||||||
* \returns the USB vendor ID of the selected joystick, or 0 if unavailable.
|
* \returns the USB vendor ID of the selected joystick, or 0 if unavailable.
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.6.
|
* \since This function is available since SDL 2.0.6.
|
||||||
@@ -579,7 +567,7 @@ extern DECLSPEC Uint16 SDLCALL SDL_JoystickGetVendor(SDL_Joystick *joystick);
|
|||||||
*
|
*
|
||||||
* If the product ID isn't available this function returns 0.
|
* If the product ID isn't available this function returns 0.
|
||||||
*
|
*
|
||||||
* \param joystick the SDL_Joystick obtained from SDL_JoystickOpen().
|
* \param joystick the SDL_Joystick obtained from SDL_JoystickOpen()
|
||||||
* \returns the USB product ID of the selected joystick, or 0 if unavailable.
|
* \returns the USB product ID of the selected joystick, or 0 if unavailable.
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.6.
|
* \since This function is available since SDL 2.0.6.
|
||||||
@@ -591,7 +579,7 @@ extern DECLSPEC Uint16 SDLCALL SDL_JoystickGetProduct(SDL_Joystick *joystick);
|
|||||||
*
|
*
|
||||||
* If the product version isn't available this function returns 0.
|
* If the product version isn't available this function returns 0.
|
||||||
*
|
*
|
||||||
* \param joystick the SDL_Joystick obtained from SDL_JoystickOpen().
|
* \param joystick the SDL_Joystick obtained from SDL_JoystickOpen()
|
||||||
* \returns the product version of the selected joystick, or 0 if unavailable.
|
* \returns the product version of the selected joystick, or 0 if unavailable.
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.6.
|
* \since This function is available since SDL 2.0.6.
|
||||||
@@ -603,7 +591,7 @@ extern DECLSPEC Uint16 SDLCALL SDL_JoystickGetProductVersion(SDL_Joystick *joyst
|
|||||||
*
|
*
|
||||||
* If the firmware version isn't available this function returns 0.
|
* If the firmware version isn't available this function returns 0.
|
||||||
*
|
*
|
||||||
* \param joystick the SDL_Joystick obtained from SDL_JoystickOpen().
|
* \param joystick the SDL_Joystick obtained from SDL_JoystickOpen()
|
||||||
* \returns the firmware version of the selected joystick, or 0 if
|
* \returns the firmware version of the selected joystick, or 0 if
|
||||||
* unavailable.
|
* unavailable.
|
||||||
*
|
*
|
||||||
@@ -616,7 +604,7 @@ extern DECLSPEC Uint16 SDLCALL SDL_JoystickGetFirmwareVersion(SDL_Joystick *joys
|
|||||||
*
|
*
|
||||||
* Returns the serial number of the joystick, or NULL if it is not available.
|
* Returns the serial number of the joystick, or NULL if it is not available.
|
||||||
*
|
*
|
||||||
* \param joystick the SDL_Joystick obtained from SDL_JoystickOpen().
|
* \param joystick the SDL_Joystick obtained from SDL_JoystickOpen()
|
||||||
* \returns the serial number of the selected joystick, or NULL if
|
* \returns the serial number of the selected joystick, or NULL if
|
||||||
* unavailable.
|
* unavailable.
|
||||||
*
|
*
|
||||||
@@ -627,7 +615,7 @@ extern DECLSPEC const char * SDLCALL SDL_JoystickGetSerial(SDL_Joystick *joystic
|
|||||||
/**
|
/**
|
||||||
* Get the type of an opened joystick.
|
* Get the type of an opened joystick.
|
||||||
*
|
*
|
||||||
* \param joystick the SDL_Joystick obtained from SDL_JoystickOpen().
|
* \param joystick the SDL_Joystick obtained from SDL_JoystickOpen()
|
||||||
* \returns the SDL_JoystickType of the selected joystick.
|
* \returns the SDL_JoystickType of the selected joystick.
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.6.
|
* \since This function is available since SDL 2.0.6.
|
||||||
@@ -639,9 +627,9 @@ extern DECLSPEC SDL_JoystickType SDLCALL SDL_JoystickGetType(SDL_Joystick *joyst
|
|||||||
*
|
*
|
||||||
* You should supply at least 33 bytes for pszGUID.
|
* You should supply at least 33 bytes for pszGUID.
|
||||||
*
|
*
|
||||||
* \param guid the SDL_JoystickGUID you wish to convert to string.
|
* \param guid the SDL_JoystickGUID you wish to convert to string
|
||||||
* \param pszGUID buffer in which to write the ASCII string.
|
* \param pszGUID buffer in which to write the ASCII string
|
||||||
* \param cbGUID the size of pszGUID.
|
* \param cbGUID the size of pszGUID
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.0.
|
* \since This function is available since SDL 2.0.0.
|
||||||
*
|
*
|
||||||
@@ -658,7 +646,7 @@ extern DECLSPEC void SDLCALL SDL_JoystickGetGUIDString(SDL_JoystickGUID guid, ch
|
|||||||
* an invalid GUID, the function will silently succeed, but the GUID generated
|
* an invalid GUID, the function will silently succeed, but the GUID generated
|
||||||
* will not be useful.
|
* will not be useful.
|
||||||
*
|
*
|
||||||
* \param pchGUID string containing an ASCII representation of a GUID.
|
* \param pchGUID string containing an ASCII representation of a GUID
|
||||||
* \returns a SDL_JoystickGUID structure.
|
* \returns a SDL_JoystickGUID structure.
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.0.
|
* \since This function is available since SDL 2.0.0.
|
||||||
@@ -670,15 +658,15 @@ extern DECLSPEC SDL_JoystickGUID SDLCALL SDL_JoystickGetGUIDFromString(const cha
|
|||||||
/**
|
/**
|
||||||
* Get the device information encoded in a SDL_JoystickGUID structure
|
* Get the device information encoded in a SDL_JoystickGUID structure
|
||||||
*
|
*
|
||||||
* \param guid the SDL_JoystickGUID you wish to get info about.
|
* \param guid the SDL_JoystickGUID you wish to get info about
|
||||||
* \param vendor A pointer filled in with the device VID, or 0 if not
|
* \param vendor A pointer filled in with the device VID, or 0 if not
|
||||||
* available.
|
* available
|
||||||
* \param product A pointer filled in with the device PID, or 0 if not
|
* \param product A pointer filled in with the device PID, or 0 if not
|
||||||
* available.
|
* available
|
||||||
* \param version A pointer filled in with the device version, or 0 if not
|
* \param version A pointer filled in with the device version, or 0 if not
|
||||||
* available.
|
* available
|
||||||
* \param crc16 A pointer filled in with a CRC used to distinguish different
|
* \param crc16 A pointer filled in with a CRC used to distinguish different
|
||||||
* products with the same VID/PID, or 0 if not available.
|
* products with the same VID/PID, or 0 if not available
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.26.0.
|
* \since This function is available since SDL 2.26.0.
|
||||||
*
|
*
|
||||||
@@ -689,7 +677,7 @@ extern DECLSPEC void SDLCALL SDL_GetJoystickGUIDInfo(SDL_JoystickGUID guid, Uint
|
|||||||
/**
|
/**
|
||||||
* Get the status of a specified joystick.
|
* Get the status of a specified joystick.
|
||||||
*
|
*
|
||||||
* \param joystick the joystick to query.
|
* \param joystick the joystick to query
|
||||||
* \returns SDL_TRUE if the joystick has been opened, SDL_FALSE if it has not;
|
* \returns SDL_TRUE if the joystick has been opened, SDL_FALSE if it has not;
|
||||||
* call SDL_GetError() for more information.
|
* call SDL_GetError() for more information.
|
||||||
*
|
*
|
||||||
@@ -703,7 +691,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_JoystickGetAttached(SDL_Joystick *joystick)
|
|||||||
/**
|
/**
|
||||||
* Get the instance ID of an opened joystick.
|
* Get the instance ID of an opened joystick.
|
||||||
*
|
*
|
||||||
* \param joystick an SDL_Joystick structure containing joystick information.
|
* \param joystick an SDL_Joystick structure containing joystick information
|
||||||
* \returns the instance ID of the specified joystick on success or a negative
|
* \returns the instance ID of the specified joystick on success or a negative
|
||||||
* error code on failure; call SDL_GetError() for more information.
|
* error code on failure; call SDL_GetError() for more information.
|
||||||
*
|
*
|
||||||
@@ -720,7 +708,7 @@ extern DECLSPEC SDL_JoystickID SDLCALL SDL_JoystickInstanceID(SDL_Joystick *joys
|
|||||||
* separate buttons or a POV hat, and not axes, but all of this is up to the
|
* separate buttons or a POV hat, and not axes, but all of this is up to the
|
||||||
* device and platform.
|
* device and platform.
|
||||||
*
|
*
|
||||||
* \param joystick an SDL_Joystick structure containing joystick information.
|
* \param joystick an SDL_Joystick structure containing joystick information
|
||||||
* \returns the number of axis controls/number of axes on success or a
|
* \returns the number of axis controls/number of axes on success or a
|
||||||
* negative error code on failure; call SDL_GetError() for more
|
* negative error code on failure; call SDL_GetError() for more
|
||||||
* information.
|
* information.
|
||||||
@@ -740,7 +728,7 @@ extern DECLSPEC int SDLCALL SDL_JoystickNumAxes(SDL_Joystick *joystick);
|
|||||||
*
|
*
|
||||||
* Most joysticks do not have trackballs.
|
* Most joysticks do not have trackballs.
|
||||||
*
|
*
|
||||||
* \param joystick an SDL_Joystick structure containing joystick information.
|
* \param joystick an SDL_Joystick structure containing joystick information
|
||||||
* \returns the number of trackballs on success or a negative error code on
|
* \returns the number of trackballs on success or a negative error code on
|
||||||
* failure; call SDL_GetError() for more information.
|
* failure; call SDL_GetError() for more information.
|
||||||
*
|
*
|
||||||
@@ -753,7 +741,7 @@ extern DECLSPEC int SDLCALL SDL_JoystickNumBalls(SDL_Joystick *joystick);
|
|||||||
/**
|
/**
|
||||||
* Get the number of POV hats on a joystick.
|
* Get the number of POV hats on a joystick.
|
||||||
*
|
*
|
||||||
* \param joystick an SDL_Joystick structure containing joystick information.
|
* \param joystick an SDL_Joystick structure containing joystick information
|
||||||
* \returns the number of POV hats on success or a negative error code on
|
* \returns the number of POV hats on success or a negative error code on
|
||||||
* failure; call SDL_GetError() for more information.
|
* failure; call SDL_GetError() for more information.
|
||||||
*
|
*
|
||||||
@@ -767,7 +755,7 @@ extern DECLSPEC int SDLCALL SDL_JoystickNumHats(SDL_Joystick *joystick);
|
|||||||
/**
|
/**
|
||||||
* Get the number of buttons on a joystick.
|
* Get the number of buttons on a joystick.
|
||||||
*
|
*
|
||||||
* \param joystick an SDL_Joystick structure containing joystick information.
|
* \param joystick an SDL_Joystick structure containing joystick information
|
||||||
* \returns the number of buttons on success or a negative error code on
|
* \returns the number of buttons on success or a negative error code on
|
||||||
* failure; call SDL_GetError() for more information.
|
* failure; call SDL_GetError() for more information.
|
||||||
*
|
*
|
||||||
@@ -802,17 +790,12 @@ extern DECLSPEC void SDLCALL SDL_JoystickUpdate(void);
|
|||||||
* **WARNING**: Calling this function may delete all events currently in SDL's
|
* **WARNING**: Calling this function may delete all events currently in SDL's
|
||||||
* event queue.
|
* event queue.
|
||||||
*
|
*
|
||||||
* While `param` is meant to be one of `SDL_QUERY`, `SDL_IGNORE`, or
|
* \param state can be one of `SDL_QUERY`, `SDL_IGNORE`, or `SDL_ENABLE`
|
||||||
* `SDL_ENABLE`, this function accepts any value, with any non-zero value that
|
* \returns 1 if enabled, 0 if disabled, or a negative error code on failure;
|
||||||
* isn't `SDL_QUERY` being treated as `SDL_ENABLE`.
|
* call SDL_GetError() for more information.
|
||||||
*
|
*
|
||||||
* If SDL was built with events disabled (extremely uncommon!), this will do
|
* If `state` is `SDL_QUERY` then the current state is returned,
|
||||||
* nothing and always return `SDL_IGNORE`.
|
* otherwise the new processing state is returned.
|
||||||
*
|
|
||||||
* \param state can be one of `SDL_QUERY`, `SDL_IGNORE`, or `SDL_ENABLE`.
|
|
||||||
* \returns If `state` is `SDL_QUERY` then the current state is returned,
|
|
||||||
* otherwise `state` is returned (even if it was not one of the
|
|
||||||
* allowed values).
|
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.0.
|
* \since This function is available since SDL 2.0.0.
|
||||||
*
|
*
|
||||||
@@ -820,7 +803,6 @@ extern DECLSPEC void SDLCALL SDL_JoystickUpdate(void);
|
|||||||
*/
|
*/
|
||||||
extern DECLSPEC int SDLCALL SDL_JoystickEventState(int state);
|
extern DECLSPEC int SDLCALL SDL_JoystickEventState(int state);
|
||||||
|
|
||||||
/* Limits for joystick axes... */
|
|
||||||
#define SDL_JOYSTICK_AXIS_MAX 32767
|
#define SDL_JOYSTICK_AXIS_MAX 32767
|
||||||
#define SDL_JOYSTICK_AXIS_MIN -32768
|
#define SDL_JOYSTICK_AXIS_MIN -32768
|
||||||
|
|
||||||
@@ -837,8 +819,8 @@ extern DECLSPEC int SDLCALL SDL_JoystickEventState(int state);
|
|||||||
* 32767) representing the current position of the axis. It may be necessary
|
* 32767) representing the current position of the axis. It may be necessary
|
||||||
* to impose certain tolerances on these values to account for jitter.
|
* to impose certain tolerances on these values to account for jitter.
|
||||||
*
|
*
|
||||||
* \param joystick an SDL_Joystick structure containing joystick information.
|
* \param joystick an SDL_Joystick structure containing joystick information
|
||||||
* \param axis the axis to query; the axis indices start at index 0.
|
* \param axis the axis to query; the axis indices start at index 0
|
||||||
* \returns a 16-bit signed integer representing the current position of the
|
* \returns a 16-bit signed integer representing the current position of the
|
||||||
* axis or 0 on failure; call SDL_GetError() for more information.
|
* axis or 0 on failure; call SDL_GetError() for more information.
|
||||||
*
|
*
|
||||||
@@ -856,8 +838,8 @@ extern DECLSPEC Sint16 SDLCALL SDL_JoystickGetAxis(SDL_Joystick *joystick,
|
|||||||
*
|
*
|
||||||
* The axis indices start at index 0.
|
* The axis indices start at index 0.
|
||||||
*
|
*
|
||||||
* \param joystick an SDL_Joystick structure containing joystick information.
|
* \param joystick an SDL_Joystick structure containing joystick information
|
||||||
* \param axis the axis to query; the axis indices start at index 0.
|
* \param axis the axis to query; the axis indices start at index 0
|
||||||
* \param state Upon return, the initial value is supplied here.
|
* \param state Upon return, the initial value is supplied here.
|
||||||
* \return SDL_TRUE if this axis has any initial value, or SDL_FALSE if not.
|
* \return SDL_TRUE if this axis has any initial value, or SDL_FALSE if not.
|
||||||
*
|
*
|
||||||
@@ -896,8 +878,8 @@ extern DECLSPEC SDL_bool SDLCALL SDL_JoystickGetAxisInitialState(SDL_Joystick *j
|
|||||||
* - `SDL_HAT_LEFTUP`
|
* - `SDL_HAT_LEFTUP`
|
||||||
* - `SDL_HAT_LEFTDOWN`
|
* - `SDL_HAT_LEFTDOWN`
|
||||||
*
|
*
|
||||||
* \param joystick an SDL_Joystick structure containing joystick information.
|
* \param joystick an SDL_Joystick structure containing joystick information
|
||||||
* \param hat the hat index to get the state from; indices start at index 0.
|
* \param hat the hat index to get the state from; indices start at index 0
|
||||||
* \returns the current hat position.
|
* \returns the current hat position.
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.0.
|
* \since This function is available since SDL 2.0.0.
|
||||||
@@ -915,10 +897,10 @@ extern DECLSPEC Uint8 SDLCALL SDL_JoystickGetHat(SDL_Joystick *joystick,
|
|||||||
*
|
*
|
||||||
* Most joysticks do not have trackballs.
|
* Most joysticks do not have trackballs.
|
||||||
*
|
*
|
||||||
* \param joystick the SDL_Joystick to query.
|
* \param joystick the SDL_Joystick to query
|
||||||
* \param ball the ball index to query; ball indices start at index 0.
|
* \param ball the ball index to query; ball indices start at index 0
|
||||||
* \param dx stores the difference in the x axis position since the last poll.
|
* \param dx stores the difference in the x axis position since the last poll
|
||||||
* \param dy stores the difference in the y axis position since the last poll.
|
* \param dy stores the difference in the y axis position since the last poll
|
||||||
* \returns 0 on success or a negative error code on failure; call
|
* \returns 0 on success or a negative error code on failure; call
|
||||||
* SDL_GetError() for more information.
|
* SDL_GetError() for more information.
|
||||||
*
|
*
|
||||||
@@ -932,9 +914,9 @@ extern DECLSPEC int SDLCALL SDL_JoystickGetBall(SDL_Joystick *joystick,
|
|||||||
/**
|
/**
|
||||||
* Get the current state of a button on a joystick.
|
* Get the current state of a button on a joystick.
|
||||||
*
|
*
|
||||||
* \param joystick an SDL_Joystick structure containing joystick information.
|
* \param joystick an SDL_Joystick structure containing joystick information
|
||||||
* \param button the button index to get the state from; indices start at
|
* \param button the button index to get the state from; indices start at
|
||||||
* index 0.
|
* index 0
|
||||||
* \returns 1 if the specified button is pressed, 0 otherwise.
|
* \returns 1 if the specified button is pressed, 0 otherwise.
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.0.
|
* \since This function is available since SDL 2.0.0.
|
||||||
@@ -950,13 +932,13 @@ extern DECLSPEC Uint8 SDLCALL SDL_JoystickGetButton(SDL_Joystick *joystick,
|
|||||||
* Each call to this function cancels any previous rumble effect, and calling
|
* Each call to this function cancels any previous rumble effect, and calling
|
||||||
* it with 0 intensity stops any rumbling.
|
* it with 0 intensity stops any rumbling.
|
||||||
*
|
*
|
||||||
* \param joystick The joystick to vibrate.
|
* \param joystick The joystick to vibrate
|
||||||
* \param low_frequency_rumble The intensity of the low frequency (left)
|
* \param low_frequency_rumble The intensity of the low frequency (left)
|
||||||
* rumble motor, from 0 to 0xFFFF.
|
* rumble motor, from 0 to 0xFFFF
|
||||||
* \param high_frequency_rumble The intensity of the high frequency (right)
|
* \param high_frequency_rumble The intensity of the high frequency (right)
|
||||||
* rumble motor, from 0 to 0xFFFF.
|
* rumble motor, from 0 to 0xFFFF
|
||||||
* \param duration_ms The duration of the rumble effect, in milliseconds.
|
* \param duration_ms The duration of the rumble effect, in milliseconds
|
||||||
* \returns 0, or -1 if rumble isn't supported on this joystick.
|
* \returns 0, or -1 if rumble isn't supported on this joystick
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.9.
|
* \since This function is available since SDL 2.0.9.
|
||||||
*
|
*
|
||||||
@@ -975,13 +957,13 @@ extern DECLSPEC int SDLCALL SDL_JoystickRumble(SDL_Joystick *joystick, Uint16 lo
|
|||||||
* want the (more common) whole-controller rumble, use SDL_JoystickRumble()
|
* want the (more common) whole-controller rumble, use SDL_JoystickRumble()
|
||||||
* instead.
|
* instead.
|
||||||
*
|
*
|
||||||
* \param joystick The joystick to vibrate.
|
* \param joystick The joystick to vibrate
|
||||||
* \param left_rumble The intensity of the left trigger rumble motor, from 0
|
* \param left_rumble The intensity of the left trigger rumble motor, from 0
|
||||||
* to 0xFFFF.
|
* to 0xFFFF
|
||||||
* \param right_rumble The intensity of the right trigger rumble motor, from 0
|
* \param right_rumble The intensity of the right trigger rumble motor, from 0
|
||||||
* to 0xFFFF.
|
* to 0xFFFF
|
||||||
* \param duration_ms The duration of the rumble effect, in milliseconds.
|
* \param duration_ms The duration of the rumble effect, in milliseconds
|
||||||
* \returns 0, or -1 if trigger rumble isn't supported on this joystick.
|
* \returns 0, or -1 if trigger rumble isn't supported on this joystick
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.14.
|
* \since This function is available since SDL 2.0.14.
|
||||||
*
|
*
|
||||||
@@ -995,7 +977,7 @@ extern DECLSPEC int SDLCALL SDL_JoystickRumbleTriggers(SDL_Joystick *joystick, U
|
|||||||
* An example of a joystick LED is the light on the back of a PlayStation 4's
|
* An example of a joystick LED is the light on the back of a PlayStation 4's
|
||||||
* DualShock 4 controller.
|
* DualShock 4 controller.
|
||||||
*
|
*
|
||||||
* \param joystick The joystick to query.
|
* \param joystick The joystick to query
|
||||||
* \return SDL_TRUE if the joystick has a modifiable LED, SDL_FALSE otherwise.
|
* \return SDL_TRUE if the joystick has a modifiable LED, SDL_FALSE otherwise.
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.14.
|
* \since This function is available since SDL 2.0.14.
|
||||||
@@ -1005,7 +987,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_JoystickHasLED(SDL_Joystick *joystick);
|
|||||||
/**
|
/**
|
||||||
* Query whether a joystick has rumble support.
|
* Query whether a joystick has rumble support.
|
||||||
*
|
*
|
||||||
* \param joystick The joystick to query.
|
* \param joystick The joystick to query
|
||||||
* \return SDL_TRUE if the joystick has rumble, SDL_FALSE otherwise.
|
* \return SDL_TRUE if the joystick has rumble, SDL_FALSE otherwise.
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.18.
|
* \since This function is available since SDL 2.0.18.
|
||||||
@@ -1017,7 +999,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_JoystickHasRumble(SDL_Joystick *joystick);
|
|||||||
/**
|
/**
|
||||||
* Query whether a joystick has rumble support on triggers.
|
* Query whether a joystick has rumble support on triggers.
|
||||||
*
|
*
|
||||||
* \param joystick The joystick to query.
|
* \param joystick The joystick to query
|
||||||
* \return SDL_TRUE if the joystick has trigger rumble, SDL_FALSE otherwise.
|
* \return SDL_TRUE if the joystick has trigger rumble, SDL_FALSE otherwise.
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.18.
|
* \since This function is available since SDL 2.0.18.
|
||||||
@@ -1032,11 +1014,11 @@ extern DECLSPEC SDL_bool SDLCALL SDL_JoystickHasRumbleTriggers(SDL_Joystick *joy
|
|||||||
* An example of a joystick LED is the light on the back of a PlayStation 4's
|
* An example of a joystick LED is the light on the back of a PlayStation 4's
|
||||||
* DualShock 4 controller.
|
* DualShock 4 controller.
|
||||||
*
|
*
|
||||||
* \param joystick The joystick to update.
|
* \param joystick The joystick to update
|
||||||
* \param red The intensity of the red LED.
|
* \param red The intensity of the red LED
|
||||||
* \param green The intensity of the green LED.
|
* \param green The intensity of the green LED
|
||||||
* \param blue The intensity of the blue LED.
|
* \param blue The intensity of the blue LED
|
||||||
* \returns 0 on success, -1 if this joystick does not have a modifiable LED.
|
* \returns 0 on success, -1 if this joystick does not have a modifiable LED
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.14.
|
* \since This function is available since SDL 2.0.14.
|
||||||
*/
|
*/
|
||||||
@@ -1045,11 +1027,10 @@ extern DECLSPEC int SDLCALL SDL_JoystickSetLED(SDL_Joystick *joystick, Uint8 red
|
|||||||
/**
|
/**
|
||||||
* Send a joystick specific effect packet
|
* Send a joystick specific effect packet
|
||||||
*
|
*
|
||||||
* \param joystick The joystick to affect.
|
* \param joystick The joystick to affect
|
||||||
* \param data The data to send to the joystick.
|
* \param data The data to send to the joystick
|
||||||
* \param size The size of the data to send to the joystick.
|
* \param size The size of the data to send to the joystick
|
||||||
* \returns 0, or -1 if this joystick or driver doesn't support effect
|
* \returns 0, or -1 if this joystick or driver doesn't support effect packets
|
||||||
* packets.
|
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.16.
|
* \since This function is available since SDL 2.0.16.
|
||||||
*/
|
*/
|
||||||
@@ -1058,7 +1039,7 @@ extern DECLSPEC int SDLCALL SDL_JoystickSendEffect(SDL_Joystick *joystick, const
|
|||||||
/**
|
/**
|
||||||
* Close a joystick previously opened with SDL_JoystickOpen().
|
* Close a joystick previously opened with SDL_JoystickOpen().
|
||||||
*
|
*
|
||||||
* \param joystick The joystick device to close.
|
* \param joystick The joystick device to close
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.0.
|
* \since This function is available since SDL 2.0.0.
|
||||||
*
|
*
|
||||||
@@ -1069,9 +1050,9 @@ extern DECLSPEC void SDLCALL SDL_JoystickClose(SDL_Joystick *joystick);
|
|||||||
/**
|
/**
|
||||||
* Get the battery level of a joystick as SDL_JoystickPowerLevel.
|
* Get the battery level of a joystick as SDL_JoystickPowerLevel.
|
||||||
*
|
*
|
||||||
* \param joystick the SDL_Joystick to query.
|
* \param joystick the SDL_Joystick to query
|
||||||
* \returns the current battery level as SDL_JoystickPowerLevel on success or
|
* \returns the current battery level as SDL_JoystickPowerLevel on success or
|
||||||
* `SDL_JOYSTICK_POWER_UNKNOWN` if it is unknown.
|
* `SDL_JOYSTICK_POWER_UNKNOWN` if it is unknown
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.4.
|
* \since This function is available since SDL 2.0.4.
|
||||||
*/
|
*/
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
/*
|
/*
|
||||||
Simple DirectMedia Layer
|
Simple DirectMedia Layer
|
||||||
Copyright (C) 1997-2025 Sam Lantinga <slouken@libsdl.org>
|
Copyright (C) 1997-2023 Sam Lantinga <slouken@libsdl.org>
|
||||||
|
|
||||||
This software is provided 'as-is', without any express or implied
|
This software is provided 'as-is', without any express or implied
|
||||||
warranty. In no event will the authors be held liable for any damages
|
warranty. In no event will the authors be held liable for any damages
|
||||||
@@ -20,9 +20,9 @@
|
|||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* # CategoryKeyboard
|
* \file SDL_keyboard.h
|
||||||
*
|
*
|
||||||
* Include file for SDL keyboard event handling
|
* Include file for SDL keyboard event handling
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#ifndef SDL_keyboard_h_
|
#ifndef SDL_keyboard_h_
|
||||||
@@ -40,16 +40,15 @@ extern "C" {
|
|||||||
#endif
|
#endif
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The SDL keysym structure, used in key events.
|
* \brief The SDL keysym structure, used in key events.
|
||||||
*
|
*
|
||||||
* If you are looking for translated character input, see the SDL_TEXTINPUT
|
* \note If you are looking for translated character input, see the ::SDL_TEXTINPUT event.
|
||||||
* event.
|
|
||||||
*/
|
*/
|
||||||
typedef struct SDL_Keysym
|
typedef struct SDL_Keysym
|
||||||
{
|
{
|
||||||
SDL_Scancode scancode; /**< SDL physical key code - see SDL_Scancode for details */
|
SDL_Scancode scancode; /**< SDL physical key code - see ::SDL_Scancode for details */
|
||||||
SDL_Keycode sym; /**< SDL virtual key code - see SDL_Keycode for details */
|
SDL_Keycode sym; /**< SDL virtual key code - see ::SDL_Keycode for details */
|
||||||
Uint16 mod; /**< current key modifiers - see SDL_Keymod for details */
|
Uint16 mod; /**< current key modifiers */
|
||||||
Uint32 unused;
|
Uint32 unused;
|
||||||
} SDL_Keysym;
|
} SDL_Keysym;
|
||||||
|
|
||||||
@@ -85,7 +84,7 @@ extern DECLSPEC SDL_Window * SDLCALL SDL_GetKeyboardFocus(void);
|
|||||||
* Note: This function doesn't take into account whether shift has been
|
* Note: This function doesn't take into account whether shift has been
|
||||||
* pressed or not.
|
* pressed or not.
|
||||||
*
|
*
|
||||||
* \param numkeys if non-NULL, receives the length of the returned array.
|
* \param numkeys if non-NULL, receives the length of the returned array
|
||||||
* \returns a pointer to an array of key states.
|
* \returns a pointer to an array of key states.
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.0.
|
* \since This function is available since SDL 2.0.0.
|
||||||
@@ -130,7 +129,7 @@ extern DECLSPEC SDL_Keymod SDLCALL SDL_GetModState(void);
|
|||||||
* This does not change the keyboard state, only the key modifier flags that
|
* This does not change the keyboard state, only the key modifier flags that
|
||||||
* SDL reports.
|
* SDL reports.
|
||||||
*
|
*
|
||||||
* \param modstate the desired SDL_Keymod for the keyboard.
|
* \param modstate the desired SDL_Keymod for the keyboard
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.0.
|
* \since This function is available since SDL 2.0.0.
|
||||||
*
|
*
|
||||||
@@ -144,7 +143,7 @@ extern DECLSPEC void SDLCALL SDL_SetModState(SDL_Keymod modstate);
|
|||||||
*
|
*
|
||||||
* See SDL_Keycode for details.
|
* See SDL_Keycode for details.
|
||||||
*
|
*
|
||||||
* \param scancode the desired SDL_Scancode to query.
|
* \param scancode the desired SDL_Scancode to query
|
||||||
* \returns the SDL_Keycode that corresponds to the given SDL_Scancode.
|
* \returns the SDL_Keycode that corresponds to the given SDL_Scancode.
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.0.
|
* \since This function is available since SDL 2.0.0.
|
||||||
@@ -160,7 +159,7 @@ extern DECLSPEC SDL_Keycode SDLCALL SDL_GetKeyFromScancode(SDL_Scancode scancode
|
|||||||
*
|
*
|
||||||
* See SDL_Scancode for details.
|
* See SDL_Scancode for details.
|
||||||
*
|
*
|
||||||
* \param key the desired SDL_Keycode to query.
|
* \param key the desired SDL_Keycode to query
|
||||||
* \returns the SDL_Scancode that corresponds to the given SDL_Keycode.
|
* \returns the SDL_Scancode that corresponds to the given SDL_Keycode.
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.0.
|
* \since This function is available since SDL 2.0.0.
|
||||||
@@ -184,7 +183,7 @@ extern DECLSPEC SDL_Scancode SDLCALL SDL_GetScancodeFromKey(SDL_Keycode key);
|
|||||||
* unsuitable for creating a stable cross-platform two-way mapping between
|
* unsuitable for creating a stable cross-platform two-way mapping between
|
||||||
* strings and scancodes.
|
* strings and scancodes.
|
||||||
*
|
*
|
||||||
* \param scancode the desired SDL_Scancode to query.
|
* \param scancode the desired SDL_Scancode to query
|
||||||
* \returns a pointer to the name for the scancode. If the scancode doesn't
|
* \returns a pointer to the name for the scancode. If the scancode doesn't
|
||||||
* have a name this function returns an empty string ("").
|
* have a name this function returns an empty string ("").
|
||||||
*
|
*
|
||||||
@@ -198,7 +197,7 @@ extern DECLSPEC const char *SDLCALL SDL_GetScancodeName(SDL_Scancode scancode);
|
|||||||
/**
|
/**
|
||||||
* Get a scancode from a human-readable name.
|
* Get a scancode from a human-readable name.
|
||||||
*
|
*
|
||||||
* \param name the human-readable scancode name.
|
* \param name the human-readable scancode name
|
||||||
* \returns the SDL_Scancode, or `SDL_SCANCODE_UNKNOWN` if the name wasn't
|
* \returns the SDL_Scancode, or `SDL_SCANCODE_UNKNOWN` if the name wasn't
|
||||||
* recognized; call SDL_GetError() for more information.
|
* recognized; call SDL_GetError() for more information.
|
||||||
*
|
*
|
||||||
@@ -215,7 +214,7 @@ extern DECLSPEC SDL_Scancode SDLCALL SDL_GetScancodeFromName(const char *name);
|
|||||||
*
|
*
|
||||||
* See SDL_Scancode and SDL_Keycode for details.
|
* See SDL_Scancode and SDL_Keycode for details.
|
||||||
*
|
*
|
||||||
* \param key the desired SDL_Keycode to query.
|
* \param key the desired SDL_Keycode to query
|
||||||
* \returns a pointer to a UTF-8 string that stays valid at least until the
|
* \returns a pointer to a UTF-8 string that stays valid at least until the
|
||||||
* next call to this function. If you need it around any longer, you
|
* next call to this function. If you need it around any longer, you
|
||||||
* must copy it. If the key doesn't have a name, this function
|
* must copy it. If the key doesn't have a name, this function
|
||||||
@@ -232,7 +231,7 @@ extern DECLSPEC const char *SDLCALL SDL_GetKeyName(SDL_Keycode key);
|
|||||||
/**
|
/**
|
||||||
* Get a key code from a human-readable name.
|
* Get a key code from a human-readable name.
|
||||||
*
|
*
|
||||||
* \param name the human-readable key name.
|
* \param name the human-readable key name
|
||||||
* \returns key code, or `SDLK_UNKNOWN` if the name wasn't recognized; call
|
* \returns key code, or `SDLK_UNKNOWN` if the name wasn't recognized; call
|
||||||
* SDL_GetError() for more information.
|
* SDL_GetError() for more information.
|
||||||
*
|
*
|
||||||
@@ -254,10 +253,6 @@ extern DECLSPEC SDL_Keycode SDLCALL SDL_GetKeyFromName(const char *name);
|
|||||||
*
|
*
|
||||||
* On some platforms using this function activates the screen keyboard.
|
* On some platforms using this function activates the screen keyboard.
|
||||||
*
|
*
|
||||||
* On desktop platforms, SDL_StartTextInput() is implicitly called on SDL
|
|
||||||
* video subsystem initialization which will cause SDL_TextInputEvent and
|
|
||||||
* SDL_TextEditingEvent to begin emitting.
|
|
||||||
*
|
|
||||||
* \since This function is available since SDL 2.0.0.
|
* \since This function is available since SDL 2.0.0.
|
||||||
*
|
*
|
||||||
* \sa SDL_SetTextInputRect
|
* \sa SDL_SetTextInputRect
|
||||||
@@ -305,9 +300,6 @@ extern DECLSPEC SDL_bool SDLCALL SDL_IsTextInputShown(void);
|
|||||||
/**
|
/**
|
||||||
* Set the rectangle used to type Unicode text inputs.
|
* Set the rectangle used to type Unicode text inputs.
|
||||||
*
|
*
|
||||||
* Native input methods will place a window with word suggestions near it,
|
|
||||||
* without covering the text being inputted.
|
|
||||||
*
|
|
||||||
* To start text input in a given location, this function is intended to be
|
* To start text input in a given location, this function is intended to be
|
||||||
* called before SDL_StartTextInput, although some platforms support moving
|
* called before SDL_StartTextInput, although some platforms support moving
|
||||||
* the rectangle even while text input (and a composition) is active.
|
* the rectangle even while text input (and a composition) is active.
|
||||||
@@ -317,7 +309,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_IsTextInputShown(void);
|
|||||||
* any feedback.
|
* any feedback.
|
||||||
*
|
*
|
||||||
* \param rect the SDL_Rect structure representing the rectangle to receive
|
* \param rect the SDL_Rect structure representing the rectangle to receive
|
||||||
* text (ignored if NULL).
|
* text (ignored if NULL)
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.0.
|
* \since This function is available since SDL 2.0.0.
|
||||||
*
|
*
|
||||||
@@ -341,7 +333,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_HasScreenKeyboardSupport(void);
|
|||||||
/**
|
/**
|
||||||
* Check whether the screen keyboard is shown for given window.
|
* Check whether the screen keyboard is shown for given window.
|
||||||
*
|
*
|
||||||
* \param window the window for which screen keyboard should be queried.
|
* \param window the window for which screen keyboard should be queried
|
||||||
* \returns SDL_TRUE if screen keyboard is shown or SDL_FALSE if not.
|
* \returns SDL_TRUE if screen keyboard is shown or SDL_FALSE if not.
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.0.
|
* \since This function is available since SDL 2.0.0.
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
/*
|
/*
|
||||||
Simple DirectMedia Layer
|
Simple DirectMedia Layer
|
||||||
Copyright (C) 1997-2025 Sam Lantinga <slouken@libsdl.org>
|
Copyright (C) 1997-2023 Sam Lantinga <slouken@libsdl.org>
|
||||||
|
|
||||||
This software is provided 'as-is', without any express or implied
|
This software is provided 'as-is', without any express or implied
|
||||||
warranty. In no event will the authors be held liable for any damages
|
warranty. In no event will the authors be held liable for any damages
|
||||||
@@ -20,9 +20,9 @@
|
|||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* # CategoryKeycode
|
* \file SDL_keycode.h
|
||||||
*
|
*
|
||||||
* Defines constants which identify keyboard keys and modifiers.
|
* Defines constants which identify keyboard keys and modifiers.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#ifndef SDL_keycode_h_
|
#ifndef SDL_keycode_h_
|
||||||
@@ -32,22 +32,22 @@
|
|||||||
#include "SDL_scancode.h"
|
#include "SDL_scancode.h"
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The SDL virtual key representation.
|
* \brief The SDL virtual key representation.
|
||||||
*
|
*
|
||||||
* Values of this type are used to represent keyboard keys using the current
|
* Values of this type are used to represent keyboard keys using the current
|
||||||
* layout of the keyboard. These values include Unicode values representing
|
* layout of the keyboard. These values include Unicode values representing
|
||||||
* the unmodified character that would be generated by pressing the key, or an
|
* the unmodified character that would be generated by pressing the key, or
|
||||||
* SDLK_* constant for those keys that do not generate characters.
|
* an SDLK_* constant for those keys that do not generate characters.
|
||||||
*
|
*
|
||||||
* A special exception is the number keys at the top of the keyboard which map
|
* A special exception is the number keys at the top of the keyboard which
|
||||||
* to SDLK_0...SDLK_9 on AZERTY layouts.
|
* map to SDLK_0...SDLK_9 on AZERTY layouts.
|
||||||
*/
|
*/
|
||||||
typedef Sint32 SDL_Keycode;
|
typedef Sint32 SDL_Keycode;
|
||||||
|
|
||||||
#define SDLK_SCANCODE_MASK (1<<30)
|
#define SDLK_SCANCODE_MASK (1<<30)
|
||||||
#define SDL_SCANCODE_TO_KEYCODE(X) (X | SDLK_SCANCODE_MASK)
|
#define SDL_SCANCODE_TO_KEYCODE(X) (X | SDLK_SCANCODE_MASK)
|
||||||
|
|
||||||
typedef enum SDL_KeyCode
|
typedef enum
|
||||||
{
|
{
|
||||||
SDLK_UNKNOWN = 0,
|
SDLK_UNKNOWN = 0,
|
||||||
|
|
||||||
@@ -327,9 +327,9 @@ typedef enum SDL_KeyCode
|
|||||||
} SDL_KeyCode;
|
} SDL_KeyCode;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Enumeration of valid key mods (possibly OR'd together).
|
* \brief Enumeration of valid key mods (possibly OR'd together).
|
||||||
*/
|
*/
|
||||||
typedef enum SDL_Keymod
|
typedef enum
|
||||||
{
|
{
|
||||||
KMOD_NONE = 0x0000,
|
KMOD_NONE = 0x0000,
|
||||||
KMOD_LSHIFT = 0x0001,
|
KMOD_LSHIFT = 0x0001,
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
/*
|
/*
|
||||||
Simple DirectMedia Layer
|
Simple DirectMedia Layer
|
||||||
Copyright (C) 1997-2025 Sam Lantinga <slouken@libsdl.org>
|
Copyright (C) 1997-2023 Sam Lantinga <slouken@libsdl.org>
|
||||||
|
|
||||||
This software is provided 'as-is', without any express or implied
|
This software is provided 'as-is', without any express or implied
|
||||||
warranty. In no event will the authors be held liable for any damages
|
warranty. In no event will the authors be held liable for any damages
|
||||||
@@ -19,25 +19,23 @@
|
|||||||
3. This notice may not be removed or altered from any source distribution.
|
3. This notice may not be removed or altered from any source distribution.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/* WIKI CATEGORY: LoadSO */
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* # CategoryLoadSO
|
* \file SDL_loadso.h
|
||||||
*
|
*
|
||||||
* System-dependent library loading routines.
|
* System dependent library loading routines
|
||||||
*
|
*
|
||||||
* Some things to keep in mind:
|
* Some things to keep in mind:
|
||||||
*
|
* \li These functions only work on C function names. Other languages may
|
||||||
* - These functions only work on C function names. Other languages may have
|
* have name mangling and intrinsic language support that varies from
|
||||||
* name mangling and intrinsic language support that varies from compiler to
|
* compiler to compiler.
|
||||||
* compiler.
|
* \li Make sure you declare your function pointers with the same calling
|
||||||
* - Make sure you declare your function pointers with the same calling
|
* convention as the actual library function. Your code will crash
|
||||||
* convention as the actual library function. Your code will crash
|
* mysteriously if you do not do this.
|
||||||
* mysteriously if you do not do this.
|
* \li Avoid namespace collisions. If you load a symbol from the library,
|
||||||
* - Avoid namespace collisions. If you load a symbol from the library, it is
|
* it is not defined whether or not it goes into the global symbol
|
||||||
* not defined whether or not it goes into the global symbol namespace for
|
* namespace for the application. If it does and it conflicts with
|
||||||
* the application. If it does and it conflicts with symbols in your code or
|
* symbols in your code or other shared libraries, you will not get
|
||||||
* other shared libraries, you will not get the results you expect. :)
|
* the results you expect. :)
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#ifndef SDL_loadso_h_
|
#ifndef SDL_loadso_h_
|
||||||
@@ -55,7 +53,7 @@ extern "C" {
|
|||||||
/**
|
/**
|
||||||
* Dynamically load a shared object.
|
* Dynamically load a shared object.
|
||||||
*
|
*
|
||||||
* \param sofile a system-dependent name of the object file.
|
* \param sofile a system-dependent name of the object file
|
||||||
* \returns an opaque pointer to the object handle or NULL if there was an
|
* \returns an opaque pointer to the object handle or NULL if there was an
|
||||||
* error; call SDL_GetError() for more information.
|
* error; call SDL_GetError() for more information.
|
||||||
*
|
*
|
||||||
@@ -81,8 +79,8 @@ extern DECLSPEC void *SDLCALL SDL_LoadObject(const char *sofile);
|
|||||||
*
|
*
|
||||||
* If the requested function doesn't exist, NULL is returned.
|
* If the requested function doesn't exist, NULL is returned.
|
||||||
*
|
*
|
||||||
* \param handle a valid shared object handle returned by SDL_LoadObject().
|
* \param handle a valid shared object handle returned by SDL_LoadObject()
|
||||||
* \param name the name of the function to look up.
|
* \param name the name of the function to look up
|
||||||
* \returns a pointer to the function or NULL if there was an error; call
|
* \returns a pointer to the function or NULL if there was an error; call
|
||||||
* SDL_GetError() for more information.
|
* SDL_GetError() for more information.
|
||||||
*
|
*
|
||||||
@@ -97,7 +95,7 @@ extern DECLSPEC void *SDLCALL SDL_LoadFunction(void *handle,
|
|||||||
/**
|
/**
|
||||||
* Unload a shared object from memory.
|
* Unload a shared object from memory.
|
||||||
*
|
*
|
||||||
* \param handle a valid shared object handle returned by SDL_LoadObject().
|
* \param handle a valid shared object handle returned by SDL_LoadObject()
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.0.
|
* \since This function is available since SDL 2.0.0.
|
||||||
*
|
*
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
/*
|
/*
|
||||||
Simple DirectMedia Layer
|
Simple DirectMedia Layer
|
||||||
Copyright (C) 1997-2025 Sam Lantinga <slouken@libsdl.org>
|
Copyright (C) 1997-2023 Sam Lantinga <slouken@libsdl.org>
|
||||||
|
|
||||||
This software is provided 'as-is', without any express or implied
|
This software is provided 'as-is', without any express or implied
|
||||||
warranty. In no event will the authors be held liable for any damages
|
warranty. In no event will the authors be held liable for any damages
|
||||||
@@ -20,9 +20,9 @@
|
|||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* # CategoryLocale
|
* \file SDL_locale.h
|
||||||
*
|
*
|
||||||
* Include file for SDL locale services
|
* Include file for SDL locale services
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#ifndef _SDL_locale_h
|
#ifndef _SDL_locale_h
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
/*
|
/*
|
||||||
Simple DirectMedia Layer
|
Simple DirectMedia Layer
|
||||||
Copyright (C) 1997-2025 Sam Lantinga <slouken@libsdl.org>
|
Copyright (C) 1997-2023 Sam Lantinga <slouken@libsdl.org>
|
||||||
|
|
||||||
This software is provided 'as-is', without any express or implied
|
This software is provided 'as-is', without any express or implied
|
||||||
warranty. In no event will the authors be held liable for any damages
|
warranty. In no event will the authors be held liable for any damages
|
||||||
@@ -20,19 +20,18 @@
|
|||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* # CategoryLog
|
* \file SDL_log.h
|
||||||
*
|
*
|
||||||
* Simple log messages with categories and priorities.
|
* Simple log messages with categories and priorities.
|
||||||
*
|
*
|
||||||
* By default logs are quiet, but if you're debugging SDL you might want:
|
* By default logs are quiet, but if you're debugging SDL you might want:
|
||||||
*
|
*
|
||||||
* SDL_LogSetAllPriority(SDL_LOG_PRIORITY_WARN);
|
* SDL_LogSetAllPriority(SDL_LOG_PRIORITY_WARN);
|
||||||
*
|
*
|
||||||
* Here's where the messages go on different platforms:
|
* Here's where the messages go on different platforms:
|
||||||
*
|
* Windows: debug output stream
|
||||||
* - Windows: debug output stream
|
* Android: log output
|
||||||
* - Android: log output
|
* Others: standard error output (stderr)
|
||||||
* - Others: standard error output (stderr)
|
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#ifndef SDL_log_h_
|
#ifndef SDL_log_h_
|
||||||
@@ -48,20 +47,21 @@ extern "C" {
|
|||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The maximum size of a log message prior to SDL 2.0.24
|
* \brief The maximum size of a log message prior to SDL 2.0.24
|
||||||
*
|
*
|
||||||
* As of 2.0.24 there is no limit to the length of SDL log messages.
|
* As of 2.0.24 there is no limit to the length of SDL log messages.
|
||||||
*/
|
*/
|
||||||
#define SDL_MAX_LOG_MESSAGE 4096
|
#define SDL_MAX_LOG_MESSAGE 4096
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The predefined log categories
|
* \brief The predefined log categories
|
||||||
*
|
*
|
||||||
* By default the application category is enabled at the INFO level, the
|
* By default the application category is enabled at the INFO level,
|
||||||
* assert category is enabled at the WARN level, test is enabled at the
|
* the assert category is enabled at the WARN level, test is enabled
|
||||||
* VERBOSE level and all other categories are enabled at the ERROR level.
|
* at the VERBOSE level and all other categories are enabled at the
|
||||||
|
* CRITICAL level.
|
||||||
*/
|
*/
|
||||||
typedef enum SDL_LogCategory
|
typedef enum
|
||||||
{
|
{
|
||||||
SDL_LOG_CATEGORY_APPLICATION,
|
SDL_LOG_CATEGORY_APPLICATION,
|
||||||
SDL_LOG_CATEGORY_ERROR,
|
SDL_LOG_CATEGORY_ERROR,
|
||||||
@@ -97,9 +97,9 @@ typedef enum SDL_LogCategory
|
|||||||
} SDL_LogCategory;
|
} SDL_LogCategory;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The predefined log priorities
|
* \brief The predefined log priorities
|
||||||
*/
|
*/
|
||||||
typedef enum SDL_LogPriority
|
typedef enum
|
||||||
{
|
{
|
||||||
SDL_LOG_PRIORITY_VERBOSE = 1,
|
SDL_LOG_PRIORITY_VERBOSE = 1,
|
||||||
SDL_LOG_PRIORITY_DEBUG,
|
SDL_LOG_PRIORITY_DEBUG,
|
||||||
@@ -114,7 +114,7 @@ typedef enum SDL_LogPriority
|
|||||||
/**
|
/**
|
||||||
* Set the priority of all log categories.
|
* Set the priority of all log categories.
|
||||||
*
|
*
|
||||||
* \param priority the SDL_LogPriority to assign.
|
* \param priority the SDL_LogPriority to assign
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.0.
|
* \since This function is available since SDL 2.0.0.
|
||||||
*
|
*
|
||||||
@@ -125,8 +125,8 @@ extern DECLSPEC void SDLCALL SDL_LogSetAllPriority(SDL_LogPriority priority);
|
|||||||
/**
|
/**
|
||||||
* Set the priority of a particular log category.
|
* Set the priority of a particular log category.
|
||||||
*
|
*
|
||||||
* \param category the category to assign a priority to.
|
* \param category the category to assign a priority to
|
||||||
* \param priority the SDL_LogPriority to assign.
|
* \param priority the SDL_LogPriority to assign
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.0.
|
* \since This function is available since SDL 2.0.0.
|
||||||
*
|
*
|
||||||
@@ -139,8 +139,8 @@ extern DECLSPEC void SDLCALL SDL_LogSetPriority(int category,
|
|||||||
/**
|
/**
|
||||||
* Get the priority of a particular log category.
|
* Get the priority of a particular log category.
|
||||||
*
|
*
|
||||||
* \param category the category to query.
|
* \param category the category to query
|
||||||
* \returns the SDL_LogPriority for the requested category.
|
* \returns the SDL_LogPriority for the requested category
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.0.
|
* \since This function is available since SDL 2.0.0.
|
||||||
*
|
*
|
||||||
@@ -166,7 +166,7 @@ extern DECLSPEC void SDLCALL SDL_LogResetPriorities(void);
|
|||||||
* = * \param fmt a printf() style message format string
|
* = * \param fmt a printf() style message format string
|
||||||
*
|
*
|
||||||
* \param ... additional parameters matching % tokens in the `fmt` string, if
|
* \param ... additional parameters matching % tokens in the `fmt` string, if
|
||||||
* any.
|
* any
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.0.
|
* \since This function is available since SDL 2.0.0.
|
||||||
*
|
*
|
||||||
@@ -184,10 +184,10 @@ extern DECLSPEC void SDLCALL SDL_Log(SDL_PRINTF_FORMAT_STRING const char *fmt, .
|
|||||||
/**
|
/**
|
||||||
* Log a message with SDL_LOG_PRIORITY_VERBOSE.
|
* Log a message with SDL_LOG_PRIORITY_VERBOSE.
|
||||||
*
|
*
|
||||||
* \param category the category of the message.
|
* \param category the category of the message
|
||||||
* \param fmt a printf() style message format string.
|
* \param fmt a printf() style message format string
|
||||||
* \param ... additional parameters matching % tokens in the **fmt** string,
|
* \param ... additional parameters matching % tokens in the **fmt** string,
|
||||||
* if any.
|
* if any
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.0.
|
* \since This function is available since SDL 2.0.0.
|
||||||
*
|
*
|
||||||
@@ -205,10 +205,10 @@ extern DECLSPEC void SDLCALL SDL_LogVerbose(int category, SDL_PRINTF_FORMAT_STRI
|
|||||||
/**
|
/**
|
||||||
* Log a message with SDL_LOG_PRIORITY_DEBUG.
|
* Log a message with SDL_LOG_PRIORITY_DEBUG.
|
||||||
*
|
*
|
||||||
* \param category the category of the message.
|
* \param category the category of the message
|
||||||
* \param fmt a printf() style message format string.
|
* \param fmt a printf() style message format string
|
||||||
* \param ... additional parameters matching % tokens in the **fmt** string,
|
* \param ... additional parameters matching % tokens in the **fmt** string,
|
||||||
* if any.
|
* if any
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.0.
|
* \since This function is available since SDL 2.0.0.
|
||||||
*
|
*
|
||||||
@@ -226,10 +226,10 @@ extern DECLSPEC void SDLCALL SDL_LogDebug(int category, SDL_PRINTF_FORMAT_STRING
|
|||||||
/**
|
/**
|
||||||
* Log a message with SDL_LOG_PRIORITY_INFO.
|
* Log a message with SDL_LOG_PRIORITY_INFO.
|
||||||
*
|
*
|
||||||
* \param category the category of the message.
|
* \param category the category of the message
|
||||||
* \param fmt a printf() style message format string.
|
* \param fmt a printf() style message format string
|
||||||
* \param ... additional parameters matching % tokens in the **fmt** string,
|
* \param ... additional parameters matching % tokens in the **fmt** string,
|
||||||
* if any.
|
* if any
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.0.
|
* \since This function is available since SDL 2.0.0.
|
||||||
*
|
*
|
||||||
@@ -247,10 +247,10 @@ extern DECLSPEC void SDLCALL SDL_LogInfo(int category, SDL_PRINTF_FORMAT_STRING
|
|||||||
/**
|
/**
|
||||||
* Log a message with SDL_LOG_PRIORITY_WARN.
|
* Log a message with SDL_LOG_PRIORITY_WARN.
|
||||||
*
|
*
|
||||||
* \param category the category of the message.
|
* \param category the category of the message
|
||||||
* \param fmt a printf() style message format string.
|
* \param fmt a printf() style message format string
|
||||||
* \param ... additional parameters matching % tokens in the **fmt** string,
|
* \param ... additional parameters matching % tokens in the **fmt** string,
|
||||||
* if any.
|
* if any
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.0.
|
* \since This function is available since SDL 2.0.0.
|
||||||
*
|
*
|
||||||
@@ -268,10 +268,10 @@ extern DECLSPEC void SDLCALL SDL_LogWarn(int category, SDL_PRINTF_FORMAT_STRING
|
|||||||
/**
|
/**
|
||||||
* Log a message with SDL_LOG_PRIORITY_ERROR.
|
* Log a message with SDL_LOG_PRIORITY_ERROR.
|
||||||
*
|
*
|
||||||
* \param category the category of the message.
|
* \param category the category of the message
|
||||||
* \param fmt a printf() style message format string.
|
* \param fmt a printf() style message format string
|
||||||
* \param ... additional parameters matching % tokens in the **fmt** string,
|
* \param ... additional parameters matching % tokens in the **fmt** string,
|
||||||
* if any.
|
* if any
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.0.
|
* \since This function is available since SDL 2.0.0.
|
||||||
*
|
*
|
||||||
@@ -289,10 +289,10 @@ extern DECLSPEC void SDLCALL SDL_LogError(int category, SDL_PRINTF_FORMAT_STRING
|
|||||||
/**
|
/**
|
||||||
* Log a message with SDL_LOG_PRIORITY_CRITICAL.
|
* Log a message with SDL_LOG_PRIORITY_CRITICAL.
|
||||||
*
|
*
|
||||||
* \param category the category of the message.
|
* \param category the category of the message
|
||||||
* \param fmt a printf() style message format string.
|
* \param fmt a printf() style message format string
|
||||||
* \param ... additional parameters matching % tokens in the **fmt** string,
|
* \param ... additional parameters matching % tokens in the **fmt** string,
|
||||||
* if any.
|
* if any
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.0.
|
* \since This function is available since SDL 2.0.0.
|
||||||
*
|
*
|
||||||
@@ -310,11 +310,11 @@ extern DECLSPEC void SDLCALL SDL_LogCritical(int category, SDL_PRINTF_FORMAT_STR
|
|||||||
/**
|
/**
|
||||||
* Log a message with the specified category and priority.
|
* Log a message with the specified category and priority.
|
||||||
*
|
*
|
||||||
* \param category the category of the message.
|
* \param category the category of the message
|
||||||
* \param priority the priority of the message.
|
* \param priority the priority of the message
|
||||||
* \param fmt a printf() style message format string.
|
* \param fmt a printf() style message format string
|
||||||
* \param ... additional parameters matching % tokens in the **fmt** string,
|
* \param ... additional parameters matching % tokens in the **fmt** string,
|
||||||
* if any.
|
* if any
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.0.
|
* \since This function is available since SDL 2.0.0.
|
||||||
*
|
*
|
||||||
@@ -334,10 +334,10 @@ extern DECLSPEC void SDLCALL SDL_LogMessage(int category,
|
|||||||
/**
|
/**
|
||||||
* Log a message with the specified category and priority.
|
* Log a message with the specified category and priority.
|
||||||
*
|
*
|
||||||
* \param category the category of the message.
|
* \param category the category of the message
|
||||||
* \param priority the priority of the message.
|
* \param priority the priority of the message
|
||||||
* \param fmt a printf() style message format string.
|
* \param fmt a printf() style message format string
|
||||||
* \param ap a variable argument list.
|
* \param ap a variable argument list
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.0.
|
* \since This function is available since SDL 2.0.0.
|
||||||
*
|
*
|
||||||
@@ -352,18 +352,17 @@ extern DECLSPEC void SDLCALL SDL_LogMessage(int category,
|
|||||||
*/
|
*/
|
||||||
extern DECLSPEC void SDLCALL SDL_LogMessageV(int category,
|
extern DECLSPEC void SDLCALL SDL_LogMessageV(int category,
|
||||||
SDL_LogPriority priority,
|
SDL_LogPriority priority,
|
||||||
SDL_PRINTF_FORMAT_STRING const char *fmt, va_list ap) SDL_PRINTF_VARARG_FUNCV(3);
|
const char *fmt, va_list ap);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The prototype for the log output callback function.
|
* The prototype for the log output callback function.
|
||||||
*
|
*
|
||||||
* This function is called by SDL when there is new text to be logged.
|
* This function is called by SDL when there is new text to be logged.
|
||||||
*
|
*
|
||||||
* \param userdata what was passed as `userdata` to
|
* \param userdata what was passed as `userdata` to SDL_LogSetOutputFunction()
|
||||||
* SDL_LogSetOutputFunction().
|
* \param category the category of the message
|
||||||
* \param category the category of the message.
|
* \param priority the priority of the message
|
||||||
* \param priority the priority of the message.
|
* \param message the message being output
|
||||||
* \param message the message being output.
|
|
||||||
*/
|
*/
|
||||||
typedef void (SDLCALL *SDL_LogOutputFunction)(void *userdata, int category, SDL_LogPriority priority, const char *message);
|
typedef void (SDLCALL *SDL_LogOutputFunction)(void *userdata, int category, SDL_LogPriority priority, const char *message);
|
||||||
|
|
||||||
@@ -371,9 +370,9 @@ typedef void (SDLCALL *SDL_LogOutputFunction)(void *userdata, int category, SDL_
|
|||||||
* Get the current log output function.
|
* Get the current log output function.
|
||||||
*
|
*
|
||||||
* \param callback an SDL_LogOutputFunction filled in with the current log
|
* \param callback an SDL_LogOutputFunction filled in with the current log
|
||||||
* callback.
|
* callback
|
||||||
* \param userdata a pointer filled in with the pointer that is passed to
|
* \param userdata a pointer filled in with the pointer that is passed to
|
||||||
* `callback`.
|
* `callback`
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.0.
|
* \since This function is available since SDL 2.0.0.
|
||||||
*
|
*
|
||||||
@@ -384,8 +383,8 @@ extern DECLSPEC void SDLCALL SDL_LogGetOutputFunction(SDL_LogOutputFunction *cal
|
|||||||
/**
|
/**
|
||||||
* Replace the default log output function with one of your own.
|
* Replace the default log output function with one of your own.
|
||||||
*
|
*
|
||||||
* \param callback an SDL_LogOutputFunction to call instead of the default.
|
* \param callback an SDL_LogOutputFunction to call instead of the default
|
||||||
* \param userdata a pointer that is passed to `callback`.
|
* \param userdata a pointer that is passed to `callback`
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.0.
|
* \since This function is available since SDL 2.0.0.
|
||||||
*
|
*
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
/*
|
/*
|
||||||
Simple DirectMedia Layer
|
Simple DirectMedia Layer
|
||||||
Copyright (C) 1997-2025 Sam Lantinga <slouken@libsdl.org>
|
Copyright (C) 1997-2023 Sam Lantinga <slouken@libsdl.org>
|
||||||
|
|
||||||
This software is provided 'as-is', without any express or implied
|
This software is provided 'as-is', without any express or implied
|
||||||
warranty. In no event will the authors be held liable for any damages
|
warranty. In no event will the authors be held liable for any damages
|
||||||
@@ -25,9 +25,9 @@
|
|||||||
#include "SDL_stdinc.h"
|
#include "SDL_stdinc.h"
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* # CategoryMain
|
* \file SDL_main.h
|
||||||
*
|
*
|
||||||
* Redefine main() on some platforms so that it is called by SDL.
|
* Redefine main() on some platforms so that it is called by SDL.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#ifndef SDL_MAIN_HANDLED
|
#ifndef SDL_MAIN_HANDLED
|
||||||
@@ -129,14 +129,14 @@
|
|||||||
*
|
*
|
||||||
* The application's main() function must be called with C linkage,
|
* The application's main() function must be called with C linkage,
|
||||||
* and should be declared like this:
|
* and should be declared like this:
|
||||||
* ```c
|
* \code
|
||||||
* #ifdef __cplusplus
|
* #ifdef __cplusplus
|
||||||
* extern "C"
|
* extern "C"
|
||||||
* #endif
|
* #endif
|
||||||
* int main(int argc, char *argv[])
|
* int main(int argc, char *argv[])
|
||||||
* {
|
* {
|
||||||
* }
|
* }
|
||||||
* ```
|
* \endcode
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#if defined(SDL_MAIN_NEEDED) || defined(SDL_MAIN_AVAILABLE)
|
#if defined(SDL_MAIN_NEEDED) || defined(SDL_MAIN_AVAILABLE)
|
||||||
@@ -149,7 +149,7 @@ extern "C" {
|
|||||||
#endif
|
#endif
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The prototype for the application's main() function
|
* The prototype for the application's main() function
|
||||||
*/
|
*/
|
||||||
typedef int (*SDL_main_func)(int argc, char *argv[]);
|
typedef int (*SDL_main_func)(int argc, char *argv[]);
|
||||||
extern SDLMAIN_DECLSPEC int SDL_main(int argc, char *argv[]);
|
extern SDLMAIN_DECLSPEC int SDL_main(int argc, char *argv[]);
|
||||||
@@ -222,8 +222,8 @@ extern DECLSPEC void SDLCALL SDL_UnregisterApp(void);
|
|||||||
/**
|
/**
|
||||||
* Initialize and launch an SDL/WinRT application.
|
* Initialize and launch an SDL/WinRT application.
|
||||||
*
|
*
|
||||||
* \param mainFunction the SDL app's C-style main(), an SDL_main_func.
|
* \param mainFunction the SDL app's C-style main(), an SDL_main_func
|
||||||
* \param reserved reserved for future use; should be NULL.
|
* \param reserved reserved for future use; should be NULL
|
||||||
* \returns 0 on success or -1 on failure; call SDL_GetError() to retrieve
|
* \returns 0 on success or -1 on failure; call SDL_GetError() to retrieve
|
||||||
* more information on the failure.
|
* more information on the failure.
|
||||||
*
|
*
|
||||||
@@ -238,10 +238,10 @@ extern DECLSPEC int SDLCALL SDL_WinRTRunApp(SDL_main_func mainFunction, void * r
|
|||||||
/**
|
/**
|
||||||
* Initializes and launches an SDL application.
|
* Initializes and launches an SDL application.
|
||||||
*
|
*
|
||||||
* \param argc The argc parameter from the application's main() function.
|
* \param argc The argc parameter from the application's main() function
|
||||||
* \param argv The argv parameter from the application's main() function.
|
* \param argv The argv parameter from the application's main() function
|
||||||
* \param mainFunction The SDL app's C-style main(), an SDL_main_func.
|
* \param mainFunction The SDL app's C-style main(), an SDL_main_func
|
||||||
* \return the return value from mainFunction.
|
* \return the return value from mainFunction
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.10.
|
* \since This function is available since SDL 2.0.10.
|
||||||
*/
|
*/
|
||||||
@@ -254,8 +254,8 @@ extern DECLSPEC int SDLCALL SDL_UIKitRunApp(int argc, char *argv[], SDL_main_fun
|
|||||||
/**
|
/**
|
||||||
* Initialize and launch an SDL GDK application.
|
* Initialize and launch an SDL GDK application.
|
||||||
*
|
*
|
||||||
* \param mainFunction the SDL app's C-style main(), an SDL_main_func.
|
* \param mainFunction the SDL app's C-style main(), an SDL_main_func
|
||||||
* \param reserved reserved for future use; should be NULL.
|
* \param reserved reserved for future use; should be NULL
|
||||||
* \returns 0 on success or -1 on failure; call SDL_GetError() to retrieve
|
* \returns 0 on success or -1 on failure; call SDL_GetError() to retrieve
|
||||||
* more information on the failure.
|
* more information on the failure.
|
||||||
*
|
*
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
/*
|
/*
|
||||||
Simple DirectMedia Layer
|
Simple DirectMedia Layer
|
||||||
Copyright (C) 1997-2025 Sam Lantinga <slouken@libsdl.org>
|
Copyright (C) 1997-2023 Sam Lantinga <slouken@libsdl.org>
|
||||||
|
|
||||||
This software is provided 'as-is', without any express or implied
|
This software is provided 'as-is', without any express or implied
|
||||||
warranty. In no event will the authors be held liable for any damages
|
warranty. In no event will the authors be held liable for any damages
|
||||||
@@ -32,11 +32,9 @@ extern "C" {
|
|||||||
#endif
|
#endif
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* SDL_MessageBox flags.
|
* SDL_MessageBox flags. If supported will display warning icon, etc.
|
||||||
*
|
|
||||||
* If supported will display warning icon, etc.
|
|
||||||
*/
|
*/
|
||||||
typedef enum SDL_MessageBoxFlags
|
typedef enum
|
||||||
{
|
{
|
||||||
SDL_MESSAGEBOX_ERROR = 0x00000010, /**< error dialog */
|
SDL_MESSAGEBOX_ERROR = 0x00000010, /**< error dialog */
|
||||||
SDL_MESSAGEBOX_WARNING = 0x00000020, /**< warning dialog */
|
SDL_MESSAGEBOX_WARNING = 0x00000020, /**< warning dialog */
|
||||||
@@ -48,7 +46,7 @@ typedef enum SDL_MessageBoxFlags
|
|||||||
/**
|
/**
|
||||||
* Flags for SDL_MessageBoxButtonData.
|
* Flags for SDL_MessageBoxButtonData.
|
||||||
*/
|
*/
|
||||||
typedef enum SDL_MessageBoxButtonFlags
|
typedef enum
|
||||||
{
|
{
|
||||||
SDL_MESSAGEBOX_BUTTON_RETURNKEY_DEFAULT = 0x00000001, /**< Marks the default button when return is hit */
|
SDL_MESSAGEBOX_BUTTON_RETURNKEY_DEFAULT = 0x00000001, /**< Marks the default button when return is hit */
|
||||||
SDL_MESSAGEBOX_BUTTON_ESCAPEKEY_DEFAULT = 0x00000002 /**< Marks the default button when escape is hit */
|
SDL_MESSAGEBOX_BUTTON_ESCAPEKEY_DEFAULT = 0x00000002 /**< Marks the default button when escape is hit */
|
||||||
@@ -57,9 +55,9 @@ typedef enum SDL_MessageBoxButtonFlags
|
|||||||
/**
|
/**
|
||||||
* Individual button data.
|
* Individual button data.
|
||||||
*/
|
*/
|
||||||
typedef struct SDL_MessageBoxButtonData
|
typedef struct
|
||||||
{
|
{
|
||||||
Uint32 flags; /**< SDL_MessageBoxButtonFlags */
|
Uint32 flags; /**< ::SDL_MessageBoxButtonFlags */
|
||||||
int buttonid; /**< User defined button id (value returned via SDL_ShowMessageBox) */
|
int buttonid; /**< User defined button id (value returned via SDL_ShowMessageBox) */
|
||||||
const char * text; /**< The UTF-8 button text */
|
const char * text; /**< The UTF-8 button text */
|
||||||
} SDL_MessageBoxButtonData;
|
} SDL_MessageBoxButtonData;
|
||||||
@@ -67,12 +65,12 @@ typedef struct SDL_MessageBoxButtonData
|
|||||||
/**
|
/**
|
||||||
* RGB value used in a message box color scheme
|
* RGB value used in a message box color scheme
|
||||||
*/
|
*/
|
||||||
typedef struct SDL_MessageBoxColor
|
typedef struct
|
||||||
{
|
{
|
||||||
Uint8 r, g, b;
|
Uint8 r, g, b;
|
||||||
} SDL_MessageBoxColor;
|
} SDL_MessageBoxColor;
|
||||||
|
|
||||||
typedef enum SDL_MessageBoxColorType
|
typedef enum
|
||||||
{
|
{
|
||||||
SDL_MESSAGEBOX_COLOR_BACKGROUND,
|
SDL_MESSAGEBOX_COLOR_BACKGROUND,
|
||||||
SDL_MESSAGEBOX_COLOR_TEXT,
|
SDL_MESSAGEBOX_COLOR_TEXT,
|
||||||
@@ -85,7 +83,7 @@ typedef enum SDL_MessageBoxColorType
|
|||||||
/**
|
/**
|
||||||
* A set of colors to use for message box dialogs
|
* A set of colors to use for message box dialogs
|
||||||
*/
|
*/
|
||||||
typedef struct SDL_MessageBoxColorScheme
|
typedef struct
|
||||||
{
|
{
|
||||||
SDL_MessageBoxColor colors[SDL_MESSAGEBOX_COLOR_MAX];
|
SDL_MessageBoxColor colors[SDL_MESSAGEBOX_COLOR_MAX];
|
||||||
} SDL_MessageBoxColorScheme;
|
} SDL_MessageBoxColorScheme;
|
||||||
@@ -93,9 +91,9 @@ typedef struct SDL_MessageBoxColorScheme
|
|||||||
/**
|
/**
|
||||||
* MessageBox structure containing title, text, window, etc.
|
* MessageBox structure containing title, text, window, etc.
|
||||||
*/
|
*/
|
||||||
typedef struct SDL_MessageBoxData
|
typedef struct
|
||||||
{
|
{
|
||||||
Uint32 flags; /**< SDL_MessageBoxFlags */
|
Uint32 flags; /**< ::SDL_MessageBoxFlags */
|
||||||
SDL_Window *window; /**< Parent window, can be NULL */
|
SDL_Window *window; /**< Parent window, can be NULL */
|
||||||
const char *title; /**< UTF-8 title */
|
const char *title; /**< UTF-8 title */
|
||||||
const char *message; /**< UTF-8 message text */
|
const char *message; /**< UTF-8 message text */
|
||||||
@@ -103,7 +101,7 @@ typedef struct SDL_MessageBoxData
|
|||||||
int numbuttons;
|
int numbuttons;
|
||||||
const SDL_MessageBoxButtonData *buttons;
|
const SDL_MessageBoxButtonData *buttons;
|
||||||
|
|
||||||
const SDL_MessageBoxColorScheme *colorScheme; /**< SDL_MessageBoxColorScheme, can be NULL to use system settings */
|
const SDL_MessageBoxColorScheme *colorScheme; /**< ::SDL_MessageBoxColorScheme, can be NULL to use system settings */
|
||||||
} SDL_MessageBoxData;
|
} SDL_MessageBoxData;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -130,9 +128,8 @@ typedef struct SDL_MessageBoxData
|
|||||||
* to stderr if you can.
|
* to stderr if you can.
|
||||||
*
|
*
|
||||||
* \param messageboxdata the SDL_MessageBoxData structure with title, text and
|
* \param messageboxdata the SDL_MessageBoxData structure with title, text and
|
||||||
* other options.
|
* other options
|
||||||
* \param buttonid the pointer to which user id of hit button should be
|
* \param buttonid the pointer to which user id of hit button should be copied
|
||||||
* copied.
|
|
||||||
* \returns 0 on success or a negative error code on failure; call
|
* \returns 0 on success or a negative error code on failure; call
|
||||||
* SDL_GetError() for more information.
|
* SDL_GetError() for more information.
|
||||||
*
|
*
|
||||||
@@ -171,10 +168,10 @@ extern DECLSPEC int SDLCALL SDL_ShowMessageBox(const SDL_MessageBoxData *message
|
|||||||
* concern, check the return value from this function and fall back to writing
|
* concern, check the return value from this function and fall back to writing
|
||||||
* to stderr if you can.
|
* to stderr if you can.
|
||||||
*
|
*
|
||||||
* \param flags an SDL_MessageBoxFlags value.
|
* \param flags an SDL_MessageBoxFlags value
|
||||||
* \param title UTF-8 title text.
|
* \param title UTF-8 title text
|
||||||
* \param message UTF-8 message text.
|
* \param message UTF-8 message text
|
||||||
* \param window the parent window, or NULL for no parent.
|
* \param window the parent window, or NULL for no parent
|
||||||
* \returns 0 on success or a negative error code on failure; call
|
* \returns 0 on success or a negative error code on failure; call
|
||||||
* SDL_GetError() for more information.
|
* SDL_GetError() for more information.
|
||||||
*
|
*
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
/*
|
/*
|
||||||
Simple DirectMedia Layer
|
Simple DirectMedia Layer
|
||||||
Copyright (C) 1997-2025 Sam Lantinga <slouken@libsdl.org>
|
Copyright (C) 1997-2023 Sam Lantinga <slouken@libsdl.org>
|
||||||
|
|
||||||
This software is provided 'as-is', without any express or implied
|
This software is provided 'as-is', without any express or implied
|
||||||
warranty. In no event will the authors be held liable for any damages
|
warranty. In no event will the authors be held liable for any damages
|
||||||
@@ -20,10 +20,9 @@
|
|||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* # CategoryMetal
|
* \file SDL_metal.h
|
||||||
*
|
*
|
||||||
* Header file for functions to creating Metal layers and views on SDL
|
* Header file for functions to creating Metal layers and views on SDL windows.
|
||||||
* windows.
|
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#ifndef SDL_metal_h_
|
#ifndef SDL_metal_h_
|
||||||
@@ -38,9 +37,9 @@ extern "C" {
|
|||||||
#endif
|
#endif
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* A handle to a CAMetalLayer-backed NSView (macOS) or UIView (iOS/tvOS).
|
* \brief A handle to a CAMetalLayer-backed NSView (macOS) or UIView (iOS/tvOS).
|
||||||
*
|
*
|
||||||
* This can be cast directly to an NSView or UIView.
|
* \note This can be cast directly to an NSView or UIView.
|
||||||
*/
|
*/
|
||||||
typedef void *SDL_MetalView;
|
typedef void *SDL_MetalView;
|
||||||
|
|
||||||
@@ -91,9 +90,9 @@ extern DECLSPEC void *SDLCALL SDL_Metal_GetLayer(SDL_MetalView view);
|
|||||||
* Get the size of a window's underlying drawable in pixels (for use with
|
* Get the size of a window's underlying drawable in pixels (for use with
|
||||||
* setting viewport, scissor & etc).
|
* setting viewport, scissor & etc).
|
||||||
*
|
*
|
||||||
* \param window SDL_Window from which the drawable size should be queried.
|
* \param window SDL_Window from which the drawable size should be queried
|
||||||
* \param w Pointer to variable for storing the width in pixels, may be NULL.
|
* \param w Pointer to variable for storing the width in pixels, may be NULL
|
||||||
* \param h Pointer to variable for storing the height in pixels, may be NULL.
|
* \param h Pointer to variable for storing the height in pixels, may be NULL
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.14.
|
* \since This function is available since SDL 2.0.14.
|
||||||
*
|
*
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
/*
|
/*
|
||||||
Simple DirectMedia Layer
|
Simple DirectMedia Layer
|
||||||
Copyright (C) 1997-2025 Sam Lantinga <slouken@libsdl.org>
|
Copyright (C) 1997-2023 Sam Lantinga <slouken@libsdl.org>
|
||||||
|
|
||||||
This software is provided 'as-is', without any express or implied
|
This software is provided 'as-is', without any express or implied
|
||||||
warranty. In no event will the authors be held liable for any damages
|
warranty. In no event will the authors be held liable for any damages
|
||||||
@@ -20,9 +20,9 @@
|
|||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* # CategoryMisc
|
* \file SDL_misc.h
|
||||||
*
|
*
|
||||||
* Include file for SDL API functions that don't fit elsewhere.
|
* \brief Include file for SDL API functions that don't fit elsewhere.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#ifndef SDL_misc_h_
|
#ifndef SDL_misc_h_
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
/*
|
/*
|
||||||
Simple DirectMedia Layer
|
Simple DirectMedia Layer
|
||||||
Copyright (C) 1997-2025 Sam Lantinga <slouken@libsdl.org>
|
Copyright (C) 1997-2023 Sam Lantinga <slouken@libsdl.org>
|
||||||
|
|
||||||
This software is provided 'as-is', without any express or implied
|
This software is provided 'as-is', without any express or implied
|
||||||
warranty. In no event will the authors be held liable for any damages
|
warranty. In no event will the authors be held liable for any damages
|
||||||
@@ -20,9 +20,9 @@
|
|||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* # CategoryMouse
|
* \file SDL_mouse.h
|
||||||
*
|
*
|
||||||
* Include file for SDL mouse event handling.
|
* Include file for SDL mouse event handling.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#ifndef SDL_mouse_h_
|
#ifndef SDL_mouse_h_
|
||||||
@@ -41,9 +41,9 @@ extern "C" {
|
|||||||
typedef struct SDL_Cursor SDL_Cursor; /**< Implementation dependent */
|
typedef struct SDL_Cursor SDL_Cursor; /**< Implementation dependent */
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Cursor types for SDL_CreateSystemCursor().
|
* \brief Cursor types for SDL_CreateSystemCursor().
|
||||||
*/
|
*/
|
||||||
typedef enum SDL_SystemCursor
|
typedef enum
|
||||||
{
|
{
|
||||||
SDL_SYSTEM_CURSOR_ARROW, /**< Arrow */
|
SDL_SYSTEM_CURSOR_ARROW, /**< Arrow */
|
||||||
SDL_SYSTEM_CURSOR_IBEAM, /**< I-beam */
|
SDL_SYSTEM_CURSOR_IBEAM, /**< I-beam */
|
||||||
@@ -61,9 +61,9 @@ typedef enum SDL_SystemCursor
|
|||||||
} SDL_SystemCursor;
|
} SDL_SystemCursor;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Scroll direction types for the Scroll event
|
* \brief Scroll direction types for the Scroll event
|
||||||
*/
|
*/
|
||||||
typedef enum SDL_MouseWheelDirection
|
typedef enum
|
||||||
{
|
{
|
||||||
SDL_MOUSEWHEEL_NORMAL, /**< The scroll direction is normal */
|
SDL_MOUSEWHEEL_NORMAL, /**< The scroll direction is normal */
|
||||||
SDL_MOUSEWHEEL_FLIPPED /**< The scroll direction is flipped / natural */
|
SDL_MOUSEWHEEL_FLIPPED /**< The scroll direction is flipped / natural */
|
||||||
@@ -90,9 +90,9 @@ extern DECLSPEC SDL_Window * SDLCALL SDL_GetMouseFocus(void);
|
|||||||
* either `x` or `y`.
|
* either `x` or `y`.
|
||||||
*
|
*
|
||||||
* \param x the x coordinate of the mouse cursor position relative to the
|
* \param x the x coordinate of the mouse cursor position relative to the
|
||||||
* focus window.
|
* focus window
|
||||||
* \param y the y coordinate of the mouse cursor position relative to the
|
* \param y the y coordinate of the mouse cursor position relative to the
|
||||||
* focus window.
|
* focus window
|
||||||
* \returns a 32-bit button bitmask of the current button state.
|
* \returns a 32-bit button bitmask of the current button state.
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.0.
|
* \since This function is available since SDL 2.0.0.
|
||||||
@@ -120,9 +120,9 @@ extern DECLSPEC Uint32 SDLCALL SDL_GetMouseState(int *x, int *y);
|
|||||||
* reason to use this function, you probably want SDL_GetMouseState() instead.
|
* reason to use this function, you probably want SDL_GetMouseState() instead.
|
||||||
*
|
*
|
||||||
* \param x filled in with the current X coord relative to the desktop; can be
|
* \param x filled in with the current X coord relative to the desktop; can be
|
||||||
* NULL.
|
* NULL
|
||||||
* \param y filled in with the current Y coord relative to the desktop; can be
|
* \param y filled in with the current Y coord relative to the desktop; can be
|
||||||
* NULL.
|
* NULL
|
||||||
* \returns the current button state as a bitmask which can be tested using
|
* \returns the current button state as a bitmask which can be tested using
|
||||||
* the SDL_BUTTON(X) macros.
|
* the SDL_BUTTON(X) macros.
|
||||||
*
|
*
|
||||||
@@ -141,8 +141,8 @@ extern DECLSPEC Uint32 SDLCALL SDL_GetGlobalMouseState(int *x, int *y);
|
|||||||
* mouse deltas since the last call to SDL_GetRelativeMouseState() or since
|
* mouse deltas since the last call to SDL_GetRelativeMouseState() or since
|
||||||
* event initialization. You can pass NULL for either `x` or `y`.
|
* event initialization. You can pass NULL for either `x` or `y`.
|
||||||
*
|
*
|
||||||
* \param x a pointer filled with the last recorded x coordinate of the mouse.
|
* \param x a pointer filled with the last recorded x coordinate of the mouse
|
||||||
* \param y a pointer filled with the last recorded y coordinate of the mouse.
|
* \param y a pointer filled with the last recorded y coordinate of the mouse
|
||||||
* \returns a 32-bit button bitmask of the relative button state.
|
* \returns a 32-bit button bitmask of the relative button state.
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.0.
|
* \since This function is available since SDL 2.0.0.
|
||||||
@@ -162,9 +162,9 @@ extern DECLSPEC Uint32 SDLCALL SDL_GetRelativeMouseState(int *x, int *y);
|
|||||||
* mouse when used over Microsoft Remote Desktop.
|
* mouse when used over Microsoft Remote Desktop.
|
||||||
*
|
*
|
||||||
* \param window the window to move the mouse into, or NULL for the current
|
* \param window the window to move the mouse into, or NULL for the current
|
||||||
* mouse focus.
|
* mouse focus
|
||||||
* \param x the x coordinate within the window.
|
* \param x the x coordinate within the window
|
||||||
* \param y the y coordinate within the window.
|
* \param y the y coordinate within the window
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.0.
|
* \since This function is available since SDL 2.0.0.
|
||||||
*
|
*
|
||||||
@@ -184,8 +184,8 @@ extern DECLSPEC void SDLCALL SDL_WarpMouseInWindow(SDL_Window * window,
|
|||||||
* Note that this function will appear to succeed, but not actually move the
|
* Note that this function will appear to succeed, but not actually move the
|
||||||
* mouse when used over Microsoft Remote Desktop.
|
* mouse when used over Microsoft Remote Desktop.
|
||||||
*
|
*
|
||||||
* \param x the x coordinate.
|
* \param x the x coordinate
|
||||||
* \param y the y coordinate.
|
* \param y the y coordinate
|
||||||
* \returns 0 on success or a negative error code on failure; call
|
* \returns 0 on success or a negative error code on failure; call
|
||||||
* SDL_GetError() for more information.
|
* SDL_GetError() for more information.
|
||||||
*
|
*
|
||||||
@@ -297,14 +297,14 @@ extern DECLSPEC SDL_bool SDLCALL SDL_GetRelativeMouseMode(void);
|
|||||||
* Also, since SDL 2.0.0, SDL_CreateSystemCursor() is available, which
|
* Also, since SDL 2.0.0, SDL_CreateSystemCursor() is available, which
|
||||||
* provides twelve readily available system cursors to pick from.
|
* provides twelve readily available system cursors to pick from.
|
||||||
*
|
*
|
||||||
* \param data the color value for each pixel of the cursor.
|
* \param data the color value for each pixel of the cursor
|
||||||
* \param mask the mask value for each pixel of the cursor.
|
* \param mask the mask value for each pixel of the cursor
|
||||||
* \param w the width of the cursor.
|
* \param w the width of the cursor
|
||||||
* \param h the height of the cursor.
|
* \param h the height of the cursor
|
||||||
* \param hot_x the X-axis location of the upper left corner of the cursor
|
* \param hot_x the X-axis location of the upper left corner of the cursor
|
||||||
* relative to the actual mouse position.
|
* relative to the actual mouse position
|
||||||
* \param hot_y the Y-axis location of the upper left corner of the cursor
|
* \param hot_y the Y-axis location of the upper left corner of the cursor
|
||||||
* relative to the actual mouse position.
|
* relative to the actual mouse position
|
||||||
* \returns a new cursor with the specified parameters on success or NULL on
|
* \returns a new cursor with the specified parameters on success or NULL on
|
||||||
* failure; call SDL_GetError() for more information.
|
* failure; call SDL_GetError() for more information.
|
||||||
*
|
*
|
||||||
@@ -322,9 +322,9 @@ extern DECLSPEC SDL_Cursor *SDLCALL SDL_CreateCursor(const Uint8 * data,
|
|||||||
/**
|
/**
|
||||||
* Create a color cursor.
|
* Create a color cursor.
|
||||||
*
|
*
|
||||||
* \param surface an SDL_Surface structure representing the cursor image.
|
* \param surface an SDL_Surface structure representing the cursor image
|
||||||
* \param hot_x the x position of the cursor hot spot.
|
* \param hot_x the x position of the cursor hot spot
|
||||||
* \param hot_y the y position of the cursor hot spot.
|
* \param hot_y the y position of the cursor hot spot
|
||||||
* \returns the new cursor on success or NULL on failure; call SDL_GetError()
|
* \returns the new cursor on success or NULL on failure; call SDL_GetError()
|
||||||
* for more information.
|
* for more information.
|
||||||
*
|
*
|
||||||
@@ -340,7 +340,7 @@ extern DECLSPEC SDL_Cursor *SDLCALL SDL_CreateColorCursor(SDL_Surface *surface,
|
|||||||
/**
|
/**
|
||||||
* Create a system cursor.
|
* Create a system cursor.
|
||||||
*
|
*
|
||||||
* \param id an SDL_SystemCursor enum value.
|
* \param id an SDL_SystemCursor enum value
|
||||||
* \returns a cursor on success or NULL on failure; call SDL_GetError() for
|
* \returns a cursor on success or NULL on failure; call SDL_GetError() for
|
||||||
* more information.
|
* more information.
|
||||||
*
|
*
|
||||||
@@ -358,7 +358,7 @@ extern DECLSPEC SDL_Cursor *SDLCALL SDL_CreateSystemCursor(SDL_SystemCursor id);
|
|||||||
* the display. SDL_SetCursor(NULL) can be used to force cursor redraw, if
|
* the display. SDL_SetCursor(NULL) can be used to force cursor redraw, if
|
||||||
* this is desired for any reason.
|
* this is desired for any reason.
|
||||||
*
|
*
|
||||||
* \param cursor a cursor to make active.
|
* \param cursor a cursor to make active
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.0.
|
* \since This function is available since SDL 2.0.0.
|
||||||
*
|
*
|
||||||
@@ -402,7 +402,7 @@ extern DECLSPEC SDL_Cursor *SDLCALL SDL_GetDefaultCursor(void);
|
|||||||
* Use this function to free cursor resources created with SDL_CreateCursor(),
|
* Use this function to free cursor resources created with SDL_CreateCursor(),
|
||||||
* SDL_CreateColorCursor() or SDL_CreateSystemCursor().
|
* SDL_CreateColorCursor() or SDL_CreateSystemCursor().
|
||||||
*
|
*
|
||||||
* \param cursor the cursor to free.
|
* \param cursor the cursor to free
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.0.
|
* \since This function is available since SDL 2.0.0.
|
||||||
*
|
*
|
||||||
@@ -437,9 +437,9 @@ extern DECLSPEC int SDLCALL SDL_ShowCursor(int toggle);
|
|||||||
/**
|
/**
|
||||||
* Used as a mask when testing buttons in buttonstate.
|
* Used as a mask when testing buttons in buttonstate.
|
||||||
*
|
*
|
||||||
* - Button 1: Left mouse button
|
* - Button 1: Left mouse button
|
||||||
* - Button 2: Middle mouse button
|
* - Button 2: Middle mouse button
|
||||||
* - Button 3: Right mouse button
|
* - Button 3: Right mouse button
|
||||||
*/
|
*/
|
||||||
#define SDL_BUTTON(X) (1 << ((X)-1))
|
#define SDL_BUTTON(X) (1 << ((X)-1))
|
||||||
#define SDL_BUTTON_LEFT 1
|
#define SDL_BUTTON_LEFT 1
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
/*
|
/*
|
||||||
Simple DirectMedia Layer
|
Simple DirectMedia Layer
|
||||||
Copyright (C) 1997-2025 Sam Lantinga <slouken@libsdl.org>
|
Copyright (C) 1997-2023 Sam Lantinga <slouken@libsdl.org>
|
||||||
|
|
||||||
This software is provided 'as-is', without any express or implied
|
This software is provided 'as-is', without any express or implied
|
||||||
warranty. In no event will the authors be held liable for any damages
|
warranty. In no event will the authors be held liable for any damages
|
||||||
@@ -23,9 +23,9 @@
|
|||||||
#define SDL_mutex_h_
|
#define SDL_mutex_h_
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* # CategoryMutex
|
* \file SDL_mutex.h
|
||||||
*
|
*
|
||||||
* Functions to provide thread synchronization primitives.
|
* Functions to provide thread synchronization primitives.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#include "SDL_stdinc.h"
|
#include "SDL_stdinc.h"
|
||||||
@@ -112,13 +112,13 @@ extern "C" {
|
|||||||
#endif
|
#endif
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Synchronization functions which can time out return this value if they time
|
* Synchronization functions which can time out return this value
|
||||||
* out.
|
* if they time out.
|
||||||
*/
|
*/
|
||||||
#define SDL_MUTEX_TIMEDOUT 1
|
#define SDL_MUTEX_TIMEDOUT 1
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* This is the timeout value which corresponds to never time out.
|
* This is the timeout value which corresponds to never time out.
|
||||||
*/
|
*/
|
||||||
#define SDL_MUTEX_MAXWAIT (~(Uint32)0)
|
#define SDL_MUTEX_MAXWAIT (~(Uint32)0)
|
||||||
|
|
||||||
@@ -165,7 +165,7 @@ extern DECLSPEC SDL_mutex *SDLCALL SDL_CreateMutex(void);
|
|||||||
* unlock it the same number of times before it is actually made available for
|
* unlock it the same number of times before it is actually made available for
|
||||||
* other threads in the system (this is known as a "recursive mutex").
|
* other threads in the system (this is known as a "recursive mutex").
|
||||||
*
|
*
|
||||||
* \param mutex the mutex to lock.
|
* \param mutex the mutex to lock
|
||||||
* \return 0, or -1 on error.
|
* \return 0, or -1 on error.
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.0.
|
* \since This function is available since SDL 2.0.0.
|
||||||
@@ -182,7 +182,7 @@ extern DECLSPEC int SDLCALL SDL_LockMutex(SDL_mutex * mutex) SDL_ACQUIRE(mutex);
|
|||||||
* This technique is useful if you need exclusive access to a resource but
|
* This technique is useful if you need exclusive access to a resource but
|
||||||
* don't want to wait for it, and will return to it to try again later.
|
* don't want to wait for it, and will return to it to try again later.
|
||||||
*
|
*
|
||||||
* \param mutex the mutex to try to lock.
|
* \param mutex the mutex to try to lock
|
||||||
* \returns 0, `SDL_MUTEX_TIMEDOUT`, or -1 on error; call SDL_GetError() for
|
* \returns 0, `SDL_MUTEX_TIMEDOUT`, or -1 on error; call SDL_GetError() for
|
||||||
* more information.
|
* more information.
|
||||||
*
|
*
|
||||||
@@ -224,7 +224,7 @@ extern DECLSPEC int SDLCALL SDL_UnlockMutex(SDL_mutex * mutex) SDL_RELEASE(mutex
|
|||||||
* to destroy a locked mutex, and may result in undefined behavior depending
|
* to destroy a locked mutex, and may result in undefined behavior depending
|
||||||
* on the platform.
|
* on the platform.
|
||||||
*
|
*
|
||||||
* \param mutex the mutex to destroy.
|
* \param mutex the mutex to destroy
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.0.
|
* \since This function is available since SDL 2.0.0.
|
||||||
*
|
*
|
||||||
@@ -256,7 +256,7 @@ typedef struct SDL_semaphore SDL_sem;
|
|||||||
* is 0. Each post operation will atomically increment the semaphore value and
|
* is 0. Each post operation will atomically increment the semaphore value and
|
||||||
* wake waiting threads and allow them to retry the wait operation.
|
* wake waiting threads and allow them to retry the wait operation.
|
||||||
*
|
*
|
||||||
* \param initial_value the starting value of the semaphore.
|
* \param initial_value the starting value of the semaphore
|
||||||
* \returns a new semaphore or NULL on failure; call SDL_GetError() for more
|
* \returns a new semaphore or NULL on failure; call SDL_GetError() for more
|
||||||
* information.
|
* information.
|
||||||
*
|
*
|
||||||
@@ -277,7 +277,7 @@ extern DECLSPEC SDL_sem *SDLCALL SDL_CreateSemaphore(Uint32 initial_value);
|
|||||||
* It is not safe to destroy a semaphore if there are threads currently
|
* It is not safe to destroy a semaphore if there are threads currently
|
||||||
* waiting on it.
|
* waiting on it.
|
||||||
*
|
*
|
||||||
* \param sem the semaphore to destroy.
|
* \param sem the semaphore to destroy
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.0.
|
* \since This function is available since SDL 2.0.0.
|
||||||
*
|
*
|
||||||
@@ -301,7 +301,7 @@ extern DECLSPEC void SDLCALL SDL_DestroySemaphore(SDL_sem * sem);
|
|||||||
* This function is the equivalent of calling SDL_SemWaitTimeout() with a time
|
* This function is the equivalent of calling SDL_SemWaitTimeout() with a time
|
||||||
* length of `SDL_MUTEX_MAXWAIT`.
|
* length of `SDL_MUTEX_MAXWAIT`.
|
||||||
*
|
*
|
||||||
* \param sem the semaphore wait on.
|
* \param sem the semaphore wait on
|
||||||
* \returns 0 on success or a negative error code on failure; call
|
* \returns 0 on success or a negative error code on failure; call
|
||||||
* SDL_GetError() for more information.
|
* SDL_GetError() for more information.
|
||||||
*
|
*
|
||||||
@@ -325,7 +325,7 @@ extern DECLSPEC int SDLCALL SDL_SemWait(SDL_sem * sem);
|
|||||||
* the semaphore doesn't have a positive value, the function immediately
|
* the semaphore doesn't have a positive value, the function immediately
|
||||||
* returns SDL_MUTEX_TIMEDOUT.
|
* returns SDL_MUTEX_TIMEDOUT.
|
||||||
*
|
*
|
||||||
* \param sem the semaphore to wait on.
|
* \param sem the semaphore to wait on
|
||||||
* \returns 0 if the wait succeeds, `SDL_MUTEX_TIMEDOUT` if the wait would
|
* \returns 0 if the wait succeeds, `SDL_MUTEX_TIMEDOUT` if the wait would
|
||||||
* block, or a negative error code on failure; call SDL_GetError()
|
* block, or a negative error code on failure; call SDL_GetError()
|
||||||
* for more information.
|
* for more information.
|
||||||
@@ -349,8 +349,8 @@ extern DECLSPEC int SDLCALL SDL_SemTryWait(SDL_sem * sem);
|
|||||||
* signal or error, or the specified time has elapsed. If the call is
|
* signal or error, or the specified time has elapsed. If the call is
|
||||||
* successful it will atomically decrement the semaphore value.
|
* successful it will atomically decrement the semaphore value.
|
||||||
*
|
*
|
||||||
* \param sem the semaphore to wait on.
|
* \param sem the semaphore to wait on
|
||||||
* \param timeout the length of the timeout, in milliseconds.
|
* \param timeout the length of the timeout, in milliseconds
|
||||||
* \returns 0 if the wait succeeds, `SDL_MUTEX_TIMEDOUT` if the wait does not
|
* \returns 0 if the wait succeeds, `SDL_MUTEX_TIMEDOUT` if the wait does not
|
||||||
* succeed in the allotted time, or a negative error code on failure;
|
* succeed in the allotted time, or a negative error code on failure;
|
||||||
* call SDL_GetError() for more information.
|
* call SDL_GetError() for more information.
|
||||||
@@ -369,7 +369,7 @@ extern DECLSPEC int SDLCALL SDL_SemWaitTimeout(SDL_sem *sem, Uint32 timeout);
|
|||||||
/**
|
/**
|
||||||
* Atomically increment a semaphore's value and wake waiting threads.
|
* Atomically increment a semaphore's value and wake waiting threads.
|
||||||
*
|
*
|
||||||
* \param sem the semaphore to increment.
|
* \param sem the semaphore to increment
|
||||||
* \returns 0 on success or a negative error code on failure; call
|
* \returns 0 on success or a negative error code on failure; call
|
||||||
* SDL_GetError() for more information.
|
* SDL_GetError() for more information.
|
||||||
*
|
*
|
||||||
@@ -387,7 +387,7 @@ extern DECLSPEC int SDLCALL SDL_SemPost(SDL_sem * sem);
|
|||||||
/**
|
/**
|
||||||
* Get the current value of a semaphore.
|
* Get the current value of a semaphore.
|
||||||
*
|
*
|
||||||
* \param sem the semaphore to query.
|
* \param sem the semaphore to query
|
||||||
* \returns the current value of the semaphore.
|
* \returns the current value of the semaphore.
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.0.
|
* \since This function is available since SDL 2.0.0.
|
||||||
@@ -427,7 +427,7 @@ extern DECLSPEC SDL_cond *SDLCALL SDL_CreateCond(void);
|
|||||||
/**
|
/**
|
||||||
* Destroy a condition variable.
|
* Destroy a condition variable.
|
||||||
*
|
*
|
||||||
* \param cond the condition variable to destroy.
|
* \param cond the condition variable to destroy
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.0.
|
* \since This function is available since SDL 2.0.0.
|
||||||
*
|
*
|
||||||
@@ -442,7 +442,7 @@ extern DECLSPEC void SDLCALL SDL_DestroyCond(SDL_cond * cond);
|
|||||||
/**
|
/**
|
||||||
* Restart one of the threads that are waiting on the condition variable.
|
* Restart one of the threads that are waiting on the condition variable.
|
||||||
*
|
*
|
||||||
* \param cond the condition variable to signal.
|
* \param cond the condition variable to signal
|
||||||
* \returns 0 on success or a negative error code on failure; call
|
* \returns 0 on success or a negative error code on failure; call
|
||||||
* SDL_GetError() for more information.
|
* SDL_GetError() for more information.
|
||||||
*
|
*
|
||||||
@@ -459,7 +459,7 @@ extern DECLSPEC int SDLCALL SDL_CondSignal(SDL_cond * cond);
|
|||||||
/**
|
/**
|
||||||
* Restart all threads that are waiting on the condition variable.
|
* Restart all threads that are waiting on the condition variable.
|
||||||
*
|
*
|
||||||
* \param cond the condition variable to signal.
|
* \param cond the condition variable to signal
|
||||||
* \returns 0 on success or a negative error code on failure; call
|
* \returns 0 on success or a negative error code on failure; call
|
||||||
* SDL_GetError() for more information.
|
* SDL_GetError() for more information.
|
||||||
*
|
*
|
||||||
@@ -486,8 +486,8 @@ extern DECLSPEC int SDLCALL SDL_CondBroadcast(SDL_cond * cond);
|
|||||||
* This function is the equivalent of calling SDL_CondWaitTimeout() with a
|
* This function is the equivalent of calling SDL_CondWaitTimeout() with a
|
||||||
* time length of `SDL_MUTEX_MAXWAIT`.
|
* time length of `SDL_MUTEX_MAXWAIT`.
|
||||||
*
|
*
|
||||||
* \param cond the condition variable to wait on.
|
* \param cond the condition variable to wait on
|
||||||
* \param mutex the mutex used to coordinate thread access.
|
* \param mutex the mutex used to coordinate thread access
|
||||||
* \returns 0 when it is signaled or a negative error code on failure; call
|
* \returns 0 when it is signaled or a negative error code on failure; call
|
||||||
* SDL_GetError() for more information.
|
* SDL_GetError() for more information.
|
||||||
*
|
*
|
||||||
@@ -512,10 +512,10 @@ extern DECLSPEC int SDLCALL SDL_CondWait(SDL_cond * cond, SDL_mutex * mutex);
|
|||||||
*
|
*
|
||||||
* The mutex must be locked before calling this function.
|
* The mutex must be locked before calling this function.
|
||||||
*
|
*
|
||||||
* \param cond the condition variable to wait on.
|
* \param cond the condition variable to wait on
|
||||||
* \param mutex the mutex used to coordinate thread access.
|
* \param mutex the mutex used to coordinate thread access
|
||||||
* \param ms the maximum time to wait, in milliseconds, or `SDL_MUTEX_MAXWAIT`
|
* \param ms the maximum time to wait, in milliseconds, or `SDL_MUTEX_MAXWAIT`
|
||||||
* to wait indefinitely.
|
* to wait indefinitely
|
||||||
* \returns 0 if the condition variable is signaled, `SDL_MUTEX_TIMEDOUT` if
|
* \returns 0 if the condition variable is signaled, `SDL_MUTEX_TIMEDOUT` if
|
||||||
* the condition is not signaled in the allotted time, or a negative
|
* the condition is not signaled in the allotted time, or a negative
|
||||||
* error code on failure; call SDL_GetError() for more information.
|
* error code on failure; call SDL_GetError() for more information.
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
/*
|
/*
|
||||||
Simple DirectMedia Layer
|
Simple DirectMedia Layer
|
||||||
Copyright (C) 1997-2025 Sam Lantinga <slouken@libsdl.org>
|
Copyright (C) 1997-2023 Sam Lantinga <slouken@libsdl.org>
|
||||||
|
|
||||||
This software is provided 'as-is', without any express or implied
|
This software is provided 'as-is', without any express or implied
|
||||||
warranty. In no event will the authors be held liable for any damages
|
warranty. In no event will the authors be held liable for any damages
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
/*
|
/*
|
||||||
Simple DirectMedia Layer
|
Simple DirectMedia Layer
|
||||||
Copyright (C) 1997-2025 Sam Lantinga <slouken@libsdl.org>
|
Copyright (C) 1997-2023 Sam Lantinga <slouken@libsdl.org>
|
||||||
|
|
||||||
This software is provided 'as-is', without any express or implied
|
This software is provided 'as-is', without any express or implied
|
||||||
warranty. In no event will the authors be held liable for any damages
|
warranty. In no event will the authors be held liable for any damages
|
||||||
@@ -19,11 +19,17 @@
|
|||||||
3. This notice may not be removed or altered from any source distribution.
|
3. This notice may not be removed or altered from any source distribution.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/*
|
/**
|
||||||
* This is a simple file to encapsulate the OpenGL API headers.
|
* \file SDL_opengl.h
|
||||||
*
|
*
|
||||||
* Define NO_SDL_GLEXT if you have your own version of glext.h and want
|
* This is a simple file to encapsulate the OpenGL API headers.
|
||||||
* to disable the version included in SDL_opengl.h.
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* \def NO_SDL_GLEXT
|
||||||
|
*
|
||||||
|
* Define this if you have your own version of glext.h and want to disable the
|
||||||
|
* version included in SDL_opengl.h.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#ifndef SDL_opengl_h_
|
#ifndef SDL_opengl_h_
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
/*
|
/*
|
||||||
Simple DirectMedia Layer
|
Simple DirectMedia Layer
|
||||||
Copyright (C) 1997-2025 Sam Lantinga <slouken@libsdl.org>
|
Copyright (C) 1997-2023 Sam Lantinga <slouken@libsdl.org>
|
||||||
|
|
||||||
This software is provided 'as-is', without any express or implied
|
This software is provided 'as-is', without any express or implied
|
||||||
warranty. In no event will the authors be held liable for any damages
|
warranty. In no event will the authors be held liable for any damages
|
||||||
@@ -19,10 +19,11 @@
|
|||||||
3. This notice may not be removed or altered from any source distribution.
|
3. This notice may not be removed or altered from any source distribution.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/*
|
/**
|
||||||
* This is a simple file to encapsulate the OpenGL ES 1.X API headers.
|
* \file SDL_opengles.h
|
||||||
|
*
|
||||||
|
* This is a simple file to encapsulate the OpenGL ES 1.X API headers.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#include "SDL_config.h"
|
#include "SDL_config.h"
|
||||||
|
|
||||||
#ifdef __IPHONEOS__
|
#ifdef __IPHONEOS__
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
/*
|
/*
|
||||||
Simple DirectMedia Layer
|
Simple DirectMedia Layer
|
||||||
Copyright (C) 1997-2025 Sam Lantinga <slouken@libsdl.org>
|
Copyright (C) 1997-2023 Sam Lantinga <slouken@libsdl.org>
|
||||||
|
|
||||||
This software is provided 'as-is', without any express or implied
|
This software is provided 'as-is', without any express or implied
|
||||||
warranty. In no event will the authors be held liable for any damages
|
warranty. In no event will the authors be held liable for any damages
|
||||||
@@ -19,10 +19,11 @@
|
|||||||
3. This notice may not be removed or altered from any source distribution.
|
3. This notice may not be removed or altered from any source distribution.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/*
|
/**
|
||||||
* This is a simple file to encapsulate the OpenGL ES 2.0 API headers.
|
* \file SDL_opengles2.h
|
||||||
|
*
|
||||||
|
* This is a simple file to encapsulate the OpenGL ES 2.0 API headers.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#include "SDL_config.h"
|
#include "SDL_config.h"
|
||||||
|
|
||||||
#if !defined(_MSC_VER) && !defined(SDL_USE_BUILTIN_OPENGL_DEFINITIONS)
|
#if !defined(_MSC_VER) && !defined(SDL_USE_BUILTIN_OPENGL_DEFINITIONS)
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
/*
|
/*
|
||||||
Simple DirectMedia Layer
|
Simple DirectMedia Layer
|
||||||
Copyright (C) 1997-2025 Sam Lantinga <slouken@libsdl.org>
|
Copyright (C) 1997-2023 Sam Lantinga <slouken@libsdl.org>
|
||||||
|
|
||||||
This software is provided 'as-is', without any express or implied
|
This software is provided 'as-is', without any express or implied
|
||||||
warranty. In no event will the authors be held liable for any damages
|
warranty. In no event will the authors be held liable for any damages
|
||||||
@@ -20,9 +20,9 @@
|
|||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* # CategoryPixels
|
* \file SDL_pixels.h
|
||||||
*
|
*
|
||||||
* Header for the enumerated pixel format definitions.
|
* Header for the enumerated pixel format definitions.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#ifndef SDL_pixels_h_
|
#ifndef SDL_pixels_h_
|
||||||
@@ -61,10 +61,7 @@ typedef enum
|
|||||||
SDL_PIXELTYPE_ARRAYU16,
|
SDL_PIXELTYPE_ARRAYU16,
|
||||||
SDL_PIXELTYPE_ARRAYU32,
|
SDL_PIXELTYPE_ARRAYU32,
|
||||||
SDL_PIXELTYPE_ARRAYF16,
|
SDL_PIXELTYPE_ARRAYF16,
|
||||||
SDL_PIXELTYPE_ARRAYF32,
|
SDL_PIXELTYPE_ARRAYF32
|
||||||
|
|
||||||
/* This must be at the end of the list to avoid breaking the existing ABI */
|
|
||||||
SDL_PIXELTYPE_INDEX2
|
|
||||||
} SDL_PixelType;
|
} SDL_PixelType;
|
||||||
|
|
||||||
/** Bitmap pixel order, high bit -> low bit. */
|
/** Bitmap pixel order, high bit -> low bit. */
|
||||||
@@ -137,7 +134,6 @@ typedef enum
|
|||||||
#define SDL_ISPIXELFORMAT_INDEXED(format) \
|
#define SDL_ISPIXELFORMAT_INDEXED(format) \
|
||||||
(!SDL_ISPIXELFORMAT_FOURCC(format) && \
|
(!SDL_ISPIXELFORMAT_FOURCC(format) && \
|
||||||
((SDL_PIXELTYPE(format) == SDL_PIXELTYPE_INDEX1) || \
|
((SDL_PIXELTYPE(format) == SDL_PIXELTYPE_INDEX1) || \
|
||||||
(SDL_PIXELTYPE(format) == SDL_PIXELTYPE_INDEX2) || \
|
|
||||||
(SDL_PIXELTYPE(format) == SDL_PIXELTYPE_INDEX4) || \
|
(SDL_PIXELTYPE(format) == SDL_PIXELTYPE_INDEX4) || \
|
||||||
(SDL_PIXELTYPE(format) == SDL_PIXELTYPE_INDEX8)))
|
(SDL_PIXELTYPE(format) == SDL_PIXELTYPE_INDEX8)))
|
||||||
|
|
||||||
@@ -181,12 +177,6 @@ typedef enum
|
|||||||
SDL_PIXELFORMAT_INDEX1MSB =
|
SDL_PIXELFORMAT_INDEX1MSB =
|
||||||
SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_INDEX1, SDL_BITMAPORDER_1234, 0,
|
SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_INDEX1, SDL_BITMAPORDER_1234, 0,
|
||||||
1, 0),
|
1, 0),
|
||||||
SDL_PIXELFORMAT_INDEX2LSB =
|
|
||||||
SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_INDEX2, SDL_BITMAPORDER_4321, 0,
|
|
||||||
2, 0),
|
|
||||||
SDL_PIXELFORMAT_INDEX2MSB =
|
|
||||||
SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_INDEX2, SDL_BITMAPORDER_1234, 0,
|
|
||||||
2, 0),
|
|
||||||
SDL_PIXELFORMAT_INDEX4LSB =
|
SDL_PIXELFORMAT_INDEX4LSB =
|
||||||
SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_INDEX4, SDL_BITMAPORDER_4321, 0,
|
SDL_DEFINE_PIXELFORMAT(SDL_PIXELTYPE_INDEX4, SDL_BITMAPORDER_4321, 0,
|
||||||
4, 0),
|
4, 0),
|
||||||
@@ -286,19 +276,11 @@ typedef enum
|
|||||||
SDL_PIXELFORMAT_ARGB32 = SDL_PIXELFORMAT_ARGB8888,
|
SDL_PIXELFORMAT_ARGB32 = SDL_PIXELFORMAT_ARGB8888,
|
||||||
SDL_PIXELFORMAT_BGRA32 = SDL_PIXELFORMAT_BGRA8888,
|
SDL_PIXELFORMAT_BGRA32 = SDL_PIXELFORMAT_BGRA8888,
|
||||||
SDL_PIXELFORMAT_ABGR32 = SDL_PIXELFORMAT_ABGR8888,
|
SDL_PIXELFORMAT_ABGR32 = SDL_PIXELFORMAT_ABGR8888,
|
||||||
SDL_PIXELFORMAT_RGBX32 = SDL_PIXELFORMAT_RGBX8888,
|
|
||||||
SDL_PIXELFORMAT_XRGB32 = SDL_PIXELFORMAT_XRGB8888,
|
|
||||||
SDL_PIXELFORMAT_BGRX32 = SDL_PIXELFORMAT_BGRX8888,
|
|
||||||
SDL_PIXELFORMAT_XBGR32 = SDL_PIXELFORMAT_XBGR8888,
|
|
||||||
#else
|
#else
|
||||||
SDL_PIXELFORMAT_RGBA32 = SDL_PIXELFORMAT_ABGR8888,
|
SDL_PIXELFORMAT_RGBA32 = SDL_PIXELFORMAT_ABGR8888,
|
||||||
SDL_PIXELFORMAT_ARGB32 = SDL_PIXELFORMAT_BGRA8888,
|
SDL_PIXELFORMAT_ARGB32 = SDL_PIXELFORMAT_BGRA8888,
|
||||||
SDL_PIXELFORMAT_BGRA32 = SDL_PIXELFORMAT_ARGB8888,
|
SDL_PIXELFORMAT_BGRA32 = SDL_PIXELFORMAT_ARGB8888,
|
||||||
SDL_PIXELFORMAT_ABGR32 = SDL_PIXELFORMAT_RGBA8888,
|
SDL_PIXELFORMAT_ABGR32 = SDL_PIXELFORMAT_RGBA8888,
|
||||||
SDL_PIXELFORMAT_RGBX32 = SDL_PIXELFORMAT_XBGR8888,
|
|
||||||
SDL_PIXELFORMAT_XRGB32 = SDL_PIXELFORMAT_BGRX8888,
|
|
||||||
SDL_PIXELFORMAT_BGRX32 = SDL_PIXELFORMAT_XRGB8888,
|
|
||||||
SDL_PIXELFORMAT_XBGR32 = SDL_PIXELFORMAT_RGBX8888,
|
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
SDL_PIXELFORMAT_YV12 = /**< Planar mode: Y + V + U (3 planes) */
|
SDL_PIXELFORMAT_YV12 = /**< Planar mode: Y + V + U (3 planes) */
|
||||||
@@ -320,10 +302,9 @@ typedef enum
|
|||||||
} SDL_PixelFormatEnum;
|
} SDL_PixelFormatEnum;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The bits of this structure can be directly reinterpreted as an
|
* The bits of this structure can be directly reinterpreted as an integer-packed
|
||||||
* integer-packed color which uses the SDL_PIXELFORMAT_RGBA32 format
|
* color which uses the SDL_PIXELFORMAT_RGBA32 format (SDL_PIXELFORMAT_ABGR8888
|
||||||
* (SDL_PIXELFORMAT_ABGR8888 on little-endian systems and
|
* on little-endian systems and SDL_PIXELFORMAT_RGBA8888 on big-endian systems).
|
||||||
* SDL_PIXELFORMAT_RGBA8888 on big-endian systems).
|
|
||||||
*/
|
*/
|
||||||
typedef struct SDL_Color
|
typedef struct SDL_Color
|
||||||
{
|
{
|
||||||
@@ -343,30 +324,7 @@ typedef struct SDL_Palette
|
|||||||
} SDL_Palette;
|
} SDL_Palette;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* A structure that contains pixel format information.
|
* \note Everything in the pixel format structure is read-only.
|
||||||
*
|
|
||||||
* Everything in the pixel format structure is read-only.
|
|
||||||
*
|
|
||||||
* A pixel format has either a palette or masks. If a palette is used `Rmask`,
|
|
||||||
* `Gmask`, `Bmask`, and `Amask` will be 0.
|
|
||||||
*
|
|
||||||
* An SDL_PixelFormat describes the format of the pixel data stored at the
|
|
||||||
* `pixels` field of an SDL_Surface. Every surface stores an SDL_PixelFormat
|
|
||||||
* in the `format` field.
|
|
||||||
*
|
|
||||||
* If you wish to do pixel level modifications on a surface, then
|
|
||||||
* understanding how SDL stores its color information is essential.
|
|
||||||
*
|
|
||||||
* For information on modern pixel color spaces, see the following Wikipedia
|
|
||||||
* article: http://en.wikipedia.org/wiki/RGBA_color_space
|
|
||||||
*
|
|
||||||
* \sa SDL_ConvertSurface
|
|
||||||
* \sa SDL_GetRGB
|
|
||||||
* \sa SDL_GetRGBA
|
|
||||||
* \sa SDL_MapRGB
|
|
||||||
* \sa SDL_MapRGBA
|
|
||||||
* \sa SDL_AllocFormat
|
|
||||||
* \sa SDL_FreeFormat
|
|
||||||
*/
|
*/
|
||||||
typedef struct SDL_PixelFormat
|
typedef struct SDL_PixelFormat
|
||||||
{
|
{
|
||||||
@@ -394,7 +352,7 @@ typedef struct SDL_PixelFormat
|
|||||||
/**
|
/**
|
||||||
* Get the human readable name of a pixel format.
|
* Get the human readable name of a pixel format.
|
||||||
*
|
*
|
||||||
* \param format the pixel format to query.
|
* \param format the pixel format to query
|
||||||
* \returns the human readable name of the specified pixel format or
|
* \returns the human readable name of the specified pixel format or
|
||||||
* `SDL_PIXELFORMAT_UNKNOWN` if the format isn't recognized.
|
* `SDL_PIXELFORMAT_UNKNOWN` if the format isn't recognized.
|
||||||
*
|
*
|
||||||
@@ -405,12 +363,12 @@ extern DECLSPEC const char* SDLCALL SDL_GetPixelFormatName(Uint32 format);
|
|||||||
/**
|
/**
|
||||||
* Convert one of the enumerated pixel formats to a bpp value and RGBA masks.
|
* Convert one of the enumerated pixel formats to a bpp value and RGBA masks.
|
||||||
*
|
*
|
||||||
* \param format one of the SDL_PixelFormatEnum values.
|
* \param format one of the SDL_PixelFormatEnum values
|
||||||
* \param bpp a bits per pixel value; usually 15, 16, or 32.
|
* \param bpp a bits per pixel value; usually 15, 16, or 32
|
||||||
* \param Rmask a pointer filled in with the red mask for the format.
|
* \param Rmask a pointer filled in with the red mask for the format
|
||||||
* \param Gmask a pointer filled in with the green mask for the format.
|
* \param Gmask a pointer filled in with the green mask for the format
|
||||||
* \param Bmask a pointer filled in with the blue mask for the format.
|
* \param Bmask a pointer filled in with the blue mask for the format
|
||||||
* \param Amask a pointer filled in with the alpha mask for the format.
|
* \param Amask a pointer filled in with the alpha mask for the format
|
||||||
* \returns SDL_TRUE on success or SDL_FALSE if the conversion wasn't
|
* \returns SDL_TRUE on success or SDL_FALSE if the conversion wasn't
|
||||||
* possible; call SDL_GetError() for more information.
|
* possible; call SDL_GetError() for more information.
|
||||||
*
|
*
|
||||||
@@ -431,12 +389,12 @@ extern DECLSPEC SDL_bool SDLCALL SDL_PixelFormatEnumToMasks(Uint32 format,
|
|||||||
* This will return `SDL_PIXELFORMAT_UNKNOWN` if the conversion wasn't
|
* This will return `SDL_PIXELFORMAT_UNKNOWN` if the conversion wasn't
|
||||||
* possible.
|
* possible.
|
||||||
*
|
*
|
||||||
* \param bpp a bits per pixel value; usually 15, 16, or 32.
|
* \param bpp a bits per pixel value; usually 15, 16, or 32
|
||||||
* \param Rmask the red mask for the format.
|
* \param Rmask the red mask for the format
|
||||||
* \param Gmask the green mask for the format.
|
* \param Gmask the green mask for the format
|
||||||
* \param Bmask the blue mask for the format.
|
* \param Bmask the blue mask for the format
|
||||||
* \param Amask the alpha mask for the format.
|
* \param Amask the alpha mask for the format
|
||||||
* \returns one of the SDL_PixelFormatEnum values.
|
* \returns one of the SDL_PixelFormatEnum values
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.0.
|
* \since This function is available since SDL 2.0.0.
|
||||||
*
|
*
|
||||||
@@ -455,7 +413,7 @@ extern DECLSPEC Uint32 SDLCALL SDL_MasksToPixelFormatEnum(int bpp,
|
|||||||
* allocated), and hence should not be modified, especially the palette. Weird
|
* allocated), and hence should not be modified, especially the palette. Weird
|
||||||
* errors such as `Blit combination not supported` may occur.
|
* errors such as `Blit combination not supported` may occur.
|
||||||
*
|
*
|
||||||
* \param pixel_format one of the SDL_PixelFormatEnum values.
|
* \param pixel_format one of the SDL_PixelFormatEnum values
|
||||||
* \returns the new SDL_PixelFormat structure or NULL on failure; call
|
* \returns the new SDL_PixelFormat structure or NULL on failure; call
|
||||||
* SDL_GetError() for more information.
|
* SDL_GetError() for more information.
|
||||||
*
|
*
|
||||||
@@ -468,7 +426,7 @@ extern DECLSPEC SDL_PixelFormat * SDLCALL SDL_AllocFormat(Uint32 pixel_format);
|
|||||||
/**
|
/**
|
||||||
* Free an SDL_PixelFormat structure allocated by SDL_AllocFormat().
|
* Free an SDL_PixelFormat structure allocated by SDL_AllocFormat().
|
||||||
*
|
*
|
||||||
* \param format the SDL_PixelFormat structure to free.
|
* \param format the SDL_PixelFormat structure to free
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.0.
|
* \since This function is available since SDL 2.0.0.
|
||||||
*
|
*
|
||||||
@@ -481,7 +439,7 @@ extern DECLSPEC void SDLCALL SDL_FreeFormat(SDL_PixelFormat *format);
|
|||||||
*
|
*
|
||||||
* The palette entries are initialized to white.
|
* The palette entries are initialized to white.
|
||||||
*
|
*
|
||||||
* \param ncolors represents the number of color entries in the color palette.
|
* \param ncolors represents the number of color entries in the color palette
|
||||||
* \returns a new SDL_Palette structure on success or NULL on failure (e.g. if
|
* \returns a new SDL_Palette structure on success or NULL on failure (e.g. if
|
||||||
* there wasn't enough memory); call SDL_GetError() for more
|
* there wasn't enough memory); call SDL_GetError() for more
|
||||||
* information.
|
* information.
|
||||||
@@ -495,8 +453,8 @@ extern DECLSPEC SDL_Palette *SDLCALL SDL_AllocPalette(int ncolors);
|
|||||||
/**
|
/**
|
||||||
* Set the palette for a pixel format structure.
|
* Set the palette for a pixel format structure.
|
||||||
*
|
*
|
||||||
* \param format the SDL_PixelFormat structure that will use the palette.
|
* \param format the SDL_PixelFormat structure that will use the palette
|
||||||
* \param palette the SDL_Palette structure that will be used.
|
* \param palette the SDL_Palette structure that will be used
|
||||||
* \returns 0 on success or a negative error code on failure; call
|
* \returns 0 on success or a negative error code on failure; call
|
||||||
* SDL_GetError() for more information.
|
* SDL_GetError() for more information.
|
||||||
*
|
*
|
||||||
@@ -511,10 +469,10 @@ extern DECLSPEC int SDLCALL SDL_SetPixelFormatPalette(SDL_PixelFormat * format,
|
|||||||
/**
|
/**
|
||||||
* Set a range of colors in a palette.
|
* Set a range of colors in a palette.
|
||||||
*
|
*
|
||||||
* \param palette the SDL_Palette structure to modify.
|
* \param palette the SDL_Palette structure to modify
|
||||||
* \param colors an array of SDL_Color structures to copy into the palette.
|
* \param colors an array of SDL_Color structures to copy into the palette
|
||||||
* \param firstcolor the index of the first palette entry to modify.
|
* \param firstcolor the index of the first palette entry to modify
|
||||||
* \param ncolors the number of entries to modify.
|
* \param ncolors the number of entries to modify
|
||||||
* \returns 0 on success or a negative error code if not all of the colors
|
* \returns 0 on success or a negative error code if not all of the colors
|
||||||
* could be set; call SDL_GetError() for more information.
|
* could be set; call SDL_GetError() for more information.
|
||||||
*
|
*
|
||||||
@@ -530,7 +488,7 @@ extern DECLSPEC int SDLCALL SDL_SetPaletteColors(SDL_Palette * palette,
|
|||||||
/**
|
/**
|
||||||
* Free a palette created with SDL_AllocPalette().
|
* Free a palette created with SDL_AllocPalette().
|
||||||
*
|
*
|
||||||
* \param palette the SDL_Palette structure to be freed.
|
* \param palette the SDL_Palette structure to be freed
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.0.
|
* \since This function is available since SDL 2.0.0.
|
||||||
*
|
*
|
||||||
@@ -556,11 +514,11 @@ extern DECLSPEC void SDLCALL SDL_FreePalette(SDL_Palette * palette);
|
|||||||
* format the return value can be assigned to a Uint16, and similarly a Uint8
|
* format the return value can be assigned to a Uint16, and similarly a Uint8
|
||||||
* for an 8-bpp format).
|
* for an 8-bpp format).
|
||||||
*
|
*
|
||||||
* \param format an SDL_PixelFormat structure describing the pixel format.
|
* \param format an SDL_PixelFormat structure describing the pixel format
|
||||||
* \param r the red component of the pixel in the range 0-255.
|
* \param r the red component of the pixel in the range 0-255
|
||||||
* \param g the green component of the pixel in the range 0-255.
|
* \param g the green component of the pixel in the range 0-255
|
||||||
* \param b the blue component of the pixel in the range 0-255.
|
* \param b the blue component of the pixel in the range 0-255
|
||||||
* \returns a pixel value.
|
* \returns a pixel value
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.0.
|
* \since This function is available since SDL 2.0.0.
|
||||||
*
|
*
|
||||||
@@ -590,12 +548,12 @@ extern DECLSPEC Uint32 SDLCALL SDL_MapRGB(const SDL_PixelFormat * format,
|
|||||||
* for an 8-bpp format).
|
* for an 8-bpp format).
|
||||||
*
|
*
|
||||||
* \param format an SDL_PixelFormat structure describing the format of the
|
* \param format an SDL_PixelFormat structure describing the format of the
|
||||||
* pixel.
|
* pixel
|
||||||
* \param r the red component of the pixel in the range 0-255.
|
* \param r the red component of the pixel in the range 0-255
|
||||||
* \param g the green component of the pixel in the range 0-255.
|
* \param g the green component of the pixel in the range 0-255
|
||||||
* \param b the blue component of the pixel in the range 0-255.
|
* \param b the blue component of the pixel in the range 0-255
|
||||||
* \param a the alpha component of the pixel in the range 0-255.
|
* \param a the alpha component of the pixel in the range 0-255
|
||||||
* \returns a pixel value.
|
* \returns a pixel value
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.0.
|
* \since This function is available since SDL 2.0.0.
|
||||||
*
|
*
|
||||||
@@ -615,12 +573,12 @@ extern DECLSPEC Uint32 SDLCALL SDL_MapRGBA(const SDL_PixelFormat * format,
|
|||||||
* (e.g., a completely white pixel in 16-bit RGB565 format would return [0xff,
|
* (e.g., a completely white pixel in 16-bit RGB565 format would return [0xff,
|
||||||
* 0xff, 0xff] not [0xf8, 0xfc, 0xf8]).
|
* 0xff, 0xff] not [0xf8, 0xfc, 0xf8]).
|
||||||
*
|
*
|
||||||
* \param pixel a pixel value.
|
* \param pixel a pixel value
|
||||||
* \param format an SDL_PixelFormat structure describing the format of the
|
* \param format an SDL_PixelFormat structure describing the format of the
|
||||||
* pixel.
|
* pixel
|
||||||
* \param r a pointer filled in with the red component.
|
* \param r a pointer filled in with the red component
|
||||||
* \param g a pointer filled in with the green component.
|
* \param g a pointer filled in with the green component
|
||||||
* \param b a pointer filled in with the blue component.
|
* \param b a pointer filled in with the blue component
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.0.
|
* \since This function is available since SDL 2.0.0.
|
||||||
*
|
*
|
||||||
@@ -643,13 +601,13 @@ extern DECLSPEC void SDLCALL SDL_GetRGB(Uint32 pixel,
|
|||||||
* If the surface has no alpha component, the alpha will be returned as 0xff
|
* If the surface has no alpha component, the alpha will be returned as 0xff
|
||||||
* (100% opaque).
|
* (100% opaque).
|
||||||
*
|
*
|
||||||
* \param pixel a pixel value.
|
* \param pixel a pixel value
|
||||||
* \param format an SDL_PixelFormat structure describing the format of the
|
* \param format an SDL_PixelFormat structure describing the format of the
|
||||||
* pixel.
|
* pixel
|
||||||
* \param r a pointer filled in with the red component.
|
* \param r a pointer filled in with the red component
|
||||||
* \param g a pointer filled in with the green component.
|
* \param g a pointer filled in with the green component
|
||||||
* \param b a pointer filled in with the blue component.
|
* \param b a pointer filled in with the blue component
|
||||||
* \param a a pointer filled in with the alpha component.
|
* \param a a pointer filled in with the alpha component
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.0.
|
* \since This function is available since SDL 2.0.0.
|
||||||
*
|
*
|
||||||
@@ -665,8 +623,8 @@ extern DECLSPEC void SDLCALL SDL_GetRGBA(Uint32 pixel,
|
|||||||
/**
|
/**
|
||||||
* Calculate a 256 entry gamma ramp for a gamma value.
|
* Calculate a 256 entry gamma ramp for a gamma value.
|
||||||
*
|
*
|
||||||
* \param gamma a gamma value where 0.0 is black and 1.0 is identity.
|
* \param gamma a gamma value where 0.0 is black and 1.0 is identity
|
||||||
* \param ramp an array of 256 values filled in with the gamma ramp.
|
* \param ramp an array of 256 values filled in with the gamma ramp
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.0.
|
* \since This function is available since SDL 2.0.0.
|
||||||
*
|
*
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
/*
|
/*
|
||||||
Simple DirectMedia Layer
|
Simple DirectMedia Layer
|
||||||
Copyright (C) 1997-2025 Sam Lantinga <slouken@libsdl.org>
|
Copyright (C) 1997-2023 Sam Lantinga <slouken@libsdl.org>
|
||||||
|
|
||||||
This software is provided 'as-is', without any express or implied
|
This software is provided 'as-is', without any express or implied
|
||||||
warranty. In no event will the authors be held liable for any damages
|
warranty. In no event will the authors be held liable for any damages
|
||||||
@@ -20,9 +20,9 @@
|
|||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* # CategoryPlatform
|
* \file SDL_platform.h
|
||||||
*
|
*
|
||||||
* Try to get a standard set of platform defines.
|
* Try to get a standard set of platform defines.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#ifndef SDL_platform_h_
|
#ifndef SDL_platform_h_
|
||||||
@@ -73,13 +73,7 @@
|
|||||||
#if defined(__APPLE__)
|
#if defined(__APPLE__)
|
||||||
/* lets us know what version of Mac OS X we're compiling on */
|
/* lets us know what version of Mac OS X we're compiling on */
|
||||||
#include <AvailabilityMacros.h>
|
#include <AvailabilityMacros.h>
|
||||||
#ifndef __has_extension /* Older compilers don't support this */
|
|
||||||
#define __has_extension(x) 0
|
|
||||||
#include <TargetConditionals.h>
|
#include <TargetConditionals.h>
|
||||||
#undef __has_extension
|
|
||||||
#else
|
|
||||||
#include <TargetConditionals.h>
|
|
||||||
#endif
|
|
||||||
|
|
||||||
/* Fix building with older SDKs that don't define these
|
/* Fix building with older SDKs that don't define these
|
||||||
See this for more information:
|
See this for more information:
|
||||||
@@ -172,12 +166,6 @@
|
|||||||
#define WINAPI_FAMILY_WINRT 0
|
#define WINAPI_FAMILY_WINRT 0
|
||||||
#endif /* HAVE_WINAPIFAMILY_H */
|
#endif /* HAVE_WINAPIFAMILY_H */
|
||||||
|
|
||||||
#if (HAVE_WINAPIFAMILY_H) && defined(WINAPI_FAMILY_PHONE_APP)
|
|
||||||
#define SDL_WINAPI_FAMILY_PHONE (WINAPI_FAMILY == WINAPI_FAMILY_PHONE_APP)
|
|
||||||
#else
|
|
||||||
#define SDL_WINAPI_FAMILY_PHONE 0
|
|
||||||
#endif
|
|
||||||
|
|
||||||
#if WINAPI_FAMILY_WINRT
|
#if WINAPI_FAMILY_WINRT
|
||||||
#undef __WINRT__
|
#undef __WINRT__
|
||||||
#define __WINRT__ 1
|
#define __WINRT__ 1
|
||||||
@@ -205,10 +193,8 @@
|
|||||||
#undef __GDK__
|
#undef __GDK__
|
||||||
#define __GDK__ 1
|
#define __GDK__ 1
|
||||||
#endif
|
#endif
|
||||||
#if defined(__PSP__) || defined(__psp__)
|
#if defined(__PSP__)
|
||||||
#ifdef __PSP__
|
|
||||||
#undef __PSP__
|
#undef __PSP__
|
||||||
#endif
|
|
||||||
#define __PSP__ 1
|
#define __PSP__ 1
|
||||||
#endif
|
#endif
|
||||||
#if defined(PS2)
|
#if defined(PS2)
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
/*
|
/*
|
||||||
Simple DirectMedia Layer
|
Simple DirectMedia Layer
|
||||||
Copyright (C) 1997-2025 Sam Lantinga <slouken@libsdl.org>
|
Copyright (C) 1997-2023 Sam Lantinga <slouken@libsdl.org>
|
||||||
|
|
||||||
This software is provided 'as-is', without any express or implied
|
This software is provided 'as-is', without any express or implied
|
||||||
warranty. In no event will the authors be held liable for any damages
|
warranty. In no event will the authors be held liable for any damages
|
||||||
@@ -23,9 +23,9 @@
|
|||||||
#define SDL_power_h_
|
#define SDL_power_h_
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* # CategoryPower
|
* \file SDL_power.h
|
||||||
*
|
*
|
||||||
* Header for the SDL power management routines.
|
* Header for the SDL power management routines.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#include "SDL_stdinc.h"
|
#include "SDL_stdinc.h"
|
||||||
@@ -37,9 +37,9 @@ extern "C" {
|
|||||||
#endif
|
#endif
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The basic state for the system's power supply.
|
* The basic state for the system's power supply.
|
||||||
*/
|
*/
|
||||||
typedef enum SDL_PowerState
|
typedef enum
|
||||||
{
|
{
|
||||||
SDL_POWERSTATE_UNKNOWN, /**< cannot determine power status */
|
SDL_POWERSTATE_UNKNOWN, /**< cannot determine power status */
|
||||||
SDL_POWERSTATE_ON_BATTERY, /**< Not plugged in, running on the battery */
|
SDL_POWERSTATE_ON_BATTERY, /**< Not plugged in, running on the battery */
|
||||||
@@ -66,10 +66,10 @@ typedef enum SDL_PowerState
|
|||||||
*
|
*
|
||||||
* \param seconds seconds of battery life left, you can pass a NULL here if
|
* \param seconds seconds of battery life left, you can pass a NULL here if
|
||||||
* you don't care, will return -1 if we can't determine a
|
* you don't care, will return -1 if we can't determine a
|
||||||
* value, or we're not running on a battery.
|
* value, or we're not running on a battery
|
||||||
* \param percent percentage of battery life left, between 0 and 100, you can
|
* \param percent percentage of battery life left, between 0 and 100, you can
|
||||||
* pass a NULL here if you don't care, will return -1 if we
|
* pass a NULL here if you don't care, will return -1 if we
|
||||||
* can't determine a value, or we're not running on a battery.
|
* can't determine a value, or we're not running on a battery
|
||||||
* \returns an SDL_PowerState enum representing the current battery state.
|
* \returns an SDL_PowerState enum representing the current battery state.
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.0.
|
* \since This function is available since SDL 2.0.0.
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
/*
|
/*
|
||||||
Simple DirectMedia Layer
|
Simple DirectMedia Layer
|
||||||
Copyright (C) 1997-2025 Sam Lantinga <slouken@libsdl.org>
|
Copyright (C) 1997-2023 Sam Lantinga <slouken@libsdl.org>
|
||||||
|
|
||||||
This software is provided 'as-is', without any express or implied
|
This software is provided 'as-is', without any express or implied
|
||||||
warranty. In no event will the authors be held liable for any damages
|
warranty. In no event will the authors be held liable for any damages
|
||||||
@@ -20,20 +20,9 @@
|
|||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* # CategoryQuit
|
* \file SDL_quit.h
|
||||||
*
|
*
|
||||||
* An SDL_QUIT event is generated when the user tries to close the application
|
* Include file for SDL quit event handling.
|
||||||
* window. If it is ignored or filtered out, the window will remain open. If
|
|
||||||
* it is not ignored or filtered, it is queued normally and the window is
|
|
||||||
* allowed to close. When the window is closed, screen updates will complete,
|
|
||||||
* but have no effect.
|
|
||||||
*
|
|
||||||
* SDL_Init() installs signal handlers for SIGINT (keyboard interrupt) and
|
|
||||||
* SIGTERM (system termination request), if handlers do not already exist,
|
|
||||||
* that generate SDL_QUIT events as well. There is no way to determine the
|
|
||||||
* cause of an SDL_QUIT event, but setting a signal handler in your
|
|
||||||
* application will override the default generation of quit events for that
|
|
||||||
* signal.
|
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#ifndef SDL_quit_h_
|
#ifndef SDL_quit_h_
|
||||||
@@ -42,6 +31,25 @@
|
|||||||
#include "SDL_stdinc.h"
|
#include "SDL_stdinc.h"
|
||||||
#include "SDL_error.h"
|
#include "SDL_error.h"
|
||||||
|
|
||||||
|
/**
|
||||||
|
* \file SDL_quit.h
|
||||||
|
*
|
||||||
|
* An ::SDL_QUIT event is generated when the user tries to close the application
|
||||||
|
* window. If it is ignored or filtered out, the window will remain open.
|
||||||
|
* If it is not ignored or filtered, it is queued normally and the window
|
||||||
|
* is allowed to close. When the window is closed, screen updates will
|
||||||
|
* complete, but have no effect.
|
||||||
|
*
|
||||||
|
* SDL_Init() installs signal handlers for SIGINT (keyboard interrupt)
|
||||||
|
* and SIGTERM (system termination request), if handlers do not already
|
||||||
|
* exist, that generate ::SDL_QUIT events as well. There is no way
|
||||||
|
* to determine the cause of an ::SDL_QUIT event, but setting a signal
|
||||||
|
* handler in your application will override the default generation of
|
||||||
|
* quit events for that signal.
|
||||||
|
*
|
||||||
|
* \sa SDL_Quit()
|
||||||
|
*/
|
||||||
|
|
||||||
/* There are no functions directly affecting the quit event */
|
/* There are no functions directly affecting the quit event */
|
||||||
|
|
||||||
#define SDL_QuitRequested() \
|
#define SDL_QuitRequested() \
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
/*
|
/*
|
||||||
Simple DirectMedia Layer
|
Simple DirectMedia Layer
|
||||||
Copyright (C) 1997-2025 Sam Lantinga <slouken@libsdl.org>
|
Copyright (C) 1997-2023 Sam Lantinga <slouken@libsdl.org>
|
||||||
|
|
||||||
This software is provided 'as-is', without any express or implied
|
This software is provided 'as-is', without any express or implied
|
||||||
warranty. In no event will the authors be held liable for any damages
|
warranty. In no event will the authors be held liable for any damages
|
||||||
@@ -20,9 +20,9 @@
|
|||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* # CategoryRect
|
* \file SDL_rect.h
|
||||||
*
|
*
|
||||||
* Header file for SDL_rect definition and management functions.
|
* Header file for SDL_rect definition and management functions.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#ifndef SDL_rect_h_
|
#ifndef SDL_rect_h_
|
||||||
@@ -135,8 +135,8 @@ SDL_FORCE_INLINE SDL_bool SDL_RectEquals(const SDL_Rect *a, const SDL_Rect *b)
|
|||||||
*
|
*
|
||||||
* If either pointer is NULL the function will return SDL_FALSE.
|
* If either pointer is NULL the function will return SDL_FALSE.
|
||||||
*
|
*
|
||||||
* \param A an SDL_Rect structure representing the first rectangle.
|
* \param A an SDL_Rect structure representing the first rectangle
|
||||||
* \param B an SDL_Rect structure representing the second rectangle.
|
* \param B an SDL_Rect structure representing the second rectangle
|
||||||
* \returns SDL_TRUE if there is an intersection, SDL_FALSE otherwise.
|
* \returns SDL_TRUE if there is an intersection, SDL_FALSE otherwise.
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.0.
|
* \since This function is available since SDL 2.0.0.
|
||||||
@@ -151,10 +151,10 @@ extern DECLSPEC SDL_bool SDLCALL SDL_HasIntersection(const SDL_Rect * A,
|
|||||||
*
|
*
|
||||||
* If `result` is NULL then this function will return SDL_FALSE.
|
* If `result` is NULL then this function will return SDL_FALSE.
|
||||||
*
|
*
|
||||||
* \param A an SDL_Rect structure representing the first rectangle.
|
* \param A an SDL_Rect structure representing the first rectangle
|
||||||
* \param B an SDL_Rect structure representing the second rectangle.
|
* \param B an SDL_Rect structure representing the second rectangle
|
||||||
* \param result an SDL_Rect structure filled in with the intersection of
|
* \param result an SDL_Rect structure filled in with the intersection of
|
||||||
* rectangles `A` and `B`.
|
* rectangles `A` and `B`
|
||||||
* \returns SDL_TRUE if there is an intersection, SDL_FALSE otherwise.
|
* \returns SDL_TRUE if there is an intersection, SDL_FALSE otherwise.
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.0.
|
* \since This function is available since SDL 2.0.0.
|
||||||
@@ -168,10 +168,10 @@ extern DECLSPEC SDL_bool SDLCALL SDL_IntersectRect(const SDL_Rect * A,
|
|||||||
/**
|
/**
|
||||||
* Calculate the union of two rectangles.
|
* Calculate the union of two rectangles.
|
||||||
*
|
*
|
||||||
* \param A an SDL_Rect structure representing the first rectangle.
|
* \param A an SDL_Rect structure representing the first rectangle
|
||||||
* \param B an SDL_Rect structure representing the second rectangle.
|
* \param B an SDL_Rect structure representing the second rectangle
|
||||||
* \param result an SDL_Rect structure filled in with the union of rectangles
|
* \param result an SDL_Rect structure filled in with the union of rectangles
|
||||||
* `A` and `B`.
|
* `A` and `B`
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.0.
|
* \since This function is available since SDL 2.0.0.
|
||||||
*/
|
*/
|
||||||
@@ -186,11 +186,11 @@ extern DECLSPEC void SDLCALL SDL_UnionRect(const SDL_Rect * A,
|
|||||||
* considered.
|
* considered.
|
||||||
*
|
*
|
||||||
* \param points an array of SDL_Point structures representing points to be
|
* \param points an array of SDL_Point structures representing points to be
|
||||||
* enclosed.
|
* enclosed
|
||||||
* \param count the number of structures in the `points` array.
|
* \param count the number of structures in the `points` array
|
||||||
* \param clip an SDL_Rect used for clipping or NULL to enclose all points.
|
* \param clip an SDL_Rect used for clipping or NULL to enclose all points
|
||||||
* \param result an SDL_Rect structure filled in with the minimal enclosing
|
* \param result an SDL_Rect structure filled in with the minimal enclosing
|
||||||
* rectangle.
|
* rectangle
|
||||||
* \returns SDL_TRUE if any points were enclosed or SDL_FALSE if all the
|
* \returns SDL_TRUE if any points were enclosed or SDL_FALSE if all the
|
||||||
* points were outside of the clipping rectangle.
|
* points were outside of the clipping rectangle.
|
||||||
*
|
*
|
||||||
@@ -210,11 +210,11 @@ extern DECLSPEC SDL_bool SDLCALL SDL_EnclosePoints(const SDL_Point * points,
|
|||||||
* both ends will be clipped to the boundary of the rectangle and the new
|
* both ends will be clipped to the boundary of the rectangle and the new
|
||||||
* coordinates saved in `X1`, `Y1`, `X2`, and/or `Y2` as necessary.
|
* coordinates saved in `X1`, `Y1`, `X2`, and/or `Y2` as necessary.
|
||||||
*
|
*
|
||||||
* \param rect an SDL_Rect structure representing the rectangle to intersect.
|
* \param rect an SDL_Rect structure representing the rectangle to intersect
|
||||||
* \param X1 a pointer to the starting X-coordinate of the line.
|
* \param X1 a pointer to the starting X-coordinate of the line
|
||||||
* \param Y1 a pointer to the starting Y-coordinate of the line.
|
* \param Y1 a pointer to the starting Y-coordinate of the line
|
||||||
* \param X2 a pointer to the ending X-coordinate of the line.
|
* \param X2 a pointer to the ending X-coordinate of the line
|
||||||
* \param Y2 a pointer to the ending Y-coordinate of the line.
|
* \param Y2 a pointer to the ending Y-coordinate of the line
|
||||||
* \returns SDL_TRUE if there is an intersection, SDL_FALSE otherwise.
|
* \returns SDL_TRUE if there is an intersection, SDL_FALSE otherwise.
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.0.
|
* \since This function is available since SDL 2.0.0.
|
||||||
@@ -274,8 +274,8 @@ SDL_FORCE_INLINE SDL_bool SDL_FRectEquals(const SDL_FRect *a, const SDL_FRect *b
|
|||||||
*
|
*
|
||||||
* If either pointer is NULL the function will return SDL_FALSE.
|
* If either pointer is NULL the function will return SDL_FALSE.
|
||||||
*
|
*
|
||||||
* \param A an SDL_FRect structure representing the first rectangle.
|
* \param A an SDL_FRect structure representing the first rectangle
|
||||||
* \param B an SDL_FRect structure representing the second rectangle.
|
* \param B an SDL_FRect structure representing the second rectangle
|
||||||
* \returns SDL_TRUE if there is an intersection, SDL_FALSE otherwise.
|
* \returns SDL_TRUE if there is an intersection, SDL_FALSE otherwise.
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.22.
|
* \since This function is available since SDL 2.0.22.
|
||||||
@@ -290,10 +290,10 @@ extern DECLSPEC SDL_bool SDLCALL SDL_HasIntersectionF(const SDL_FRect * A,
|
|||||||
*
|
*
|
||||||
* If `result` is NULL then this function will return SDL_FALSE.
|
* If `result` is NULL then this function will return SDL_FALSE.
|
||||||
*
|
*
|
||||||
* \param A an SDL_FRect structure representing the first rectangle.
|
* \param A an SDL_FRect structure representing the first rectangle
|
||||||
* \param B an SDL_FRect structure representing the second rectangle.
|
* \param B an SDL_FRect structure representing the second rectangle
|
||||||
* \param result an SDL_FRect structure filled in with the intersection of
|
* \param result an SDL_FRect structure filled in with the intersection of
|
||||||
* rectangles `A` and `B`.
|
* rectangles `A` and `B`
|
||||||
* \returns SDL_TRUE if there is an intersection, SDL_FALSE otherwise.
|
* \returns SDL_TRUE if there is an intersection, SDL_FALSE otherwise.
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.22.
|
* \since This function is available since SDL 2.0.22.
|
||||||
@@ -307,10 +307,10 @@ extern DECLSPEC SDL_bool SDLCALL SDL_IntersectFRect(const SDL_FRect * A,
|
|||||||
/**
|
/**
|
||||||
* Calculate the union of two rectangles with float precision.
|
* Calculate the union of two rectangles with float precision.
|
||||||
*
|
*
|
||||||
* \param A an SDL_FRect structure representing the first rectangle.
|
* \param A an SDL_FRect structure representing the first rectangle
|
||||||
* \param B an SDL_FRect structure representing the second rectangle.
|
* \param B an SDL_FRect structure representing the second rectangle
|
||||||
* \param result an SDL_FRect structure filled in with the union of rectangles
|
* \param result an SDL_FRect structure filled in with the union of rectangles
|
||||||
* `A` and `B`.
|
* `A` and `B`
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.22.
|
* \since This function is available since SDL 2.0.22.
|
||||||
*/
|
*/
|
||||||
@@ -326,11 +326,11 @@ extern DECLSPEC void SDLCALL SDL_UnionFRect(const SDL_FRect * A,
|
|||||||
* considered.
|
* considered.
|
||||||
*
|
*
|
||||||
* \param points an array of SDL_FPoint structures representing points to be
|
* \param points an array of SDL_FPoint structures representing points to be
|
||||||
* enclosed.
|
* enclosed
|
||||||
* \param count the number of structures in the `points` array.
|
* \param count the number of structures in the `points` array
|
||||||
* \param clip an SDL_FRect used for clipping or NULL to enclose all points.
|
* \param clip an SDL_FRect used for clipping or NULL to enclose all points
|
||||||
* \param result an SDL_FRect structure filled in with the minimal enclosing
|
* \param result an SDL_FRect structure filled in with the minimal enclosing
|
||||||
* rectangle.
|
* rectangle
|
||||||
* \returns SDL_TRUE if any points were enclosed or SDL_FALSE if all the
|
* \returns SDL_TRUE if any points were enclosed or SDL_FALSE if all the
|
||||||
* points were outside of the clipping rectangle.
|
* points were outside of the clipping rectangle.
|
||||||
*
|
*
|
||||||
@@ -351,11 +351,11 @@ extern DECLSPEC SDL_bool SDLCALL SDL_EncloseFPoints(const SDL_FPoint * points,
|
|||||||
* both ends will be clipped to the boundary of the rectangle and the new
|
* both ends will be clipped to the boundary of the rectangle and the new
|
||||||
* coordinates saved in `X1`, `Y1`, `X2`, and/or `Y2` as necessary.
|
* coordinates saved in `X1`, `Y1`, `X2`, and/or `Y2` as necessary.
|
||||||
*
|
*
|
||||||
* \param rect an SDL_FRect structure representing the rectangle to intersect.
|
* \param rect an SDL_FRect structure representing the rectangle to intersect
|
||||||
* \param X1 a pointer to the starting X-coordinate of the line.
|
* \param X1 a pointer to the starting X-coordinate of the line
|
||||||
* \param Y1 a pointer to the starting Y-coordinate of the line.
|
* \param Y1 a pointer to the starting Y-coordinate of the line
|
||||||
* \param X2 a pointer to the ending X-coordinate of the line.
|
* \param X2 a pointer to the ending X-coordinate of the line
|
||||||
* \param Y2 a pointer to the ending Y-coordinate of the line.
|
* \param Y2 a pointer to the ending Y-coordinate of the line
|
||||||
* \returns SDL_TRUE if there is an intersection, SDL_FALSE otherwise.
|
* \returns SDL_TRUE if there is an intersection, SDL_FALSE otherwise.
|
||||||
*
|
*
|
||||||
* \since This function is available since SDL 2.0.22.
|
* \since This function is available since SDL 2.0.22.
|
||||||
|
|||||||
File diff suppressed because it is too large.
Load diff
Loaded 100 of 564 files, more files were not shown because too many files have changed in this diff.
Show more
Reference in new issue
Block a user