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