2024-04-30 21:39:54 -04:00
projectfullname = Simple Directmedia Layer
2022-11-22 12:48:33 -05:00
projectshortname = SDL
2023-01-24 19:42:03 -05:00
incsubdir = include/SDL3
2022-06-15 23:25:36 -04:00
wikisubdir =
2023-02-28 11:37:46 -05:00
readmesubdir = docs
2024-11-01 23:47:32 -04:00
apiprefixregex = (SDL_|SDLK_|[US]int\d+)
2023-03-18 01:29:05 +01:00
mainincludefname = SDL3/SDL.h
2024-05-15 14:22:41 -07:00
versionfname = include/SDL3/SDL_version.h
2022-06-15 23:25:36 -04:00
versionmajorregex = \A\#define\s+SDL_MAJOR_VERSION\s+(\d+)\Z
versionminorregex = \A\#define\s+SDL_MINOR_VERSION\s+(\d+)\Z
2024-05-14 07:47:13 -07:00
versionmicroregex = \A\#define\s+SDL_MICRO_VERSION\s+(\d+)\Z
2025-06-15 22:32:15 -04:00
apipropertyregex = \A\s*\#\s*define\s+SDL_PROP_
2022-06-15 23:25:36 -04:00
selectheaderregex = \ASDL.*?\.h\Z
projecturl = https://libsdl.org/
wikiurl = https://wiki.libsdl.org
bugreporturl = https://github.com/libsdl-org/sdlwiki/issues/new
warn_about_missing = 0
2025-01-24 01:53:51 -05:00
#wikipreamble = (This is the documentation for SDL3, which is the current stable version. [SDL2](https://wiki.libsdl.org/SDL2/) was the previous version!)
2024-04-22 23:54:40 -04:00
wikiheaderfiletext = Defined in [<SDL3/%fname%>](https://github.com/libsdl-org/SDL/blob/main/include/SDL3/%fname%)
2025-01-09 14:12:07 -05:00
2024-04-22 23:54:40 -04:00
manpageheaderfiletext = Defined in SDL3/%fname%
2025-01-09 14:12:07 -05:00
manpagesymbolfilterregex = \A[US]int\d+\Z
2024-05-14 10:19:34 -04:00
2024-05-16 10:44:37 -04:00
# All SDL_test_* headers become undefined categories, everything else just converts like SDL_audio.h -> Audio
2024-05-14 10:19:34 -04:00
# A handful of others we fix up in the header itself with /* WIKI CATEGORY: x */ comments.
2024-05-16 10:44:37 -04:00
headercategoryeval = s/\ASDL_test_?.*?\.h\Z//; s/\ASDL_?(.*?)\.h\Z/$1/; ucfirst();
2024-12-10 11:21:57 -05:00
quickrefenabled = 1
2025-06-01 10:48:32 -04:00
quickrefcategoryorder = Init,Hints,Error,Version,Properties,Log,Video,Events,Keyboard,Mouse,Touch,Gamepad,Joystick,Haptic,Audio,Time,Timer,Render,SharedObject,Thread,Mutex,Atomic,Filesystem,IOStream,AsyncIO,Storage,Pixels,Surface,Blendmode,Rect,Camera,Clipboard,Dialog,Tray,Messagebox,GPU,Vulkan,Metal,Platform,Power,Sensor,Process,Bits,Endian,Assert,CPUInfo,Intrinsics,Locale,System,Misc,GUID,Main,Stdinc
2024-12-10 11:21:57 -05:00
quickreftitle = SDL3 API Quick Reference
quickrefurl = https://libsdl.org/
quickrefdesc = The latest version of this document can be found at https://wiki.libsdl.org/SDL3/QuickReference
2024-12-18 01:18:23 -05:00
quickrefmacroregex = \A(SDL_PLATFORM_.*|SDL_.*_INTRINSICS|SDL_Atomic...Ref|SDL_assert.*?|SDL_COMPILE_TIME_ASSERT|SDL_arraysize|SDL_Swap[BL]E\d\d|SDL_[a-z]+_cast)\Z
2025-09-02 15:49:52 -04:00
envvarenabled = 1
envvartitle = SDL3 Environment Variables
envvardesc = SDL3 can be controlled by the user, externally, with environment variables. They are all operate exactly like the [hints you can get and set programmatically](CategoryHints), but named without the `_HINT` part (so `"SDL_HINT_A"` would be environment variable `"SDL_A"`).\n\nThis list matches the latest in SDL3's revision control.
envvarsymregex = \ASDL_HINT_(.*)\Z
envvarsymreplace = SDL_$1