Ryan C. Gordon
d231edd2ad
SDL_dialog.h: Added missing `\param` lines to callback documentation.
2024-05-09 19:57:36 -04:00
SDL Wiki Bot
5f86f64f06
Sync SDL3 wiki -> header
2024-05-09 23:33:11 +00:00
Sam Lantinga
bcbf09acde
Renamed SDL_AttachVirtualJoystickEx() to SDL_AttachVirtualJoystick()
...
The shorthand version of this function didn't allow specifying a controller name, which seems pretty important. It seems like anyone actually implementing a virtual joystick is going to want to use some of the extended functionality.
2024-05-09 14:05:58 -07:00
Sam Lantinga
598b4e0a1f
Removed the limit on the number of supported renderer texture formats
...
Fixes https://github.com/libsdl-org/SDL/issues/9056
2024-05-09 13:30:07 -07:00
Ozkan Sezer
890ceb4ac4
SDL_stdinc.h: add fallback cases for SDL_SINT64_C and SDL_UINT64_C
...
These are needed when INT64_C and UINT64_C macros are either not
available (not likely), or guarded by __STDC_LIMIT_MACROS in C++
compilations (which is the case in many old SDKs.)
2024-05-09 20:55:56 +03:00
Ryan C. Gordon
9245084c06
SDL_video.h: Added a `\sa` from SDL_GLContext to SDL_GL_CreateContext.
2024-05-09 13:51:26 -04:00
Sam Lantinga
54fb629da5
SDL_WindowFlags is now 64-bit
...
Fixes https://github.com/libsdl-org/SDL/issues/7321
2024-05-09 10:39:54 -07: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
1944c009e9
SDL_Keycode is now Uint32
2024-05-09 10:00:46 -07:00
SDL Wiki Bot
d3e28f3ab8
Sync SDL3 wiki -> header
2024-05-09 16:18:35 +00:00
Sam Lantinga
33e7238268
Clarified the meaning of the cursor hotspot (thanks @nbriggs!)
...
Fixes https://github.com/libsdl-org/sdlwiki/issues/380
2024-05-09 09:16:46 -07:00
Sam Lantinga
3947356282
Removed obsolete documentation
2024-05-09 09:01:27 -07:00
SDL Wiki Bot
793622ff1c
Sync SDL3 wiki -> header
2024-05-08 21:48:12 +00:00
SDL Wiki Bot
a5e49cc4e8
Sync SDL3 wiki -> header
2024-05-08 19:36:35 +00:00
Frank Praznik
1f43c88220
time: Use a function instead of properties to retrieve the system date and time locale info
...
This allows applications to re-query the values if the system locale is changed during runtime, and better matches the other locale functions. A note is included in the documentation mentioning that this can be slow, as it has to call into OS functions.
Also allows for the removal of the init/quit time functions, as they are no longer needed.
2024-05-08 15:35:04 -04:00
SDL Wiki Bot
7abc589438
Sync SDL3 wiki -> header
2024-05-08 16:56:38 +00:00
Frank Praznik
7d47d16526
kmsdrm: Report the panel orientation hint property
...
Queries the "panel orientation" property on the connector and reports it in degrees of clockwise rotation via the 'SDL.display.KMSDRM.panel_orientation' display property.
This is provided by the kernel as a hint to userspace applications, and the application itself is ultimately responsible for any required coordinate transformations needed to conform to the requested orientation.
2024-05-08 12:55:19 -04:00
SDL Wiki Bot
8af26cf463
Sync SDL3 wiki -> header
2024-05-08 07:53:33 +00:00
Ryan C. Gordon
e14ba41689
Some minor documentation tweaks.
2024-05-08 03:52:31 -04:00
Sam Lantinga
04be04c338
Removed mostly unused SDL_errorcode
2024-05-07 15:45:06 -07:00
Sam Lantinga
afe7c7a644
Changed SDL_ClearError() to always return 0.
...
This will provide a quick and easy way of clearing the error when a function succeeds, if we want to do that in a more widespread way.
For now we guarantee that SDL_Init() will never have an error set when it returns successfully.
Fixes https://github.com/libsdl-org/SDL/issues/8421
2024-05-07 15:45:06 -07:00
Sam Lantinga
748490677c
Use SDL_RendererFlags in the API (thanks @Sackzement!)
2024-05-07 13:41:12 -07:00
SDL Wiki Bot
4928d0e479
Sync SDL3 wiki -> header
2024-05-07 19:25:31 +00: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
Sam Lantinga
53a45a4437
Fixed inconsistent hint names (thanks @Sackzement!)
...
Fixes https://github.com/libsdl-org/SDL/issues/9643
2024-05-07 08:47:25 -07:00
SDL Wiki Bot
ea1904eda1
Sync SDL3 wiki -> header
2024-05-06 16:09:31 +00:00
Petar Popovic
45ac1a09d9
System dependent 64 bit integer suffixes
...
Added macros SDL_SINT64_C() and SDL_UINT64_C().
Integer suffixes of SDL_MAX_SINT64, SDL_MIN_SINT64, SDL_MAX_UINT64
and SDL_MIN_UINT64 are now system dependent.
2024-05-06 09:08:49 -07:00
SDL Wiki Bot
d7d3028765
Sync SDL3 wiki -> header
2024-05-06 16:06:32 +00:00
Miku AuahDark
33ae7e38d6
Android: Allow SDL_IOFromFile to open content:// URI. ( #9696 )
2024-05-06 09:05:49 -07:00
Ryan C. Gordon
5dc207b3b6
include: Fix a preformatted piece of documentation that isn't C code.
2024-05-05 01:22:46 -04:00
SDL Wiki Bot
7856c8fb8f
Sync SDL3 wiki -> header
2024-05-03 19:40:33 +00:00
Ryan C. Gordon
cf0b5db9e1
SDL_system.h: Improve window message hook documentation.
2024-05-03 15:37:11 -04:00
Ryan C. Gordon
a04abd78d3
SDL_filesystem.h: Add a `\sa` from SDL_GetUserFolder to SDL_Folder.
...
Reference https://github.com/libsdl-org/sdlwiki/issues/522
2024-05-03 15:24:06 -04:00
SDL Wiki Bot
27b931a8a0
Sync SDL3 wiki -> header
2024-05-03 18:11:35 +00:00
Semphris
06b9d88682
Add more links in SDL_dialog documentation
2024-05-03 11:10:03 -07:00
Ryan C. Gordon
a790a67883
include: Filling in more documentation gaps.
2024-05-03 13:19:26 -04:00
Ryan C. Gordon
3473cef7df
surface: `SDL_blit` is not used in the public API, remove it from headers.
2024-05-03 12:57:09 -04:00
SDL Wiki Bot
7559acaf75
Sync SDL3 wiki -> header
2024-05-03 16:34:33 +00:00
Frank Praznik
3a6d9c59f4
wayland: Add mouse pointer warp support
...
The pointer confinement protocol does allow attempted warping the pointer via a hint, provided that the pointer is locked at the time of the request, and the requested coordinates fall within the bounds of the window.
Toggle the pointer locked state and request the pointer warp when the required protocol is available. This is similar to what XWayland does internally.
2024-05-03 12:33:19 -04:00
Sam Lantinga
b18a071639
Removed SDL_DROPEVENT_DATA_SIZE and SDL_TEXTEDITINGEVENT_TEXT_SIZE
...
Fixes https://github.com/libsdl-org/SDL/issues/9681
2024-05-03 09:19:49 -07:00
SDL Wiki Bot
a03829d636
Sync SDL3 wiki -> header
2024-05-03 13:59:29 +00:00
Ryan C. Gordon
31a45d7cb3
SDL_main.h: Document SDL_main.
2024-05-03 09:58:05 -04:00
Ryan C. Gordon
21c181b3b4
SDL_main.h: Minor documentation tweaks.
2024-05-03 09:48:27 -04:00
SDL Wiki Bot
e86f22b52b
Sync SDL3 wiki -> header
2024-05-03 13:42:29 +00:00
Ryan C. Gordon
d570fd7c2c
SDL_main.h: Document SDL_MAIN_USE_CALLBACKS.
2024-05-03 09:41:02 -04:00
SDL Wiki Bot
3bd04e5a34
Sync SDL3 wiki -> header
2024-05-03 13:32:31 +00:00
SDL Wiki Bot
ab5b904890
Sync SDL3 wiki -> header
2024-05-03 03:27:33 +00:00
Ryan C. Gordon
0e0bb22f79
include: More documentation updates.
2024-05-02 23:25:45 -04:00
Ryan C. Gordon
46b69af5a3
SDL_vulkan.h: Remove Tizen compatibility typedefs.
...
Any app for this system that wants to move to SDL3 will have to adjust to
all the other API changes anyhow, so there's no need to keep these anymore.
Fixes #9678 .
2024-05-02 23:25:44 -04:00
SDL Wiki Bot
10c2682647
Sync SDL3 wiki -> header
2024-05-03 02:54:35 +00:00
Ryan C. Gordon
760d7d276b
include: Filled in some missing documentation.
2024-05-02 22:53:08 -04:00
Ryan C. Gordon
9f842e9b5a
wikiheaders: Bind `#define`s 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
Sam Lantinga
d95f5bad24
Updated to version 3.1.2 for the preview release
2024-05-01 09:34:25 -07:00
Semphris
b9d3d746a0
Add trailing path separator to SDL_GetUserFolder()
2024-04-30 18:01:16 -07:00
SDL Wiki Bot
97d0e78842
Sync SDL3 wiki -> header
2024-04-30 17:48:27 +00:00
Semphris
c6a70d6898
Add support for modal windows to more platforms
...
- Adds support for modal windows to Win32, Mac, and Haiku, and enhances functionality on Wayland and X11, which previous set only the parent window, but not the modal state.
- Windows can be declared modal at creation time, and the modal state can be toggled at any time via SDL_SetWindowModalFor() (tested with UE5 through sdl2-compat).
- Allows dynamic unparenting/reparenting of windows.
- Includes a modal window test.
2024-04-30 13:47:57 -04:00
Ravbug
2f8cfce154
Fix SDL_main on UWP with C++20
...
/ZW is incompatible with C++20, so disable the #error in that case. In addition, define a main function because UWP in C++20 mode links to standard main.
2024-04-30 10:16:32 -07:00
Nhalrath
8eeaa815d9
docs: rename num to size in SDL_iostream
2024-04-30 10:16:10 -07:00
SDL Wiki Bot
556d9b8497
Sync SDL3 wiki -> header
2024-04-30 10:45:12 +00:00
SDL Wiki Bot
8b06473a11
Sync SDL3 wiki -> header
2024-04-29 20:53:27 +00:00
Petar Popovic
7bfecacc02
Removing function macro SDL_TABLESIZE()
2024-04-29 13:52:48 -07:00
Petar Popovic
8d0ad44edd
Adding tag names to enums
...
Adding tag names to following enums:
SDL_JoystickType, SDL_JoystickConnectionState, SDL_TouchDeviceType, SDL_DUMMY_ENUM
2024-04-28 16:09:37 -07:00
Petar Popovic
dffbb574ea
renaming SDL_eventaction tag to SDL_EventAction
2024-04-28 16:09:09 -07:00
SDL Wiki Bot
3f2f712fff
Sync SDL3 wiki -> header
2024-04-28 12:29:13 +00:00
Sam Lantinga
14f584a94b
SDL_CreateWindowAndRenderer() takes the window title as the first parameter
...
Fixes https://github.com/libsdl-org/SDL/issues/9626
2024-04-25 20:00:14 -07:00
SDL Wiki Bot
57f96fb124
Sync SDL3 wiki -> header
2024-04-25 21:23:14 +00:00
SDL Wiki Bot
1b8d4d77d6
Sync SDL3 wiki -> header
2024-04-25 21:01:12 +00: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
SDL Wiki Bot
a13bdeee8a
Sync SDL3 wiki -> header
2024-04-25 20:40:14 +00: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
Ryan C. Gordon
2fb024ab8e
wikiheaders: Defines directly following a non-struct typedef are documented.
...
The idea is that if you have a `typedef Uint32 MyFlags` that has a bunch of
defines that are meant to be bitflags, you can pack them into the same wiki
page automatically.
This only works with `typedef`s that are _not_ struct/union/enums, and it
only pulls in `#define` lines that immediately follow the typedef line.
Even a blank line or a comment will signal to stop including lines for
this page!
2024-04-25 03:02:27 -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
SDL Wiki Bot
ceeefb0512
Sync SDL3 wiki -> header
2024-04-24 20:43:29 +00:00
Ryan C. Gordon
cdb3cea76d
SDL_atomic.h: Documentation updates.
2024-04-24 16:42:16 -04:00
Ryan C. Gordon
ec97857a87
SDL_assert.h: Documentation improvements.
2024-04-24 15:17:31 -04:00
SDL Wiki Bot
5fbc038375
Sync SDL3 wiki -> header
2024-04-24 17:20:14 +00:00
Sam Lantinga
30d93fb29b
Relax, it's not that exciting :)
2024-04-24 09:19:38 -07:00
Ryan C. Gordon
4a11809370
SDL_TextInputEvent: Note that `text` field is UTF-8 encoded.
...
Reference Issue https://github.com/libsdl-org/sdlwiki/issues/516
2024-04-24 11:18:35 -04:00
Petar Popovic
b98116a996
Removing trailing commas in enums in SDL headers
...
Trailing commas in enums is a C99 feature.
This commit removes them in SDL headers for ANSI compatibility.
2024-04-24 09:44:41 -04:00
Ryan C. Gordon
30970780a9
include: Fixed some old Doxygen markup to be Markdown instead.
2024-04-23 14:38:04 -04:00
Ryan C. Gordon
7a36504952
storage: SDL_WriteStorageFile() wasn't marked as SDLCALL.
...
Fixes #9594 .
2024-04-21 09:26:07 -04:00
Erik Scholz
c623bd2fdc
reword SDL_BlitSurfaceScaled param
...
so it will link to the type in the docs/wiki
2024-04-20 07:51:40 -07:00
Frank Praznik
bede245395
Remove references to renderers being destroyed with windows in the documentation
2024-04-19 12:23:40 -04:00
Anonymous Maarten
7dd4f1ec22
SDL3 removed SDL_HINT_RENDER_SCALE_QUALITY hint
...
textures now default to linear filtering, use SDL_SetTextureScaleMode(texture, SDL_SCALEMODE_NEAREST) if you want nearest pixel mode instead
2024-04-17 16:38:15 -07:00
Ryan C. Gordon
093160904d
SDL_Keymod: Removed SDL_KMOD_RESERVED.
...
Fixes #9481 .
2024-04-17 17:30:10 -04:00
SDL Wiki Bot
2c183c602d
Sync SDL3 wiki -> header
2024-04-17 21:09:29 +00:00
Ryan C. Gordon
a18f3d55b7
SDL_iostream.h: Corrected documentation for SDL_ReadIO and SDL_WriteIO.
...
Fixes #9443 .
2024-04-17 17:08:05 -04:00
SDL Wiki Bot
bf0bf80df6
Sync SDL3 wiki -> header
2024-04-16 17:30:27 +00:00
Ryan C. Gordon
db6b6bd75e
include: Fixed up some sensor documentation.
...
Fixes #9468 .
2024-04-16 13:29:26 -04:00
Sam Lantinga
650d3b44e1
Removed the word "other" since the version has been removed
2024-04-16 08:52:21 -07:00
Ryan C. Gordon
235bfe2631
SDL_log.h: Remove SDL_MAX_LOG_MESSAGE.
...
The message length limit was removed in 2.0.24, so there's no need for
this define in SDL3 at all.
Fixes #9467 .
2024-04-16 00:31:57 -04:00
Brick
edaab8ad9f
Refactored audio conversion to reduce copying
...
More of the logic has been moved into SDL_AudioQueue,
allowing data to be converted directly from the input buffer.
2024-04-15 11:47:18 -10:00
Sam Lantinga
d69e6714a8
Document that tooltip windows don't get mouse or keyboard focus
2024-04-15 14:38:00 -07:00
Sam Lantinga
bfde7294f5
Added a note that the joystick should be initialized on the main thread on Windows
...
Fixes https://github.com/libsdl-org/SDL/issues/9533
2024-04-15 14:19:44 -07:00
SDL Wiki Bot
7000a112a3
Sync SDL3 wiki -> header
2024-04-15 21:13:12 +00:00
Sam Lantinga
70ce808c09
Changed SDL_KeyCode values to defines
...
This clears up confusion about whether to use SDL_KeyCode or SDL_Keycode and makes it clear that the values aren't the full set of possible keycodes.
Fixes https://github.com/libsdl-org/SDL/issues/9493
2024-04-15 11:08:51 -10:00
Sam Lantinga
2fa4937e1a
Removed obsolete padding
2024-04-15 13:55:01 -07:00
SDL Wiki Bot
35c08c828b
Sync SDL3 wiki -> header
2024-04-15 19:23:27 +00:00
Sam Lantinga
1862a62b5d
Replaced SDL_GetNumTouchFingers() and SDL_GetTouchFinger() with SDL_GetTouchFingers()
...
Fixes https://github.com/libsdl-org/SDL/issues/9484
2024-04-15 09:22:41 -10:00