NAME¶

SDL_SetRenderLogicalPresentation - Set a device independent resolution and presentation mode for rendering.

HEADER FILE¶

Defined in SDL3/SDL_render.h

SYNOPSIS¶

#include "SDL3/SDL.h"

bool SDL_SetRenderLogicalPresentation(SDL_Renderer *renderer, int w, int h, SDL_RendererLogicalPresentation mode);

DESCRIPTION¶

This function sets the width and height of the logical rendering output. The renderer will act as if the window is always the requested dimensions, scaling to the actual window resolution as necessary.

This can be useful for games that expect a fixed size, but would like to scale the output to whatever is available, regardless of how a user resizes a window, or if the display is high DPI.

You can disable logical coordinates by setting the mode to

SDL_LOGICAL_PRESENTATION_DISABLED , and in that case you get the full pixel resolution of the output window; it is safe to toggle logical presentation during the rendering of a frame: perhaps most of the rendering is done to specific dimensions but to make fonts look sharp, the app turns off logical presentation while drawing text.

Letterboxing will only happen if logical presentation is enabled during

SDL_RenderPresent ; be sure to reenable it first if you were using it.

You can convert coordinates in an event into rendering coordinates using

SDL_ConvertEventToRenderCoordinates ().

FUNCTION PARAMETERS¶

renderer

the rendering context.

w

the width of the logical resolution.

h

the height of the logical resolution.

mode

the presentation mode used.

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_ConvertEventToRenderCoordinates(3), •(3), SDL_GetRenderLogicalPresentation(3), •(3), SDL_GetRenderLogicalPresentationRect(3)