SDL_GetWindowOpacity(3)

SDL_GetWindowOpacity3

Get the opacity of a window.

Usage

#include "SDL3/SDL.h"

float SDL_GetWindowOpacity(SDL_Window *window);

Header file

Defined in SDL3/SDL_video.h

Overview

If transparency isn't supported on this platform, opacity will be returned as 1.0f without error.

Function parameters

window

the window to get the current opacity value from.

Return value

Returns the opacity, (0.0f - transparent, 1.0f - opaque), or -1.0f 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.