display_server.h 49 KB

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