(This is the legacy documentation for stable SDL2, the current stable version; SDL3 is the current development version.)

SDL_GetShapedWindowMode

Get the shape parameters of a shaped window.

Header File

Defined in SDL_shape.h, but apps should only #include "SDL.h"!

Syntax

int SDL_GetShapedWindowMode(SDL_Window *window,SDL_WindowShapeMode *shape_mode);

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

Return Value

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

Version

This function is available since SDL 2.0.0.