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

SDL_SetWindowOpacity

Set the opacity for a window.

Header File

Defined in <SDL3/SDL_video.h>

Syntax

bool SDL_SetWindowOpacity(SDL_Window *window, float opacity);

Function Parameters

SDL_Window *	window	the window which will be made transparent or opaque.
float	opacity	the opacity value (0.0f - transparent, 1.0f - opaque).

Return Value

(bool) Returns true on success or false on failure; call SDL_GetError() for more information.

Remarks

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.

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_GetWindowOpacity

---

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.