SDL_SetRenderScale(3)

SDL_SetRenderScale3

Set the drawing scale for rendering on the current target.

Usage

#include "SDL3/SDL.h"

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

Header file

Defined in SDL3/SDL_render.h

Overview

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.

Each render target has its own scale. This function sets the scale for the current render target.

Function parameters

renderer

the rendering context.

scaleX

the horizontal scaling factor.

scaleY

the vertical scaling factor.

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.