1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
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
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
|
/* ScummVM - Graphic Adventure Engine
*
* ScummVM is the legal property of its developers, whose names
* are too numerous to list here. Please refer to the COPYRIGHT
* file distributed with this source distribution.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
#ifndef BACKENDS_PLATFORM_SDL_WINDOW_H
#define BACKENDS_PLATFORM_SDL_WINDOW_H
#include "backends/platform/sdl/sdl-sys.h"
#include "common/rect.h"
#include "common/str.h"
class SdlWindow {
public:
SdlWindow();
virtual ~SdlWindow();
/**
* Setup the window icon.
*/
virtual void setupIcon();
/**
* Change the caption of the window.
*
* @param caption New window caption in UTF-8 encoding.
*/
void setWindowCaption(const Common::String &caption);
/**
* Grab or ungrab the mouse cursor. This decides whether the cursor can leave
* the window or not.
*/
void grabMouse(bool grab);
/**
* Specify the area of the window to confine the mouse cursor.
*/
void setMouseRect(const Common::Rect &rect);
/**
* Lock or unlock the mouse cursor within the window.
*/
bool lockMouse(bool lock);
/**
* Check whether the application has mouse focus.
*/
bool hasMouseFocus() const;
/**
* Warp the mouse to the specified position in window coordinates. The mouse
* will only be warped if the window is focused in the window manager.
*
* @returns true if the system cursor was warped.
*/
bool warpMouseInWindow(int x, int y);
/**
* Iconifies the window.
*/
void iconifyWindow();
/**
* Query platform specific SDL window manager information.
*
* Since this is an SDL internal structure clients are responsible
* for accessing it in a version safe manner.
*/
bool getSDLWMInformation(SDL_SysWMinfo *info) const;
/*
* Retrieve the current desktop resolution.
*/
Common::Rect getDesktopResolution();
/*
* Get the scaling between the SDL Window size and the SDL
* drawable area size. On some system, when HiDPI support is
* enabled, those two sizes are different.
*
* To convert from window coordinate to drawable area coordinate,
* multiple the coordinate by this scaling factor. To convert
* from drawable area coordinate to window coordinate, divide the
* coordinate by this scaling factor.
*/
float getSdlDpiScalingFactor() const;
/**
* Returns the scaling mode based on the display DPI
*/
virtual float getDpiScalingFactor() const;
bool mouseIsGrabbed() const {
#if SDL_VERSION_ATLEAST(2, 0, 0)
if (_window) {
return SDL_GetWindowGrab(_window) == SDL_TRUE;
}
#endif
return _inputGrabState;
}
bool mouseIsLocked() const {
#if SDL_VERSION_ATLEAST(2, 0, 0)
return SDL_GetRelativeMouseMode() == SDL_TRUE;
#else
return _inputLockState;
#endif
}
private:
Common::Rect _desktopRes;
bool _inputGrabState, _inputLockState;
SDL_Rect grabRect;
protected:
void getDisplayDpi(float *dpi, float *defaultDpi) const;
#if SDL_VERSION_ATLEAST(2, 0, 0)
public:
/**
* @return The window ScummVM has setup with SDL.
*/
SDL_Window *getSDLWindow() const { return _window; }
/**
* @return The display containing the ScummVM window.
*/
int getDisplayIndex() const;
/**
* Creates or updates the SDL window.
*
* @param width Width of the window.
* @param height Height of the window.
* @param flags SDL flags passed to SDL_CreateWindow
* @return true on success, false otherwise
*/
virtual bool createOrUpdateWindow(int width, int height, uint32 flags);
/**
* Destroys the current SDL window.
*/
void destroyWindow();
protected:
SDL_Window *_window;
private:
uint32 _lastFlags;
/**
* Switching between software and OpenGL modes requires the window to be
* destroyed and recreated. These properties store the position of the last
* window so the new window will be created in the same place.
*/
int _lastX, _lastY;
Common::String _windowCaption;
#endif
};
class SdlIconlessWindow : public SdlWindow {
public:
virtual void setupIcon() {}
};
#endif
|
