NAME

       SDL_SetWindowAspectRatio - Request that the aspect ratio of a window's client area be set.

SYNOPSIS

       #include <SDL3/SDL_video.h>

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

DESCRIPTION

       The  aspect  ratio  is  the  ratio of width divided by height, e.g. 2560x1600 would be 1.6. Larger aspect
       ratios are wider and smaller aspect ratios are narrower.

       If, at the time of this request, the window in a fixed-size state, such as maximized or  fullscreen,  the
       request will be deferred until the window exits this state and becomes resizable again.

       On some windowing systems, this request is asynchronous and the new window aspect ratio may not have have
       been  applied  immediately  upon  the  return  of this function. If an immediate change is required, call
       SDL_SyncWindow() to block until the changes have taken effect.

       When the window size changes, an SDL_EVENT_WINDOW_RESIZED event will  be  emitted  with  the  new  window
       dimensions.  Note  that  the  new  dimensions  may  not  match  the exact aspect ratio requested, as some
       windowing systems can restrict the window size in certain scenarios (e.g. constraining the  size  of  the
       content area to remain within the usable desktop bounds). Additionally, as this is just a request, it can
       be denied by the windowing system.

FUNCTION PARAMETERS

       window the window to change.

       min_aspect
              the minimum aspect ratio of the window, or 0.0f for no limit.

       max_aspect
              the maximum aspect ratio of the window, or 0.0f for no limit.

RETURN VALUE

       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

       SDL_GetWindowAspectRatio(3), SDL_SyncWindow(3)

Simple Directmedia Layer                           SDL 3.2.20                        SDL_SetWindowAspectRatio(3)