NAME¶

SDL_GetShapedWindowMode - Get the shape parameters of a shaped window.

SYNOPSIS¶

#include "SDL3/SDL.h"

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¶

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.

AVAILABILITY¶

This function is available since SDL 3.0.0.

SEE ALSO¶

SDL_WindowShapeMode(3), SDL_SetWindowShape(3)