(This is the legacy documentation for SDL2, the previous stable version; SDL3 is the current stable version.)

SDL_SetWindowOpacity

Set the opacity for a window.

Header File

Defined in SDL_video.h

Syntax

int 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

(int) Returns 0 on success or a negative error code 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 -1 if setting the opacity isn't supported.

Version

This function is available since SDL 2.0.5.

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.