CoCalc -- display_server

GitHub Repository: godotengine/godot
Path: blob/master/platform/android/display_server_android.h
²⁰⁸⁴³ views
1
/**************************************************************************/
2
/*  display_server_android.h                                              */
3
/**************************************************************************/
4
/*                         This file is part of:                          */
5
/*                             GODOT ENGINE                               */
6
/*                        https://godotengine.org                         */
7
/**************************************************************************/
8
/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
9
/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur.                  */
10
/*                                                                        */
11
/* Permission is hereby granted, free of charge, to any person obtaining  */
12
/* a copy of this software and associated documentation files (the        */
13
/* "Software"), to deal in the Software without restriction, including    */
14
/* without limitation the rights to use, copy, modify, merge, publish,    */
15
/* distribute, sublicense, and/or sell copies of the Software, and to     */
16
/* permit persons to whom the Software is furnished to do so, subject to  */
17
/* the following conditions:                                              */
18
/*                                                                        */
19
/* The above copyright notice and this permission notice shall be         */
20
/* included in all copies or substantial portions of the Software.        */
21
/*                                                                        */
22
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,        */
23
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF     */
24
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
25
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY   */
26
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,   */
27
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE      */
28
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.                 */
29
/**************************************************************************/
30

31
#pragma once
32

33
#include "core/input/input_event.h"
34
#include "servers/display/display_server.h"
35

36
#if defined(RD_ENABLED)
37
class RenderingContextDriver;
38
class RenderingDevice;
39
#endif
40

41
class DisplayServerAndroid : public DisplayServer {
42
	GDSOFTCLASS(DisplayServerAndroid, DisplayServer);
43

44
	String rendering_driver;
45

46
	// https://developer.android.com/reference/android/view/PointerIcon
47
	// mapping between Godot's cursor shape to Android's'
48
	int android_cursors[CURSOR_MAX] = {
49
		1000, //CURSOR_ARROW
50
		1008, //CURSOR_IBEAM
51
		1002, //CURSOR_POINTIN
52
		1007, //CURSOR_CROSS
53
		1004, //CURSOR_WAIT
54
		1004, //CURSOR_BUSY
55
		1021, //CURSOR_DRAG
56
		1021, //CURSOR_CAN_DRO
57
		1000, //CURSOR_FORBIDD (no corresponding icon in Android's icon so fallback to default)
58
		1015, //CURSOR_VSIZE
59
		1014, //CURSOR_HSIZE
60
		1017, //CURSOR_BDIAGSI
61
		1016, //CURSOR_FDIAGSI
62
		1020, //CURSOR_MOVE
63
		1015, //CURSOR_VSPLIT
64
		1014, //CURSOR_HSPLIT
65
		1003, //CURSOR_HELP
66
	};
67
	const int CURSOR_TYPE_NULL = 0;
68
	MouseMode mouse_mode = MouseMode::MOUSE_MODE_VISIBLE;
69
	MouseMode mouse_mode_base = MouseMode::MOUSE_MODE_VISIBLE;
70
	MouseMode mouse_mode_override = MouseMode::MOUSE_MODE_VISIBLE;
71
	bool mouse_mode_override_enabled = false;
72
	void _mouse_update_mode();
73

74
	bool keep_screen_on;
75
	bool swap_buffers_flag;
76

77
	CursorShape cursor_shape = CursorShape::CURSOR_ARROW;
78

79
#if defined(RD_ENABLED)
80
	RenderingDevice *rendering_device = nullptr;
81
#endif
82
	NativeMenu *native_menu = nullptr;
83

84
	ObjectID window_attached_instance_id;
85

86
	Callable window_event_callback;
87
	Callable input_event_callback;
88
	Callable input_text_callback;
89
	Callable rect_changed_callback;
90

91
	Callable system_theme_changed;
92
	Callable hardware_keyboard_connection_changed;
93

94
	Callable dialog_callback;
95
	Callable input_dialog_callback;
96

97
	Callable file_picker_callback;
98

99
	template <typename... Args>
100
	void _window_callback(const Callable &p_callable, bool p_deferred, const Args &...p_rest_args) const;
101

102
	static void _dispatch_input_events(const Ref<InputEvent> &p_event);
103

104
public:
105
	static DisplayServerAndroid *get_singleton();
106

107
	virtual bool has_feature(Feature p_feature) const override;
108
	virtual String get_name() const override;
109

110
	virtual bool tts_is_speaking() const override;
111
	virtual bool tts_is_paused() const override;
112
	virtual TypedArray<Dictionary> tts_get_voices() const override;
113

114
	virtual void tts_speak(const String &p_text, const String &p_voice, int p_volume = 50, float p_pitch = 1.f, float p_rate = 1.f, int64_t p_utterance_id = 0, bool p_interrupt = false) override;
115
	virtual void tts_pause() override;
116
	virtual void tts_resume() override;
117
	virtual void tts_stop() override;
118

119
	virtual bool is_dark_mode_supported() const override;
120
	virtual bool is_dark_mode() const override;
121
	virtual void set_system_theme_change_callback(const Callable &p_callable) override;
122
	void emit_system_theme_changed();
123

124
	virtual void clipboard_set(const String &p_text) override;
125
	virtual String clipboard_get() const override;
126
	virtual bool clipboard_has() const override;
127

128
	virtual Error dialog_show(String p_title, String p_description, Vector<String> p_buttons, const Callable &p_callback) override;
129
	void emit_dialog_callback(int p_button_index);
130

131
	virtual Error dialog_input_text(String p_title, String p_description, String p_partial, const Callable &p_callback) override;
132
	void emit_input_dialog_callback(String p_text);
133

134
	virtual Error file_dialog_show(const String &p_title, const String &p_current_directory, const String &p_filename, bool p_show_hidden, const FileDialogMode p_mode, const Vector<String> &p_filters, const Callable &p_callback, WindowID p_window_id) override;
135
	void emit_file_picker_callback(bool p_ok, const Vector<String> &p_selected_paths);
136

137
	virtual Color get_accent_color() const override;
138
	virtual Color get_base_color() const override;
139

140
	virtual TypedArray<Rect2> get_display_cutouts() const override;
141
	virtual Rect2i get_display_safe_area() const override;
142

143
	virtual void screen_set_keep_on(bool p_enable) override;
144
	virtual bool screen_is_kept_on() const override;
145

146
	virtual void screen_set_orientation(ScreenOrientation p_orientation, int p_screen = SCREEN_OF_MAIN_WINDOW) override;
147
	virtual ScreenOrientation screen_get_orientation(int p_screen = SCREEN_OF_MAIN_WINDOW) const override;
148
	int get_display_rotation() const;
149

150
	virtual int get_screen_count() const override;
151
	virtual int get_primary_screen() const override;
152
	virtual Point2i screen_get_position(int p_screen = SCREEN_OF_MAIN_WINDOW) const override;
153
	virtual Size2i screen_get_size(int p_screen = SCREEN_OF_MAIN_WINDOW) const override;
154
	virtual Rect2i screen_get_usable_rect(int p_screen = SCREEN_OF_MAIN_WINDOW) const override;
155
	virtual int screen_get_dpi(int p_screen = SCREEN_OF_MAIN_WINDOW) const override;
156
	virtual float screen_get_scale(int p_screen = SCREEN_OF_MAIN_WINDOW) const override;
157
	virtual float screen_get_refresh_rate(int p_screen = SCREEN_OF_MAIN_WINDOW) const override;
158
	virtual bool is_touchscreen_available() const override;
159

160
	virtual void virtual_keyboard_show(const String &p_existing_text, const Rect2 &p_screen_rect = Rect2(), VirtualKeyboardType p_type = KEYBOARD_TYPE_DEFAULT, int p_max_length = -1, int p_cursor_start = -1, int p_cursor_end = -1) override;
161
	virtual void virtual_keyboard_hide() override;
162
	virtual int virtual_keyboard_get_height() const override;
163
	virtual bool has_hardware_keyboard() const override;
164
	virtual void set_hardware_keyboard_connection_change_callback(const Callable &p_callable) override;
165
	void emit_hardware_keyboard_connection_changed(bool p_connected);
166

167
	virtual void window_set_window_event_callback(const Callable &p_callable, WindowID p_window = MAIN_WINDOW_ID) override;
168
	virtual void window_set_input_event_callback(const Callable &p_callable, WindowID p_window = MAIN_WINDOW_ID) override;
169
	virtual void window_set_input_text_callback(const Callable &p_callable, WindowID p_window = MAIN_WINDOW_ID) override;
170
	virtual void window_set_rect_changed_callback(const Callable &p_callable, WindowID p_window = MAIN_WINDOW_ID) override;
171
	virtual void window_set_drop_files_callback(const Callable &p_callable, WindowID p_window = MAIN_WINDOW_ID) override;
172

173
	void send_window_event(WindowEvent p_event, bool p_deferred = false) const;
174
	void send_input_event(const Ref<InputEvent> &p_event) const;
175
	void send_input_text(const String &p_text) const;
176

177
	virtual Vector<WindowID> get_window_list() const override;
178
	virtual WindowID get_window_at_screen_position(const Point2i &p_position) const override;
179

180
	virtual int64_t window_get_native_handle(HandleType p_handle_type, WindowID p_window = MAIN_WINDOW_ID) const override;
181

182
	virtual void window_attach_instance_id(ObjectID p_instance, WindowID p_window = MAIN_WINDOW_ID) override;
183
	virtual ObjectID window_get_attached_instance_id(WindowID p_window = MAIN_WINDOW_ID) const override;
184
	virtual void window_set_title(const String &p_title, WindowID p_window = MAIN_WINDOW_ID) override;
185

186
	virtual int window_get_current_screen(WindowID p_window = MAIN_WINDOW_ID) const override;
187
	virtual void window_set_current_screen(int p_screen, WindowID p_window = MAIN_WINDOW_ID) override;
188

189
	virtual Point2i window_get_position(WindowID p_window = MAIN_WINDOW_ID) const override;
190
	virtual Point2i window_get_position_with_decorations(WindowID p_window = MAIN_WINDOW_ID) const override;
191
	virtual void window_set_position(const Point2i &p_position, WindowID p_window = MAIN_WINDOW_ID) override;
192

193
	virtual void window_set_transient(WindowID p_window, WindowID p_parent) override;
194

195
	virtual void window_set_max_size(const Size2i p_size, WindowID p_window = MAIN_WINDOW_ID) override;
196
	virtual Size2i window_get_max_size(WindowID p_window = MAIN_WINDOW_ID) const override;
197

198
	virtual void window_set_min_size(const Size2i p_size, WindowID p_window = MAIN_WINDOW_ID) override;
199
	virtual Size2i window_get_min_size(WindowID p_window = MAIN_WINDOW_ID) const override;
200

201
	virtual void window_set_size(const Size2i p_size, WindowID p_window = MAIN_WINDOW_ID) override;
202
	virtual Size2i window_get_size(WindowID p_window = MAIN_WINDOW_ID) const override;
203
	virtual Size2i window_get_size_with_decorations(WindowID p_window = MAIN_WINDOW_ID) const override;
204

205
	virtual void window_set_mode(WindowMode p_mode, WindowID p_window = MAIN_WINDOW_ID) override;
206
	virtual WindowMode window_get_mode(WindowID p_window = MAIN_WINDOW_ID) const override;
207

208
	virtual bool window_is_maximize_allowed(WindowID p_window = MAIN_WINDOW_ID) const override;
209

210
	virtual void window_set_flag(WindowFlags p_flag, bool p_enabled, WindowID p_window = MAIN_WINDOW_ID) override;
211
	virtual bool window_get_flag(WindowFlags p_flag, WindowID p_window = MAIN_WINDOW_ID) const override;
212

213
	virtual void window_request_attention(WindowID p_window = MAIN_WINDOW_ID) override;
214
	virtual void window_move_to_foreground(WindowID p_window = MAIN_WINDOW_ID) override;
215
	virtual bool window_is_focused(WindowID p_window = MAIN_WINDOW_ID) const override;
216

217
	virtual bool window_can_draw(WindowID p_window = MAIN_WINDOW_ID) const override;
218

219
	virtual bool can_any_window_draw() const override;
220

221
	virtual void window_set_vsync_mode(DisplayServer::VSyncMode p_vsync_mode, WindowID p_window = MAIN_WINDOW_ID) override;
222
	virtual DisplayServer::VSyncMode window_get_vsync_mode(WindowID p_vsync_mode) const override;
223

224
	virtual void window_set_color(const Color &p_color) override;
225

226
	virtual void process_events() override;
227

228
	void process_accelerometer(const Vector3 &p_accelerometer);
229
	void process_gravity(const Vector3 &p_gravity);
230
	void process_magnetometer(const Vector3 &p_magnetometer);
231
	void process_gyroscope(const Vector3 &p_gyroscope);
232

233
	void _cursor_set_shape_helper(CursorShape p_shape, bool force = false);
234
	virtual void cursor_set_shape(CursorShape p_shape) override;
235
	virtual CursorShape cursor_get_shape() const override;
236
	virtual void cursor_set_custom_image(const Ref<Resource> &p_cursor, CursorShape p_shape = CURSOR_ARROW, const Vector2 &p_hotspot = Vector2()) override;
237

238
	virtual void mouse_set_mode(MouseMode p_mode) override;
239
	virtual MouseMode mouse_get_mode() const override;
240
	virtual void mouse_set_mode_override(MouseMode p_mode) override;
241
	virtual MouseMode mouse_get_mode_override() const override;
242
	virtual void mouse_set_mode_override_enabled(bool p_override_enabled) override;
243
	virtual bool mouse_is_mode_override_enabled() const override;
244

245
	static DisplayServer *create_func(const String &p_rendering_driver, WindowMode p_mode, DisplayServer::VSyncMode p_vsync_mode, uint32_t p_flags, const Vector2i *p_position, const Vector2i &p_resolution, int p_screen, Context p_context, int64_t p_parent_window, Error &r_error);
246
	static Vector<String> get_rendering_drivers_func();
247
	static void register_android_driver();
248

249
#ifdef VULKAN_ENABLED
250
	static bool check_vulkan_global_context(bool p_vulkan_requirements_met);
251
	static void free_vulkan_global_context();
252
#endif
253

254
	void reset_window();
255
	void notify_surface_changed(int p_width, int p_height);
256
	void notify_application_paused();
257

258
	virtual Point2i mouse_get_position() const override;
259
	virtual BitField<MouseButtonMask> mouse_get_button_state() const override;
260

261
	void reset_swap_buffers_flag();
262
	bool should_swap_buffers() const;
263
	virtual void swap_buffers() override;
264

265
	virtual void set_native_icon(const String &p_filename) override;
266
	virtual void set_icon(const Ref<Image> &p_icon) override;
267

268
	virtual bool is_window_transparency_available() const override;
269

270
	DisplayServerAndroid(const String &p_rendering_driver, WindowMode p_mode, DisplayServer::VSyncMode p_vsync_mode, uint32_t p_flags, const Vector2i *p_position, const Vector2i &p_resolution, int p_screen, Context p_context, int64_t p_parent_window, Error &r_error);
271
	~DisplayServerAndroid();
272
};
273

274
Product

Resources

Company
