My Project
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
SDL_shape.h
Go to the documentation of this file.
1 /*
2  Simple DirectMedia Layer
3  Copyright (C) 1997-2013 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 
42 #define SDL_NONSHAPEABLE_WINDOW -1
43 #define SDL_INVALID_SHAPE_ARGUMENT -2
44 #define SDL_WINDOW_LACKS_SHAPE -3
45 
66 extern DECLSPEC SDL_Window * SDLCALL SDL_CreateShapedWindow(const char *title,unsigned int x,unsigned int y,unsigned int w,unsigned int h,Uint32 flags);
67 
76 extern DECLSPEC SDL_bool SDLCALL SDL_IsShapedWindow(const SDL_Window *window);
77 
79 typedef enum {
89 
90 #define SDL_SHAPEMODEALPHA(mode) (mode == ShapeModeDefault || mode == ShapeModeBinarizeAlpha || mode == ShapeModeReverseBinarizeAlpha)
91 
93 typedef union {
96  SDL_Color colorKey;
98 
100 typedef struct SDL_WindowShapeMode {
106 
120 extern DECLSPEC int SDLCALL SDL_SetWindowShape(SDL_Window *window,SDL_Surface *shape,SDL_WindowShapeMode *shape_mode);
121 
135 extern DECLSPEC int SDLCALL SDL_GetShapedWindowMode(SDL_Window *window,SDL_WindowShapeMode *shape_mode);
136 
137 /* Ends C function definitions when using C++ */
138 #ifdef __cplusplus
139 }
140 #endif
141 #include "close_code.h"
142 
143 #endif /* _SDL_shape_h */
uint8_t Uint8
An unsigned 8-bit integer type.
Definition: SDL_stdinc.h:129
struct SDL_Window SDL_Window
The type used to identify a window.
Definition: SDL_video.h:89
DECLSPEC SDL_Window *SDLCALL SDL_CreateShapedWindow(const char *title, unsigned int x, unsigned int y, unsigned int w, unsigned int h, Uint32 flags)
Create a window that can be shaped with the specified position, dimensions, and flags.
SDL_WindowShapeParams parameters
Window-shape parameters.
Definition: SDL_shape.h:104
uint32_t Uint32
An unsigned 32-bit integer type.
Definition: SDL_stdinc.h:145
A binarized alpha cutoff with a given integer value, but with the opposite comparison.
Definition: SDL_shape.h:85
A collection of pixels used in software blitting.
Definition: SDL_surface.h:69
Definition: SDL_pixels.h:252
DECLSPEC SDL_bool SDLCALL SDL_IsShapedWindow(const SDL_Window *window)
Return whether the given window is a shaped window.
struct SDL_WindowShapeMode SDL_WindowShapeMode
A struct that tags the SDL_WindowShapeParams union with an enum describing the type of its contents...
The default mode, a binarized alpha cutoff of 1.
Definition: SDL_shape.h:81
A union containing parameters for shaped windows.
Definition: SDL_shape.h:93
DECLSPEC int SDLCALL SDL_SetWindowShape(SDL_Window *window, SDL_Surface *shape, SDL_WindowShapeMode *shape_mode)
Set the shape and parameters of a shaped window.
WindowShapeMode mode
The mode of these window-shape parameters.
Definition: SDL_shape.h:102
A color key is applied.
Definition: SDL_shape.h:87
A struct that tags the SDL_WindowShapeParams union with an enum describing the type of its contents...
Definition: SDL_shape.h:100
WindowShapeMode
An enum denoting the specific type of contents present in an SDL_WindowShapeParams union...
Definition: SDL_shape.h:79
A binarized alpha cutoff with a given integer value.
Definition: SDL_shape.h:83
Uint8 binarizationCutoff
a cutoff alpha value for binarization of the window shape&#39;s alpha channel.
Definition: SDL_shape.h:95
DECLSPEC int SDLCALL SDL_GetShapedWindowMode(SDL_Window *window, SDL_WindowShapeMode *shape_mode)
Get the shape parameters of a shaped window.