SDL_shape.h File Reference

A struct that tags the SDL_WindowShapeParams union with an enum describing the type of its contents.

An enum denoting the specific type of contents present in an SDL_WindowShapeParams union.

Enumerator:

ShapeModeDefault	The default mode, a binarized alpha cutoff of 1.
ShapeModeBinarizeAlpha	A binarized alpha cutoff with a given integer value.
ShapeModeReverseBinarizeAlpha	A binarized alpha cutoff with a given integer value, but with the opposite comparison.
ShapeModeColorKey	A color key is applied.

Definition at line 79 of file SDL_shape.h.

Create a window that can be shaped with the specified position, dimensions, and flags.

Parameters:

title	The title of the window, in UTF-8 encoding.
x	The x position of the window, SDL_WINDOWPOS_CENTERED, or SDL_WINDOWPOS_UNDEFINED.
y	The y position of the window, SDL_WINDOWPOS_CENTERED, or SDL_WINDOWPOS_UNDEFINED.
w	The width of the window.
h	The height of the window.
flags	The flags for the window, a mask of SDL_WINDOW_BORDERLESS with any of the following: SDL_WINDOW_OPENGL, SDL_WINDOW_INPUT_GRABBED, SDL_WINDOW_HIDDEN, SDL_WINDOW_RESIZABLE, SDL_WINDOW_MAXIMIZED, SDL_WINDOW_MINIMIZED, SDL_WINDOW_BORDERLESS is always set, and SDL_WINDOW_FULLSCREEN is always unset.

Returns:

The window created, or NULL if window creation failed.

See also:

SDL_DestroyWindow()

Get the shape parameters of a shaped window.

Parameters:

window	The shaped window whose parameters should be retrieved.
shape_mode	An empty shape-mode structure to fill, or NULL to check whether the window has a shape.

Returns:

0 if the window has a shape and, provided shape_mode was not NULL, shape_mode has been filled with the mode data, SDL_NONSHAPEABLE_WINDOW if the SDL_Window given is not a shaped window, or SDL_WINDOW_LACKS_SHAPE if the SDL_Window* given is a shapeable window currently lacking a shape.

See also:

SDL_WindowShapeMode

SDL_SetWindowShape

Return whether the given window is a shaped window.

Parameters:

window

The window to query for being shaped.

Returns:

SDL_TRUE if the window is a window that can be shaped, SDL_FALSE if the window is unshaped or NULL.

See also:

SDL_CreateShapedWindow

Set the shape and parameters of a shaped window.

Parameters:

window	The shaped window whose parameters should be set.
shape	A surface encoding the desired shape for the window.
shape_mode	The parameters to set for the shaped window.

Returns:

0 on success, SDL_INVALID_SHAPE_ARGUMENT on invalid an invalid shape argument, or SDL_NONSHAPEABLE_WINDOW if the SDL_Window* given does not reference a valid shaped window.

See also:

SDL_WindowShapeMode

SDL_GetShapedWindowMode.