11de629dd2
Sync SDL3 wiki -> header
2024-04-14 05:50:22 +00:00
291edc073c
include: Document SDL_TriggerBreakpoint.
2024-04-14 01:48:52 -04:00
59c332e569
Sync SDL3 wiki -> header
2024-04-14 05:35:26 +00:00
041de0c2eb
include: Some documentation improvements.
2024-04-14 01:33:56 -04:00
21bc72bef1
wikiheaders: Allow parts of the headers to be ignored.
...
The specific cases here were SDL_size_mul_overflow_builtin and
SDL_size_add_overflow_builtin, which are forced-inline symbols in
SDL_stdinc.h that have to exist, but aren't really part of the public API,
and thus shouldn't be exported as documentation.
2024-04-13 22:57:23 -04:00
e4f097805b
Sync SDL3 wiki -> header
2024-04-14 00:22:23 +00:00
081a94e321
include: Updated a bunch of documentation.
2024-04-13 20:10:13 -04:00
239b34d760
docs: Added some notes about iOS and the main callbacks.
2024-04-13 15:14:32 -04:00
9c5ae7293f
Sync SDL3 wiki -> header
2024-04-13 18:59:10 +00:00
cae90ef489
Sync SDL3 wiki -> header
2024-04-13 18:38:11 +00:00
6e1ed94913
ios: Renamed APIs that referred to "iPhone" to refer to "iOS".
...
Macros that papered over this difference in SDL2 have been removed for SDL3.
Fixes #9527 .
2024-04-13 14:30:30 -04:00
d252a8fe12
joystick: SDL_VirtualJoystickDesc no longer takes a struct version.
...
If we need to extend this in the future, we'll make a second struct and
a second SDL_AttachVirtualJoystickEx-style function that uses it.
Just zero the struct and don't set a version.
Fixes #9489 .
2024-04-13 14:16:12 -04:00
202bd7b0ff
Sync SDL3 wiki -> header
2024-04-13 13:24:25 +00:00
f01b34fd8d
include: Removed some SDL2 references in the documentation.
2024-04-13 09:23:37 -04:00
98e9f361a8
winrt: Remove SDL_WinRTGetFSPathUNICODE, rename SDL_WinRTGetFSPathUTF8.
...
Fixes #9470 .
2024-04-13 08:24:12 -04:00
02da4acf0f
Sync SDL3 wiki -> header
2024-04-13 12:07:27 +00:00
3f4ac1a3c7
winrt: Implemented SDL_GetUserFolder() for WinRT/UWP.
2024-04-13 08:05:43 -04:00
cbb3c69cb0
Sync SDL3 wiki -> header
2024-04-13 01:10:12 +00:00
03bc53fe31
include: Fixes the improper fix I made before of documentation, SDL_SensorType.
2024-04-12 14:51:52 -04:00
935b6502ac
Sync SDL3 wiki -> header
2024-04-11 19:40:25 +00:00
7ab8e4797e
include: Add documentation to SDL_MessageBoxColorType.
2024-04-11 15:39:58 -04:00
1abaacedb2
include: Fix documentation generation for SDL_SensorType.
2024-04-11 15:38:54 -04:00
2f4f1f6923
Sync SDL3 wiki -> header
2024-04-11 17:35:27 +00:00
0df988389c
include: Add `\since` to all documentation that was missing it.
2024-04-11 13:34:29 -04:00
073d2378dc
Sync SDL3 wiki -> header
2024-04-11 12:59:41 +00:00
9421a01400
SDL_AudioStreamCallback: Note that there's no _requirement_ to do anything.
...
This is as opposed to something like the SDL2 audio callback, where you
_must_ supply data or disaster occurs.
2024-04-11 08:56:10 -04:00
e47f2956cf
include: Documented SDL_bool a little.
2024-04-11 00:48:11 -04:00
407e54e188
include: More improved docs for the wikibridge!
2024-04-11 00:37:11 -04:00
f121553082
include: Fixed up SDL_AudioFormat documentation.
...
(this is not currently bridged to the wiki, but will be soon!)
2024-04-10 18:45:29 -04:00
b2239cb7ba
Sync SDL3 wiki -> header
2024-04-10 19:59:14 +00:00
557f26e6f0
include: Fixed up some more documentation.
2024-04-10 15:58:28 -04:00
06758685a5
stdinc: modify default alloca prototype
...
For compatibilty with TinyCC.
2024-04-10 08:03:46 +00:00
132cef91c8
Removing macro SDL_FColour from SDL_pixels.h
2024-04-09 18:20:03 -04:00
534c44b156
Sync SDL3 wiki -> header
2024-04-09 22:04:21 +00:00
a15a46340f
SDL_revision: Added documentation.
2024-04-09 18:02:30 -04:00
f687e0732a
Doxygen comment fixes in SDL_pixels.h
2024-04-09 16:57:34 -04:00
196d123c66
Sync SDL3 wiki -> header
2024-04-09 16:36:25 +00:00
d321e19ee5
stdinc: Document maths functions
...
SDL_stdinc.h has a documentation comment for SDL_acos(), but nothing else. Expand on
that comment, and add comments for the remaining maths functions.
2024-04-09 12:35:42 -04:00
afd91b5e9c
stdinc: Note that these functions match their C runtime equivalents
...
This header basically just consists of C runtime #defines and functions, but with
an SDL_ prefix. Note this in the documentation so people don't waste their time
reading through things they already understand.
2024-04-09 12:35:42 -04:00
629c694bd6
Fixed Doxygen comments
...
Added '*' to the start of Doxygen comments for SDL_FlipSurface and SDL_DuplicateSurface so they highlight properly in IDEs
2024-04-09 12:30:13 -04:00
9b5944a14f
Removing SDL_Colour macro
2024-04-09 12:25:36 -04:00
baf09904b3
Sync SDL3 wiki -> header
2024-04-09 13:59:22 +00:00
79dc6af98f
SDL_endian.h: Documented SDL_Swap* macros.
2024-04-09 09:58:01 -04:00
e044318a8e
Sync SDL3 wiki -> headers
2024-04-09 00:50:03 -04:00
ad090d2444
include: A ton of little documentation tweaks, fixes, and improvements.
...
This is just stuff I noticed while working on the wikiheaders updates. A
thorough pass over all the docs would not be terrible, and maybe a simple
script to check for consistency (does everything have a `\since` on it? etc)
might be nice, too.
2024-04-09 00:50:02 -04:00
6906c50e8b
assert: SDL_AssertData::always_ignore should be an SDL_bool, not an int.
2024-04-09 00:50:01 -04:00
c8a066019b
Renaming SDL_eventaction to SDL_EventAction
2024-04-08 14:28:52 -04:00
1efadcc5d4
Revert renaming SDL_eventaction. adding it again in next commit with
...
scripts
This reverts commit f08c31060a
2024-04-08 14:28:52 -04:00
764fe72449
SDL_time.h: Renaming enums SDL_DATE_FORMAT and SDL_TIME_FORMAT to SDL_DateFormat and SDL_TimeFormat
2024-04-07 23:03:01 -04:00
f08c31060a
Renaming SDL_eventaction to SDL_EventAction
2024-04-07 12:04:32 -04:00
SDL Wiki Bot
Ryan C. Gordon
anon
Anonymous Maarten
Petar Popovic
David Gow
Henry Wilson