SDL Wiki Bot
2f24e9c2f2
Sync SDL3 wiki -> header
2024-08-03 13:30:08 +00:00
Sam Lantinga
b5ad74998b
Removed SDL_DECLSPEC_FREE
2024-07-28 07:24:21 -07:00
SDL Wiki Bot
0f2fc2fbaa
Sync SDL3 wiki -> header
2024-07-27 03:59:43 +00:00
Sam Lantinga
4f55271571
Removed temporary memory from the API
...
It was intended to make the API easier to use, but various automatic garbage collection all had flaws, and making the application periodically clean up temporary memory added cognitive load to using the API, and in many cases was it was difficult to restructure threaded code to handle this.
So, we're largely going back to the original system, where the API returns allocated results and you free them.
In addition, to solve the problems we originally wanted temporary memory for:
* Short strings with a finite count, like device names, get stored in a per-thread string pool.
* Events continue to use temporary memory internally, which is cleaned up on the next event processing cycle.
2024-07-26 20:59:14 -07:00
Sam Lantinga
5e513ecc7f
Don't automatically free temporary memory, let the application call SDL_FreeTemporaryMemory() when it's ready.
...
Also mark up all functions that return temporary memory with SDL_DECLSPEC_TEMP, to help people implementing language bindings.
Fixes https://github.com/libsdl-org/SDL/issues/10378
2024-07-26 10:05:03 -07:00
Sam Lantinga
9bfd0d901c
Audio device IDs are unsigned
2024-07-22 05:48:01 -07:00
SDL Wiki Bot
975457cfb6
Sync SDL3 wiki -> header
2024-07-19 19:23:24 +00:00
Sam Lantinga
71a60d4c0e
Updated documentation for functions that return temporary memory
2024-07-19 12:22:03 -07:00
Sam Lantinga
637e9700dd
Standardize placement of '*' in function declarations
...
Implemented using these sed commands on the headers:
sed -E -i'' '/SDLCALL|;/ s,([a-z])\* ,\1 *,g' *
sed -E -i'' 's,(\(.*[^\*])\* ([a-z])(.*\)),\1*\2\3,g' *
sed -E -i'' 's,\*const,* const,g' *
sed -E -i'' 's,\*SDLCALL,* SDLCALL,g' *
sed -E -i'' 's,void\(,void (,g' *
git checkout *gl*
2024-07-19 12:22:03 -07:00
Sam Lantinga
8ca6caeda5
SDL_GetAudioPlaybackDevices() and SDL_GetAudioRecordingDevices() follow the SDL_GetStringRule
2024-07-19 12:22:03 -07:00
Sam Lantinga
217330a7b3
Made return value descriptions more consistent across the API
2024-07-19 12:22:03 -07:00
Sam Lantinga
d73c7311d5
Clarify that the SDL_GetStringRule means that SDL will automatically free the memory later.
2024-07-19 12:22:03 -07:00
Sam Lantinga
cb395f7e80
Change SDL_AudioFormat into an enum
...
This makes it easier to understand in the debugger, and is consistent with SDL_PixelFormat and SDL_Colorspace
2024-07-14 10:04:31 -07:00
Sam Lantinga
5bf6bc4d7d
Renamed SDL_Get/SetProperty() to SDL_Get/SetPointerProperty()
...
This is consistent with the naming for the functions that affect other data types
Fixes https://github.com/libsdl-org/SDL/issues/10241
2024-07-12 10:41:02 -07:00
SDL Wiki Bot
29b0076659
Sync SDL3 wiki -> header
2024-07-10 19:45:01 +00:00
Ryan C. Gordon
4755055bc3
audio: Separate channel maps out of SDL_AudioSpec.
2024-07-10 15:43:57 -04:00
SDL Wiki Bot
d7a875432b
Sync SDL3 wiki -> header
2024-07-03 20:07:11 +00:00
Ryan C. Gordon
2a8f1e11ca
audio: Add gain support to audio streams and logical audio devices.
...
Fixes #10028 .
2024-07-03 16:05:55 -04:00
SDL Wiki Bot
98f27b8f2e
Sync SDL3 wiki -> header
2024-07-03 18:39:46 +00:00
Ryan C. Gordon
16e7fdc4f2
audio: Add channel remapping to SDL_AudioSpec and SDL_AudioStream.
...
Fixes #8367 .
2024-07-03 14:38:33 -04:00
SDL Wiki Bot
63138c79af
Sync SDL3 wiki -> header
2024-06-15 05:09:09 +00:00
Ryan C. Gordon
38f0214e8a
audio: Refer to audio devices to "playback" and "recording".
...
Fixes #9619 .
2024-06-15 01:08:12 -04:00
Ryan C. Gordon
51902d4ac5
Updated headers with latest wikiheaders tweaks.
2024-06-14 02:09:55 -04:00
Ryan C. Gordon
2ad7c70ac6
documentation: clean up a minor syntax issue.
2024-06-13 18:10:28 -04:00
Sam Lantinga
66aac9aced
Fixed channel order typo
2024-06-10 18:05:31 -07:00
SDL Wiki Bot
454d890bef
Sync SDL3 wiki -> header
2024-06-11 00:57:54 +00:00
Ryan C. Gordon
d3a62d8298
audio: Update docs on channel ordering.
2024-06-10 20:56:50 -04:00
Ryan C. Gordon
e23257307e
Introduce formal policy for APIs that return strings.
...
This declares that any `const char *` returned from SDL is owned by SDL, and
promises to be valid _at least_ until the next time the event queue runs, or
SDL_Quit() is called, even if the thing that owns the string gets destroyed
or changed before then.
This is noted in the headers as "the SDL_GetStringRule", so this will both be
greppable to find a detailed explaination in docs/README-strings.md and
wikiheaders will automatically turn it into a link we can point at the
appropriate documentation.
Fixes #9902 .
(and several FIXMEs, both known and yet-undocumented.)
2024-06-03 14:20:49 -04:00
Ryan C. Gordon
a4ccace9c5
include: Fix warnings from gendynapi.py.
...
Fixes #9890 .
2024-05-26 13:44:16 -04:00
SDL Wiki Bot
8e3ff8c3a1
Sync SDL3 wiki -> header
2024-05-26 17:21:54 +00:00
Sam Lantinga
534768c7c5
Added SDL_PauseAudioStreamDevice() and SDL_ResumeAudioStreamDevice()
2024-05-26 13:21:23 -04:00
SDL Wiki Bot
84cb065da2
Sync SDL3 wiki -> header
2024-05-26 03:34:35 +00:00
Ryan C. Gordon
033793faed
audio: SDL_OpenAudioDeviceStream() now allows a NULL spec.
2024-05-25 23:34:01 -04:00
Ryan C. Gordon
6a40a8eb12
audio: Minor documentation clarifications.
2024-05-25 23:34:00 -04:00
Sam Lantinga
6f2621438a
Renamed DECLSPEC to SDL_DECLSPEC
2024-05-17 17:09:09 -07:00
SDL Wiki Bot
eda9247f01
Sync SDL3 wiki -> header
2024-05-17 12:37:31 +00:00
Brick
b6b9d5508e
Renamed SDL_MixAudioFormat to SDL_MixAudio, and use float volume
2024-05-17 13:36:51 +01:00
Ryan C. Gordon
5e6d85b8f0
wikiheaders: bridge wiki Category docs to the headers!
...
Did an initial cleanup on the headers and wrote a few pieces of documentation,
but this needs more work to fill out the documentation.
2024-05-16 11:48:23 -04:00
SDL Wiki Bot
678cfd23c0
Sync SDL3 wiki -> header
2024-05-13 21:30:12 +00:00
SDL Wiki Bot
7d6453ea33
Sync SDL3 wiki -> header
2024-05-13 21:24:33 +00:00
Ryan C. Gordon
766de7deff
SDL_audio.h: Whoops, one more documentation typo!
2024-05-13 17:24:08 -04:00
Ryan C. Gordon
7bc4bb9f96
SDL_audio.h: Fixed a documentation typo.
2024-05-13 17:23:21 -04:00
Susko3
895586c928
Use 1u literal for flags/masks calculation
...
Changes `1 <<` and `1<<` to use `1u`.
2024-05-09 10:29:48 -07:00
Sam Lantinga
aecb62e30d
Improved API consistency for flag data types
...
Flag data types are always unsigned and have the valid values following the typedef.
2024-05-07 12:24:37 -07:00
Ryan C. Gordon
a790a67883
include: Filling in more documentation gaps.
2024-05-03 13:19:26 -04:00
Ryan C. Gordon
9f842e9b5a
wikiheaders: Bind #defines below a function to it, like typedefs.
...
This effectively adds the property symbols for various functions to the
function's wiki page.
2024-05-02 12:49:30 -04:00
Ryan C. Gordon
6b1a98e664
wikiheaders: Allow basic typedefs to pull in some preprocessor logic.
...
Reference Issue #9557 .
This lets SDL_AudioFormat have the `#if byteorder == lilendian` section.
2024-04-25 16:44:09 -04:00
Ryan C. Gordon
d29b861a76
wikiheaders: Allow blank lines in post-typedef #define blocks.
...
Reference Issue #9557 .
2024-04-25 14:26:49 -04:00
SDL Wiki Bot
47ff4addd4
Sync SDL3 wiki -> header
2024-04-25 06:37:31 +00:00
Ryan C. Gordon
2733345422
SDL_audio.h: Documentation updates.
2024-04-25 02:36:08 -04:00
