SDL_GetWindowAspectRatio - Man Page

Get the size of a window's client area.

Header File

Defined in SDL3/SDL_video.h

Synopsis

#include "SDL3/SDL.h"

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

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.

See Also

·(3), SDL_SetWindowAspectRatio(3)

Referenced By

SDL_SetWindowAspectRatio(3).

SDL 3.2.2 Simple Directmedia Layer SDL3 FUNCTIONS