SDL_RenderCoordinatesFromWindow(3)

SDL_RenderCoordinatesFromWindow3

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

Usage

#include "SDL3/SDL.h"

bool SDL_RenderCoordinatesFromWindow(SDL_Renderer *renderer, float window_x, float window_y, float *x, float *y);

Header file

Defined in SDL3/SDL_render.h

Overview

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

renderer

the rendering context.

window_x

the x coordinate in window coordinates.

window_y

the y coordinate in window coordinates.

x

a pointer filled with the x coordinate in render coordinates.

y

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

This function should only be called on the main thread.

Availability

This function is available since SDL 3.2.0.

From libsdl3-doc 3.2.10+ds-1 in Debian 13 (Trixie). Parsed by carta from the page's man source.