Files
kaizen/include/SDL3/SDL_haptic.h
irisz64 b22c6238d5 Squashed 'external/SDL/' changes from 90fd2a3cbe..279dabfc96
279dabfc96 cocoa: Don't use trick of briefly focusing the Dock on newer macOS releases.
afa27243df Ignore sensor delta values that look like they're out of range
cd98b66114 Allow overriding SDL_FORK_MESSAGEBOX in build environment
8d5bf053f7 Fixed detecting 8BitDo sensor timestamp on older firmware
0ac1241b7a x11: Always update the borders on frame extent events
f40bf44928 Removed unnecessary include
6d3e8b749e add 8BitDo Controller sensor_timestamp (#13278)
727b4924c8 Update the viewport when logical presentation changes
de6a23028a Fix #13276: Crash in SDL_GetAudioDeviceChannelMap
8442d4f0f7 joystick: Add support Xbox Adaptive Controller
3cd979b353 SDL_render.h: enum SDL_TextureAddressMode: Removed trailing comma
db3a35e9bc joystick: Fix MSVC errors C2099 with `/fp:strict`
9ed83e71f6 Fixed memory leaks in KMSDRM property handling
603118c340 Sync SDL3 wiki -> header
aa4f916b71 Renamed SDL_PROP_AUDIOSTREAM_KEEP_ON_SHUTDOWN_BOOLEAN to SDL_PROP_AUDIOSTREAM_AUTO_CLEANUP_BOOLEAN
6cfe211142 Sync SDL3 wiki -> header
274aa0242e audio: Let apps save an audio stream from destruction during SDL_Quit(). (#13244)
af8bee2dd1 alsa: change an SDL_LogError into SDL_LogDebug.
bbc674b9e7 test: Fix resource paths in testtray
796961acec Resolve bug for calibration Nintendo Switch Pro Controller (#13260)
3a6f9e01f8 Fixed Nintendo Switch thumbstick calibration
038a3806eb Fixed Nintendo Switch Pro thumbstick calibration
e6c2649afc Updated testffmpeg for ffmpeg 7.1
e80d084766 expose events originating from a live-resize set the data1 field to 1.
6aedc488d3 win32: Invalidate window message mouse button flags when reading buttons from raw input or GameInput
81e3066303 hidapi/libusb: disable C5287 warning in MSVC builds
7d9fd48557 alsa: recover from snd_pcm_avail() returning -EPIPE
e68f5ca99a alsa: use udev if available instead of a hotplug thread
051ce0ff89 alsa: fixed disconnecting the microphone when opened
5fcc83d93b Vita Render: Limit the scope of cliprect to viewport
1bd5110ff0 Vita: Fixed absence of clipping when viewport is set
eb04219efe audio: Enumerating audio devices will skip zombie devices still in the hash.
d06b6e42d2 Sync SDL3 wiki -> header
c19ad189dc Clarify that SDL_GetAudioStreamDevice() returns the logical device.
7882e60f0e Don't log an error for disconnected audio devices
e4e29b8601 Fix support for F21 to F24 scancodes on Linux
d7939abf42 Use consistent style for pointer declarations and casts
390fe65323 test: Fix a window parenting bug in testmodal
ca9b7c8ea3 video: Explicitly disallow setting the parent of a window to itself
c04624972e alsa: Simplify ALSA_WaitDevice.
b4ac5f43f5 include: Fixed copy/paste error in endian-specific SDL_Read function docs.
3896b1b3f4 wikiheaders: Let each subproject specify how to find their property symbols.
efed3c63b3 Added support for an alternate version of the Vader 4 Pro
d6bae53341 Added support for an alternate version of the Vader 4 Pro
f62c982bcf Reverted Accelerometer and Gyro displays to throttled display (10hz)
b833c618a9 Improved reliability detecting FlyDigi Vader controllers
0e262dfd44 Sync SDL3 wiki -> header
6c406dd122 include: a couple of documentation tweaks and typo fixes.
42c9fe119d Sync SDL3 wiki -> header
f5d1402c28 Flydigi Vader 4 Pro IMU rate correction (#13215)
1e886c8a2f 8 bitdo polling rate corrections (#13221)
913b611ccd Added tools for evaluating gyroscope accuracy and IMU polling rates. (#13209)
e2239c36d3 wayland: Ensure that the tablet tool list is always initialized to empty
ec1297199e wayland: Implement the pointer warp protocol
558a89fdb6 Read Switch controller gyro/accel sensitivity coeffs (SDL3)
fd4ffa6d27 Sync SDL3 wiki -> header
c5b1341757 Tweak Vulkan include guard check and 64-bit platform defines (#13210)
e18a6313de Added gyro support for the Flydigi Vader 3 Pro controller
71f479b4aa Fix a broken link inside README-cmake.md that's meant to send to README-linux.md also made said link more consistent with other links by adding .md suffix
f2bcfe3dd2 Correct the texture format used for the N-Gage (#13192)
685f1720fe Revert "[Nokia N-Gage] Fix alpha transparency in 4K color mode using BitBltMasked"
a89a20a9ab Fix Markdown typo in Arch Linux dependencies docs
cbc9d662ea [Nokia N-Gage] Add define to disable FPS counter by default.
d9af41b5ac cmake: more private definitions
5826966873 Fixed replacing existing specific gamepad mappings
f90a21483c Added support for the ZEROPLUS P4 Wired Gamepad
638acdc02a Remove the CRC from automatically generated gamepad mappings
45eb6310a8 x11: Resize fixed-size windows after mapping on xmonad
7dd5e765df joystick: Report battery on GIP controllers
c54a017f47 joystick: Clean up Elite Button handling
559efd58e2 joystick: Add headset stub to GIP driver
7cc3feeb1b keyboard: Search for the correct base key value when querying the keycode from a scancode
22fa45b3c1 win32: Ensure that text input is initially disabled when creating a window
c240ed976f Sync SDL3 wiki -> header
27464ffb08 Clarify that icon and cursor alternate images are added with SDL_AddSurfaceAlternateImage()
2ef7944170 [Nokia N-Gage] Fix alpha transparency in 4K color mode using BitBltMasked
d86fb8a83a gdk: Ignore focus loss events caused by text input showing the OSK
6622f4e1ea Added support for the NACON Revolution X Unlimited controller on macOS
45aa497813 [Nokia N-Gage] Fix SDL_GetPerformanceFrequency and SDL_GetPerformanceCounter
7457857304 Fixed input from the MayFlash GameCube adapter with version 7 firmware
1ec12b38e5 Sync SDL3 wiki -> header
b6c4a46b85 workflows: Use stable Steam Runtime 3 on both x86_64 and arm64
fbba5b272a GPU: Binding validation and prevent null dereference if expected binding is missing (#13164)
cf6c42e6e6 Use HEAPU8.set rather than Module.HEAPU8.set (thanks @sbc100!)
4b0f48c4cf Mark gamepads as invalid if they can't be opened
a314a58e7e Sync SDL3 wiki -> header
d283f4651c Sync SDL3 wiki -> header
8510331f66 .wikiheaders-options: Add Tray to quickreference categories.
b8187e2abd wikiheaders: Trim whitespace from end of lines in section headers.
9e0d9f30a7 x11: Be a little less aggressive with Xinput2IsInitialized checks.
57b6e6c7f9 Checks if xinput is loaded before trying to call xinput functions
ac3ab026fe audio: corrected comment about device format minimums.
83cc3bc234 audio: Opened device spec must be >= simple minimums, not device's defaults.
14a4ae521a pulseaudio: Request more recording data per-fragment.
3a4de2ad89 Sync SDL3 wiki -> header
47717f22fd cocoa: Always add a window-sized NSTrackingArea to each window.
f61d956a04 cocoa: add explicit tracking areas to the window.
58afb0d8ae wayland: Update xkbcommon names and types
c764e8864b wayland: Update xkbcommon to avoid using deprecated modifier names
b61586b492 [Nokia N-Gage] Increase max. texture size from 256 to 1024; the previous setting was chosen at random and does not necessarily make sense in practice.
329b5f27d6 fix preprocessor directive for SDL_RESTRICT definition in C99 case.
0d58594e66 fix inverted __STDC_VERSION__ condition in SDL_RESTRICT definition.
6a686185f7 SDL_begin_code.h: Actually define SDL_RESTRICT.
51dfca813b Pass text input rect to steam deck keyboard invocation
520d73ae57 include/SDL_gpu: fix bool members documentation indentation
a26e5f32e0 Gyro degrees per second is 2000 across all 8bitdo controllers (#13147)
fc1c0618de kmsdrm: fixed creating GBM surfaces on NVIDIA cards
03a6d98aee Update SDL_pixels.h
885e611f3c Added macros to push/pop error messages while cleaning up
61d105247e Fixed typos
7db0ac7380 Updated SDL_StretchSurface() documentation
ca988dbc2c Bail out if Xrandr returns zero CRTCs in the X11 messagebox implementation
c147ddf3e3 Do not use Xrandr if the extension is not queryable in the X11 messagebox implementation
df07c09f55 Use visuals and colormapsin the X11 messagebox implementation
737b9e117d Removed obsolete documentation
d2be547642 Removed spurious parentheses
36936cbf37 Set the serial number to the Bluetooth MAC address for 8BitDo controllers
f80e819c5b Sync SDL3 wiki -> header
b7082e7e18 Sync SDL3 wiki -> header
3940c660be begin_code: Added SDL_ALIGNED macro.
aa870d511e Disable SDL_HINT_JOYSTICK_RAWINPUT by default
db972604a8 gpu: Xbox buildfix
8a2e2e75d1 Simplified loop logic
b4f7948410 Ensure that report 06 command reads normally
e3d44cdd51 wayland: Use raw timestamps to calculate the elapsed repeat time on a key up event
b51273512b Sync SDL3 wiki -> header
988c0be934 Sync SDL3 wiki -> header
9b025e3cab PSP fullscreen is the only mode (#13125)
08b6f6175a Sync SDL3 wiki -> header
5e50d39b38 audio: Added SDL_PutAudioStreamDataNoCopy.
25db127450 SDL_video.c: remove two stray line continuation chars .
168d1a9253 emscripten: Proxy Emscripten_GetSystemTheme and EMSCRIPTENAUDIO_OpenDevice to the main thread.
f62572344f Clean up INTERFACE_COMPILE_OPTIONS
b70919ecd9 x11: Assume the window was mapped after showing
0657ece55d x11: Always send fullscreen dimensions except on XWayland
1f6b5c681d Set the initial axis values for HIDAPI and XInput controllers
fdc4f8fa39 x11: Include the XTest header when needed
2b4d61e4a6 VITA: support only fullscreen windows. Fixes #13079
4cd889cb13 joystick: Several minor GIP fixes
0a7548230c Sync SDL3 wiki -> header
c9cf4c42e0 Improved HIDAPI support for Flydigi controllers
ead32c706d fix error handling in WideCharToMultiByte
8ddb074889 bugfix advancing UTF-8 length in UTF-16 string
dcdbc0bf9f README-documentation-rules: Add a note about being UTF-8 only!
56bb73a8d2 README-ngage.md: Really actually got all the non-UTF-8 characters this time!
ecef0d3564 README-ngage.md: Found a few more non-UTF-8 things.
fb7afabbd6 README-ngage.md: Removed non-UTF-8 character.
73ca59b423 Sync SDL3 wiki -> header
136a44b0bd Sync SDL3 wiki -> header
7ae64592c9 Restore support for the Nokia N-Gage (#12148)
26f9940f82 Sync SDL3 wiki -> header
6f994cc7a8 Fixed macOS build
354895d975 Add Flydigi VADER 4 Pro HIDAPI support (#12874)
8d9a4fe843 stdinc: Corrected documentation for SDL_atan2 and SDL_atan2f.
abcfa1b7de wayland: Use SDL_memcpy instead of SDL_copyp to copy the repeated text string
22828d5f2a Fix #13083 segfault in `SDL_RemoveTrayEntry()` for submenu entries
264eb8d440 Fixed the Bluetooth flag for the combined Joy-Con controller
05f779f61e wayland: Cap the max key repeat elapsed time
20e8ac0075 wayland: Fix keymap changed event spam with non-latin keyboard layouts
b8e055ce64 use SDL style - else on same line as closing brace
8e22194217 get preferred locales on android
c08b1049d3 gpu/d3d12: Acknowledge that we've bound vertex buffers (#13088)
c89357bf60 Fix wrong callback type
f4942b3eae GPU: Update D3D12 to create multisample textures with default MSAA alignment
c7549eb0b6 wayland: Set the text input cursor rect properly
3be57ec774 docs: fix man page return value section generation
2dad6534b8 GPU: Add missing compute-writeable texture formats
992e4c59bd Fixed rare crash trying to interrupt SDL_WaitEvent()
4db8fe2f9b Sync SDL3 wiki -> header
6c61a94a4b wayland: Don't add the nanosecond timestamp offset to the pre-conversion millisecond value
25f2376e79 Fixed touch not being delivered as mouse events by default on Vita
afd1e51023 Fix: GameCube controller adapter hotplug not working
510126ee63 gpu: Check shader format support in PrepareDriver
8289656a4e GPU: Update to set supported shader formats inside CreateDevice
514d96de07 Sync SDL3 wiki -> header
d6a99752b7 Fix properties name in SDL_CreateGPUDeviceWithProperties
3dceb728b7 Suppress spammy gamepad and joystick update events
b0a282e31f wayland: Enable relative pointer mode based on the window flag
968222e74f Fix #13057 - fixes bug with NSEventTypeMouseMoved having a NULL window causing us to suppress future mouse move events because the window was considered out of focus.
d16371b923 Fix reference to nonexistent "README-3ds.md"
945eb6dc87 MacOS: fix cocoa clipboard text
b08d79b832 GPU: Check that a texture format is valid for compute writes (#13044)
604c192154 GPU: Always return NULL if beginning a pass fails an assert check
252129f433 GPU: Debug mode layer and level index checks
db154c8b9b Added HIDAPI mapping for the 8BitDo SF30 Pro
ec685e87fd Clarify logic in UpdateLogicalPresentation()
8aa5b97bb5 renderer: Always use the output size when updating the main view
1f7aa16eae wikiheaders: Man pages should escape apostrophe chars.
cf62637261 joystick: Add support for Xbox One Chatpad attachment
83cbf7f811 Sync SDL3 wiki -> header
f85f83ec7c SDL GPU: Implemented opt out Vulkan device features (#13016)
1eeffc5933 Revert "x11: Send key events for dead keys consumed by the IME"
3304d24bea Revert "x11: Filter out duplicate key presses when an IME is active"
cd95152b2c Fixed crash if out of memory in the Vulkan GPU driver
70b2d162e3 audio: Assert that all devices from device_hash are the appropriate type
83d4dce697 wayland: Remove all window references from seats when destroying a window
0a34279578 audio: Fix SDL_GetAudioDeviceName() not working with logical devices.
e2f7c4046c Sync SDL3 wiki -> header
f6c1e81394 [Process API] Quoting enhancements (#12946)
9a6f70d75a tray: Fix wrong `fByPositon` parameter of SetMenuItemInfoW in SDL_SetTrayEntryLabel
38da39c8c9 Added rightx and righty
2ae3418260 GPU Vulkan: set correct destination usage mode for storage buffer read/write bindings (#13009)
c6e9d6cc79 AAudio: Implemented sample frames hint
aaa5d70efc wayland: Check the cursor visibility flag when updating seat pointers
e1066ceea1 Revert "pulseaudio: cleanup TLS every time we finish a threaded-mainloop callback."
84308e7fba x11: Fix the Openbox quirk flag
6344712b04 GPU Vulkan: fix for Swapchain Semaphore Reuse
3f2226a917 Add progress bar support for Linux
e90f7ac4a8 Add hid_version and hid_version_str to renamed LIBUSB impl symbols
f92843da83 Sync SDL3 wiki -> header
86b206dadf GPU: Special case to avoid assert on GenerateMipmaps (#12995)
7b3bd8c538 joystick: Improve GIP metadata retry
367cf9ba63 joystick: Always continue processing GIP packets
955a49c883 joystick: Add quirk for no impulse vibration on the Spectra Pro
82899501b5 joystick: Fix GIP fast ACK issue
9e0edea16f joystick: Assume GIP gamepads have the LED command if no metadata is present
9a96960728 joystick: Sort out GIP vendor messages into the supported interfaces
72dd79752e joystick: Add initial support for GIP flight sticks
2248d3812e joystick: Rework GIP code to allow separate states for individual attachments
87fe9ef79b Fixed crash if WGI isn't correlated in RAWINPUT_JoystickRumble()
29d2116495 Define illegal_instruction() when it will be actually used
2aa0957081 Fixed 8BitDo Ultimate 2 Wireless controller on macOS
ad55597715 ci: Update Steam Linux Runtime tasks.
36c3a7a5e2 ci: Add slrsniper-arm64 task
8690a9ab54 Prefer the HIDAPI driver for 8BitDo controllers on macOS
2b57d58f7d Added GCController mapping for the 8BitDo SN30 Pro on macOS
d157600d3d Added GCController mapping for the 8BitDo Pro 2 on macOS
09c8d4b556 Sync SDL3 wiki -> header
37b86a6d2f windows: fix Unicode function and type inconsistencies
d9e58baa6d fixed the  field of SDL_MouseMotionTransformCallback
e7a765d648 Replace SDL_free with delete for new-allocated objects
5bee85408c Cleanup 8BitDo HIDAPI support for SF30 Pro and SN30 Pro
89a8cf2505 Sync SDL3 wiki -> header
6b048f59d7 fix #12963
2b3c481215 add 8BitDo Controller (#12964)
ca47dc59a9 Fixed building with the OpenVR video driver
195ad85ba4 Fixed typo
f4813ca2cf x11: Filter out duplicate key presses when an IME is active
8e1f4bafb4 [emscripten] Remove referenc to Module['createContext']
1dbb813316 VITA: fix audio playback
20f783532b Sync SDL3 wiki -> header
bbd973c8d2 Sync SDL3 wiki -> header
71303b41bf Sync SDL3 wiki -> header
a7344206e8 wikiheaders: Patched to compile.
06c2f9fcfc wikiheaders: Correct wiki README digest links.
ad46394e82 wikiheaders: README.md should be READMEs.md
2c97a48c51 wikiheaders: READMEs go in the base dir of the wiki now.
92a5417a98 docs: Tweak some minor things to keep wikiheaders happy.
d357aa29a3 Fixed initializing the OpenVR driver
f8c77908ad Use motor sequence ID 0 in the HIDAPI GIP driver
33e5f4885a x11: Don't update grab on enter when the mouse is captured
1abac3ccc3 Revert "x11: Better handle XInput2 mouse tracking outside the window"
85d2345bd8 Sync SDL3 wiki -> header
5bd886519b Sync SDL3 wiki -> header
c6362b4788 tests: Revert some leftover testing code
c91f9f6968 x11: #ifdef the XRandR path in the message box code
7490471796 cpuinfo: Use auxv for AltiVec on Linux if possible
17bba029ba don't prototype strdup() for __clang_analyzer__ case in windows builds.
15c6acf74f capture g27 shifter r input
795d1ae1fb testmessage: Don't push the event if "Retry" was chosen.
d73fe0bc53 win32: Hide the borders when showing a fullscreen window
ab12b7cbba Added support for the share button on the GameSir-K1 FLUX controller
1e6a25324c Added support for the PowerA Battle Dragon Advanced Wireless Controller
57346f2ba8 dialog: Cocoa backend should reactivate the app after the modal dialog.
caf269ce00 Added a link to the GIP documentation
34c045aa39 Fixed paddles on the Xbox Elite controller using the GIP driver
0447c2f3c3 events: Add integer wheel fields for sdl2-compat
ae251a05be Fixed warning: no previous prototype for function 'GIP_ParseMetadata'
193b0c8963 uikit: Use SDL_RunOnMainThread instead of dispatch_sync for message boxes.
691cc5bb5e dialog: Cocoa shouldn't crash if there's a '.' in the filters.
4ef8b6ce1b X11: Center Message Box on Multi Monitor Displays (#12819)
c5d5967c3a video: Store the preferred fullscreen display in a property for sdl2-compat
11e1d4a145 Sync SDL3 wiki -> header
00f3a82ada Joystick: Add new GIP driver to replace old Xbox One wired driver
48dfc03a87 Added the gamepad hint SDL_GAMECONTROLLER_USE_GAMECUBE_LABELS
21a7bbbf14 Restore compatibility with older GameCube mappings
3730128e33 Simplify WIN_CreateHCursor (#12933)
6a0505c090 wayland: Remove unnecessary function call
fdd8b5d630 wayland: Query the mouse global button states from the seats
e3df61b070 Fixed right mouse button emulation when using a pen
106ccc722e Fixed missing simulated mouse events using a Wacom tablet
8ae962c904 Fixed build
e04064350f Fixed right click mouse emulation for the Wacom tablet
a163257295 GPU: Validate that textures are not bound for both read and write on render passes (#12925)
ea67133e4f pen: Windows can't check WM_POINTER[DOWN|UP] for touches directly.
f131791005 Sync SDL3 wiki -> header
e1a41c1c97 GPU Vulkan: Add locks for layout object lookups (#12924)
fd5380ffc6 Sync SDL3 wiki -> header
b871ac0d97 Add support for non-constrained and non-grabbing popups
8abcc27535 Removed timeout in SDL_RunOnMainThread()
ef54c3bf18 Always enable D3D12 GPU on Windows
39d3148185 events: Fix undefined behavior when disabling some event types
510c7edd9b migrate usage of SetCursor(NULL) to RedrawCursor()
4779499048 Split the redraw effect to own function
6c172e5220 SDL_SetCursor should not skip focus check
cbf44700d8 bytepusher example: always render text to render target and remove unused variable
faddff1bcc Sync SDL3 wiki -> header
31650d566c Added SDL_GAMEPAD_TYPE_GAMECUBE
c4d5cc358f streamline boolean logic
441e7e488f invert cursor_visible to hide_cursor
d553372682 rename cursor_shown to cursor_visible
016ba86f93 tray, unix: make pointers g_object_ref and g_object_ref_sink static
6f5892e543 cocoa: Immediately update the mouse focus when showing/hiding a popup menu
8c733d1f7b x11: Better handle XInput2 mouse tracking outside the window
0dbf585ace fix SDL_audiocvt.c MSVC build.
af0972c33f audio: SDL_PutAudioStreamPlanarData should take a channel count.
5f03cb3882 d3d12: Patched to compile with GDK builds.
360cc2791f test/msdf_font.bmp: mark as non-executable.
34fe967f3e Sync SDL3 wiki -> header
22692e308f events: Added SDL_GetEventDescription().
c2ed58db7b windows: Fix stale zoom/iconic state in WM_WINDOWPOSCHANGED handler
14ae45c2b8 GDK: Handle ProjectDir with space
faa2e40406 gpu: Warn about Direct3D 12 texture alignment requirements.
2e45198299 Sync SDL3 wiki -> header
608f706a95 audio: Added SDL_SetAudioIterationCallbacks().
18a86ea6bb testaudio: Use SDL_SetAppMetadata at startup.
a9bee3c0bf pipewire: Use a more specific stream name than "Audio Stream".
2767c1a440 aaudio: We PlayDevice first and WaitDevice after; reduce semaphore count by 1.
7642c0468d Log information about Wayland environment detection
5b1e92ae88 cmake: use CMAKE_ANDROID_NDK variable as root of Android ndk
09b2aae47e cocoa: Popup menus always accept first click
29ef31d589 Sync SDL3 wiki -> header
15cb9bd610 Sync SDL3 wiki -> header
b28449a58c audio: Tweak SDL_GetAudioDeviceName.
da3c864d4c Reset the keyboard when entering a modal loop on Windows
a82f70dc21 use GetMessagePos instead of GetCursorPos
bfbeaca29f inline WIN_UpdateMouseCapture
de2c5c33b7 SDL_hidapi_steamdeck: report touch controller events
5cacdf2513 Fix crash in UIKit indirect pointer handling
32bbabe2a5 Add Padix Rockfire devices (#12884)
7e1d4f843c Emscripten: fix incorrect error check for WebGL context creation
fcdaff4110 Fixed compiler warning
dd625a6763 defer clipcursor refresh unto pump finish
c84c2aa2c4 pass ground-truth cursor pos to WIN_UpdateFocus
11a3296a42 x11: Handle size/position events arriving before state events
d50520462a Add and use SDL_HapticEffectID typedef
fb940fff80 audio: Fix warning C4701: potentially uninitialized local variable 'isstack' used
e8bd9cc150 audio: SDL_GetAudioDeviceName() doesn't need a full device lock.
3343cb2147 gpu: rework alpha-to-coverage validation
ceb9fecfc1 Joystick: Add trigger rumble resend
c81b62293a GPU D3D12 - Update to use typeless formats for depth buffer (#12701)
27b256022b SDL_GetRectIntersectionFloat(): Allow rendering zero-sized srcrect
d04b28926c GPU: Make D3D12 debug layers optional
695cad459b Corrected documentation for SDL_SetGPUSwapchainParameters()
2b16c961ea Add and use typedefs SDL_HapticEffectType and SDL_HapticDirectionType
a1332d77f6 wayland: Cleanup timestamp handling
b5ed0d0138 stb_image.h: apply mainstream PR/1736
e3181a0bcd Sync SDL3 wiki -> header
e3507b390e examples: added audio/05-planar-data
3905aa0587 audio: Added SDL_PutAudioStreamPlanarData.
483d1c36ed comments: Fixed a few typos I ran into in the audio code.
727a5fae59 Sync SDL3 wiki -> header
5a8be8e4c2 Fixed formatting
6e4ace310c GPU: Validate shader bytecode
89d7d406ab Added tests to cover invalid surface blits
fe849f1572 SDL_BlitSurfaceScaled(): Do not divide by zero
8017d38adc SDL_BlitSurfaceScaled(): Do not blit if surfaces have no pixel data
18fbe6a92f Renamed SDL_PROP_GPU_TEXTURE_CREATE_D3D12_CLEAR_STENCIL_UINT8 to SDL_PROP_GPU_TEXTURE_CREATE_D3D12_CLEAR_STENCIL_NUMBER
6a6917b0df Sync SDL3 wiki -> header
e70a49892b Add missing type suffix to SDL_PROP_WINDOW_OPENVR_OVERLAY_ID
a696b108ac SDL_BlitSurface() comment: Remove sentence about final blit rect being stored in srcrect and dstrect
c076b0d17f Removed incorrect documentation for SDL_RenderViewportSet()
47162a4168 x11: Send key events for dead keys consumed by the IME
3aed80cd82 Updated documentation for SDL_HINT_GPU_DRIVER
86b3369491 wayland: Check the origin of clipboard offers before forwarding them to the client
23a7a74133 Sync SDL3 wiki -> header
3be0ec5631 Sync SDL3 wiki -> header
5bd1578a45 wayland: Account for timer rollover when calculating the elapsed time for key repeats.
10f51da28d cocoa: Use CGFLOAT_MAX for unbounded max window dimensions
3519a59d8f The SDL_BUTTON_*MASK defines must come immediately after the SDL_MouseButtonFlags typedef to be associated
8e0b39f465 Sync SDL3 wiki -> header
9da46bc37f win32: Check internal data when positioning child windows

git-subtree-dir: external/SDL
git-subtree-split: 279dabfc96631965f8dad2e39d57daa4b9130d24
2025-06-26 22:23:47 +02:00

1462 lines
44 KiB
C

/*
Simple DirectMedia Layer
Copyright (C) 1997-2025 Sam Lantinga <slouken@libsdl.org>
This software is provided 'as-is', without any express or implied
warranty. In no event will the authors be held liable for any damages
arising from the use of this software.
Permission is granted to anyone to use this software for any purpose,
including commercial applications, and to alter it and redistribute it
freely, subject to the following restrictions:
1. The origin of this software must not be misrepresented; you must not
claim that you wrote the original software. If you use this software
in a product, an acknowledgment in the product documentation would be
appreciated but is not required.
2. Altered source versions must be plainly marked as such, and must not be
misrepresented as being the original software.
3. This notice may not be removed or altered from any source distribution.
*/
/**
* # CategoryHaptic
*
* The SDL haptic subsystem manages haptic (force feedback) devices.
*
* The basic usage is as follows:
*
* - Initialize the subsystem (SDL_INIT_HAPTIC).
* - Open a haptic device.
* - SDL_OpenHaptic() to open from index.
* - SDL_OpenHapticFromJoystick() to open from an existing joystick.
* - Create an effect (SDL_HapticEffect).
* - Upload the effect with SDL_CreateHapticEffect().
* - Run the effect with SDL_RunHapticEffect().
* - (optional) Free the effect with SDL_DestroyHapticEffect().
* - Close the haptic device with SDL_CloseHaptic().
*
* Simple rumble example:
*
* ```c
* SDL_Haptic *haptic = NULL;
*
* // Open the device
* SDL_HapticID *haptics = SDL_GetHaptics(NULL);
* if (haptics) {
* haptic = SDL_OpenHaptic(haptics[0]);
* SDL_free(haptics);
* }
* if (haptic == NULL)
* return;
*
* // Initialize simple rumble
* if (!SDL_InitHapticRumble(haptic))
* return;
*
* // Play effect at 50% strength for 2 seconds
* if (!SDL_PlayHapticRumble(haptic, 0.5, 2000))
* return;
* SDL_Delay(2000);
*
* // Clean up
* SDL_CloseHaptic(haptic);
* ```
*
* Complete example:
*
* ```c
* bool test_haptic(SDL_Joystick *joystick)
* {
* SDL_Haptic *haptic;
* SDL_HapticEffect effect;
* SDL_HapticEffectID effect_id;
*
* // Open the device
* haptic = SDL_OpenHapticFromJoystick(joystick);
* if (haptic == NULL) return false; // Most likely joystick isn't haptic
*
* // See if it can do sine waves
* if ((SDL_GetHapticFeatures(haptic) & SDL_HAPTIC_SINE)==0) {
* SDL_CloseHaptic(haptic); // No sine effect
* return false;
* }
*
* // Create the effect
* SDL_memset(&effect, 0, sizeof(SDL_HapticEffect)); // 0 is safe default
* effect.type = SDL_HAPTIC_SINE;
* effect.periodic.direction.type = SDL_HAPTIC_POLAR; // Polar coordinates
* effect.periodic.direction.dir[0] = 18000; // Force comes from south
* effect.periodic.period = 1000; // 1000 ms
* effect.periodic.magnitude = 20000; // 20000/32767 strength
* effect.periodic.length = 5000; // 5 seconds long
* effect.periodic.attack_length = 1000; // Takes 1 second to get max strength
* effect.periodic.fade_length = 1000; // Takes 1 second to fade away
*
* // Upload the effect
* effect_id = SDL_CreateHapticEffect(haptic, &effect);
*
* // Test the effect
* SDL_RunHapticEffect(haptic, effect_id, 1);
* SDL_Delay(5000); // Wait for the effect to finish
*
* // We destroy the effect, although closing the device also does this
* SDL_DestroyHapticEffect(haptic, effect_id);
*
* // Close the device
* SDL_CloseHaptic(haptic);
*
* return true; // Success
* }
* ```
*
* Note that the SDL haptic subsystem is not thread-safe.
*/
#ifndef SDL_haptic_h_
#define SDL_haptic_h_
#include <SDL3/SDL_stdinc.h>
#include <SDL3/SDL_error.h>
#include <SDL3/SDL_joystick.h>
#include <SDL3/SDL_begin_code.h>
/* Set up for C function definitions, even when using C++ */
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
/* FIXME:
*
* At the moment the magnitude variables are mixed between signed/unsigned, and
* it is also not made clear that ALL of those variables expect a max of 0x7FFF.
*
* Some platforms may have higher precision than that (Linux FF, Windows XInput)
* so we should fix the inconsistency in favor of higher possible precision,
* adjusting for platforms that use different scales.
* -flibit
*/
/**
* The haptic structure used to identify an SDL haptic.
*
* \since This struct is available since SDL 3.2.0.
*
* \sa SDL_OpenHaptic
* \sa SDL_OpenHapticFromJoystick
* \sa SDL_CloseHaptic
*/
typedef struct SDL_Haptic SDL_Haptic;
/*
* Misc defines.
*/
/**
* Used to play a device an infinite number of times.
*
* \since This macro is available since SDL 3.2.0.
*
* \sa SDL_RunHapticEffect
*/
#define SDL_HAPTIC_INFINITY 4294967295U
/**
* \name Haptic features
*
* Different haptic features a device can have.
*/
/* @{ */
/**
* \name Haptic effects
*/
/* @{ */
/**
* Type of haptic effect.
*/
typedef Uint16 SDL_HapticEffectType;
/**
* Constant effect supported.
*
* Constant haptic effect.
*
* \since This macro is available since SDL 3.2.0.
*
* \sa SDL_HapticCondition
*/
#define SDL_HAPTIC_CONSTANT (1u<<0)
/**
* Sine wave effect supported.
*
* Periodic haptic effect that simulates sine waves.
*
* \since This macro is available since SDL 3.2.0.
*
* \sa SDL_HapticPeriodic
*/
#define SDL_HAPTIC_SINE (1u<<1)
/**
* Square wave effect supported.
*
* Periodic haptic effect that simulates square waves.
*
* \since This macro is available since SDL 3.2.0.
*
* \sa SDL_HapticPeriodic
*/
#define SDL_HAPTIC_SQUARE (1u<<2)
/**
* Triangle wave effect supported.
*
* Periodic haptic effect that simulates triangular waves.
*
* \since This macro is available since SDL 3.2.0.
*
* \sa SDL_HapticPeriodic
*/
#define SDL_HAPTIC_TRIANGLE (1u<<3)
/**
* Sawtoothup wave effect supported.
*
* Periodic haptic effect that simulates saw tooth up waves.
*
* \since This macro is available since SDL 3.2.0.
*
* \sa SDL_HapticPeriodic
*/
#define SDL_HAPTIC_SAWTOOTHUP (1u<<4)
/**
* Sawtoothdown wave effect supported.
*
* Periodic haptic effect that simulates saw tooth down waves.
*
* \since This macro is available since SDL 3.2.0.
*
* \sa SDL_HapticPeriodic
*/
#define SDL_HAPTIC_SAWTOOTHDOWN (1u<<5)
/**
* Ramp effect supported.
*
* Ramp haptic effect.
*
* \since This macro is available since SDL 3.2.0.
*
* \sa SDL_HapticRamp
*/
#define SDL_HAPTIC_RAMP (1u<<6)
/**
* Spring effect supported - uses axes position.
*
* Condition haptic effect that simulates a spring. Effect is based on the
* axes position.
*
* \since This macro is available since SDL 3.2.0.
*
* \sa SDL_HapticCondition
*/
#define SDL_HAPTIC_SPRING (1u<<7)
/**
* Damper effect supported - uses axes velocity.
*
* Condition haptic effect that simulates dampening. Effect is based on the
* axes velocity.
*
* \since This macro is available since SDL 3.2.0.
*
* \sa SDL_HapticCondition
*/
#define SDL_HAPTIC_DAMPER (1u<<8)
/**
* Inertia effect supported - uses axes acceleration.
*
* Condition haptic effect that simulates inertia. Effect is based on the axes
* acceleration.
*
* \since This macro is available since SDL 3.2.0.
*
* \sa SDL_HapticCondition
*/
#define SDL_HAPTIC_INERTIA (1u<<9)
/**
* Friction effect supported - uses axes movement.
*
* Condition haptic effect that simulates friction. Effect is based on the
* axes movement.
*
* \since This macro is available since SDL 3.2.0.
*
* \sa SDL_HapticCondition
*/
#define SDL_HAPTIC_FRICTION (1u<<10)
/**
* Left/Right effect supported.
*
* Haptic effect for direct control over high/low frequency motors.
*
* \since This macro is available since SDL 3.2.0.
*
* \sa SDL_HapticLeftRight
*/
#define SDL_HAPTIC_LEFTRIGHT (1u<<11)
/**
* Reserved for future use.
*
* \since This macro is available since SDL 3.2.0.
*/
#define SDL_HAPTIC_RESERVED1 (1u<<12)
/**
* Reserved for future use.
*
* \since This macro is available since SDL 3.2.0.
*/
#define SDL_HAPTIC_RESERVED2 (1u<<13)
/**
* Reserved for future use.
*
* \since This macro is available since SDL 3.2.0.
*/
#define SDL_HAPTIC_RESERVED3 (1u<<14)
/**
* Custom effect is supported.
*
* User defined custom haptic effect.
*
* \since This macro is available since SDL 3.2.0.
*/
#define SDL_HAPTIC_CUSTOM (1u<<15)
/* @} *//* Haptic effects */
/* These last few are features the device has, not effects */
/**
* Device can set global gain.
*
* Device supports setting the global gain.
*
* \since This macro is available since SDL 3.2.0.
*
* \sa SDL_SetHapticGain
*/
#define SDL_HAPTIC_GAIN (1u<<16)
/**
* Device can set autocenter.
*
* Device supports setting autocenter.
*
* \since This macro is available since SDL 3.2.0.
*
* \sa SDL_SetHapticAutocenter
*/
#define SDL_HAPTIC_AUTOCENTER (1u<<17)
/**
* Device can be queried for effect status.
*
* Device supports querying effect status.
*
* \since This macro is available since SDL 3.2.0.
*
* \sa SDL_GetHapticEffectStatus
*/
#define SDL_HAPTIC_STATUS (1u<<18)
/**
* Device can be paused.
*
* Devices supports being paused.
*
* \since This macro is available since SDL 3.2.0.
*
* \sa SDL_PauseHaptic
* \sa SDL_ResumeHaptic
*/
#define SDL_HAPTIC_PAUSE (1u<<19)
/**
* \name Direction encodings
*/
/* @{ */
/**
* Type of coordinates used for haptic direction.
*/
typedef Uint8 SDL_HapticDirectionType;
/**
* Uses polar coordinates for the direction.
*
* \since This macro is available since SDL 3.2.0.
*
* \sa SDL_HapticDirection
*/
#define SDL_HAPTIC_POLAR 0
/**
* Uses cartesian coordinates for the direction.
*
* \since This macro is available since SDL 3.2.0.
*
* \sa SDL_HapticDirection
*/
#define SDL_HAPTIC_CARTESIAN 1
/**
* Uses spherical coordinates for the direction.
*
* \since This macro is available since SDL 3.2.0.
*
* \sa SDL_HapticDirection
*/
#define SDL_HAPTIC_SPHERICAL 2
/**
* Use this value to play an effect on the steering wheel axis.
*
* This provides better compatibility across platforms and devices as SDL will
* guess the correct axis.
*
* \since This macro is available since SDL 3.2.0.
*
* \sa SDL_HapticDirection
*/
#define SDL_HAPTIC_STEERING_AXIS 3
/* @} *//* Direction encodings */
/* @} *//* Haptic features */
/**
* ID for haptic effects.
*
* This is -1 if the ID is invalid.
*
* \sa SDL_CreateHapticEffect
*/
typedef int SDL_HapticEffectID;
/**
* Structure that represents a haptic direction.
*
* This is the direction where the force comes from, instead of the direction
* in which the force is exerted.
*
* Directions can be specified by:
*
* - SDL_HAPTIC_POLAR : Specified by polar coordinates.
* - SDL_HAPTIC_CARTESIAN : Specified by cartesian coordinates.
* - SDL_HAPTIC_SPHERICAL : Specified by spherical coordinates.
*
* Cardinal directions of the haptic device are relative to the positioning of
* the device. North is considered to be away from the user.
*
* The following diagram represents the cardinal directions:
*
* ```
* .--.
* |__| .-------.
* |=.| |.-----.|
* |--| || ||
* | | |'-----'|
* |__|~')_____('
* [ COMPUTER ]
*
*
* North (0,-1)
* ^
* |
* |
* (-1,0) West <----[ HAPTIC ]----> East (1,0)
* |
* |
* v
* South (0,1)
*
*
* [ USER ]
* \|||/
* (o o)
* ---ooO-(_)-Ooo---
* ```
*
* If type is SDL_HAPTIC_POLAR, direction is encoded by hundredths of a degree
* starting north and turning clockwise. SDL_HAPTIC_POLAR only uses the first
* `dir` parameter. The cardinal directions would be:
*
* - North: 0 (0 degrees)
* - East: 9000 (90 degrees)
* - South: 18000 (180 degrees)
* - West: 27000 (270 degrees)
*
* If type is SDL_HAPTIC_CARTESIAN, direction is encoded by three positions (X
* axis, Y axis and Z axis (with 3 axes)). SDL_HAPTIC_CARTESIAN uses the first
* three `dir` parameters. The cardinal directions would be:
*
* - North: 0,-1, 0
* - East: 1, 0, 0
* - South: 0, 1, 0
* - West: -1, 0, 0
*
* The Z axis represents the height of the effect if supported, otherwise it's
* unused. In cartesian encoding (1, 2) would be the same as (2, 4), you can
* use any multiple you want, only the direction matters.
*
* If type is SDL_HAPTIC_SPHERICAL, direction is encoded by two rotations. The
* first two `dir` parameters are used. The `dir` parameters are as follows
* (all values are in hundredths of degrees):
*
* - Degrees from (1, 0) rotated towards (0, 1).
* - Degrees towards (0, 0, 1) (device needs at least 3 axes).
*
* Example of force coming from the south with all encodings (force coming
* from the south means the user will have to pull the stick to counteract):
*
* ```c
* SDL_HapticDirection direction;
*
* // Cartesian directions
* direction.type = SDL_HAPTIC_CARTESIAN; // Using cartesian direction encoding.
* direction.dir[0] = 0; // X position
* direction.dir[1] = 1; // Y position
* // Assuming the device has 2 axes, we don't need to specify third parameter.
*
* // Polar directions
* direction.type = SDL_HAPTIC_POLAR; // We'll be using polar direction encoding.
* direction.dir[0] = 18000; // Polar only uses first parameter
*
* // Spherical coordinates
* direction.type = SDL_HAPTIC_SPHERICAL; // Spherical encoding
* direction.dir[0] = 9000; // Since we only have two axes we don't need more parameters.
* ```
*
* \since This struct is available since SDL 3.2.0.
*
* \sa SDL_HAPTIC_POLAR
* \sa SDL_HAPTIC_CARTESIAN
* \sa SDL_HAPTIC_SPHERICAL
* \sa SDL_HAPTIC_STEERING_AXIS
* \sa SDL_HapticEffect
* \sa SDL_GetNumHapticAxes
*/
typedef struct SDL_HapticDirection
{
SDL_HapticDirectionType type; /**< The type of encoding. */
Sint32 dir[3]; /**< The encoded direction. */
} SDL_HapticDirection;
/**
* A structure containing a template for a Constant effect.
*
* This struct is exclusively for the SDL_HAPTIC_CONSTANT effect.
*
* A constant effect applies a constant force in the specified direction to
* the joystick.
*
* \since This struct is available since SDL 3.2.0.
*
* \sa SDL_HAPTIC_CONSTANT
* \sa SDL_HapticEffect
*/
typedef struct SDL_HapticConstant
{
/* Header */
SDL_HapticEffectType type; /**< SDL_HAPTIC_CONSTANT */
SDL_HapticDirection direction; /**< Direction of the effect. */
/* Replay */
Uint32 length; /**< Duration of the effect. */
Uint16 delay; /**< Delay before starting the effect. */
/* Trigger */
Uint16 button; /**< Button that triggers the effect. */
Uint16 interval; /**< How soon it can be triggered again after button. */
/* Constant */
Sint16 level; /**< Strength of the constant effect. */
/* Envelope */
Uint16 attack_length; /**< Duration of the attack. */
Uint16 attack_level; /**< Level at the start of the attack. */
Uint16 fade_length; /**< Duration of the fade. */
Uint16 fade_level; /**< Level at the end of the fade. */
} SDL_HapticConstant;
/**
* A structure containing a template for a Periodic effect.
*
* The struct handles the following effects:
*
* - SDL_HAPTIC_SINE
* - SDL_HAPTIC_SQUARE
* - SDL_HAPTIC_TRIANGLE
* - SDL_HAPTIC_SAWTOOTHUP
* - SDL_HAPTIC_SAWTOOTHDOWN
*
* A periodic effect consists in a wave-shaped effect that repeats itself over
* time. The type determines the shape of the wave and the parameters
* determine the dimensions of the wave.
*
* Phase is given by hundredth of a degree meaning that giving the phase a
* value of 9000 will displace it 25% of its period. Here are sample values:
*
* - 0: No phase displacement.
* - 9000: Displaced 25% of its period.
* - 18000: Displaced 50% of its period.
* - 27000: Displaced 75% of its period.
* - 36000: Displaced 100% of its period, same as 0, but 0 is preferred.
*
* Examples:
*
* ```
* SDL_HAPTIC_SINE
* __ __ __ __
* / \ / \ / \ /
* / \__/ \__/ \__/
*
* SDL_HAPTIC_SQUARE
* __ __ __ __ __
* | | | | | | | | | |
* | |__| |__| |__| |__| |
*
* SDL_HAPTIC_TRIANGLE
* /\ /\ /\ /\ /\
* / \ / \ / \ / \ /
* / \/ \/ \/ \/
*
* SDL_HAPTIC_SAWTOOTHUP
* /| /| /| /| /| /| /|
* / | / | / | / | / | / | / |
* / |/ |/ |/ |/ |/ |/ |
*
* SDL_HAPTIC_SAWTOOTHDOWN
* \ |\ |\ |\ |\ |\ |\ |
* \ | \ | \ | \ | \ | \ | \ |
* \| \| \| \| \| \| \|
* ```
*
* \since This struct is available since SDL 3.2.0.
*
* \sa SDL_HAPTIC_SINE
* \sa SDL_HAPTIC_SQUARE
* \sa SDL_HAPTIC_TRIANGLE
* \sa SDL_HAPTIC_SAWTOOTHUP
* \sa SDL_HAPTIC_SAWTOOTHDOWN
* \sa SDL_HapticEffect
*/
typedef struct SDL_HapticPeriodic
{
/* Header */
SDL_HapticEffectType type; /**< SDL_HAPTIC_SINE, SDL_HAPTIC_SQUARE
SDL_HAPTIC_TRIANGLE, SDL_HAPTIC_SAWTOOTHUP or
SDL_HAPTIC_SAWTOOTHDOWN */
SDL_HapticDirection direction; /**< Direction of the effect. */
/* Replay */
Uint32 length; /**< Duration of the effect. */
Uint16 delay; /**< Delay before starting the effect. */
/* Trigger */
Uint16 button; /**< Button that triggers the effect. */
Uint16 interval; /**< How soon it can be triggered again after button. */
/* Periodic */
Uint16 period; /**< Period of the wave. */
Sint16 magnitude; /**< Peak value; if negative, equivalent to 180 degrees extra phase shift. */
Sint16 offset; /**< Mean value of the wave. */
Uint16 phase; /**< Positive phase shift given by hundredth of a degree. */
/* Envelope */
Uint16 attack_length; /**< Duration of the attack. */
Uint16 attack_level; /**< Level at the start of the attack. */
Uint16 fade_length; /**< Duration of the fade. */
Uint16 fade_level; /**< Level at the end of the fade. */
} SDL_HapticPeriodic;
/**
* A structure containing a template for a Condition effect.
*
* The struct handles the following effects:
*
* - SDL_HAPTIC_SPRING: Effect based on axes position.
* - SDL_HAPTIC_DAMPER: Effect based on axes velocity.
* - SDL_HAPTIC_INERTIA: Effect based on axes acceleration.
* - SDL_HAPTIC_FRICTION: Effect based on axes movement.
*
* Direction is handled by condition internals instead of a direction member.
* The condition effect specific members have three parameters. The first
* refers to the X axis, the second refers to the Y axis and the third refers
* to the Z axis. The right terms refer to the positive side of the axis and
* the left terms refer to the negative side of the axis. Please refer to the
* SDL_HapticDirection diagram for which side is positive and which is
* negative.
*
* \since This struct is available since SDL 3.2.0.
*
* \sa SDL_HapticDirection
* \sa SDL_HAPTIC_SPRING
* \sa SDL_HAPTIC_DAMPER
* \sa SDL_HAPTIC_INERTIA
* \sa SDL_HAPTIC_FRICTION
* \sa SDL_HapticEffect
*/
typedef struct SDL_HapticCondition
{
/* Header */
SDL_HapticEffectType type; /**< SDL_HAPTIC_SPRING, SDL_HAPTIC_DAMPER,
SDL_HAPTIC_INERTIA or SDL_HAPTIC_FRICTION */
SDL_HapticDirection direction; /**< Direction of the effect. */
/* Replay */
Uint32 length; /**< Duration of the effect. */
Uint16 delay; /**< Delay before starting the effect. */
/* Trigger */
Uint16 button; /**< Button that triggers the effect. */
Uint16 interval; /**< How soon it can be triggered again after button. */
/* Condition */
Uint16 right_sat[3]; /**< Level when joystick is to the positive side; max 0xFFFF. */
Uint16 left_sat[3]; /**< Level when joystick is to the negative side; max 0xFFFF. */
Sint16 right_coeff[3]; /**< How fast to increase the force towards the positive side. */
Sint16 left_coeff[3]; /**< How fast to increase the force towards the negative side. */
Uint16 deadband[3]; /**< Size of the dead zone; max 0xFFFF: whole axis-range when 0-centered. */
Sint16 center[3]; /**< Position of the dead zone. */
} SDL_HapticCondition;
/**
* A structure containing a template for a Ramp effect.
*
* This struct is exclusively for the SDL_HAPTIC_RAMP effect.
*
* The ramp effect starts at start strength and ends at end strength. It
* augments in linear fashion. If you use attack and fade with a ramp the
* effects get added to the ramp effect making the effect become quadratic
* instead of linear.
*
* \since This struct is available since SDL 3.2.0.
*
* \sa SDL_HAPTIC_RAMP
* \sa SDL_HapticEffect
*/
typedef struct SDL_HapticRamp
{
/* Header */
SDL_HapticEffectType type; /**< SDL_HAPTIC_RAMP */
SDL_HapticDirection direction; /**< Direction of the effect. */
/* Replay */
Uint32 length; /**< Duration of the effect. */
Uint16 delay; /**< Delay before starting the effect. */
/* Trigger */
Uint16 button; /**< Button that triggers the effect. */
Uint16 interval; /**< How soon it can be triggered again after button. */
/* Ramp */
Sint16 start; /**< Beginning strength level. */
Sint16 end; /**< Ending strength level. */
/* Envelope */
Uint16 attack_length; /**< Duration of the attack. */
Uint16 attack_level; /**< Level at the start of the attack. */
Uint16 fade_length; /**< Duration of the fade. */
Uint16 fade_level; /**< Level at the end of the fade. */
} SDL_HapticRamp;
/**
* A structure containing a template for a Left/Right effect.
*
* This struct is exclusively for the SDL_HAPTIC_LEFTRIGHT effect.
*
* The Left/Right effect is used to explicitly control the large and small
* motors, commonly found in modern game controllers. The small (right) motor
* is high frequency, and the large (left) motor is low frequency.
*
* \since This struct is available since SDL 3.2.0.
*
* \sa SDL_HAPTIC_LEFTRIGHT
* \sa SDL_HapticEffect
*/
typedef struct SDL_HapticLeftRight
{
/* Header */
SDL_HapticEffectType type; /**< SDL_HAPTIC_LEFTRIGHT */
/* Replay */
Uint32 length; /**< Duration of the effect in milliseconds. */
/* Rumble */
Uint16 large_magnitude; /**< Control of the large controller motor. */
Uint16 small_magnitude; /**< Control of the small controller motor. */
} SDL_HapticLeftRight;
/**
* A structure containing a template for the SDL_HAPTIC_CUSTOM effect.
*
* This struct is exclusively for the SDL_HAPTIC_CUSTOM effect.
*
* A custom force feedback effect is much like a periodic effect, where the
* application can define its exact shape. You will have to allocate the data
* yourself. Data should consist of channels * samples Uint16 samples.
*
* If channels is one, the effect is rotated using the defined direction.
* Otherwise it uses the samples in data for the different axes.
*
* \since This struct is available since SDL 3.2.0.
*
* \sa SDL_HAPTIC_CUSTOM
* \sa SDL_HapticEffect
*/
typedef struct SDL_HapticCustom
{
/* Header */
SDL_HapticEffectType type; /**< SDL_HAPTIC_CUSTOM */
SDL_HapticDirection direction; /**< Direction of the effect. */
/* Replay */
Uint32 length; /**< Duration of the effect. */
Uint16 delay; /**< Delay before starting the effect. */
/* Trigger */
Uint16 button; /**< Button that triggers the effect. */
Uint16 interval; /**< How soon it can be triggered again after button. */
/* Custom */
Uint8 channels; /**< Axes to use, minimum of one. */
Uint16 period; /**< Sample periods. */
Uint16 samples; /**< Amount of samples. */
Uint16 *data; /**< Should contain channels*samples items. */
/* Envelope */
Uint16 attack_length; /**< Duration of the attack. */
Uint16 attack_level; /**< Level at the start of the attack. */
Uint16 fade_length; /**< Duration of the fade. */
Uint16 fade_level; /**< Level at the end of the fade. */
} SDL_HapticCustom;
/**
* The generic template for any haptic effect.
*
* All values max at 32767 (0x7FFF). Signed values also can be negative. Time
* values unless specified otherwise are in milliseconds.
*
* You can also pass SDL_HAPTIC_INFINITY to length instead of a 0-32767 value.
* Neither delay, interval, attack_length nor fade_length support
* SDL_HAPTIC_INFINITY. Fade will also not be used since effect never ends.
*
* Additionally, the SDL_HAPTIC_RAMP effect does not support a duration of
* SDL_HAPTIC_INFINITY.
*
* Button triggers may not be supported on all devices, it is advised to not
* use them if possible. Buttons start at index 1 instead of index 0 like the
* joystick.
*
* If both attack_length and fade_level are 0, the envelope is not used,
* otherwise both values are used.
*
* Common parts:
*
* ```c
* // Replay - All effects have this
* Uint32 length; // Duration of effect (ms).
* Uint16 delay; // Delay before starting effect.
*
* // Trigger - All effects have this
* Uint16 button; // Button that triggers effect.
* Uint16 interval; // How soon before effect can be triggered again.
*
* // Envelope - All effects except condition effects have this
* Uint16 attack_length; // Duration of the attack (ms).
* Uint16 attack_level; // Level at the start of the attack.
* Uint16 fade_length; // Duration of the fade out (ms).
* Uint16 fade_level; // Level at the end of the fade.
* ```
*
* Here we have an example of a constant effect evolution in time:
*
* ```
* Strength
* ^
* |
* | effect level --> _________________
* | / \
* | / \
* | / \
* | / \
* | attack_level --> | \
* | | | <--- fade_level
* |
* +--------------------------------------------------> Time
* [--] [---]
* attack_length fade_length
*
* [------------------][-----------------------]
* delay length
* ```
*
* Note either the attack_level or the fade_level may be above the actual
* effect level.
*
* \since This struct is available since SDL 3.2.0.
*
* \sa SDL_HapticConstant
* \sa SDL_HapticPeriodic
* \sa SDL_HapticCondition
* \sa SDL_HapticRamp
* \sa SDL_HapticLeftRight
* \sa SDL_HapticCustom
*/
typedef union SDL_HapticEffect
{
/* Common for all force feedback effects */
SDL_HapticEffectType type; /**< Effect type. */
SDL_HapticConstant constant; /**< Constant effect. */
SDL_HapticPeriodic periodic; /**< Periodic effect. */
SDL_HapticCondition condition; /**< Condition effect. */
SDL_HapticRamp ramp; /**< Ramp effect. */
SDL_HapticLeftRight leftright; /**< Left/Right effect. */
SDL_HapticCustom custom; /**< Custom effect. */
} SDL_HapticEffect;
/**
* This is a unique ID for a haptic device for the time it is connected to the
* system, and is never reused for the lifetime of the application.
*
* If the haptic device is disconnected and reconnected, it will get a new ID.
*
* The value 0 is an invalid ID.
*
* \since This datatype is available since SDL 3.2.0.
*/
typedef Uint32 SDL_HapticID;
/* Function prototypes */
/**
* Get a list of currently connected haptic devices.
*
* \param count a pointer filled in with the number of haptic devices
* returned, may be NULL.
* \returns a 0 terminated array of haptic device instance IDs or NULL on
* failure; call SDL_GetError() for more information. This should be
* freed with SDL_free() when it is no longer needed.
*
* \since This function is available since SDL 3.2.0.
*
* \sa SDL_OpenHaptic
*/
extern SDL_DECLSPEC SDL_HapticID * SDLCALL SDL_GetHaptics(int *count);
/**
* Get the implementation dependent name of a haptic device.
*
* This can be called before any haptic devices are opened.
*
* \param instance_id the haptic device instance ID.
* \returns the name of the selected haptic device. If no name can be found,
* this function returns NULL; call SDL_GetError() for more
* information.
*
* \since This function is available since SDL 3.2.0.
*
* \sa SDL_GetHapticName
* \sa SDL_OpenHaptic
*/
extern SDL_DECLSPEC const char * SDLCALL SDL_GetHapticNameForID(SDL_HapticID instance_id);
/**
* Open a haptic device for use.
*
* The index passed as an argument refers to the N'th haptic device on this
* system.
*
* When opening a haptic device, its gain will be set to maximum and
* autocenter will be disabled. To modify these values use SDL_SetHapticGain()
* and SDL_SetHapticAutocenter().
*
* \param instance_id the haptic device instance ID.
* \returns the device identifier or NULL on failure; call SDL_GetError() for
* more information.
*
* \since This function is available since SDL 3.2.0.
*
* \sa SDL_CloseHaptic
* \sa SDL_GetHaptics
* \sa SDL_OpenHapticFromJoystick
* \sa SDL_OpenHapticFromMouse
* \sa SDL_SetHapticAutocenter
* \sa SDL_SetHapticGain
*/
extern SDL_DECLSPEC SDL_Haptic * SDLCALL SDL_OpenHaptic(SDL_HapticID instance_id);
/**
* Get the SDL_Haptic associated with an instance ID, if it has been opened.
*
* \param instance_id the instance ID to get the SDL_Haptic for.
* \returns an SDL_Haptic on success or NULL on failure or if it hasn't been
* opened yet; call SDL_GetError() for more information.
*
* \since This function is available since SDL 3.2.0.
*/
extern SDL_DECLSPEC SDL_Haptic * SDLCALL SDL_GetHapticFromID(SDL_HapticID instance_id);
/**
* Get the instance ID of an opened haptic device.
*
* \param haptic the SDL_Haptic device to query.
* \returns the instance ID of the specified haptic device on success or 0 on
* failure; call SDL_GetError() for more information.
*
* \since This function is available since SDL 3.2.0.
*/
extern SDL_DECLSPEC SDL_HapticID SDLCALL SDL_GetHapticID(SDL_Haptic *haptic);
/**
* Get the implementation dependent name of a haptic device.
*
* \param haptic the SDL_Haptic obtained from SDL_OpenJoystick().
* \returns the name of the selected haptic device. If no name can be found,
* this function returns NULL; call SDL_GetError() for more
* information.
*
* \since This function is available since SDL 3.2.0.
*
* \sa SDL_GetHapticNameForID
*/
extern SDL_DECLSPEC const char * SDLCALL SDL_GetHapticName(SDL_Haptic *haptic);
/**
* Query whether or not the current mouse has haptic capabilities.
*
* \returns true if the mouse is haptic or false if it isn't.
*
* \since This function is available since SDL 3.2.0.
*
* \sa SDL_OpenHapticFromMouse
*/
extern SDL_DECLSPEC bool SDLCALL SDL_IsMouseHaptic(void);
/**
* Try to open a haptic device from the current mouse.
*
* \returns the haptic device identifier or NULL on failure; call
* SDL_GetError() for more information.
*
* \since This function is available since SDL 3.2.0.
*
* \sa SDL_CloseHaptic
* \sa SDL_IsMouseHaptic
*/
extern SDL_DECLSPEC SDL_Haptic * SDLCALL SDL_OpenHapticFromMouse(void);
/**
* Query if a joystick has haptic features.
*
* \param joystick the SDL_Joystick to test for haptic capabilities.
* \returns true if the joystick is haptic or false if it isn't.
*
* \since This function is available since SDL 3.2.0.
*
* \sa SDL_OpenHapticFromJoystick
*/
extern SDL_DECLSPEC bool SDLCALL SDL_IsJoystickHaptic(SDL_Joystick *joystick);
/**
* Open a haptic device for use from a joystick device.
*
* You must still close the haptic device separately. It will not be closed
* with the joystick.
*
* When opened from a joystick you should first close the haptic device before
* closing the joystick device. If not, on some implementations the haptic
* device will also get unallocated and you'll be unable to use force feedback
* on that device.
*
* \param joystick the SDL_Joystick to create a haptic device from.
* \returns a valid haptic device identifier on success or NULL on failure;
* call SDL_GetError() for more information.
*
* \since This function is available since SDL 3.2.0.
*
* \sa SDL_CloseHaptic
* \sa SDL_IsJoystickHaptic
*/
extern SDL_DECLSPEC SDL_Haptic * SDLCALL SDL_OpenHapticFromJoystick(SDL_Joystick *joystick);
/**
* Close a haptic device previously opened with SDL_OpenHaptic().
*
* \param haptic the SDL_Haptic device to close.
*
* \since This function is available since SDL 3.2.0.
*
* \sa SDL_OpenHaptic
*/
extern SDL_DECLSPEC void SDLCALL SDL_CloseHaptic(SDL_Haptic *haptic);
/**
* Get the number of effects a haptic device can store.
*
* On some platforms this isn't fully supported, and therefore is an
* approximation. Always check to see if your created effect was actually
* created and do not rely solely on SDL_GetMaxHapticEffects().
*
* \param haptic the SDL_Haptic device to query.
* \returns the number of effects the haptic device can store or a negative
* error code on failure; call SDL_GetError() for more information.
*
* \since This function is available since SDL 3.2.0.
*
* \sa SDL_GetMaxHapticEffectsPlaying
* \sa SDL_GetHapticFeatures
*/
extern SDL_DECLSPEC int SDLCALL SDL_GetMaxHapticEffects(SDL_Haptic *haptic);
/**
* Get the number of effects a haptic device can play at the same time.
*
* This is not supported on all platforms, but will always return a value.
*
* \param haptic the SDL_Haptic device to query maximum playing effects.
* \returns the number of effects the haptic device can play at the same time
* or -1 on failure; call SDL_GetError() for more information.
*
* \since This function is available since SDL 3.2.0.
*
* \sa SDL_GetMaxHapticEffects
* \sa SDL_GetHapticFeatures
*/
extern SDL_DECLSPEC int SDLCALL SDL_GetMaxHapticEffectsPlaying(SDL_Haptic *haptic);
/**
* Get the haptic device's supported features in bitwise manner.
*
* \param haptic the SDL_Haptic device to query.
* \returns a list of supported haptic features in bitwise manner (OR'd), or 0
* on failure; call SDL_GetError() for more information.
*
* \since This function is available since SDL 3.2.0.
*
* \sa SDL_HapticEffectSupported
* \sa SDL_GetMaxHapticEffects
*/
extern SDL_DECLSPEC Uint32 SDLCALL SDL_GetHapticFeatures(SDL_Haptic *haptic);
/**
* Get the number of haptic axes the device has.
*
* The number of haptic axes might be useful if working with the
* SDL_HapticDirection effect.
*
* \param haptic the SDL_Haptic device to query.
* \returns the number of axes on success or -1 on failure; call
* SDL_GetError() for more information.
*
* \since This function is available since SDL 3.2.0.
*/
extern SDL_DECLSPEC int SDLCALL SDL_GetNumHapticAxes(SDL_Haptic *haptic);
/**
* Check to see if an effect is supported by a haptic device.
*
* \param haptic the SDL_Haptic device to query.
* \param effect the desired effect to query.
* \returns true if the effect is supported or false if it isn't.
*
* \since This function is available since SDL 3.2.0.
*
* \sa SDL_CreateHapticEffect
* \sa SDL_GetHapticFeatures
*/
extern SDL_DECLSPEC bool SDLCALL SDL_HapticEffectSupported(SDL_Haptic *haptic, const SDL_HapticEffect *effect);
/**
* Create a new haptic effect on a specified device.
*
* \param haptic an SDL_Haptic device to create the effect on.
* \param effect an SDL_HapticEffect structure containing the properties of
* the effect to create.
* \returns the ID of the effect on success or -1 on failure; call
* SDL_GetError() for more information.
*
* \since This function is available since SDL 3.2.0.
*
* \sa SDL_DestroyHapticEffect
* \sa SDL_RunHapticEffect
* \sa SDL_UpdateHapticEffect
*/
extern SDL_DECLSPEC SDL_HapticEffectID SDLCALL SDL_CreateHapticEffect(SDL_Haptic *haptic, const SDL_HapticEffect *effect);
/**
* Update the properties of an effect.
*
* Can be used dynamically, although behavior when dynamically changing
* direction may be strange. Specifically the effect may re-upload itself and
* start playing from the start. You also cannot change the type either when
* running SDL_UpdateHapticEffect().
*
* \param haptic the SDL_Haptic device that has the effect.
* \param effect the identifier of the effect to update.
* \param data an SDL_HapticEffect structure containing the new effect
* properties to use.
* \returns true on success or false on failure; call SDL_GetError() for more
* information.
*
* \since This function is available since SDL 3.2.0.
*
* \sa SDL_CreateHapticEffect
* \sa SDL_RunHapticEffect
*/
extern SDL_DECLSPEC bool SDLCALL SDL_UpdateHapticEffect(SDL_Haptic *haptic, SDL_HapticEffectID effect, const SDL_HapticEffect *data);
/**
* Run the haptic effect on its associated haptic device.
*
* To repeat the effect over and over indefinitely, set `iterations` to
* `SDL_HAPTIC_INFINITY`. (Repeats the envelope - attack and fade.) To make
* one instance of the effect last indefinitely (so the effect does not fade),
* set the effect's `length` in its structure/union to `SDL_HAPTIC_INFINITY`
* instead.
*
* \param haptic the SDL_Haptic device to run the effect on.
* \param effect the ID of the haptic effect to run.
* \param iterations the number of iterations to run the effect; use
* `SDL_HAPTIC_INFINITY` to repeat forever.
* \returns true on success or false on failure; call SDL_GetError() for more
* information.
*
* \since This function is available since SDL 3.2.0.
*
* \sa SDL_GetHapticEffectStatus
* \sa SDL_StopHapticEffect
* \sa SDL_StopHapticEffects
*/
extern SDL_DECLSPEC bool SDLCALL SDL_RunHapticEffect(SDL_Haptic *haptic, SDL_HapticEffectID effect, Uint32 iterations);
/**
* Stop the haptic effect on its associated haptic device.
*
* \param haptic the SDL_Haptic device to stop the effect on.
* \param effect the ID of the haptic effect to stop.
* \returns true on success or false on failure; call SDL_GetError() for more
* information.
*
* \since This function is available since SDL 3.2.0.
*
* \sa SDL_RunHapticEffect
* \sa SDL_StopHapticEffects
*/
extern SDL_DECLSPEC bool SDLCALL SDL_StopHapticEffect(SDL_Haptic *haptic, SDL_HapticEffectID effect);
/**
* Destroy a haptic effect on the device.
*
* This will stop the effect if it's running. Effects are automatically
* destroyed when the device is closed.
*
* \param haptic the SDL_Haptic device to destroy the effect on.
* \param effect the ID of the haptic effect to destroy.
*
* \since This function is available since SDL 3.2.0.
*
* \sa SDL_CreateHapticEffect
*/
extern SDL_DECLSPEC void SDLCALL SDL_DestroyHapticEffect(SDL_Haptic *haptic, SDL_HapticEffectID effect);
/**
* Get the status of the current effect on the specified haptic device.
*
* Device must support the SDL_HAPTIC_STATUS feature.
*
* \param haptic the SDL_Haptic device to query for the effect status on.
* \param effect the ID of the haptic effect to query its status.
* \returns true if it is playing, false if it isn't playing or haptic status
* isn't supported.
*
* \since This function is available since SDL 3.2.0.
*
* \sa SDL_GetHapticFeatures
*/
extern SDL_DECLSPEC bool SDLCALL SDL_GetHapticEffectStatus(SDL_Haptic *haptic, SDL_HapticEffectID effect);
/**
* Set the global gain of the specified haptic device.
*
* Device must support the SDL_HAPTIC_GAIN feature.
*
* The user may specify the maximum gain by setting the environment variable
* `SDL_HAPTIC_GAIN_MAX` which should be between 0 and 100. All calls to
* SDL_SetHapticGain() will scale linearly using `SDL_HAPTIC_GAIN_MAX` as the
* maximum.
*
* \param haptic the SDL_Haptic device to set the gain on.
* \param gain value to set the gain to, should be between 0 and 100 (0 -
* 100).
* \returns true on success or false on failure; call SDL_GetError() for more
* information.
*
* \since This function is available since SDL 3.2.0.
*
* \sa SDL_GetHapticFeatures
*/
extern SDL_DECLSPEC bool SDLCALL SDL_SetHapticGain(SDL_Haptic *haptic, int gain);
/**
* Set the global autocenter of the device.
*
* Autocenter should be between 0 and 100. Setting it to 0 will disable
* autocentering.
*
* Device must support the SDL_HAPTIC_AUTOCENTER feature.
*
* \param haptic the SDL_Haptic device to set autocentering on.
* \param autocenter value to set autocenter to (0-100).
* \returns true on success or false on failure; call SDL_GetError() for more
* information.
*
* \since This function is available since SDL 3.2.0.
*
* \sa SDL_GetHapticFeatures
*/
extern SDL_DECLSPEC bool SDLCALL SDL_SetHapticAutocenter(SDL_Haptic *haptic, int autocenter);
/**
* Pause a haptic device.
*
* Device must support the `SDL_HAPTIC_PAUSE` feature. Call SDL_ResumeHaptic()
* to resume playback.
*
* Do not modify the effects nor add new ones while the device is paused. That
* can cause all sorts of weird errors.
*
* \param haptic the SDL_Haptic device to pause.
* \returns true on success or false on failure; call SDL_GetError() for more
* information.
*
* \since This function is available since SDL 3.2.0.
*
* \sa SDL_ResumeHaptic
*/
extern SDL_DECLSPEC bool SDLCALL SDL_PauseHaptic(SDL_Haptic *haptic);
/**
* Resume a haptic device.
*
* Call to unpause after SDL_PauseHaptic().
*
* \param haptic the SDL_Haptic device to unpause.
* \returns true on success or false on failure; call SDL_GetError() for more
* information.
*
* \since This function is available since SDL 3.2.0.
*
* \sa SDL_PauseHaptic
*/
extern SDL_DECLSPEC bool SDLCALL SDL_ResumeHaptic(SDL_Haptic *haptic);
/**
* Stop all the currently playing effects on a haptic device.
*
* \param haptic the SDL_Haptic device to stop.
* \returns true on success or false on failure; call SDL_GetError() for more
* information.
*
* \since This function is available since SDL 3.2.0.
*
* \sa SDL_RunHapticEffect
* \sa SDL_StopHapticEffects
*/
extern SDL_DECLSPEC bool SDLCALL SDL_StopHapticEffects(SDL_Haptic *haptic);
/**
* Check whether rumble is supported on a haptic device.
*
* \param haptic haptic device to check for rumble support.
* \returns true if the effect is supported or false if it isn't.
*
* \since This function is available since SDL 3.2.0.
*
* \sa SDL_InitHapticRumble
*/
extern SDL_DECLSPEC bool SDLCALL SDL_HapticRumbleSupported(SDL_Haptic *haptic);
/**
* Initialize a haptic device for simple rumble playback.
*
* \param haptic the haptic device to initialize for simple rumble playback.
* \returns true on success or false on failure; call SDL_GetError() for more
* information.
*
* \since This function is available since SDL 3.2.0.
*
* \sa SDL_PlayHapticRumble
* \sa SDL_StopHapticRumble
* \sa SDL_HapticRumbleSupported
*/
extern SDL_DECLSPEC bool SDLCALL SDL_InitHapticRumble(SDL_Haptic *haptic);
/**
* Run a simple rumble effect on a haptic device.
*
* \param haptic the haptic device to play the rumble effect on.
* \param strength strength of the rumble to play as a 0-1 float value.
* \param length length of the rumble to play in milliseconds.
* \returns true on success or false on failure; call SDL_GetError() for more
* information.
*
* \since This function is available since SDL 3.2.0.
*
* \sa SDL_InitHapticRumble
* \sa SDL_StopHapticRumble
*/
extern SDL_DECLSPEC bool SDLCALL SDL_PlayHapticRumble(SDL_Haptic *haptic, float strength, Uint32 length);
/**
* Stop the simple rumble on a haptic device.
*
* \param haptic the haptic device to stop the rumble effect on.
* \returns true on success or false on failure; call SDL_GetError() for more
* information.
*
* \since This function is available since SDL 3.2.0.
*
* \sa SDL_PlayHapticRumble
*/
extern SDL_DECLSPEC bool SDLCALL SDL_StopHapticRumble(SDL_Haptic *haptic);
/* Ends C function definitions when using C++ */
#ifdef __cplusplus
}
#endif
#include <SDL3/SDL_close_code.h>
#endif /* SDL_haptic_h_ */