display_server.h 21 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474
  1. /*************************************************************************/
  2. /* display_server.h */
  3. /*************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /*************************************************************************/
  8. /* Copyright (c) 2007-2022 Juan Linietsky, Ariel Manzur. */
  9. /* Copyright (c) 2014-2022 Godot Engine contributors (cf. AUTHORS.md). */
  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. #ifndef DISPLAY_SERVER_H
  31. #define DISPLAY_SERVER_H
  32. #include "core/input/input.h"
  33. #include "core/io/resource.h"
  34. #include "core/os/os.h"
  35. #include "core/variant/callable.h"
  36. class Texture2D;
  37. class DisplayServer : public Object {
  38. GDCLASS(DisplayServer, Object)
  39. static DisplayServer *singleton;
  40. static bool hidpi_allowed;
  41. public:
  42. _FORCE_INLINE_ static DisplayServer *get_singleton() {
  43. return singleton;
  44. }
  45. enum WindowMode {
  46. WINDOW_MODE_WINDOWED,
  47. WINDOW_MODE_MINIMIZED,
  48. WINDOW_MODE_MAXIMIZED,
  49. WINDOW_MODE_FULLSCREEN,
  50. WINDOW_MODE_EXCLUSIVE_FULLSCREEN,
  51. };
  52. // Keep the VSyncMode enum values in sync with the `display/window/vsync/vsync_mode`
  53. // project setting hint.
  54. enum VSyncMode {
  55. VSYNC_DISABLED,
  56. VSYNC_ENABLED,
  57. VSYNC_ADAPTIVE,
  58. VSYNC_MAILBOX
  59. };
  60. enum HandleType {
  61. DISPLAY_HANDLE,
  62. WINDOW_HANDLE,
  63. WINDOW_VIEW,
  64. };
  65. typedef DisplayServer *(*CreateFunction)(const String &, WindowMode, VSyncMode, uint32_t, const Size2i &, Error &r_error);
  66. typedef Vector<String> (*GetRenderingDriversFunction)();
  67. private:
  68. static void _input_set_mouse_mode(Input::MouseMode p_mode);
  69. static Input::MouseMode _input_get_mouse_mode();
  70. static void _input_warp(const Vector2 &p_to_pos);
  71. static Input::CursorShape _input_get_current_cursor_shape();
  72. static void _input_set_custom_mouse_cursor_func(const Ref<Resource> &, Input::CursorShape, const Vector2 &p_hostspot);
  73. protected:
  74. static void _bind_methods();
  75. enum {
  76. MAX_SERVERS = 64
  77. };
  78. struct DisplayServerCreate {
  79. const char *name;
  80. CreateFunction create_function;
  81. GetRenderingDriversFunction get_rendering_drivers_function;
  82. };
  83. static DisplayServerCreate server_create_functions[MAX_SERVERS];
  84. static int server_create_count;
  85. friend class RendererViewport;
  86. public:
  87. enum Feature {
  88. FEATURE_GLOBAL_MENU,
  89. FEATURE_SUBWINDOWS,
  90. FEATURE_TOUCHSCREEN,
  91. FEATURE_MOUSE,
  92. FEATURE_MOUSE_WARP,
  93. FEATURE_CLIPBOARD,
  94. FEATURE_VIRTUAL_KEYBOARD,
  95. FEATURE_CURSOR_SHAPE,
  96. FEATURE_CUSTOM_CURSOR_SHAPE,
  97. FEATURE_NATIVE_DIALOG,
  98. FEATURE_IME,
  99. FEATURE_WINDOW_TRANSPARENCY,
  100. FEATURE_HIDPI,
  101. FEATURE_ICON,
  102. FEATURE_NATIVE_ICON,
  103. FEATURE_ORIENTATION,
  104. FEATURE_SWAP_BUFFERS,
  105. FEATURE_KEEP_SCREEN_ON,
  106. FEATURE_CLIPBOARD_PRIMARY,
  107. FEATURE_TEXT_TO_SPEECH,
  108. };
  109. virtual bool has_feature(Feature p_feature) const = 0;
  110. virtual String get_name() const = 0;
  111. virtual void global_menu_add_item(const String &p_menu_root, const String &p_label, const Callable &p_callback = Callable(), const Variant &p_tag = Variant(), Key p_accel = Key::NONE, int p_index = -1);
  112. virtual void global_menu_add_check_item(const String &p_menu_root, const String &p_label, const Callable &p_callback = Callable(), const Variant &p_tag = Variant(), Key p_accel = Key::NONE, int p_index = -1);
  113. virtual void 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 Variant &p_tag = Variant(), Key p_accel = Key::NONE, int p_index = -1);
  114. virtual void 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 Variant &p_tag = Variant(), Key p_accel = Key::NONE, int p_index = -1);
  115. virtual void global_menu_add_radio_check_item(const String &p_menu_root, const String &p_label, const Callable &p_callback = Callable(), const Variant &p_tag = Variant(), Key p_accel = Key::NONE, int p_index = -1);
  116. virtual void 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 Variant &p_tag = Variant(), Key p_accel = Key::NONE, int p_index = -1);
  117. virtual void 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 Variant &p_tag = Variant(), Key p_accel = Key::NONE, int p_index = -1);
  118. virtual void global_menu_add_submenu_item(const String &p_menu_root, const String &p_label, const String &p_submenu, int p_index = -1);
  119. virtual void global_menu_add_separator(const String &p_menu_root, int p_index = -1);
  120. virtual int global_menu_get_item_index_from_text(const String &p_menu_root, const String &p_text) const;
  121. virtual int global_menu_get_item_index_from_tag(const String &p_menu_root, const Variant &p_tag) const;
  122. virtual bool global_menu_is_item_checked(const String &p_menu_root, int p_idx) const;
  123. virtual bool global_menu_is_item_checkable(const String &p_menu_root, int p_idx) const;
  124. virtual bool global_menu_is_item_radio_checkable(const String &p_menu_root, int p_idx) const;
  125. virtual Callable global_menu_get_item_callback(const String &p_menu_root, int p_idx) const;
  126. virtual Variant global_menu_get_item_tag(const String &p_menu_root, int p_idx) const;
  127. virtual String global_menu_get_item_text(const String &p_menu_root, int p_idx) const;
  128. virtual String global_menu_get_item_submenu(const String &p_menu_root, int p_idx) const;
  129. virtual Key global_menu_get_item_accelerator(const String &p_menu_root, int p_idx) const;
  130. virtual bool global_menu_is_item_disabled(const String &p_menu_root, int p_idx) const;
  131. virtual String global_menu_get_item_tooltip(const String &p_menu_root, int p_idx) const;
  132. virtual int global_menu_get_item_state(const String &p_menu_root, int p_idx) const;
  133. virtual int global_menu_get_item_max_states(const String &p_menu_root, int p_idx) const;
  134. virtual Ref<Texture2D> global_menu_get_item_icon(const String &p_menu_root, int p_idx) const;
  135. virtual void global_menu_set_item_checked(const String &p_menu_root, int p_idx, bool p_checked);
  136. virtual void global_menu_set_item_checkable(const String &p_menu_root, int p_idx, bool p_checkable);
  137. virtual void global_menu_set_item_radio_checkable(const String &p_menu_root, int p_idx, bool p_checkable);
  138. virtual void global_menu_set_item_callback(const String &p_menu_root, int p_idx, const Callable &p_callback);
  139. virtual void global_menu_set_item_tag(const String &p_menu_root, int p_idx, const Variant &p_tag);
  140. virtual void global_menu_set_item_text(const String &p_menu_root, int p_idx, const String &p_text);
  141. virtual void global_menu_set_item_submenu(const String &p_menu_root, int p_idx, const String &p_submenu);
  142. virtual void global_menu_set_item_accelerator(const String &p_menu_root, int p_idx, Key p_keycode);
  143. virtual void global_menu_set_item_disabled(const String &p_menu_root, int p_idx, bool p_disabled);
  144. virtual void global_menu_set_item_tooltip(const String &p_menu_root, int p_idx, const String &p_tooltip);
  145. virtual void global_menu_set_item_state(const String &p_menu_root, int p_idx, int p_state);
  146. virtual void global_menu_set_item_max_states(const String &p_menu_root, int p_idx, int p_max_states);
  147. virtual void global_menu_set_item_icon(const String &p_menu_root, int p_idx, const Ref<Texture2D> &p_icon);
  148. virtual int global_menu_get_item_count(const String &p_menu_root) const;
  149. virtual void global_menu_remove_item(const String &p_menu_root, int p_idx);
  150. virtual void global_menu_clear(const String &p_menu_root);
  151. struct TTSUtterance {
  152. String text;
  153. String voice;
  154. int volume = 50;
  155. float pitch = 1.f;
  156. float rate = 1.f;
  157. int id = 0;
  158. };
  159. enum TTSUtteranceEvent {
  160. TTS_UTTERANCE_STARTED,
  161. TTS_UTTERANCE_ENDED,
  162. TTS_UTTERANCE_CANCELED,
  163. TTS_UTTERANCE_BOUNDARY,
  164. TTS_UTTERANCE_MAX,
  165. };
  166. private:
  167. Callable utterance_callback[TTS_UTTERANCE_MAX];
  168. public:
  169. virtual bool tts_is_speaking() const;
  170. virtual bool tts_is_paused() const;
  171. virtual Array tts_get_voices() const;
  172. virtual PackedStringArray tts_get_voices_for_language(const String &p_language) const;
  173. 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);
  174. virtual void tts_pause();
  175. virtual void tts_resume();
  176. virtual void tts_stop();
  177. virtual void tts_set_utterance_callback(TTSUtteranceEvent p_event, const Callable &p_callable);
  178. virtual void tts_post_utterance_event(TTSUtteranceEvent p_event, int p_id, int p_pos = 0);
  179. enum MouseMode {
  180. MOUSE_MODE_VISIBLE,
  181. MOUSE_MODE_HIDDEN,
  182. MOUSE_MODE_CAPTURED,
  183. MOUSE_MODE_CONFINED,
  184. MOUSE_MODE_CONFINED_HIDDEN,
  185. };
  186. virtual void mouse_set_mode(MouseMode p_mode);
  187. virtual MouseMode mouse_get_mode() const;
  188. virtual void warp_mouse(const Point2i &p_position);
  189. virtual Point2i mouse_get_position() const;
  190. virtual MouseButton mouse_get_button_state() const;
  191. virtual void clipboard_set(const String &p_text);
  192. virtual String clipboard_get() const;
  193. virtual bool clipboard_has() const;
  194. virtual void clipboard_set_primary(const String &p_text);
  195. virtual String clipboard_get_primary() const;
  196. virtual Array get_display_cutouts() const { return Array(); }
  197. virtual Rect2i get_display_safe_area() const { return screen_get_usable_rect(); }
  198. enum {
  199. SCREEN_OF_MAIN_WINDOW = -1
  200. };
  201. const float SCREEN_REFRESH_RATE_FALLBACK = -1.0; // Returned by screen_get_refresh_rate if the method fails.
  202. virtual int get_screen_count() const = 0;
  203. virtual Point2i screen_get_position(int p_screen = SCREEN_OF_MAIN_WINDOW) const = 0;
  204. virtual Size2i screen_get_size(int p_screen = SCREEN_OF_MAIN_WINDOW) const = 0;
  205. virtual Rect2i screen_get_usable_rect(int p_screen = SCREEN_OF_MAIN_WINDOW) const = 0;
  206. virtual int screen_get_dpi(int p_screen = SCREEN_OF_MAIN_WINDOW) const = 0;
  207. virtual float screen_get_scale(int p_screen = SCREEN_OF_MAIN_WINDOW) const;
  208. virtual float screen_get_max_scale() const {
  209. float scale = 1.f;
  210. int screen_count = get_screen_count();
  211. for (int i = 0; i < screen_count; i++) {
  212. scale = fmax(scale, screen_get_scale(i));
  213. }
  214. return scale;
  215. }
  216. virtual float screen_get_refresh_rate(int p_screen = SCREEN_OF_MAIN_WINDOW) const = 0;
  217. virtual bool screen_is_touchscreen(int p_screen = SCREEN_OF_MAIN_WINDOW) const;
  218. // Keep the ScreenOrientation enum values in sync with the `display/window/handheld/orientation`
  219. // project setting hint.
  220. enum ScreenOrientation {
  221. SCREEN_LANDSCAPE,
  222. SCREEN_PORTRAIT,
  223. SCREEN_REVERSE_LANDSCAPE,
  224. SCREEN_REVERSE_PORTRAIT,
  225. SCREEN_SENSOR_LANDSCAPE,
  226. SCREEN_SENSOR_PORTRAIT,
  227. SCREEN_SENSOR,
  228. };
  229. virtual void screen_set_orientation(ScreenOrientation p_orientation, int p_screen = SCREEN_OF_MAIN_WINDOW);
  230. virtual ScreenOrientation screen_get_orientation(int p_screen = SCREEN_OF_MAIN_WINDOW) const;
  231. virtual void screen_set_keep_on(bool p_enable); //disable screensaver
  232. virtual bool screen_is_kept_on() const;
  233. enum {
  234. MAIN_WINDOW_ID = 0,
  235. INVALID_WINDOW_ID = -1
  236. };
  237. typedef int WindowID;
  238. virtual Vector<DisplayServer::WindowID> get_window_list() const = 0;
  239. enum WindowFlags {
  240. WINDOW_FLAG_RESIZE_DISABLED,
  241. WINDOW_FLAG_BORDERLESS,
  242. WINDOW_FLAG_ALWAYS_ON_TOP,
  243. WINDOW_FLAG_TRANSPARENT,
  244. WINDOW_FLAG_NO_FOCUS,
  245. WINDOW_FLAG_POPUP,
  246. WINDOW_FLAG_MAX,
  247. };
  248. // Separate enum otherwise we get warnings in switches not handling all values.
  249. enum WindowFlagsBit {
  250. WINDOW_FLAG_RESIZE_DISABLED_BIT = (1 << WINDOW_FLAG_RESIZE_DISABLED),
  251. WINDOW_FLAG_BORDERLESS_BIT = (1 << WINDOW_FLAG_BORDERLESS),
  252. WINDOW_FLAG_ALWAYS_ON_TOP_BIT = (1 << WINDOW_FLAG_ALWAYS_ON_TOP),
  253. WINDOW_FLAG_TRANSPARENT_BIT = (1 << WINDOW_FLAG_TRANSPARENT),
  254. WINDOW_FLAG_NO_FOCUS_BIT = (1 << WINDOW_FLAG_NO_FOCUS),
  255. WINDOW_FLAG_POPUP_BIT = (1 << WINDOW_FLAG_POPUP),
  256. };
  257. virtual WindowID create_sub_window(WindowMode p_mode, VSyncMode p_vsync_mode, uint32_t p_flags, const Rect2i &p_rect = Rect2i());
  258. virtual void show_window(WindowID p_id);
  259. virtual void delete_sub_window(WindowID p_id);
  260. virtual WindowID window_get_active_popup() const { return INVALID_WINDOW_ID; };
  261. virtual void window_set_popup_safe_rect(WindowID p_window, const Rect2i &p_rect){};
  262. virtual Rect2i window_get_popup_safe_rect(WindowID p_window) const { return Rect2i(); };
  263. virtual int64_t window_get_native_handle(HandleType p_handle_type, WindowID p_window = MAIN_WINDOW_ID) const;
  264. virtual WindowID get_window_at_screen_position(const Point2i &p_position) const = 0;
  265. virtual void window_attach_instance_id(ObjectID p_instance, WindowID p_window = MAIN_WINDOW_ID) = 0;
  266. virtual ObjectID window_get_attached_instance_id(WindowID p_window = MAIN_WINDOW_ID) const = 0;
  267. virtual void window_set_rect_changed_callback(const Callable &p_callable, WindowID p_window = MAIN_WINDOW_ID) = 0;
  268. enum WindowEvent {
  269. WINDOW_EVENT_MOUSE_ENTER,
  270. WINDOW_EVENT_MOUSE_EXIT,
  271. WINDOW_EVENT_FOCUS_IN,
  272. WINDOW_EVENT_FOCUS_OUT,
  273. WINDOW_EVENT_CLOSE_REQUEST,
  274. WINDOW_EVENT_GO_BACK_REQUEST,
  275. WINDOW_EVENT_DPI_CHANGE,
  276. };
  277. virtual void window_set_window_event_callback(const Callable &p_callable, WindowID p_window = MAIN_WINDOW_ID) = 0;
  278. virtual void window_set_input_event_callback(const Callable &p_callable, WindowID p_window = MAIN_WINDOW_ID) = 0;
  279. virtual void window_set_input_text_callback(const Callable &p_callable, WindowID p_window = MAIN_WINDOW_ID) = 0;
  280. virtual void window_set_drop_files_callback(const Callable &p_callable, WindowID p_window = MAIN_WINDOW_ID) = 0;
  281. virtual void window_set_title(const String &p_title, WindowID p_window = MAIN_WINDOW_ID) = 0;
  282. virtual void window_set_mouse_passthrough(const Vector<Vector2> &p_region, WindowID p_window = MAIN_WINDOW_ID);
  283. virtual int window_get_current_screen(WindowID p_window = MAIN_WINDOW_ID) const = 0;
  284. virtual void window_set_current_screen(int p_screen, WindowID p_window = MAIN_WINDOW_ID) = 0;
  285. virtual Point2i window_get_position(WindowID p_window = MAIN_WINDOW_ID) const = 0;
  286. virtual void window_set_position(const Point2i &p_position, WindowID p_window = MAIN_WINDOW_ID) = 0;
  287. virtual void window_set_transient(WindowID p_window, WindowID p_parent) = 0;
  288. virtual void window_set_exclusive(WindowID p_window, bool p_exclusive);
  289. virtual void window_set_max_size(const Size2i p_size, WindowID p_window = MAIN_WINDOW_ID) = 0;
  290. virtual Size2i window_get_max_size(WindowID p_window = MAIN_WINDOW_ID) const = 0;
  291. virtual void window_set_min_size(const Size2i p_size, WindowID p_window = MAIN_WINDOW_ID) = 0;
  292. virtual Size2i window_get_min_size(WindowID p_window = MAIN_WINDOW_ID) const = 0;
  293. virtual void window_set_size(const Size2i p_size, WindowID p_window = MAIN_WINDOW_ID) = 0;
  294. virtual Size2i window_get_size(WindowID p_window = MAIN_WINDOW_ID) const = 0;
  295. virtual Size2i window_get_real_size(WindowID p_window = MAIN_WINDOW_ID) const = 0; // FIXME: Find clearer name for this.
  296. virtual void window_set_mode(WindowMode p_mode, WindowID p_window = MAIN_WINDOW_ID) = 0;
  297. virtual WindowMode window_get_mode(WindowID p_window = MAIN_WINDOW_ID) const = 0;
  298. virtual void window_set_vsync_mode(VSyncMode p_vsync_mode, WindowID p_window = MAIN_WINDOW_ID);
  299. virtual VSyncMode window_get_vsync_mode(WindowID p_window) const;
  300. virtual bool window_is_maximize_allowed(WindowID p_window = MAIN_WINDOW_ID) const = 0;
  301. virtual void window_set_flag(WindowFlags p_flag, bool p_enabled, WindowID p_window = MAIN_WINDOW_ID) = 0;
  302. virtual bool window_get_flag(WindowFlags p_flag, WindowID p_window = MAIN_WINDOW_ID) const = 0;
  303. virtual void window_request_attention(WindowID p_window = MAIN_WINDOW_ID) = 0;
  304. virtual void window_move_to_foreground(WindowID p_window = MAIN_WINDOW_ID) = 0;
  305. virtual bool window_can_draw(WindowID p_window = MAIN_WINDOW_ID) const = 0;
  306. virtual bool can_any_window_draw() const = 0;
  307. virtual void window_set_ime_active(const bool p_active, WindowID p_window = MAIN_WINDOW_ID);
  308. virtual void window_set_ime_position(const Point2i &p_pos, WindowID p_window = MAIN_WINDOW_ID);
  309. // necessary for GL focus, may be able to use one of the existing functions for this, not sure yet
  310. virtual void gl_window_make_current(DisplayServer::WindowID p_window_id);
  311. virtual Point2i ime_get_selection() const;
  312. virtual String ime_get_text() const;
  313. virtual void virtual_keyboard_show(const String &p_existing_text, const Rect2 &p_screen_rect = Rect2(), bool p_multiline = false, int p_max_length = -1, int p_cursor_start = -1, int p_cursor_end = -1);
  314. virtual void virtual_keyboard_hide();
  315. // returns height of the currently shown virtual keyboard (0 if keyboard is hidden)
  316. virtual int virtual_keyboard_get_height() const;
  317. enum CursorShape {
  318. CURSOR_ARROW,
  319. CURSOR_IBEAM,
  320. CURSOR_POINTING_HAND,
  321. CURSOR_CROSS,
  322. CURSOR_WAIT,
  323. CURSOR_BUSY,
  324. CURSOR_DRAG,
  325. CURSOR_CAN_DROP,
  326. CURSOR_FORBIDDEN,
  327. CURSOR_VSIZE,
  328. CURSOR_HSIZE,
  329. CURSOR_BDIAGSIZE,
  330. CURSOR_FDIAGSIZE,
  331. CURSOR_MOVE,
  332. CURSOR_VSPLIT,
  333. CURSOR_HSPLIT,
  334. CURSOR_HELP,
  335. CURSOR_MAX
  336. };
  337. virtual void cursor_set_shape(CursorShape p_shape);
  338. virtual CursorShape cursor_get_shape() const;
  339. virtual void cursor_set_custom_image(const Ref<Resource> &p_cursor, CursorShape p_shape = CURSOR_ARROW, const Vector2 &p_hotspot = Vector2());
  340. virtual bool get_swap_cancel_ok();
  341. virtual void enable_for_stealing_focus(OS::ProcessID pid);
  342. virtual Error dialog_show(String p_title, String p_description, Vector<String> p_buttons, const Callable &p_callback);
  343. virtual Error dialog_input_text(String p_title, String p_description, String p_partial, const Callable &p_callback);
  344. virtual int keyboard_get_layout_count() const;
  345. virtual int keyboard_get_current_layout() const;
  346. virtual void keyboard_set_current_layout(int p_index);
  347. virtual String keyboard_get_layout_language(int p_index) const;
  348. virtual String keyboard_get_layout_name(int p_index) const;
  349. virtual Key keyboard_get_keycode_from_physical(Key p_keycode) const;
  350. virtual int tablet_get_driver_count() const { return 1; };
  351. virtual String tablet_get_driver_name(int p_driver) const { return "default"; };
  352. virtual String tablet_get_current_driver() const { return "default"; };
  353. virtual void tablet_set_current_driver(const String &p_driver){};
  354. virtual void process_events() = 0;
  355. virtual void force_process_and_drop_events();
  356. virtual void release_rendering_thread();
  357. virtual void make_rendering_thread();
  358. virtual void swap_buffers();
  359. virtual void set_native_icon(const String &p_filename);
  360. virtual void set_icon(const Ref<Image> &p_icon);
  361. enum Context {
  362. CONTEXT_EDITOR,
  363. CONTEXT_PROJECTMAN,
  364. CONTEXT_ENGINE,
  365. };
  366. virtual void set_context(Context p_context);
  367. static void register_create_function(const char *p_name, CreateFunction p_function, GetRenderingDriversFunction p_get_drivers);
  368. static int get_create_function_count();
  369. static const char *get_create_function_name(int p_index);
  370. static Vector<String> get_create_function_rendering_drivers(int p_index);
  371. 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_resolution, Error &r_error);
  372. DisplayServer();
  373. ~DisplayServer();
  374. };
  375. VARIANT_ENUM_CAST(DisplayServer::WindowEvent)
  376. VARIANT_ENUM_CAST(DisplayServer::Feature)
  377. VARIANT_ENUM_CAST(DisplayServer::MouseMode)
  378. VARIANT_ENUM_CAST(DisplayServer::ScreenOrientation)
  379. VARIANT_ENUM_CAST(DisplayServer::WindowMode)
  380. VARIANT_ENUM_CAST(DisplayServer::WindowFlags)
  381. VARIANT_ENUM_CAST(DisplayServer::HandleType)
  382. VARIANT_ENUM_CAST(DisplayServer::CursorShape)
  383. VARIANT_ENUM_CAST(DisplayServer::VSyncMode)
  384. VARIANT_ENUM_CAST(DisplayServer::TTSUtteranceEvent)
  385. #endif // DISPLAY_SERVER_H