This repository has been archived by the owner on Feb 11, 2021. It is now read-only.
/
SDL_shape.h
141 lines (125 loc) · 5.35 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
/*
SDL - Simple DirectMedia Layer
Copyright (C) 2010 Eli Gottlieb
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Eli Gottlieb
eligottlieb@gmail.com
*/
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
#ifndef _SDL_shape_h
#define _SDL_shape_h
#include "SDL_stdinc.h"
#include "SDL_pixels.h"
#include "SDL_rect.h"
#include "SDL_surface.h"
#include "SDL_video.h"
#include "begin_code.h"
/* Set up for C function definitions, even when using C++ */
#ifdef __cplusplus
/* *INDENT-OFF* */
extern "C" {
/* *INDENT-ON* */
#endif
39
40
41
42
43
44
45
46
47
48
49
50
/**
* \brief Create a shaped window with the specified position, dimensions, and flags.
*
* \param title The title of the window, in UTF-8 encoding.
* \param x The x position of the window, ::SDL_WINDOWPOS_CENTERED, or
* ::SDL_WINDOWPOS_UNDEFINED.
* \param y The y position of the window, ::SDL_WINDOWPOS_CENTERED, or
* ::SDL_WINDOWPOS_UNDEFINED.
* \param w The width of the window.
* \param h The height of the window.
* \param flags The flags for the window, a mask of SDL_WINDOW_BORDERLESS with any of the following:
51
* ::SDL_WINDOW_OPENGL, ::SDL_WINDOW_INPUT_GRABBED,
52
53
* ::SDL_WINDOW_SHOWN, ::SDL_WINDOW_RESIZABLE,
* ::SDL_WINDOW_MAXIMIZED, ::SDL_WINDOW_MINIMIZED,
54
* ::SDL_WINDOW_BORDERLESS is always set, and ::SDL_WINDOW_FULLSCREEN is always unset.
55
56
57
58
59
*
* \return The id of the window created, or zero if window creation failed.
*
* \sa SDL_DestroyWindow()
*/
60
extern DECLSPEC SDL_Window * SDLCALL SDL_CreateShapedWindow(const char *title,unsigned int x,unsigned int y,unsigned int w,unsigned int h,Uint32 flags);
61
62
63
64
65
66
67
68
69
/**
* \brief Return whether the given window is a shaped window.
*
* \param window The window to query for being shaped.
*
* \return SDL_TRUE if the window is a shaped window and SDL_FALSE otherwise.
* \sa SDL_CreateShapedWindow
*/
70
extern DECLSPEC SDL_bool SDLCALL SDL_WindowIsShaped(const SDL_Window *window);
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
/**
* \brief Select the shape of a given window as a rendering target.
*
* \param window The window whose shape should become the current rendering target.
*
* \return 0 on success, -1 if something other than a valid shaped window is passed into \c window.
*
* The shape of the window given in \c window is selected as the new render target, and in the default mode (see
* SDL_WindowShapeParams) the alpha channel of that render target determines which pixels of the window are part of its
* visible shape and which are not according to a cutoff value. All normal SDL rendering functions can be used on it,
* and its own specific parameters can be examined and set with SDL_GetShapeParameters() and SDL_SetShapeParameters().
* The final shape will be computed and the actual appearance of the window changed only upon a call to
* SDL_RenderPresent().
*
* \sa SDL_GetShapeParameters
* \sa SDL_SetShapeParameters
* \sa SDL_RenderPresent
*/
90
extern DECLSPEC int SDLCALL SDL_SelectShapeRenderer(const SDL_Window *window);
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
/** \brief An enum denoting the specific type of contents present in an SDL_WindowShapeParams union. */
typedef enum {ShapeModeDefault, ShapeModeBinarizeAlpha} WindowShapeMode;
/** \brief A union containing parameters for shaped windows. */
typedef union {
/** \brief a cutoff alpha value for binarization of the window shape's alpha channel. */
Uint8 binarizationCutoff;
} SDL_WindowShapeParams;
/** \brief A struct that tags the SDL_WindowShapeParams union with an enum describing the type of its contents. */
typedef struct SDL_WindowShapeMode {
WindowShapeMode mode;
SDL_WindowShapeParams parameters;
} SDL_WindowShapeMode;
/**
* \brief Set the shape parameters of a shaped window.
*
* \param window The shaped window whose parameters should be set.
* \param shapeMode The parameters to set for the shaped window.
*
* \return 0 on success, -1 on invalid parameters in the shapeMode argument, or -2 if the SDL_Window given is not a
* shaped window.
*
* \sa SDL_WindowShapeMode
* \sa SDL_GetShapeParameters
*/
extern DECLSPEC int SDLCALL SDL_SetShapeParameters(SDL_Window *window,SDL_WindowShapeMode shapeMode);
/**
* \brief Set the shape parameters of a shaped window.
*
* \param window The shaped window whose parameters should be retrieved.
* \param shapeMode An empty shape-parameters structure to fill.
*
* \return 0 on success, -1 on a null shapeMode, or -2 if the SDL_Window given is not a shaped window.
*
* \sa SDL_WindowShapeMode
* \sa SDL_SetShapeParameters
*/
extern DECLSPEC int SDLCALL SDL_GetShapeParameters(SDL_Window *window,SDL_WindowShapeMode *shapeMode);
133
134
135
136
137
138
139
140
141
/* Ends C function definitions when using C++ */
#ifdef __cplusplus
/* *INDENT-OFF* */
}
/* *INDENT-ON* */
#endif
#include "close_code.h"
#endif /* _SDL_shape_h */