SDL_GetCurrentRenderOutputSize

Get the current output size in pixels of a rendering context.

Header File

Defined in <SDL3/SDL_render.h>

Syntax

bool SDL_GetCurrentRenderOutputSize(SDL_Renderer *renderer, int *w, int *h);

Function Parameters

SDL_Renderer * renderer the rendering context.
int * w a pointer filled in with the current width.
int * h a pointer filled in with the current height.

Return Value

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

Remarks

If a rendering target is active, this will return the size of the rendering target in pixels, otherwise return the value of SDL_GetRenderOutputSize().

Rendering target or not, the output will be adjusted by the current logical presentation state, dictated by SDL_SetRenderLogicalPresentation().

Thread Safety

This function should only be called on the main thread.

Version

This function is available since SDL 3.2.0.

See Also


CategoryAPI, CategoryAPIFunction, CategoryRender