Book a Demo!
CoCalc Logo Icon
StoreFeaturesDocsShareSupportNewsAboutPoliciesSign UpSign In
godotengine
GitHub Repository: godotengine/godot
Path: blob/master/servers/display/display_server.h
21158 views
1
/**************************************************************************/
2
/* display_server.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 "core/io/image.h"
35
#include "core/io/resource.h"
36
#include "core/os/os.h"
37
#include "core/templates/rb_map.h"
38
#include "core/templates/rb_set.h"
39
#include "core/variant/callable.h"
40
#include "core/variant/typed_array.h"
41
#include "servers/display/native_menu.h"
42
43
class Texture2D;
44
class AccessibilityDriver;
45
46
namespace InputClassEnums {
47
enum MouseMode : int;
48
enum CursorShape : int;
49
} //namespace InputClassEnums
50
51
class DisplayServer : public Object {
52
GDCLASS(DisplayServer, Object)
53
54
static DisplayServer *singleton;
55
static bool hidpi_allowed;
56
57
#ifndef DISABLE_DEPRECATED
58
mutable HashMap<String, RID> menu_names;
59
60
RID _get_rid_from_name(NativeMenu *p_nmenu, const String &p_menu_root) const;
61
RID _accessibility_create_sub_text_edit_elements_bind_compat_113459(const RID &p_parent_rid, const RID &p_shaped_text, float p_min_height, int p_insert_pos = -1);
62
#endif
63
64
LocalVector<ObjectID> additional_outputs;
65
66
public:
67
_FORCE_INLINE_ static DisplayServer *get_singleton() {
68
return singleton;
69
}
70
71
enum WindowMode {
72
WINDOW_MODE_WINDOWED,
73
WINDOW_MODE_MINIMIZED,
74
WINDOW_MODE_MAXIMIZED,
75
WINDOW_MODE_FULLSCREEN,
76
WINDOW_MODE_EXCLUSIVE_FULLSCREEN,
77
};
78
79
// Keep the VSyncMode enum values in sync with the `display/window/vsync/vsync_mode`
80
// project setting hint.
81
enum VSyncMode {
82
VSYNC_DISABLED,
83
VSYNC_ENABLED,
84
VSYNC_ADAPTIVE,
85
VSYNC_MAILBOX
86
};
87
88
enum HandleType {
89
DISPLAY_HANDLE,
90
WINDOW_HANDLE,
91
WINDOW_VIEW,
92
OPENGL_CONTEXT,
93
EGL_DISPLAY,
94
EGL_CONFIG,
95
};
96
97
enum Context {
98
CONTEXT_EDITOR,
99
CONTEXT_PROJECTMAN,
100
CONTEXT_ENGINE,
101
};
102
103
typedef DisplayServer *(*CreateFunction)(const String &, WindowMode, VSyncMode, uint32_t, const Point2i *, const Size2i &, int p_screen, Context, int64_t p_parent_window, Error &r_error);
104
typedef Vector<String> (*GetRenderingDriversFunction)();
105
106
private:
107
static void _input_set_mouse_mode(InputClassEnums::MouseMode p_mode);
108
static InputClassEnums::MouseMode _input_get_mouse_mode();
109
static void _input_set_mouse_mode_override(InputClassEnums::MouseMode p_mode);
110
static InputClassEnums::MouseMode _input_get_mouse_mode_override();
111
static void _input_set_mouse_mode_override_enabled(bool p_enabled);
112
static bool _input_is_mouse_mode_override_enabled();
113
static void _input_warp(const Vector2 &p_to_pos);
114
static InputClassEnums::CursorShape _input_get_current_cursor_shape();
115
static void _input_set_custom_mouse_cursor_func(const Ref<Resource> &, InputClassEnums::CursorShape, const Vector2 &p_hotspot);
116
117
protected:
118
static void _bind_methods();
119
120
#ifndef DISABLE_DEPRECATED
121
static void _bind_compatibility_methods();
122
#endif
123
124
static Ref<Image> _get_cursor_image_from_resource(const Ref<Resource> &p_cursor, const Vector2 &p_hotspot);
125
126
enum {
127
MAX_SERVERS = 64
128
};
129
130
struct DisplayServerCreate {
131
const char *name;
132
CreateFunction create_function;
133
GetRenderingDriversFunction get_rendering_drivers_function;
134
};
135
136
static DisplayServerCreate server_create_functions[MAX_SERVERS];
137
static int server_create_count;
138
139
friend class RendererViewport;
140
141
public:
142
enum Feature {
143
#ifndef DISABLE_DEPRECATED
144
FEATURE_GLOBAL_MENU,
145
#endif
146
FEATURE_SUBWINDOWS,
147
FEATURE_TOUCHSCREEN,
148
FEATURE_MOUSE,
149
FEATURE_MOUSE_WARP,
150
FEATURE_CLIPBOARD,
151
FEATURE_VIRTUAL_KEYBOARD,
152
FEATURE_CURSOR_SHAPE,
153
FEATURE_CUSTOM_CURSOR_SHAPE,
154
FEATURE_NATIVE_DIALOG,
155
FEATURE_IME,
156
FEATURE_WINDOW_TRANSPARENCY,
157
FEATURE_HIDPI,
158
FEATURE_ICON,
159
FEATURE_NATIVE_ICON,
160
FEATURE_ORIENTATION,
161
FEATURE_SWAP_BUFFERS,
162
FEATURE_KEEP_SCREEN_ON,
163
FEATURE_CLIPBOARD_PRIMARY,
164
FEATURE_TEXT_TO_SPEECH,
165
FEATURE_EXTEND_TO_TITLE,
166
FEATURE_SCREEN_CAPTURE,
167
FEATURE_STATUS_INDICATOR,
168
FEATURE_NATIVE_HELP,
169
FEATURE_NATIVE_DIALOG_INPUT,
170
FEATURE_NATIVE_DIALOG_FILE,
171
FEATURE_NATIVE_DIALOG_FILE_EXTRA,
172
FEATURE_WINDOW_DRAG,
173
FEATURE_SCREEN_EXCLUDE_FROM_CAPTURE,
174
FEATURE_WINDOW_EMBEDDING,
175
FEATURE_NATIVE_DIALOG_FILE_MIME,
176
FEATURE_EMOJI_AND_SYMBOL_PICKER,
177
FEATURE_NATIVE_COLOR_PICKER,
178
FEATURE_SELF_FITTING_WINDOWS,
179
FEATURE_ACCESSIBILITY_SCREEN_READER,
180
};
181
182
virtual bool has_feature(Feature p_feature) const = 0;
183
virtual String get_name() const = 0;
184
185
virtual void help_set_search_callbacks(const Callable &p_search_callback = Callable(), const Callable &p_action_callback = Callable());
186
187
#ifndef DISABLE_DEPRECATED
188
virtual void global_menu_set_popup_callbacks(const String &p_menu_root, const Callable &p_open_callback = Callable(), const Callable &p_close_callback = Callable());
189
190
virtual int global_menu_add_submenu_item(const String &p_menu_root, const String &p_label, const String &p_submenu, int p_index = -1);
191
virtual int global_menu_add_item(const String &p_menu_root, const String &p_label, const Callable &p_callback = Callable(), const Callable &p_key_callback = Callable(), const Variant &p_tag = Variant(), Key p_accel = Key::NONE, int p_index = -1);
192
virtual int global_menu_add_check_item(const String &p_menu_root, const String &p_label, const Callable &p_callback = Callable(), const Callable &p_key_callback = Callable(), const Variant &p_tag = Variant(), Key p_accel = Key::NONE, int p_index = -1);
193
virtual int global_menu_add_icon_item(const String &p_menu_root, const Ref<Texture2D> &p_icon, const String &p_label, const Callable &p_callback = Callable(), const Callable &p_key_callback = Callable(), const Variant &p_tag = Variant(), Key p_accel = Key::NONE, int p_index = -1);
194
virtual int global_menu_add_icon_check_item(const String &p_menu_root, const Ref<Texture2D> &p_icon, const String &p_label, const Callable &p_callback = Callable(), const Callable &p_key_callback = Callable(), const Variant &p_tag = Variant(), Key p_accel = Key::NONE, int p_index = -1);
195
virtual int global_menu_add_radio_check_item(const String &p_menu_root, const String &p_label, const Callable &p_callback = Callable(), const Callable &p_key_callback = Callable(), const Variant &p_tag = Variant(), Key p_accel = Key::NONE, int p_index = -1);
196
virtual int global_menu_add_icon_radio_check_item(const String &p_menu_root, const Ref<Texture2D> &p_icon, const String &p_label, const Callable &p_callback = Callable(), const Callable &p_key_callback = Callable(), const Variant &p_tag = Variant(), Key p_accel = Key::NONE, int p_index = -1);
197
virtual int global_menu_add_multistate_item(const String &p_menu_root, const String &p_label, int p_max_states, int p_default_state, const Callable &p_callback = Callable(), const Callable &p_key_callback = Callable(), const Variant &p_tag = Variant(), Key p_accel = Key::NONE, int p_index = -1);
198
virtual int global_menu_add_separator(const String &p_menu_root, int p_index = -1);
199
200
virtual int global_menu_get_item_index_from_text(const String &p_menu_root, const String &p_text) const;
201
virtual int global_menu_get_item_index_from_tag(const String &p_menu_root, const Variant &p_tag) const;
202
203
virtual bool global_menu_is_item_checked(const String &p_menu_root, int p_idx) const;
204
virtual bool global_menu_is_item_checkable(const String &p_menu_root, int p_idx) const;
205
virtual bool global_menu_is_item_radio_checkable(const String &p_menu_root, int p_idx) const;
206
virtual Callable global_menu_get_item_callback(const String &p_menu_root, int p_idx) const;
207
virtual Callable global_menu_get_item_key_callback(const String &p_menu_root, int p_idx) const;
208
virtual Variant global_menu_get_item_tag(const String &p_menu_root, int p_idx) const;
209
virtual String global_menu_get_item_text(const String &p_menu_root, int p_idx) const;
210
virtual String global_menu_get_item_submenu(const String &p_menu_root, int p_idx) const;
211
virtual Key global_menu_get_item_accelerator(const String &p_menu_root, int p_idx) const;
212
virtual bool global_menu_is_item_disabled(const String &p_menu_root, int p_idx) const;
213
virtual bool global_menu_is_item_hidden(const String &p_menu_root, int p_idx) const;
214
virtual String global_menu_get_item_tooltip(const String &p_menu_root, int p_idx) const;
215
virtual int global_menu_get_item_state(const String &p_menu_root, int p_idx) const;
216
virtual int global_menu_get_item_max_states(const String &p_menu_root, int p_idx) const;
217
virtual Ref<Texture2D> global_menu_get_item_icon(const String &p_menu_root, int p_idx) const;
218
virtual int global_menu_get_item_indentation_level(const String &p_menu_root, int p_idx) const;
219
220
virtual void global_menu_set_item_checked(const String &p_menu_root, int p_idx, bool p_checked);
221
virtual void global_menu_set_item_checkable(const String &p_menu_root, int p_idx, bool p_checkable);
222
virtual void global_menu_set_item_radio_checkable(const String &p_menu_root, int p_idx, bool p_checkable);
223
virtual void global_menu_set_item_callback(const String &p_menu_root, int p_idx, const Callable &p_callback);
224
virtual void global_menu_set_item_key_callback(const String &p_menu_root, int p_idx, const Callable &p_key_callback);
225
virtual void global_menu_set_item_hover_callbacks(const String &p_menu_root, int p_idx, const Callable &p_callback);
226
virtual void global_menu_set_item_tag(const String &p_menu_root, int p_idx, const Variant &p_tag);
227
virtual void global_menu_set_item_text(const String &p_menu_root, int p_idx, const String &p_text);
228
virtual void global_menu_set_item_submenu(const String &p_menu_root, int p_idx, const String &p_submenu);
229
virtual void global_menu_set_item_accelerator(const String &p_menu_root, int p_idx, Key p_keycode);
230
virtual void global_menu_set_item_disabled(const String &p_menu_root, int p_idx, bool p_disabled);
231
virtual void global_menu_set_item_hidden(const String &p_menu_root, int p_idx, bool p_hidden);
232
virtual void global_menu_set_item_tooltip(const String &p_menu_root, int p_idx, const String &p_tooltip);
233
virtual void global_menu_set_item_state(const String &p_menu_root, int p_idx, int p_state);
234
virtual void global_menu_set_item_max_states(const String &p_menu_root, int p_idx, int p_max_states);
235
virtual void global_menu_set_item_icon(const String &p_menu_root, int p_idx, const Ref<Texture2D> &p_icon);
236
virtual void global_menu_set_item_indentation_level(const String &p_menu_root, int p_idx, int p_level);
237
238
virtual int global_menu_get_item_count(const String &p_menu_root) const;
239
240
virtual void global_menu_remove_item(const String &p_menu_root, int p_idx);
241
virtual void global_menu_clear(const String &p_menu_root);
242
243
virtual Dictionary global_menu_get_system_menu_roots() const;
244
#endif
245
246
struct TTSUtterance {
247
String text;
248
String voice;
249
int volume = 50;
250
float pitch = 1.f;
251
float rate = 1.f;
252
int64_t id = 0;
253
};
254
255
enum TTSUtteranceEvent {
256
TTS_UTTERANCE_STARTED,
257
TTS_UTTERANCE_ENDED,
258
TTS_UTTERANCE_CANCELED,
259
TTS_UTTERANCE_BOUNDARY,
260
TTS_UTTERANCE_MAX,
261
};
262
263
private:
264
Callable utterance_callback[TTS_UTTERANCE_MAX];
265
266
public:
267
virtual bool tts_is_speaking() const;
268
virtual bool tts_is_paused() const;
269
virtual TypedArray<Dictionary> tts_get_voices() const;
270
virtual PackedStringArray tts_get_voices_for_language(const String &p_language) const;
271
272
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);
273
virtual void tts_pause();
274
virtual void tts_resume();
275
virtual void tts_stop();
276
277
virtual void tts_set_utterance_callback(TTSUtteranceEvent p_event, const Callable &p_callable);
278
virtual void tts_post_utterance_event(TTSUtteranceEvent p_event, int64_t p_id, int p_pos = 0);
279
280
virtual bool is_dark_mode_supported() const { return false; }
281
virtual bool is_dark_mode() const { return false; }
282
virtual Color get_accent_color() const { return Color(0, 0, 0, 0); }
283
virtual Color get_base_color() const { return Color(0, 0, 0, 0); }
284
virtual void set_system_theme_change_callback(const Callable &p_callable) {}
285
virtual void set_hardware_keyboard_connection_change_callback(const Callable &p_callable) {}
286
287
private:
288
static bool window_early_clear_override_enabled;
289
static Color window_early_clear_override_color;
290
291
protected:
292
static bool _get_window_early_clear_override(Color &r_color);
293
294
public:
295
static void set_early_window_clear_color_override(bool p_enabled, Color p_color = Color(0, 0, 0, 0));
296
297
enum MouseMode {
298
MOUSE_MODE_VISIBLE, // Input::MouseMode::MOUSE_MODE_VISIBLE
299
MOUSE_MODE_HIDDEN, // Input::MouseMode::MOUSE_MODE_HIDDEN
300
MOUSE_MODE_CAPTURED, // Input::MouseMode::MOUSE_MODE_CAPTURED
301
MOUSE_MODE_CONFINED, // Input::MouseMode::MOUSE_MODE_CONFINED
302
MOUSE_MODE_CONFINED_HIDDEN, // Input::MouseMode::MOUSE_MODE_CONFINED_HIDDEN
303
MOUSE_MODE_MAX, // Input::MouseMode::MOUSE_MODE_MAX
304
};
305
306
virtual void mouse_set_mode(MouseMode p_mode);
307
virtual MouseMode mouse_get_mode() const;
308
virtual void mouse_set_mode_override(MouseMode p_mode);
309
virtual MouseMode mouse_get_mode_override() const;
310
virtual void mouse_set_mode_override_enabled(bool p_override_enabled);
311
virtual bool mouse_is_mode_override_enabled() const;
312
313
virtual void warp_mouse(const Point2i &p_position);
314
virtual Point2i mouse_get_position() const;
315
virtual BitField<MouseButtonMask> mouse_get_button_state() const;
316
317
virtual void clipboard_set(const String &p_text);
318
virtual String clipboard_get() const;
319
virtual Ref<Image> clipboard_get_image() const;
320
virtual bool clipboard_has() const;
321
virtual bool clipboard_has_image() const;
322
virtual void clipboard_set_primary(const String &p_text);
323
virtual String clipboard_get_primary() const;
324
325
virtual TypedArray<Rect2> get_display_cutouts() const { return TypedArray<Rect2>(); }
326
virtual Rect2i get_display_safe_area() const { return screen_get_usable_rect(); }
327
328
enum {
329
INVALID_SCREEN = -1,
330
SCREEN_WITH_MOUSE_FOCUS = -4,
331
SCREEN_WITH_KEYBOARD_FOCUS = -3,
332
SCREEN_PRIMARY = -2,
333
SCREEN_OF_MAIN_WINDOW = -1, // Note: for the main window, determine screen from position.
334
};
335
336
const float SCREEN_REFRESH_RATE_FALLBACK = -1.0; // Returned by screen_get_refresh_rate if the method fails.
337
338
int _get_screen_index(int p_screen) const {
339
switch (p_screen) {
340
case SCREEN_WITH_MOUSE_FOCUS: {
341
const Rect2i rect = Rect2i(mouse_get_position(), Vector2i(1, 1));
342
return get_screen_from_rect(rect);
343
} break;
344
case SCREEN_WITH_KEYBOARD_FOCUS: {
345
return get_keyboard_focus_screen();
346
} break;
347
case SCREEN_PRIMARY: {
348
return get_primary_screen();
349
} break;
350
case SCREEN_OF_MAIN_WINDOW: {
351
return window_get_current_screen(MAIN_WINDOW_ID);
352
} break;
353
default: {
354
return p_screen;
355
} break;
356
}
357
}
358
359
virtual int get_screen_count() const = 0;
360
virtual int get_primary_screen() const = 0;
361
virtual int get_keyboard_focus_screen() const { return get_primary_screen(); }
362
virtual int get_screen_from_rect(const Rect2 &p_rect) const;
363
virtual Point2i screen_get_position(int p_screen = SCREEN_OF_MAIN_WINDOW) const = 0;
364
virtual Size2i screen_get_size(int p_screen = SCREEN_OF_MAIN_WINDOW) const = 0;
365
virtual Rect2i screen_get_usable_rect(int p_screen = SCREEN_OF_MAIN_WINDOW) const = 0;
366
virtual int screen_get_dpi(int p_screen = SCREEN_OF_MAIN_WINDOW) const = 0;
367
virtual float screen_get_scale(int p_screen = SCREEN_OF_MAIN_WINDOW) const;
368
virtual float screen_get_max_scale() const {
369
float max_scale = 1.f;
370
int screen_count = get_screen_count();
371
for (int i = 0; i < screen_count; i++) {
372
max_scale = std::fmax(max_scale, screen_get_scale(i));
373
}
374
return max_scale;
375
}
376
virtual float screen_get_refresh_rate(int p_screen = SCREEN_OF_MAIN_WINDOW) const = 0;
377
virtual Color screen_get_pixel(const Point2i &p_position) const { return Color(); }
378
virtual Ref<Image> screen_get_image(int p_screen = SCREEN_OF_MAIN_WINDOW) const { return Ref<Image>(); }
379
virtual Ref<Image> screen_get_image_rect(const Rect2i &p_rect) const { return Ref<Image>(); }
380
virtual bool is_touchscreen_available() const;
381
382
// Keep the ScreenOrientation enum values in sync with the `display/window/handheld/orientation`
383
// project setting hint.
384
enum ScreenOrientation {
385
SCREEN_LANDSCAPE,
386
SCREEN_PORTRAIT,
387
SCREEN_REVERSE_LANDSCAPE,
388
SCREEN_REVERSE_PORTRAIT,
389
SCREEN_SENSOR_LANDSCAPE,
390
SCREEN_SENSOR_PORTRAIT,
391
SCREEN_SENSOR,
392
};
393
394
virtual void screen_set_orientation(ScreenOrientation p_orientation, int p_screen = SCREEN_OF_MAIN_WINDOW);
395
virtual ScreenOrientation screen_get_orientation(int p_screen = SCREEN_OF_MAIN_WINDOW) const;
396
397
virtual void screen_set_keep_on(bool p_enable); //disable screensaver
398
virtual bool screen_is_kept_on() const;
399
enum {
400
MAIN_WINDOW_ID = 0,
401
INVALID_WINDOW_ID = -1,
402
INVALID_INDICATOR_ID = -1
403
};
404
405
public:
406
typedef int WindowID;
407
typedef int IndicatorID;
408
409
virtual Vector<DisplayServer::WindowID> get_window_list() const = 0;
410
411
enum WindowFlags {
412
WINDOW_FLAG_RESIZE_DISABLED,
413
WINDOW_FLAG_BORDERLESS,
414
WINDOW_FLAG_ALWAYS_ON_TOP,
415
WINDOW_FLAG_TRANSPARENT,
416
WINDOW_FLAG_NO_FOCUS,
417
WINDOW_FLAG_POPUP,
418
WINDOW_FLAG_EXTEND_TO_TITLE,
419
WINDOW_FLAG_MOUSE_PASSTHROUGH,
420
WINDOW_FLAG_SHARP_CORNERS,
421
WINDOW_FLAG_EXCLUDE_FROM_CAPTURE,
422
WINDOW_FLAG_POPUP_WM_HINT,
423
WINDOW_FLAG_MINIMIZE_DISABLED,
424
WINDOW_FLAG_MAXIMIZE_DISABLED,
425
WINDOW_FLAG_MAX,
426
};
427
428
// Separate enum otherwise we get warnings in switches not handling all values.
429
enum WindowFlagsBit {
430
WINDOW_FLAG_RESIZE_DISABLED_BIT = (1 << WINDOW_FLAG_RESIZE_DISABLED),
431
WINDOW_FLAG_BORDERLESS_BIT = (1 << WINDOW_FLAG_BORDERLESS),
432
WINDOW_FLAG_ALWAYS_ON_TOP_BIT = (1 << WINDOW_FLAG_ALWAYS_ON_TOP),
433
WINDOW_FLAG_TRANSPARENT_BIT = (1 << WINDOW_FLAG_TRANSPARENT),
434
WINDOW_FLAG_NO_FOCUS_BIT = (1 << WINDOW_FLAG_NO_FOCUS),
435
WINDOW_FLAG_POPUP_BIT = (1 << WINDOW_FLAG_POPUP),
436
WINDOW_FLAG_EXTEND_TO_TITLE_BIT = (1 << WINDOW_FLAG_EXTEND_TO_TITLE),
437
WINDOW_FLAG_MOUSE_PASSTHROUGH_BIT = (1 << WINDOW_FLAG_MOUSE_PASSTHROUGH),
438
WINDOW_FLAG_SHARP_CORNERS_BIT = (1 << WINDOW_FLAG_SHARP_CORNERS),
439
WINDOW_FLAG_EXCLUDE_FROM_CAPTURE_BIT = (1 << WINDOW_FLAG_EXCLUDE_FROM_CAPTURE),
440
WINDOW_FLAG_POPUP_WM_HINT_BIT = (1 << WINDOW_FLAG_POPUP_WM_HINT),
441
WINDOW_FLAG_MINIMIZE_DISABLED_BIT = (1 << WINDOW_FLAG_MINIMIZE_DISABLED),
442
WINDOW_FLAG_MAXIMIZE_DISABLED_BIT = (1 << WINDOW_FLAG_MAXIMIZE_DISABLED),
443
};
444
445
virtual WindowID create_sub_window(WindowMode p_mode, VSyncMode p_vsync_mode, uint32_t p_flags, const Rect2i &p_rect = Rect2i(), bool p_exclusive = false, WindowID p_transient_parent = INVALID_WINDOW_ID);
446
virtual void show_window(WindowID p_id);
447
virtual void delete_sub_window(WindowID p_id);
448
449
virtual WindowID window_get_active_popup() const { return INVALID_WINDOW_ID; }
450
virtual void window_set_popup_safe_rect(WindowID p_window, const Rect2i &p_rect) {}
451
virtual Rect2i window_get_popup_safe_rect(WindowID p_window) const { return Rect2i(); }
452
453
virtual int64_t window_get_native_handle(HandleType p_handle_type, WindowID p_window = MAIN_WINDOW_ID) const;
454
455
virtual WindowID get_window_at_screen_position(const Point2i &p_position) const = 0;
456
457
virtual void window_attach_instance_id(ObjectID p_instance, WindowID p_window = MAIN_WINDOW_ID) = 0;
458
virtual ObjectID window_get_attached_instance_id(WindowID p_window = MAIN_WINDOW_ID) const = 0;
459
460
virtual void window_set_rect_changed_callback(const Callable &p_callable, WindowID p_window = MAIN_WINDOW_ID) = 0;
461
462
enum WindowEvent {
463
WINDOW_EVENT_MOUSE_ENTER,
464
WINDOW_EVENT_MOUSE_EXIT,
465
WINDOW_EVENT_FOCUS_IN,
466
WINDOW_EVENT_FOCUS_OUT,
467
WINDOW_EVENT_CLOSE_REQUEST,
468
WINDOW_EVENT_GO_BACK_REQUEST,
469
WINDOW_EVENT_DPI_CHANGE,
470
WINDOW_EVENT_TITLEBAR_CHANGE,
471
WINDOW_EVENT_FORCE_CLOSE,
472
};
473
virtual void window_set_window_event_callback(const Callable &p_callable, WindowID p_window = MAIN_WINDOW_ID) = 0;
474
virtual void window_set_input_event_callback(const Callable &p_callable, WindowID p_window = MAIN_WINDOW_ID) = 0;
475
virtual void window_set_input_text_callback(const Callable &p_callable, WindowID p_window = MAIN_WINDOW_ID) = 0;
476
477
virtual void window_set_drop_files_callback(const Callable &p_callable, WindowID p_window = MAIN_WINDOW_ID) = 0;
478
479
virtual void window_set_title(const String &p_title, WindowID p_window = MAIN_WINDOW_ID) = 0;
480
virtual Size2i window_get_title_size(const String &p_title, WindowID p_window = MAIN_WINDOW_ID) const { return Size2i(); }
481
482
virtual void window_set_mouse_passthrough(const Vector<Vector2> &p_region, WindowID p_window = MAIN_WINDOW_ID);
483
484
virtual int window_get_current_screen(WindowID p_window = MAIN_WINDOW_ID) const = 0;
485
virtual void window_set_current_screen(int p_screen, WindowID p_window = MAIN_WINDOW_ID) = 0;
486
487
virtual Point2i window_get_position(WindowID p_window = MAIN_WINDOW_ID) const = 0;
488
virtual Point2i window_get_position_with_decorations(WindowID p_window = MAIN_WINDOW_ID) const = 0;
489
virtual void window_set_position(const Point2i &p_position, WindowID p_window = MAIN_WINDOW_ID) = 0;
490
491
virtual void window_set_transient(WindowID p_window, WindowID p_parent) = 0;
492
virtual void window_set_exclusive(WindowID p_window, bool p_exclusive);
493
494
virtual void window_set_max_size(const Size2i p_size, WindowID p_window = MAIN_WINDOW_ID) = 0;
495
virtual Size2i window_get_max_size(WindowID p_window = MAIN_WINDOW_ID) const = 0;
496
497
virtual void window_set_min_size(const Size2i p_size, WindowID p_window = MAIN_WINDOW_ID) = 0;
498
virtual Size2i window_get_min_size(WindowID p_window = MAIN_WINDOW_ID) const = 0;
499
500
virtual void window_set_size(const Size2i p_size, WindowID p_window = MAIN_WINDOW_ID) = 0;
501
virtual Size2i window_get_size(WindowID p_window = MAIN_WINDOW_ID) const = 0;
502
virtual Size2i window_get_size_with_decorations(WindowID p_window = MAIN_WINDOW_ID) const = 0;
503
504
virtual float window_get_scale(WindowID p_window = MAIN_WINDOW_ID) const {
505
int screen = window_get_current_screen(p_window);
506
return screen_get_scale(screen);
507
}
508
509
virtual void window_set_mode(WindowMode p_mode, WindowID p_window = MAIN_WINDOW_ID) = 0;
510
virtual WindowMode window_get_mode(WindowID p_window = MAIN_WINDOW_ID) const = 0;
511
512
virtual void window_set_vsync_mode(VSyncMode p_vsync_mode, WindowID p_window = MAIN_WINDOW_ID);
513
virtual VSyncMode window_get_vsync_mode(WindowID p_window) const;
514
515
virtual bool window_is_maximize_allowed(WindowID p_window = MAIN_WINDOW_ID) const = 0;
516
517
virtual void window_set_flag(WindowFlags p_flag, bool p_enabled, WindowID p_window = MAIN_WINDOW_ID) = 0;
518
virtual bool window_get_flag(WindowFlags p_flag, WindowID p_window = MAIN_WINDOW_ID) const = 0;
519
520
virtual void window_request_attention(WindowID p_window = MAIN_WINDOW_ID) = 0;
521
virtual void window_move_to_foreground(WindowID p_window = MAIN_WINDOW_ID) = 0;
522
virtual bool window_is_focused(WindowID p_window = MAIN_WINDOW_ID) const = 0;
523
524
virtual WindowID get_focused_window() const;
525
526
virtual void window_set_window_buttons_offset(const Vector2i &p_offset, WindowID p_window = MAIN_WINDOW_ID) {}
527
virtual Vector3i window_get_safe_title_margins(WindowID p_window = MAIN_WINDOW_ID) const { return Vector3i(); }
528
529
virtual bool window_can_draw(WindowID p_window = MAIN_WINDOW_ID) const = 0;
530
531
virtual bool can_any_window_draw() const = 0;
532
533
virtual void window_set_ime_active(const bool p_active, WindowID p_window = MAIN_WINDOW_ID);
534
virtual void window_set_ime_position(const Point2i &p_pos, WindowID p_window = MAIN_WINDOW_ID);
535
536
virtual bool window_maximize_on_title_dbl_click() const { return false; }
537
virtual bool window_minimize_on_title_dbl_click() const { return false; }
538
539
virtual void window_start_drag(WindowID p_window = MAIN_WINDOW_ID) {}
540
541
virtual void window_set_color(const Color &p_color) {}
542
543
enum WindowResizeEdge {
544
WINDOW_EDGE_TOP_LEFT,
545
WINDOW_EDGE_TOP,
546
WINDOW_EDGE_TOP_RIGHT,
547
WINDOW_EDGE_LEFT,
548
WINDOW_EDGE_RIGHT,
549
WINDOW_EDGE_BOTTOM_LEFT,
550
WINDOW_EDGE_BOTTOM,
551
WINDOW_EDGE_BOTTOM_RIGHT,
552
WINDOW_EDGE_MAX,
553
};
554
555
virtual void window_start_resize(WindowResizeEdge p_edge, WindowID p_window = MAIN_WINDOW_ID) {}
556
557
// Accessibility.
558
559
enum AccessibilityMode {
560
ACCESSIBILITY_AUTO,
561
ACCESSIBILITY_ALWAYS,
562
ACCESSIBILITY_DISABLED,
563
};
564
565
protected:
566
AccessibilityDriver *accessibility_driver = nullptr;
567
static AccessibilityMode accessibility_mode;
568
569
public:
570
enum AccessibilityRole {
571
ROLE_UNKNOWN,
572
ROLE_DEFAULT_BUTTON,
573
ROLE_AUDIO,
574
ROLE_VIDEO,
575
ROLE_STATIC_TEXT,
576
ROLE_CONTAINER,
577
ROLE_PANEL,
578
ROLE_BUTTON,
579
ROLE_LINK,
580
ROLE_CHECK_BOX,
581
ROLE_RADIO_BUTTON,
582
ROLE_CHECK_BUTTON,
583
ROLE_SCROLL_BAR,
584
ROLE_SCROLL_VIEW,
585
ROLE_SPLITTER,
586
ROLE_SLIDER,
587
ROLE_SPIN_BUTTON,
588
ROLE_PROGRESS_INDICATOR,
589
ROLE_TEXT_FIELD,
590
ROLE_MULTILINE_TEXT_FIELD,
591
ROLE_COLOR_PICKER,
592
ROLE_TABLE,
593
ROLE_CELL,
594
ROLE_ROW,
595
ROLE_ROW_GROUP,
596
ROLE_ROW_HEADER,
597
ROLE_COLUMN_HEADER,
598
ROLE_TREE,
599
ROLE_TREE_ITEM,
600
ROLE_LIST,
601
ROLE_LIST_ITEM,
602
ROLE_LIST_BOX,
603
ROLE_LIST_BOX_OPTION,
604
ROLE_TAB_BAR,
605
ROLE_TAB,
606
ROLE_TAB_PANEL,
607
ROLE_MENU_BAR,
608
ROLE_MENU,
609
ROLE_MENU_ITEM,
610
ROLE_MENU_ITEM_CHECK_BOX,
611
ROLE_MENU_ITEM_RADIO,
612
ROLE_IMAGE,
613
ROLE_WINDOW,
614
ROLE_TITLE_BAR,
615
ROLE_DIALOG,
616
ROLE_TOOLTIP,
617
ROLE_REGION,
618
};
619
620
enum AccessibilityPopupType {
621
POPUP_MENU,
622
POPUP_LIST,
623
POPUP_TREE,
624
POPUP_DIALOG,
625
};
626
627
enum AccessibilityFlags {
628
FLAG_HIDDEN,
629
FLAG_MULTISELECTABLE,
630
FLAG_REQUIRED,
631
FLAG_VISITED,
632
FLAG_BUSY,
633
FLAG_MODAL,
634
FLAG_TOUCH_PASSTHROUGH,
635
FLAG_READONLY,
636
FLAG_DISABLED,
637
FLAG_CLIPS_CHILDREN,
638
};
639
640
enum AccessibilityAction {
641
ACTION_CLICK,
642
ACTION_FOCUS,
643
ACTION_BLUR,
644
ACTION_COLLAPSE,
645
ACTION_EXPAND,
646
ACTION_DECREMENT,
647
ACTION_INCREMENT,
648
ACTION_HIDE_TOOLTIP,
649
ACTION_SHOW_TOOLTIP,
650
ACTION_SET_TEXT_SELECTION,
651
ACTION_REPLACE_SELECTED_TEXT,
652
ACTION_SCROLL_BACKWARD,
653
ACTION_SCROLL_DOWN,
654
ACTION_SCROLL_FORWARD,
655
ACTION_SCROLL_LEFT,
656
ACTION_SCROLL_RIGHT,
657
ACTION_SCROLL_UP,
658
ACTION_SCROLL_INTO_VIEW,
659
ACTION_SCROLL_TO_POINT,
660
ACTION_SET_SCROLL_OFFSET,
661
ACTION_SET_VALUE,
662
ACTION_SHOW_CONTEXT_MENU,
663
ACTION_CUSTOM,
664
};
665
666
enum AccessibilityLiveMode {
667
LIVE_OFF,
668
LIVE_POLITE,
669
LIVE_ASSERTIVE,
670
};
671
672
enum AccessibilityScrollUnit {
673
SCROLL_UNIT_ITEM,
674
SCROLL_UNIT_PAGE,
675
};
676
677
enum AccessibilityScrollHint {
678
SCROLL_HINT_TOP_LEFT,
679
SCROLL_HINT_BOTTOM_RIGHT,
680
SCROLL_HINT_TOP_EDGE,
681
SCROLL_HINT_BOTTOM_EDGE,
682
SCROLL_HINT_LEFT_EDGE,
683
SCROLL_HINT_RIGHT_EDGE,
684
};
685
686
static AccessibilityMode accessibility_get_mode() { return accessibility_mode; }
687
static void accessibility_set_mode(AccessibilityMode p_mode) { accessibility_mode = p_mode; }
688
689
virtual int accessibility_should_increase_contrast() const { return -1; }
690
virtual int accessibility_should_reduce_animation() const { return -1; }
691
virtual int accessibility_should_reduce_transparency() const { return -1; }
692
virtual int accessibility_screen_reader_active() const { return -1; }
693
694
virtual RID accessibility_create_element(WindowID p_window_id, DisplayServer::AccessibilityRole p_role);
695
virtual RID accessibility_create_sub_element(const RID &p_parent_rid, DisplayServer::AccessibilityRole p_role, int p_insert_pos = -1);
696
virtual RID accessibility_create_sub_text_edit_elements(const RID &p_parent_rid, const RID &p_shaped_text, float p_min_height, int p_insert_pos = -1, bool p_is_last_line = false);
697
virtual bool accessibility_has_element(const RID &p_id) const;
698
virtual void accessibility_free_element(const RID &p_id);
699
700
virtual void accessibility_element_set_meta(const RID &p_id, const Variant &p_meta);
701
virtual Variant accessibility_element_get_meta(const RID &p_id) const;
702
703
virtual void accessibility_update_if_active(const Callable &p_callable);
704
705
virtual void accessibility_update_set_focus(const RID &p_id);
706
virtual RID accessibility_get_window_root(DisplayServer::WindowID p_window_id) const;
707
708
virtual void accessibility_set_window_rect(DisplayServer::WindowID p_window_id, const Rect2 &p_rect_out, const Rect2 &p_rect_in);
709
virtual void accessibility_set_window_focused(DisplayServer::WindowID p_window_id, bool p_focused);
710
711
virtual void accessibility_update_set_role(const RID &p_id, DisplayServer::AccessibilityRole p_role);
712
virtual void accessibility_update_set_name(const RID &p_id, const String &p_name);
713
virtual void accessibility_update_set_extra_info(const RID &p_id, const String &p_name_extra_info);
714
virtual void accessibility_update_set_description(const RID &p_id, const String &p_description);
715
virtual void accessibility_update_set_value(const RID &p_id, const String &p_value);
716
virtual void accessibility_update_set_tooltip(const RID &p_id, const String &p_tooltip);
717
virtual void accessibility_update_set_bounds(const RID &p_id, const Rect2 &p_rect);
718
virtual void accessibility_update_set_transform(const RID &p_id, const Transform2D &p_transform);
719
virtual void accessibility_update_add_child(const RID &p_id, const RID &p_child_id);
720
virtual void accessibility_update_add_related_controls(const RID &p_id, const RID &p_related_id);
721
virtual void accessibility_update_add_related_details(const RID &p_id, const RID &p_related_id);
722
virtual void accessibility_update_add_related_described_by(const RID &p_id, const RID &p_related_id);
723
virtual void accessibility_update_add_related_flow_to(const RID &p_id, const RID &p_related_id);
724
virtual void accessibility_update_add_related_labeled_by(const RID &p_id, const RID &p_related_id);
725
virtual void accessibility_update_add_related_radio_group(const RID &p_id, const RID &p_related_id);
726
virtual void accessibility_update_set_active_descendant(const RID &p_id, const RID &p_other_id);
727
virtual void accessibility_update_set_next_on_line(const RID &p_id, const RID &p_other_id);
728
virtual void accessibility_update_set_previous_on_line(const RID &p_id, const RID &p_other_id);
729
virtual void accessibility_update_set_member_of(const RID &p_id, const RID &p_group_id);
730
virtual void accessibility_update_set_in_page_link_target(const RID &p_id, const RID &p_other_id);
731
virtual void accessibility_update_set_error_message(const RID &p_id, const RID &p_other_id);
732
virtual void accessibility_update_set_live(const RID &p_id, DisplayServer::AccessibilityLiveMode p_live);
733
virtual void accessibility_update_add_action(const RID &p_id, DisplayServer::AccessibilityAction p_action, const Callable &p_callable);
734
virtual void accessibility_update_add_custom_action(const RID &p_id, int p_action_id, const String &p_action_description);
735
virtual void accessibility_update_set_table_row_count(const RID &p_id, int p_count);
736
virtual void accessibility_update_set_table_column_count(const RID &p_id, int p_count);
737
virtual void accessibility_update_set_table_row_index(const RID &p_id, int p_index);
738
virtual void accessibility_update_set_table_column_index(const RID &p_id, int p_index);
739
virtual void accessibility_update_set_table_cell_position(const RID &p_id, int p_row_index, int p_column_index);
740
virtual void accessibility_update_set_table_cell_span(const RID &p_id, int p_row_span, int p_column_span);
741
virtual void accessibility_update_set_list_item_count(const RID &p_id, int p_size);
742
virtual void accessibility_update_set_list_item_index(const RID &p_id, int p_index);
743
virtual void accessibility_update_set_list_item_level(const RID &p_id, int p_level);
744
virtual void accessibility_update_set_list_item_selected(const RID &p_id, bool p_selected);
745
virtual void accessibility_update_set_list_item_expanded(const RID &p_id, bool p_expanded);
746
virtual void accessibility_update_set_popup_type(const RID &p_id, DisplayServer::AccessibilityPopupType p_popup);
747
virtual void accessibility_update_set_checked(const RID &p_id, bool p_checekd);
748
virtual void accessibility_update_set_num_value(const RID &p_id, double p_position);
749
virtual void accessibility_update_set_num_range(const RID &p_id, double p_min, double p_max);
750
virtual void accessibility_update_set_num_step(const RID &p_id, double p_step);
751
virtual void accessibility_update_set_num_jump(const RID &p_id, double p_jump);
752
virtual void accessibility_update_set_scroll_x(const RID &p_id, double p_position);
753
virtual void accessibility_update_set_scroll_x_range(const RID &p_id, double p_min, double p_max);
754
virtual void accessibility_update_set_scroll_y(const RID &p_id, double p_position);
755
virtual void accessibility_update_set_scroll_y_range(const RID &p_id, double p_min, double p_max);
756
virtual void accessibility_update_set_text_decorations(const RID &p_id, bool p_underline, bool p_strikethrough, bool p_overline);
757
virtual void accessibility_update_set_text_align(const RID &p_id, HorizontalAlignment p_align);
758
virtual void accessibility_update_set_text_selection(const RID &p_id, const RID &p_text_start_id, int p_start_char, const RID &p_text_end_id, int p_end_char);
759
virtual void accessibility_update_set_flag(const RID &p_id, DisplayServer::AccessibilityFlags p_flag, bool p_value);
760
virtual void accessibility_update_set_classname(const RID &p_id, const String &p_classname);
761
virtual void accessibility_update_set_placeholder(const RID &p_id, const String &p_placeholder);
762
virtual void accessibility_update_set_language(const RID &p_id, const String &p_language);
763
virtual void accessibility_update_set_text_orientation(const RID &p_id, bool p_vertical);
764
virtual void accessibility_update_set_list_orientation(const RID &p_id, bool p_vertical);
765
virtual void accessibility_update_set_shortcut(const RID &p_id, const String &p_shortcut);
766
virtual void accessibility_update_set_url(const RID &p_id, const String &p_url);
767
virtual void accessibility_update_set_role_description(const RID &p_id, const String &p_description);
768
virtual void accessibility_update_set_state_description(const RID &p_id, const String &p_description);
769
virtual void accessibility_update_set_color_value(const RID &p_id, const Color &p_color);
770
virtual void accessibility_update_set_background_color(const RID &p_id, const Color &p_color);
771
virtual void accessibility_update_set_foreground_color(const RID &p_id, const Color &p_color);
772
773
// necessary for GL focus, may be able to use one of the existing functions for this, not sure yet
774
virtual void gl_window_make_current(DisplayServer::WindowID p_window_id);
775
776
virtual Point2i ime_get_selection() const;
777
virtual String ime_get_text() const;
778
779
enum VirtualKeyboardType {
780
KEYBOARD_TYPE_DEFAULT,
781
KEYBOARD_TYPE_MULTILINE,
782
KEYBOARD_TYPE_NUMBER,
783
KEYBOARD_TYPE_NUMBER_DECIMAL,
784
KEYBOARD_TYPE_PHONE,
785
KEYBOARD_TYPE_EMAIL_ADDRESS,
786
KEYBOARD_TYPE_PASSWORD,
787
KEYBOARD_TYPE_URL
788
};
789
790
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);
791
virtual void virtual_keyboard_hide();
792
793
// returns height of the currently shown virtual keyboard (0 if keyboard is hidden)
794
virtual int virtual_keyboard_get_height() const;
795
796
virtual bool has_hardware_keyboard() const;
797
798
enum CursorShape {
799
CURSOR_ARROW,
800
CURSOR_IBEAM,
801
CURSOR_POINTING_HAND,
802
CURSOR_CROSS,
803
CURSOR_WAIT,
804
CURSOR_BUSY,
805
CURSOR_DRAG,
806
CURSOR_CAN_DROP,
807
CURSOR_FORBIDDEN,
808
CURSOR_VSIZE,
809
CURSOR_HSIZE,
810
CURSOR_BDIAGSIZE,
811
CURSOR_FDIAGSIZE,
812
CURSOR_MOVE,
813
CURSOR_VSPLIT,
814
CURSOR_HSPLIT,
815
CURSOR_HELP,
816
CURSOR_MAX
817
};
818
virtual void cursor_set_shape(CursorShape p_shape);
819
virtual CursorShape cursor_get_shape() const;
820
virtual void cursor_set_custom_image(const Ref<Resource> &p_cursor, CursorShape p_shape = CURSOR_ARROW, const Vector2 &p_hotspot = Vector2());
821
822
virtual bool get_swap_cancel_ok();
823
824
virtual void enable_for_stealing_focus(OS::ProcessID pid);
825
826
virtual Error embed_process(WindowID p_window, OS::ProcessID p_pid, const Rect2i &p_rect, bool p_visible, bool p_grab_focus);
827
virtual Error request_close_embedded_process(OS::ProcessID p_pid);
828
virtual Error remove_embedded_process(OS::ProcessID p_pid);
829
virtual OS::ProcessID get_focused_process_id();
830
831
virtual Error dialog_show(String p_title, String p_description, Vector<String> p_buttons, const Callable &p_callback);
832
virtual Error dialog_input_text(String p_title, String p_description, String p_partial, const Callable &p_callback);
833
834
enum FileDialogMode {
835
FILE_DIALOG_MODE_OPEN_FILE,
836
FILE_DIALOG_MODE_OPEN_FILES,
837
FILE_DIALOG_MODE_OPEN_DIR,
838
FILE_DIALOG_MODE_OPEN_ANY,
839
FILE_DIALOG_MODE_SAVE_FILE,
840
FILE_DIALOG_MODE_SAVE_MAX
841
};
842
virtual Error file_dialog_show(const String &p_title, const String &p_current_directory, const String &p_filename, bool p_show_hidden, FileDialogMode p_mode, const Vector<String> &p_filters, const Callable &p_callback, WindowID p_window_id = MAIN_WINDOW_ID);
843
virtual Error file_dialog_with_options_show(const String &p_title, const String &p_current_directory, const String &p_root, const String &p_filename, bool p_show_hidden, FileDialogMode p_mode, const Vector<String> &p_filters, const TypedArray<Dictionary> &p_options, const Callable &p_callback, WindowID p_window_id = MAIN_WINDOW_ID);
844
845
#ifndef DISABLE_DEPRECATED
846
Error _file_dialog_show_bind_compat_98194(const String &p_title, const String &p_current_directory, const String &p_filename, bool p_show_hidden, FileDialogMode p_mode, const Vector<String> &p_filters, const Callable &p_callback);
847
Error _file_dialog_with_options_show_bind_compat_98194(const String &p_title, const String &p_current_directory, const String &p_root, const String &p_filename, bool p_show_hidden, FileDialogMode p_mode, const Vector<String> &p_filters, const TypedArray<Dictionary> &p_options, const Callable &p_callback);
848
#endif
849
850
virtual void beep() const;
851
852
virtual int keyboard_get_layout_count() const;
853
virtual int keyboard_get_current_layout() const;
854
virtual void keyboard_set_current_layout(int p_index);
855
virtual String keyboard_get_layout_language(int p_index) const;
856
virtual String keyboard_get_layout_name(int p_index) const;
857
virtual Key keyboard_get_keycode_from_physical(Key p_keycode) const;
858
virtual Key keyboard_get_label_from_physical(Key p_keycode) const;
859
virtual void show_emoji_and_symbol_picker() const;
860
virtual bool color_picker(const Callable &p_callback);
861
862
virtual int tablet_get_driver_count() const { return 1; }
863
virtual String tablet_get_driver_name(int p_driver) const { return "default"; }
864
virtual String tablet_get_current_driver() const { return "default"; }
865
virtual void tablet_set_current_driver(const String &p_driver) {}
866
867
virtual void process_events() = 0;
868
869
virtual void force_process_and_drop_events();
870
871
virtual void release_rendering_thread();
872
virtual void swap_buffers();
873
874
virtual void set_native_icon(const String &p_filename);
875
virtual void set_icon(const Ref<Image> &p_icon);
876
877
virtual IndicatorID create_status_indicator(const Ref<Texture2D> &p_icon, const String &p_tooltip, const Callable &p_callback);
878
virtual void status_indicator_set_icon(IndicatorID p_id, const Ref<Texture2D> &p_icon);
879
virtual void status_indicator_set_tooltip(IndicatorID p_id, const String &p_tooltip);
880
virtual void status_indicator_set_menu(IndicatorID p_id, const RID &p_menu_rid);
881
virtual void status_indicator_set_callback(IndicatorID p_id, const Callable &p_callback);
882
virtual Rect2 status_indicator_get_rect(IndicatorID p_id) const;
883
virtual void delete_status_indicator(IndicatorID p_id);
884
885
virtual void set_context(Context p_context);
886
887
virtual bool is_window_transparency_available() const { return false; }
888
889
void register_additional_output(Object *p_output);
890
void unregister_additional_output(Object *p_output);
891
bool has_additional_outputs() const { return additional_outputs.size() > 0; }
892
893
static void register_create_function(const char *p_name, CreateFunction p_function, GetRenderingDriversFunction p_get_drivers);
894
static int get_create_function_count();
895
static const char *get_create_function_name(int p_index);
896
static Vector<String> get_create_function_rendering_drivers(int p_index);
897
static DisplayServer *create(int p_index, const String &p_rendering_driver, WindowMode p_mode, 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);
898
899
enum RenderingDeviceCreationStatus {
900
UNKNOWN,
901
SUCCESS,
902
FAILURE,
903
};
904
905
// Used to cache the result of `can_create_rendering_device()` when RenderingDevice isn't currently being used.
906
// This is done as creating a RenderingDevice is quite slow.
907
static inline RenderingDeviceCreationStatus created_rendering_device = RenderingDeviceCreationStatus::UNKNOWN;
908
static bool can_create_rendering_device();
909
910
static inline RenderingDeviceCreationStatus supported_rendering_device = RenderingDeviceCreationStatus::UNKNOWN;
911
static bool is_rendering_device_supported();
912
913
DisplayServer();
914
~DisplayServer();
915
};
916
917
/**************************************************************************/
918
919
class AccessibilityDriver {
920
public:
921
virtual Error init() = 0;
922
923
virtual bool window_create(DisplayServer::WindowID p_window_id, void *p_handle) = 0;
924
virtual void window_destroy(DisplayServer::WindowID p_window_id) = 0;
925
926
virtual RID accessibility_create_element(DisplayServer::WindowID p_window_id, DisplayServer::AccessibilityRole p_role) = 0;
927
virtual RID accessibility_create_sub_element(const RID &p_parent_rid, DisplayServer::AccessibilityRole p_role, int p_insert_pos = -1) = 0;
928
virtual RID accessibility_create_sub_text_edit_elements(const RID &p_parent_rid, const RID &p_shaped_text, float p_min_height, int p_insert_pos = -1, bool p_is_last_line = false) = 0;
929
virtual bool accessibility_has_element(const RID &p_id) const = 0;
930
virtual void accessibility_free_element(const RID &p_id) = 0;
931
932
virtual void accessibility_element_set_meta(const RID &p_id, const Variant &p_meta) = 0;
933
virtual Variant accessibility_element_get_meta(const RID &p_id) const = 0;
934
935
virtual void accessibility_update_if_active(const Callable &p_callable) = 0;
936
937
virtual RID accessibility_get_window_root(DisplayServer::WindowID p_window_id) const = 0;
938
virtual void accessibility_update_set_focus(const RID &p_id) = 0;
939
940
virtual void accessibility_set_window_rect(DisplayServer::WindowID p_window_id, const Rect2 &p_rect_out, const Rect2 &p_rect_in) = 0;
941
virtual void accessibility_set_window_focused(DisplayServer::WindowID p_window_id, bool p_focused) = 0;
942
943
virtual void accessibility_update_set_role(const RID &p_id, DisplayServer::AccessibilityRole p_role) = 0;
944
virtual void accessibility_update_set_name(const RID &p_id, const String &p_name) = 0;
945
virtual void accessibility_update_set_extra_info(const RID &p_id, const String &p_name_extra_info) = 0;
946
virtual void accessibility_update_set_description(const RID &p_id, const String &p_description) = 0;
947
virtual void accessibility_update_set_value(const RID &p_id, const String &p_value) = 0;
948
virtual void accessibility_update_set_tooltip(const RID &p_id, const String &p_tooltip) = 0;
949
virtual void accessibility_update_set_bounds(const RID &p_id, const Rect2 &p_rect) = 0;
950
virtual void accessibility_update_set_transform(const RID &p_id, const Transform2D &p_transform) = 0;
951
virtual void accessibility_update_add_child(const RID &p_id, const RID &p_child_id) = 0;
952
virtual void accessibility_update_add_related_controls(const RID &p_id, const RID &p_related_id) = 0;
953
virtual void accessibility_update_add_related_details(const RID &p_id, const RID &p_related_id) = 0;
954
virtual void accessibility_update_add_related_described_by(const RID &p_id, const RID &p_related_id) = 0;
955
virtual void accessibility_update_add_related_flow_to(const RID &p_id, const RID &p_related_id) = 0;
956
virtual void accessibility_update_add_related_labeled_by(const RID &p_id, const RID &p_related_id) = 0;
957
virtual void accessibility_update_add_related_radio_group(const RID &p_id, const RID &p_related_id) = 0;
958
virtual void accessibility_update_set_active_descendant(const RID &p_id, const RID &p_other_id) = 0;
959
virtual void accessibility_update_set_next_on_line(const RID &p_id, const RID &p_other_id) = 0;
960
virtual void accessibility_update_set_previous_on_line(const RID &p_id, const RID &p_other_id) = 0;
961
virtual void accessibility_update_set_member_of(const RID &p_id, const RID &p_group_id) = 0;
962
virtual void accessibility_update_set_in_page_link_target(const RID &p_id, const RID &p_other_id) = 0;
963
virtual void accessibility_update_set_error_message(const RID &p_id, const RID &p_other_id) = 0;
964
virtual void accessibility_update_set_live(const RID &p_id, DisplayServer::AccessibilityLiveMode p_live) = 0;
965
virtual void accessibility_update_add_action(const RID &p_id, DisplayServer::AccessibilityAction p_action, const Callable &p_callable) = 0;
966
virtual void accessibility_update_add_custom_action(const RID &p_id, int p_action_id, const String &p_action_description) = 0;
967
virtual void accessibility_update_set_table_row_count(const RID &p_id, int p_count) = 0;
968
virtual void accessibility_update_set_table_column_count(const RID &p_id, int p_count) = 0;
969
virtual void accessibility_update_set_table_row_index(const RID &p_id, int p_index) = 0;
970
virtual void accessibility_update_set_table_column_index(const RID &p_id, int p_index) = 0;
971
virtual void accessibility_update_set_table_cell_position(const RID &p_id, int p_row_index, int p_column_index) = 0;
972
virtual void accessibility_update_set_table_cell_span(const RID &p_id, int p_row_span, int p_column_span) = 0;
973
virtual void accessibility_update_set_list_item_count(const RID &p_id, int p_size) = 0;
974
virtual void accessibility_update_set_list_item_index(const RID &p_id, int p_index) = 0;
975
virtual void accessibility_update_set_list_item_level(const RID &p_id, int p_level) = 0;
976
virtual void accessibility_update_set_list_item_selected(const RID &p_id, bool p_selected) = 0;
977
virtual void accessibility_update_set_list_item_expanded(const RID &p_id, bool p_expanded) = 0;
978
virtual void accessibility_update_set_popup_type(const RID &p_id, DisplayServer::AccessibilityPopupType p_popup) = 0;
979
virtual void accessibility_update_set_checked(const RID &p_id, bool p_checekd) = 0;
980
virtual void accessibility_update_set_num_value(const RID &p_id, double p_position) = 0;
981
virtual void accessibility_update_set_num_range(const RID &p_id, double p_min, double p_max) = 0;
982
virtual void accessibility_update_set_num_step(const RID &p_id, double p_step) = 0;
983
virtual void accessibility_update_set_num_jump(const RID &p_id, double p_jump) = 0;
984
virtual void accessibility_update_set_scroll_x(const RID &p_id, double p_position) = 0;
985
virtual void accessibility_update_set_scroll_x_range(const RID &p_id, double p_min, double p_max) = 0;
986
virtual void accessibility_update_set_scroll_y(const RID &p_id, double p_position) = 0;
987
virtual void accessibility_update_set_scroll_y_range(const RID &p_id, double p_min, double p_max) = 0;
988
virtual void accessibility_update_set_text_decorations(const RID &p_id, bool p_underline, bool p_strikethrough, bool p_overline) = 0;
989
virtual void accessibility_update_set_text_align(const RID &p_id, HorizontalAlignment p_align) = 0;
990
virtual void accessibility_update_set_text_selection(const RID &p_id, const RID &p_text_start_id, int p_start_char, const RID &p_text_end_id, int p_end_char) = 0;
991
virtual void accessibility_update_set_flag(const RID &p_id, DisplayServer::AccessibilityFlags p_flag, bool p_value) = 0;
992
virtual void accessibility_update_set_classname(const RID &p_id, const String &p_classname) = 0;
993
virtual void accessibility_update_set_placeholder(const RID &p_id, const String &p_placeholder) = 0;
994
virtual void accessibility_update_set_language(const RID &p_id, const String &p_language) = 0;
995
virtual void accessibility_update_set_text_orientation(const RID &p_id, bool p_vertical) = 0;
996
virtual void accessibility_update_set_list_orientation(const RID &p_id, bool p_vertical) = 0;
997
virtual void accessibility_update_set_shortcut(const RID &p_id, const String &p_shortcut) = 0;
998
virtual void accessibility_update_set_url(const RID &p_id, const String &p_url) = 0;
999
virtual void accessibility_update_set_role_description(const RID &p_id, const String &p_description) = 0;
1000
virtual void accessibility_update_set_state_description(const RID &p_id, const String &p_description) = 0;
1001
virtual void accessibility_update_set_color_value(const RID &p_id, const Color &p_color) = 0;
1002
virtual void accessibility_update_set_background_color(const RID &p_id, const Color &p_color) = 0;
1003
virtual void accessibility_update_set_foreground_color(const RID &p_id, const Color &p_color) = 0;
1004
1005
AccessibilityDriver() {}
1006
virtual ~AccessibilityDriver() {}
1007
};
1008
1009
VARIANT_ENUM_CAST(DisplayServer::AccessibilityAction)
1010
VARIANT_ENUM_CAST(DisplayServer::AccessibilityFlags)
1011
VARIANT_ENUM_CAST(DisplayServer::AccessibilityLiveMode)
1012
VARIANT_ENUM_CAST(DisplayServer::AccessibilityPopupType)
1013
VARIANT_ENUM_CAST(DisplayServer::AccessibilityRole)
1014
VARIANT_ENUM_CAST(DisplayServer::AccessibilityScrollUnit)
1015
VARIANT_ENUM_CAST(DisplayServer::AccessibilityScrollHint)
1016
1017
VARIANT_ENUM_CAST(DisplayServer::WindowEvent)
1018
VARIANT_ENUM_CAST(DisplayServer::Feature)
1019
VARIANT_ENUM_CAST(DisplayServer::MouseMode)
1020
VARIANT_ENUM_CAST(DisplayServer::ScreenOrientation)
1021
VARIANT_ENUM_CAST(DisplayServer::WindowMode)
1022
VARIANT_ENUM_CAST(DisplayServer::WindowFlags)
1023
VARIANT_ENUM_CAST(DisplayServer::WindowResizeEdge)
1024
VARIANT_ENUM_CAST(DisplayServer::HandleType)
1025
VARIANT_ENUM_CAST(DisplayServer::VirtualKeyboardType);
1026
VARIANT_ENUM_CAST(DisplayServer::CursorShape)
1027
VARIANT_ENUM_CAST(DisplayServer::VSyncMode)
1028
VARIANT_ENUM_CAST(DisplayServer::TTSUtteranceEvent)
1029
VARIANT_ENUM_CAST(DisplayServer::FileDialogMode)
1030
1031