eden-emu/SDL
15
0
Fork 0
mirror of https://github.com/libsdl-org/SDL.git synced 2025-05-23 21:19:11 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Sync SDL3 wiki -> header

Browse source 
[ci skip]
This commit is contained in:
SDL Wiki Bot 2025-03-02 15:53:56 +00:00
parent 1a7c206986
commit 2a0223487f
2 changed files with 28 additions and 19 deletions
Download patch file Download diff file Expand all files Collapse all files

40
include/SDL3/SDL_mouse.h
View file

@ -150,22 +150,29 @@ typedef Uint32 SDL_MouseButtonFlags;
/** /**
* A callback used to transform mouse motion delta from raw values. * A callback used to transform mouse motion delta from raw values.
* *
* This is called during SDL's handling of platform mouse events to * This is called during SDL's handling of platform mouse events to scale the
* scale the values of the resulting motion delta. * values of the resulting motion delta.
* *
* \param userdata what was passed as `userdata` to SDL_SetRelativeMouseTransform(). * \param userdata what was passed as `userdata` to
* \param timestamp the associated time at which this mouse motion event was received. * SDL_SetRelativeMouseTransform().
* \param window the associated window to which this mouse motion event was addressed. * \param timestamp the associated time at which this mouse motion event was
* \param mouseID the associated mouse from which this mouse motion event was emitted. * received.
* \param x pointer to a variable that will be treated as the resulting x-axis motion. * \param window the associated window to which this mouse motion event was
* \param y pointer to a variable that will be treated as the resulting y-axis motion. * addressed.
* \param mouseID the associated mouse from which this mouse motion event was
* emitted.
* \param x pointer to a variable that will be treated as the resulting x-axis
* motion.
* \param y pointer to a variable that will be treated as the resulting y-axis
* motion.
* *
* \threadsafety This callback is called by SDL's internal mouse input processing * \threadsafety This callback is called by SDL's internal mouse input
* procedure, which may be a thread separate from the main event loop * processing procedure, which may be a thread separate from the
* that is run at realtime priority. Stalling this thread with too much * main event loop that is run at realtime priority. Stalling
* work in the callback can therefore potentially freeze the entire * this thread with too much work in the callback can therefore
* system. Care should be taken with proper synchronization practices * potentially freeze the entire system. Care should be taken
* when adding other side effects beyond mutation of the x and y values. * with proper synchronization practices when adding other side
* effects beyond mutation of the x and y values.
* *
* \since This datatype is available since SDL 3.2.6. * \since This datatype is available since SDL 3.2.6.
* *
@ -414,11 +421,12 @@ extern SDL_DECLSPEC bool SDLCALL SDL_WarpMouseGlobal(float x, float y);
/** /**
* Set a user-defined function by which to transform relative mouse inputs. * Set a user-defined function by which to transform relative mouse inputs.
*
* This overrides the relative system scale and relative speed scale hints. * This overrides the relative system scale and relative speed scale hints.
* Should be called prior to enabling relative mouse mode, fails otherwise. * Should be called prior to enabling relative mouse mode, fails otherwise.
* *
* \param callback a callback used to transform relative mouse motion, * \param callback a callback used to transform relative mouse motion, or NULL
or NULL for default behavior. * for default behavior.
* \param userdata a pointer that will be passed to `callback`. * \param userdata a pointer that will be passed to `callback`.
* \returns true on success or false on failure; call SDL_GetError() for more * \returns true on success or false on failure; call SDL_GetError() for more
* information. * information.

5
include/SDL3/SDL_render.h
View file

@ -2258,8 +2258,9 @@ extern SDL_DECLSPEC bool SDLCALL SDL_RenderTexture9Grid(SDL_Renderer *renderer,
* corner of `dstrect`, or 0.0f for an unscaled copy. * corner of `dstrect`, or 0.0f for an unscaled copy.
* \param dstrect a pointer to the destination rectangle, or NULL for the * \param dstrect a pointer to the destination rectangle, or NULL for the
* entire rendering target. * entire rendering target.
* \param tileScale the scale used to transform the borders and center of `srcrect` into the * \param tileScale the scale used to transform the borders and center of
* borders and middle of `dstrect`, or 1.0f for an unscaled copy. * `srcrect` into the borders and middle of `dstrect`, or
* 1.0f for an unscaled copy.
* \returns true on success or false on failure; call SDL_GetError() for more * \returns true on success or false on failure; call SDL_GetError() for more
* information. * information.
* *