SDL_SetWindowOpacity(3)

SDL_SetWindowOpacity3

Set the opacity for a window.

Usage

#include "SDL3/SDL.h"

bool SDL_SetWindowOpacity(SDL_Window *window, float opacity);

Header file

Defined in SDL3/SDL_video.h

Overview

The parameter opacity will be clamped internally between 0.0f (transparent) and 1.0f (opaque).

This function also returns false if setting the opacity isn't supported.

Function parameters

window

the window which will be made transparent or opaque.

opacity

the opacity value (0.0f - transparent, 1.0f - opaque).

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.