eden-emu/SDL
14
0
Fork 0
mirror of https://github.com/libsdl-org/SDL.git synced 2025-05-16 09:48:26 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2
16304 commits 8 branches 71 tags 154 MiB
Commit graph

43 commits

Author SHA1 Message Date
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
SDL Wiki Bot
d65a8146b9 Sync SDL3 wiki -> header 2024-07-16 19:03:15 +00:00
Sam Lantinga
ec3bb4c029 Removed the need for SDL_CreateTLS() 
This eliminates the tap dancing needed for allocating TLS slots, we'll automatically allocate them as needed, in a thread-safe way.
 2024-07-16 12:01:51 -07:00
Ryan C. Gordon
51902d4ac5
Updated headers with latest wikiheaders tweaks. 2024-06-14 02:09:55 -04:00
SDL Wiki Bot
f003461a0b Sync SDL3 wiki -> header 2024-06-11 16:23:27 +00:00
Ryan C. Gordon
96f2ef77ab
include: Make function pointer params into typedefs. 
This is easier to read and document in general, but will also make some
new parsing work in wikiheaders much easier.
 2024-06-11 12:22:46 -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
Sam Lantinga
89caa88b73 Get the definition for SDL_PropertiesID in SDL_thread.h 2024-05-23 17:14:07 -07:00
SDL Wiki Bot
be5d4e5857 Sync SDL3 wiki -> header 2024-05-22 21:40:15 +00:00
Ryan C. Gordon
f2e3437311
include: Fixed headers to not break with wikiheaders. This is a hack for now. 
I broke the "Don't taunt wikiheaders" rule.  :)

https://wiki.libsdl.org/SDL3/README/documentation-rules#dont-taunt-wikiheaders
 2024-05-22 12:29:30 -04:00
SDL Wiki Bot
b7bb220e60 Sync SDL3 wiki -> header 2024-05-22 15:40:15 +00:00
Ryan C. Gordon
b2ca8fe458 thread: Simplified docs, moved some technical details to a non-wiki comment. 2024-05-22 11:39:43 -04:00
Ryan C. Gordon
b83bb035e6 thread: SDL_CreateThreadWithStackSize is now SDL_CreateThreadWithProperties. 2024-05-22 11:39:43 -04:00
Ryan C. Gordon
0ec716819e thread: Reworked SDL_CreateThread to be consistent across platforms. 
Also documented missing and weird bits, rename typedefs to fit SDL standards.
 2024-05-22 11:39:43 -04:00
Sam Lantinga
6f2621438a Renamed DECLSPEC to SDL_DECLSPEC 2024-05-17 17:09:09 -07: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
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
0df988389c
include: Add \since to all documentation that was missing it. 2024-04-11 13:34:29 -04:00
Ryan C. Gordon
e044318a8e
Sync SDL3 wiki -> headers 2024-04-09 00:50:03 -04:00
Ryan C. Gordon
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
Sam Lantinga
d8a54cd4f8 Updated "see also" references to be more consistent 
Fixes https://github.com/libsdl-org/SDL/issues/9282
 2024-03-17 12:28:11 -07:00
Ozkan Sezer
c5792cc0de SDL_thread.h: replace uses of __GDK__ and __WINRT__ (missed in #8875.) 2024-01-24 06:28:10 +03:00
Anonymous Maarten
31d133db40
Define SDL_PLATFORM_* macros instead of underscored ones (#8875) 2024-01-24 01:40:51 +00:00
Sam Lantinga
df4b855af5 Updated SDL_TLSID to use the same type as other IDs in SDL 2024-01-18 08:18:37 -08:00
Sam Lantinga
fc0c774976 Renamed SDL_ThreadID() to SDL_GetCurrentThreadID() 
Also renamed SDL_threadID to SDL_ThreadID and made it Uint64 for consistency with other ID types
 2024-01-18 08:18:37 -08:00
Sam Lantinga
26996e2c02 We've decided to keep separate functions for creating a thread with and without stack size specified. 
Fixes https://github.com/libsdl-org/SDL/issues/6652
 2024-01-18 06:11:55 -08:00
Sam Lantinga
5b3ee51c6c Updated copyright for 2024 2024-01-01 13:15:26 -08:00
Ryan C. Gordon
c53843a961
docs: Remove Doxygen \brief tags. 
Doxygen and the wiki bridge don't need them; they'll both just use the first
line/sentence instead.

Fixes #8446.
 2023-11-06 10:26:06 -05:00
Ozkan Sezer
f3cb46b083 SDL_thread.h: do not conflict with sdl2-compat::sdl3_include_wrapper.h 
The windows hacks in there will not be needed any longer
 2023-08-06 14:11:02 +03:00
Sylvain
aab3cbf207 SDL_thread.h: fix parameter name in comment 2023-07-07 21:55:20 +02:00
Sam Lantinga
cb73bed6eb SDL API renaming: SDL TLS functions 
Fixes https://github.com/libsdl-org/SDL/issues/7743
 2023-05-26 08:33:15 -07:00
Anonymous Maarten
549cedfa88 include: add \brief to includes 2023-02-19 10:01:33 -08:00
Sylvain
81c94a165c Add \since docs where missing and resets some to 3.0.0 
- remove a \returns
 2023-02-12 20:43:11 +01:00
Sylvain
43c08170af Add missing '\param' documentation 2023-02-12 09:42:13 +01:00
Sylvain
ce366facaa Add missing \returns, change "return" to "returns" to have same naming 2023-02-12 09:22:25 +01:00
Ozkan Sezer
7f3036c353 make sure to not enable SDL_PASSED_BEGINTHREAD_ENDTHREAD for WinRT 2023-02-07 00:22:37 +03:00
Sam Lantinga
fde78d12f2 Updated copyright for 2023 2023-01-09 09:41:41 -08:00
Ozkan Sezer
29ba5f5d64 SDL_thread.h: fix beginthread param of SDL_CreateThreadWithStackSize for win32 2022-12-27 00:10:00 +03:00
Vincent Hamm
5410d361f7 Fix SDL_CreateThreadWithStackSize not passing staacksize with win32 static api 
(cherry picked from commit 68073c6276)
 2022-12-26 11:24:17 -08:00
Sam Lantinga
63724c113b Removed the vi format comments from the source 
Vim users can use the [editorconfig plugin](https://github.com/editorconfig/editorconfig-vim) to automatically set tab spacing for the SDL coding style.

Fixes https://github.com/libsdl-org/SDL/issues/6903
 2022-12-26 11:17:23 -08:00
Ryan C. Gordon
3197632347
include: Renamed begin_code.h and close_code.h to have SDL_ prefixes. 
Fixes #6864.
 2022-12-22 11:39:26 -05:00
Sam Lantinga
0a48abc860 Switch header convention from #include "SDL.h" to #include <SDL3/SDLh> 
I ran this script in the include directory:
```sh
sed -i '' -e 's,#include "\(SDL.*\)",#include <SDL3/\1>,' *.h
```

I ran this script in the src directory:
```sh
for i in ../include/SDL3/SDL*.h
do hdr=$(basename $i)
   if [ x"$(echo $hdr | egrep 'SDL_main|SDL_name|SDL_test|SDL_syswm|SDL_opengl|SDL_egl|SDL_vulkan')" != x ]; then
        find . -type f -exec sed -i '' -e 's,#include "\('$hdr'\)",#include <SDL3/\1>,' {} \;
    else
        find . -type f -exec sed -i '' -e '/#include "'$hdr'"/d' {} \;
    fi
done
```

Fixes https://github.com/libsdl-org/SDL/issues/6575
 2022-11-26 22:15:18 -08:00
Renamed from include/SDL_thread.h (Browse further)