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

SDL_GetWindowAspectRatio

Get the size of a window's client area.

Header File

Defined in <SDL3/SDL_video.h>

Syntax

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

Function Parameters

SDL_Window *	window	the window to query the width and height from.
float *	min_aspect	a pointer filled in with the minimum aspect ratio of the window, may be NULL.
float *	max_aspect	a pointer filled in with the maximum aspect ratio of the window, may be NULL.

Return Value

(bool) 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.

Version

This function is available since SDL 3.1.3.

See Also

• SDL_SetWindowAspectRatio

---

CategoryAPI, CategoryAPIFunction, CategoryVideo

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.