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