Wiki Page Content

DRAFT

SDL_SetWindowOpacity

Use this function to set the opacity for a window.

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.

Code Examples

You can add your code example here

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.

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_SetWindowOpacity (last edited 2016-09-29 22:50:23 by PhilippWiesemann)

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