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

SDL_SetRenderScale

Set the drawing scale for rendering on the current target.

Header File

Syntax

bool SDL_SetRenderScale(SDL_Renderer *renderer, float scaleX, float scaleY);

Function Parameters

SDL_Renderer *	renderer	the rendering context.
float	scaleX	the horizontal scaling factor.
float	scaleY	the vertical scaling factor.

Return Value

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

Remarks

The drawing coordinates are scaled by the x/y scaling factors before they are used by the renderer. This allows resolution independent drawing with a single coordinate system.

If this results in scaling or subpixel drawing by the rendering backend, it will be handled using the appropriate quality hints. For best results use integer scaling factors.

Thread Safety

You may only call this function from the main thread.

Version

This function is available since SDL 3.1.3.