Scroll to navigation

SDL_RenderCoordinatesFromWindow(3) SDL3 FUNCTIONS SDL_RenderCoordinatesFromWindow(3)

NAME

SDL_RenderCoordinatesFromWindow - Get a point in render coordinates when given a point in window coordinates.

HEADER FILE

Defined in SDL3/SDL_render.h

SYNOPSIS

#include "SDL3/SDL.h"
bool SDL_RenderCoordinatesFromWindow(SDL_Renderer *renderer, float window_x, float window_y, float *x, float *y);

DESCRIPTION

This takes into account several states:

• The window dimensions.

• The logical presentation settings
( SDL_SetRenderLogicalPresentation )

• The scale ( SDL_SetRenderScale )

• The viewport ( SDL_SetRenderViewport )

FUNCTION PARAMETERS

the rendering context.
the x coordinate in window coordinates.
the y coordinate in window coordinates.
a pointer filled with the x coordinate in render coordinates.
a pointer filled with the y coordinate in render coordinates.

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_SetRenderLogicalPresentation(3), (3), SDL_SetRenderScale(3)

SDL 3.1.6 Simple Directmedia Layer