SDL 3.0
SDL_shape.h
Go to the documentation of this file.
1/*
2 Simple DirectMedia Layer
3 Copyright (C) 1997-2023 Sam Lantinga <slouken@libsdl.org>
4
5 This software is provided 'as-is', without any express or implied
6 warranty. In no event will the authors be held liable for any damages
7 arising from the use of this software.
8
9 Permission is granted to anyone to use this software for any purpose,
10 including commercial applications, and to alter it and redistribute it
11 freely, subject to the following restrictions:
12
13 1. The origin of this software must not be misrepresented; you must not
14 claim that you wrote the original software. If you use this software
15 in a product, an acknowledgment in the product documentation would be
16 appreciated but is not required.
17 2. Altered source versions must be plainly marked as such, and must not be
18 misrepresented as being the original software.
19 3. This notice may not be removed or altered from any source distribution.
20*/
21
22#ifndef SDL_shape_h_
23#define SDL_shape_h_
24
25#include <SDL3/SDL_stdinc.h>
26#include <SDL3/SDL_pixels.h>
27#include <SDL3/SDL_rect.h>
28#include <SDL3/SDL_surface.h>
29#include <SDL3/SDL_video.h>
30
31#include <SDL3/SDL_begin_code.h>
32/* Set up for C function definitions, even when using C++ */
33#ifdef __cplusplus
34extern "C" {
35#endif
36
37/** \file SDL_shape.h
38 *
39 * \brief Header file for the shaped window API.
40 */
41
42#define SDL_NONSHAPEABLE_WINDOW -1
43#define SDL_INVALID_SHAPE_ARGUMENT -2
44#define SDL_WINDOW_LACKS_SHAPE -3
45
46/**
47 * Create a window that can be shaped with the specified dimensions and flags.
48 *
49 * \param title The title of the window, in UTF-8 encoding.
50 * \param w The width of the window.
51 * \param h The height of the window.
52 * \param flags The flags for the window, a mask of SDL_WINDOW_BORDERLESS with
53 * any of the following: ::SDL_WINDOW_OPENGL,
54 * ::SDL_WINDOW_MOUSE_GRABBED, ::SDL_WINDOW_HIDDEN,
55 * ::SDL_WINDOW_RESIZABLE, ::SDL_WINDOW_MAXIMIZED,
56 * ::SDL_WINDOW_MINIMIZED, ::SDL_WINDOW_BORDERLESS is always set,
57 * and ::SDL_WINDOW_FULLSCREEN is always unset.
58 * \returns the window created, or NULL if window creation failed.
59 *
60 * \since This function is available since SDL 3.0.0.
61 *
62 * \sa SDL_DestroyWindow
63 */
64extern DECLSPEC SDL_Window *SDLCALL SDL_CreateShapedWindow(const char *title, int w, int h, Uint32 flags);
65
66/**
67 * Return whether the given window is a shaped window.
68 *
69 * \param window The window to query for being shaped.
70 * \returns SDL_TRUE if the window is a window that can be shaped, SDL_FALSE
71 * if the window is unshaped or NULL.
72 *
73 * \since This function is available since SDL 3.0.0.
74 *
75 * \sa SDL_CreateShapedWindow
76 */
77extern DECLSPEC SDL_bool SDLCALL SDL_IsShapedWindow(const SDL_Window *window);
78
79/** \brief An enum denoting the specific type of contents present in an SDL_WindowShapeParams union. */
80typedef enum {
81 /** \brief The default mode, a binarized alpha cutoff of 1. */
83 /** \brief A binarized alpha cutoff with a given integer value. */
85 /** \brief A binarized alpha cutoff with a given integer value, but with the opposite comparison. */
87 /** \brief A color key is applied. */
90
91#define SDL_SHAPEMODEALPHA(mode) (mode == ShapeModeDefault || mode == ShapeModeBinarizeAlpha || mode == ShapeModeReverseBinarizeAlpha)
92
93/** \brief A union containing parameters for shaped windows. */
94typedef union {
95 /** \brief A cutoff alpha value for binarization of the window shape's alpha channel. */
99
100/** \brief A struct that tags the SDL_WindowShapeParams union with an enum describing the type of its contents. */
101typedef struct SDL_WindowShapeMode {
102 /** \brief The mode of these window-shape parameters. */
104 /** \brief Window-shape parameters. */
107
108/**
109 * Set the shape and parameters of a shaped window.
110 *
111 * \param window The shaped window whose parameters should be set.
112 * \param shape A surface encoding the desired shape for the window.
113 * \param shape_mode The parameters to set for the shaped window.
114 * \returns 0 on success, SDL_INVALID_SHAPE_ARGUMENT on an invalid shape
115 * argument, or SDL_NONSHAPEABLE_WINDOW if the SDL_Window given does
116 * not reference a valid shaped window.
117 *
118 * \since This function is available since SDL 3.0.0.
119 *
120 * \sa SDL_WindowShapeMode
121 * \sa SDL_GetShapedWindowMode
122 */
123extern DECLSPEC int SDLCALL SDL_SetWindowShape(SDL_Window *window,SDL_Surface *shape,SDL_WindowShapeMode *shape_mode);
124
125/**
126 * Get the shape parameters of a shaped window.
127 *
128 * \param window The shaped window whose parameters should be retrieved.
129 * \param shape_mode An empty shape-mode structure to fill, or NULL to check
130 * whether the window has a shape.
131 * \returns 0 if the window has a shape and, provided shape_mode was not NULL,
132 * shape_mode has been filled with the mode data,
133 * SDL_NONSHAPEABLE_WINDOW if the SDL_Window given is not a shaped
134 * window, or SDL_WINDOW_LACKS_SHAPE if the SDL_Window given is a
135 * shapeable window currently lacking a shape.
136 *
137 * \since This function is available since SDL 3.0.0.
138 *
139 * \sa SDL_WindowShapeMode
140 * \sa SDL_SetWindowShape
141 */
142extern DECLSPEC int SDLCALL SDL_GetShapedWindowMode(SDL_Window *window,SDL_WindowShapeMode *shape_mode);
143
144/* Ends C function definitions when using C++ */
145#ifdef __cplusplus
146}
147#endif
148#include <SDL3/SDL_close_code.h>
149
150#endif /* SDL_shape_h_ */
Header for the enumerated pixel format definitions.
Header file for SDL_rect definition and management functions.
int SDL_GetShapedWindowMode(SDL_Window *window, SDL_WindowShapeMode *shape_mode)
WindowShapeMode
An enum denoting the specific type of contents present in an SDL_WindowShapeParams union.
Definition SDL_shape.h:80
@ ShapeModeBinarizeAlpha
A binarized alpha cutoff with a given integer value.
Definition SDL_shape.h:84
@ ShapeModeColorKey
A color key is applied.
Definition SDL_shape.h:88
@ ShapeModeDefault
The default mode, a binarized alpha cutoff of 1.
Definition SDL_shape.h:82
@ ShapeModeReverseBinarizeAlpha
A binarized alpha cutoff with a given integer value, but with the opposite comparison.
Definition SDL_shape.h:86
SDL_bool SDL_IsShapedWindow(const SDL_Window *window)
SDL_Window * SDL_CreateShapedWindow(const char *title, int w, int h, Uint32 flags)
int SDL_SetWindowShape(SDL_Window *window, SDL_Surface *shape, SDL_WindowShapeMode *shape_mode)
This is a general header that includes C language support.
uint8_t Uint8
Definition SDL_stdinc.h:147
SDL_bool
Definition SDL_stdinc.h:130
uint32_t Uint32
Definition SDL_stdinc.h:171
Header file for SDL_Surface definition and management functions.
Header file for SDL video functions.
struct SDL_Window SDL_Window
The type used to identify a window.
Definition SDL_video.h:123
A collection of pixels used in software blitting.
Definition SDL_surface.h:87
A struct that tags the SDL_WindowShapeParams union with an enum describing the type of its contents.
Definition SDL_shape.h:101
SDL_WindowShapeParams parameters
Window-shape parameters.
Definition SDL_shape.h:105
WindowShapeMode mode
The mode of these window-shape parameters.
Definition SDL_shape.h:103
A union containing parameters for shaped windows.
Definition SDL_shape.h:94
Uint8 binarizationCutoff
A cutoff alpha value for binarization of the window shape's alpha channel.
Definition SDL_shape.h:96