My Project
Loading...
Searching...
No Matches
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 "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
34extern "C" {
35#endif
36
42#define SDL_NONSHAPEABLE_WINDOW -1
43#define SDL_INVALID_SHAPE_ARGUMENT -2
44#define SDL_WINDOW_LACKS_SHAPE -3
45
69extern DECLSPEC SDL_Window * SDLCALL SDL_CreateShapedWindow(const char *title,unsigned int x,unsigned int y,unsigned int w,unsigned int h,Uint32 flags);
70
82extern DECLSPEC SDL_bool SDLCALL SDL_IsShapedWindow(const SDL_Window *window);
83
85typedef enum {
95
96#define SDL_SHAPEMODEALPHA(mode) (mode == ShapeModeDefault || mode == ShapeModeBinarizeAlpha || mode == ShapeModeReverseBinarizeAlpha)
97
99typedef union {
102 SDL_Color colorKey;
104
106typedef struct SDL_WindowShapeMode {
112
128extern DECLSPEC int SDLCALL SDL_SetWindowShape(SDL_Window *window,SDL_Surface *shape,SDL_WindowShapeMode *shape_mode);
129
147extern 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_ */
DECLSPEC SDL_bool SDLCALL SDL_IsShapedWindow(const SDL_Window *window)
DECLSPEC int SDLCALL SDL_GetShapedWindowMode(SDL_Window *window, SDL_WindowShapeMode *shape_mode)
DECLSPEC int SDLCALL SDL_SetWindowShape(SDL_Window *window, SDL_Surface *shape, SDL_WindowShapeMode *shape_mode)
WindowShapeMode
An enum denoting the specific type of contents present in an SDL_WindowShapeParams union.
Definition: SDL_shape.h:85
@ ShapeModeBinarizeAlpha
A binarized alpha cutoff with a given integer value.
Definition: SDL_shape.h:89
@ ShapeModeColorKey
A color key is applied.
Definition: SDL_shape.h:93
@ ShapeModeDefault
The default mode, a binarized alpha cutoff of 1.
Definition: SDL_shape.h:87
@ ShapeModeReverseBinarizeAlpha
A binarized alpha cutoff with a given integer value, but with the opposite comparison.
Definition: SDL_shape.h:91
DECLSPEC SDL_Window *SDLCALL SDL_CreateShapedWindow(const char *title, unsigned int x, unsigned int y, unsigned int w, unsigned int h, Uint32 flags)
struct SDL_Window SDL_Window
The type used to identify a window.
Definition: SDL_video.h:95
Definition: SDL_pixels.h:310
A collection of pixels used in software blitting.
Definition: SDL_surface.h:73
A struct that tags the SDL_WindowShapeParams union with an enum describing the type of its contents.
Definition: SDL_shape.h:106
WindowShapeMode mode
The mode of these window-shape parameters.
Definition: SDL_shape.h:108
SDL_WindowShapeParams parameters
Window-shape parameters.
Definition: SDL_shape.h:110
A union containing parameters for shaped windows.
Definition: SDL_shape.h:99
Uint8 binarizationCutoff
A cutoff alpha value for binarization of the window shape's alpha channel.
Definition: SDL_shape.h:101