SDL_GetWindowAspectRatio(3)

SDL_GetWindowAspectRatio3

Get the size of a window's client area.

Usage

#include "SDL3/SDL.h"

bool SDL_GetWindowAspectRatio(SDL_Window *window, float *min_aspect, float *max_aspect);

Header file

Defined in SDL3/SDL_video.h

Function parameters

window

the window to query the width and height from.

min_aspect

a pointer filled in with the minimum aspect ratio of the window, may be NULL.

max_aspect

a pointer filled in with the maximum aspect ratio of the window, may be NULL.

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.