Wiki Page Content

DRAFT

SDL_GetWindowOpacity

Use this function to get the opacity of a window.

Syntax

int SDL_GetWindowOpacity(SDL_Window* window,
                         float*      opacity)

Function Parameters

window

the window to get the current opacity value from

opacity

the float filled in (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.

Code Examples

You can add your code example here

Remarks

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

The parameter opacity is ignored if it is NULL.

This function also returns -1 if an invalid window was provided.

This function is only supported on DirectFB, X11, Cocoa (Apple Mac OS X) and Microsoft Windows.

Version

This function is available since SDL 2.0.5.


CategoryAPI, CategoryVideo

None: SDL_GetWindowOpacity (last edited 2016-09-29 22:54:20 by PhilippWiesemann)

(Page Info.)
Feedback
Please include your contact information if you'd like to receive a reply.
Submit