Scroll to navigation

SDL_ConvertEventToRenderCoordinates(3) SDL3 FUNCTIONS SDL_ConvertEventToRenderCoordinates(3)

NAME

SDL_ConvertEventToRenderCoordinates - Convert the coordinates in an event to render coordinates.

HEADER FILE

Defined in SDL3/SDL_render.h

SYNOPSIS

#include "SDL3/SDL.h"
bool SDL_ConvertEventToRenderCoordinates(SDL_Renderer *renderer, SDL_Event *event);

DESCRIPTION

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.

FUNCTION PARAMETERS

the rendering context.
the event to modify.

RETURN VALUE

Returns true on success or false on failure; call

SDL_GetError () for more information.

THREAD SAFETY

You may only call this function from the main thread.

AVAILABILITY

This function is available since SDL 3.1.3.

SEE ALSO

(3), SDL_RenderCoordinatesFromWindow(3)

SDL 3.1.6 Simple Directmedia Layer