SDL_SetWindowAlwaysOnTop(3)

SDL_SetWindowAlwaysOnTop3

Set the window to always be above the others.

Usage

#include "SDL3/SDL.h"

bool SDL_SetWindowAlwaysOnTop(SDL_Window *window, bool on_top);

Header file

Defined in SDL3/SDL_video.h

Overview

This will add or remove the window's

SDL_WINDOW_ALWAYS_ON_TOP flag. This will bring the window to the front and keep the window above the rest.

Function parameters

window

the window of which to change the always on top state.

on_top

true to set the window always on top, false to disable.

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.