(This is the documentation for SDL3, which is under heavy development and the API is changing! SDL2 is the current stable version!)

SDL_SetWindowOpacity

Set the opacity for a window.

Header File

Defined in <SDL3/SDL_video.h>

Syntax

int SDL_SetWindowOpacity(SDL_Window *window, float opacity);

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 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 3.0.0.

See Also

CategoryAPI, CategoryAPIFunction, CategoryVideo