Details | Last modification | View Log | RSS feed
| Rev | Author | Line No. | Line |
|---|---|---|---|
| 1 | pmbaty | 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 "SDL_stdinc.h" |
||
| 26 | #include "SDL_pixels.h" |
||
| 27 | #include "SDL_rect.h" |
||
| 28 | #include "SDL_surface.h" |
||
| 29 | #include "SDL_video.h" |
||
| 30 | |||
| 31 | #include "begin_code.h" |
||
| 32 | /* Set up for C function definitions, even when using C++ */ |
||
| 33 | #ifdef __cplusplus |
||
| 34 | extern "C" { |
||
| 35 | #endif |
||
| 36 | |||
| 37 | /** \file SDL_shape.h |
||
| 38 | * |
||
| 39 | * 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 position, dimensions, |
||
| 48 | * and flags. |
||
| 49 | * |
||
| 50 | * \param title The title of the window, in UTF-8 encoding. |
||
| 51 | * \param x The x position of the window, ::SDL_WINDOWPOS_CENTERED, or |
||
| 52 | * ::SDL_WINDOWPOS_UNDEFINED. |
||
| 53 | * \param y The y position of the window, ::SDL_WINDOWPOS_CENTERED, or |
||
| 54 | * ::SDL_WINDOWPOS_UNDEFINED. |
||
| 55 | * \param w The width of the window. |
||
| 56 | * \param h The height of the window. |
||
| 57 | * \param flags The flags for the window, a mask of SDL_WINDOW_BORDERLESS with |
||
| 58 | * any of the following: ::SDL_WINDOW_OPENGL, |
||
| 59 | * ::SDL_WINDOW_INPUT_GRABBED, ::SDL_WINDOW_HIDDEN, |
||
| 60 | * ::SDL_WINDOW_RESIZABLE, ::SDL_WINDOW_MAXIMIZED, |
||
| 61 | * ::SDL_WINDOW_MINIMIZED, ::SDL_WINDOW_BORDERLESS is always set, |
||
| 62 | * and ::SDL_WINDOW_FULLSCREEN is always unset. |
||
| 63 | * \return the window created, or NULL if window creation failed. |
||
| 64 | * |
||
| 65 | * \since This function is available since SDL 2.0.0. |
||
| 66 | * |
||
| 67 | * \sa SDL_DestroyWindow |
||
| 68 | */ |
||
| 69 | extern DECLSPEC SDL_Window * SDLCALL SDL_CreateShapedWindow(const char *title,unsigned int x,unsigned int y,unsigned int w,unsigned int h,Uint32 flags); |
||
| 70 | |||
| 71 | /** |
||
| 72 | * Return whether the given window is a shaped window. |
||
| 73 | * |
||
| 74 | * \param window The window to query for being shaped. |
||
| 75 | * \return SDL_TRUE if the window is a window that can be shaped, SDL_FALSE if |
||
| 76 | * the window is unshaped or NULL. |
||
| 77 | * |
||
| 78 | * \since This function is available since SDL 2.0.0. |
||
| 79 | * |
||
| 80 | * \sa SDL_CreateShapedWindow |
||
| 81 | */ |
||
| 82 | extern DECLSPEC SDL_bool SDLCALL SDL_IsShapedWindow(const SDL_Window *window); |
||
| 83 | |||
| 84 | /** \brief An enum denoting the specific type of contents present in an SDL_WindowShapeParams union. */ |
||
| 85 | typedef enum { |
||
| 86 | /** \brief The default mode, a binarized alpha cutoff of 1. */ |
||
| 87 | ShapeModeDefault, |
||
| 88 | /** \brief A binarized alpha cutoff with a given integer value. */ |
||
| 89 | ShapeModeBinarizeAlpha, |
||
| 90 | /** \brief A binarized alpha cutoff with a given integer value, but with the opposite comparison. */ |
||
| 91 | ShapeModeReverseBinarizeAlpha, |
||
| 92 | /** \brief A color key is applied. */ |
||
| 93 | ShapeModeColorKey |
||
| 94 | } WindowShapeMode; |
||
| 95 | |||
| 96 | #define SDL_SHAPEMODEALPHA(mode) (mode == ShapeModeDefault || mode == ShapeModeBinarizeAlpha || mode == ShapeModeReverseBinarizeAlpha) |
||
| 97 | |||
| 98 | /** \brief A union containing parameters for shaped windows. */ |
||
| 99 | typedef union { |
||
| 100 | /** \brief A cutoff alpha value for binarization of the window shape's alpha channel. */ |
||
| 101 | Uint8 binarizationCutoff; |
||
| 102 | SDL_Color colorKey; |
||
| 103 | } SDL_WindowShapeParams; |
||
| 104 | |||
| 105 | /** \brief A struct that tags the SDL_WindowShapeParams union with an enum describing the type of its contents. */ |
||
| 106 | typedef struct SDL_WindowShapeMode { |
||
| 107 | /** \brief The mode of these window-shape parameters. */ |
||
| 108 | WindowShapeMode mode; |
||
| 109 | /** \brief Window-shape parameters. */ |
||
| 110 | SDL_WindowShapeParams parameters; |
||
| 111 | } SDL_WindowShapeMode; |
||
| 112 | |||
| 113 | /** |
||
| 114 | * Set the shape and parameters of a shaped window. |
||
| 115 | * |
||
| 116 | * \param window The shaped window whose parameters should be set. |
||
| 117 | * \param shape A surface encoding the desired shape for the window. |
||
| 118 | * \param shape_mode The parameters to set for the shaped window. |
||
| 119 | * \return 0 on success, SDL_INVALID_SHAPE_ARGUMENT on an invalid shape |
||
| 120 | * argument, or SDL_NONSHAPEABLE_WINDOW if the SDL_Window given does |
||
| 121 | * not reference a valid shaped window. |
||
| 122 | * |
||
| 123 | * \since This function is available since SDL 2.0.0. |
||
| 124 | * |
||
| 125 | * \sa SDL_WindowShapeMode |
||
| 126 | * \sa SDL_GetShapedWindowMode |
||
| 127 | */ |
||
| 128 | extern DECLSPEC int SDLCALL SDL_SetWindowShape(SDL_Window *window,SDL_Surface *shape,SDL_WindowShapeMode *shape_mode); |
||
| 129 | |||
| 130 | /** |
||
| 131 | * Get the shape parameters of a shaped window. |
||
| 132 | * |
||
| 133 | * \param window The shaped window whose parameters should be retrieved. |
||
| 134 | * \param shape_mode An empty shape-mode structure to fill, or NULL to check |
||
| 135 | * whether the window has a shape. |
||
| 136 | * \return 0 if the window has a shape and, provided shape_mode was not NULL, |
||
| 137 | * shape_mode has been filled with the mode data, |
||
| 138 | * SDL_NONSHAPEABLE_WINDOW if the SDL_Window given is not a shaped |
||
| 139 | * window, or SDL_WINDOW_LACKS_SHAPE if the SDL_Window given is a |
||
| 140 | * shapeable window currently lacking a shape. |
||
| 141 | * |
||
| 142 | * \since This function is available since SDL 2.0.0. |
||
| 143 | * |
||
| 144 | * \sa SDL_WindowShapeMode |
||
| 145 | * \sa SDL_SetWindowShape |
||
| 146 | */ |
||
| 147 | extern DECLSPEC int SDLCALL SDL_GetShapedWindowMode(SDL_Window *window,SDL_WindowShapeMode *shape_mode); |
||
| 148 | |||
| 149 | /* Ends C function definitions when using C++ */ |
||
| 150 | #ifdef __cplusplus |
||
| 151 | } |
||
| 152 | #endif |
||
| 153 | #include "close_code.h" |
||
| 154 | |||
| 155 | #endif /* SDL_shape_h_ */ |