(This is the documentation for SDL3, which is the current stable version. SDL2 was the previous version!)

SDL_ConvertEventToRenderCoordinates

Convert the coordinates in an event to render coordinates.

Header File

Defined in <SDL3/SDL_render.h>

Syntax

bool SDL_ConvertEventToRenderCoordinates(SDL_Renderer *renderer, SDL_Event *event);

Function Parameters

SDL_Renderer *	renderer	the rendering context.
SDL_Event *	event	the event to modify.

Return Value

(bool) Returns true on success or false on failure; call SDL_GetError() for more information.

Remarks

This takes into account several states:

• The window dimensions.
• The logical presentation settings (SDL_SetRenderLogicalPresentation)
• The scale (SDL_SetRenderScale)
• The viewport (SDL_SetRenderViewport)

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.

Thread Safety

This function should only be called on the main thread.

Version

This function is available since SDL 3.1.3.

See Also

• SDL_RenderCoordinatesFromWindow

---

CategoryAPI, CategoryAPIFunction, CategoryRender

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.