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

SDL_render.h: Improve SDL_ConvertEventToRenderCoordinates documentation.

Browse source 
Fixes #9424.
This commit is contained in:
Ryan C. Gordon 2025-01-05 16:40:56 -05:00
parent 2b375d9704
commit 742f2a2fad
1 changed files with 9 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

10
include/SDL3/SDL_render.h
View file

@ -1498,10 +1498,18 @@ extern SDL_DECLSPEC bool SDLCALL SDL_RenderCoordinatesToWindow(SDL_Renderer *ren
* - The scale (SDL_SetRenderScale)
* - The viewport (SDL_SetRenderViewport)
*
* Various event types are converted with this function: mouse, touch, pen,
* etc.
*
* Touch coordinates are converted from normalized coordinates in the window
* to non-normalized rendering coordinates.
*
* Once converted, the coordinates may be outside the rendering area.
* Relative mouse coordinates (xrel and yrel event fields) are _also_
* converted. Applications that do not want these fields converted should
* use SDL_RenderCoordinatesFromWindow() on the specific event fields instead
* of converting the entire event structure.
*
* Once converted, coordinates may be outside the rendering area.
*
* \param renderer the rendering context.
* \param event the event to modify.