display_server_android.cpp 32 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973
  1. /**************************************************************************/
  2. /* display_server_android.cpp */
  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. #include "display_server_android.h"
  31. #include "java_godot_io_wrapper.h"
  32. #include "java_godot_wrapper.h"
  33. #include "os_android.h"
  34. #include "tts_android.h"
  35. #include "core/config/project_settings.h"
  36. #if defined(RD_ENABLED)
  37. #include "servers/rendering/renderer_rd/renderer_compositor_rd.h"
  38. #include "servers/rendering/rendering_device.h"
  39. #if defined(VULKAN_ENABLED)
  40. #include "rendering_context_driver_vulkan_android.h"
  41. #endif
  42. #endif
  43. #ifdef GLES3_ENABLED
  44. #include "drivers/gles3/rasterizer_gles3.h"
  45. #include <EGL/egl.h>
  46. #endif
  47. DisplayServerAndroid *DisplayServerAndroid::get_singleton() {
  48. return static_cast<DisplayServerAndroid *>(DisplayServer::get_singleton());
  49. }
  50. bool DisplayServerAndroid::has_feature(Feature p_feature) const {
  51. switch (p_feature) {
  52. #ifndef DISABLE_DEPRECATED
  53. case FEATURE_GLOBAL_MENU: {
  54. return (native_menu && native_menu->has_feature(NativeMenu::FEATURE_GLOBAL_MENU));
  55. } break;
  56. #endif
  57. case FEATURE_CURSOR_SHAPE:
  58. //case FEATURE_CUSTOM_CURSOR_SHAPE:
  59. //case FEATURE_HIDPI:
  60. //case FEATURE_ICON:
  61. //case FEATURE_IME:
  62. case FEATURE_MOUSE:
  63. //case FEATURE_MOUSE_WARP:
  64. case FEATURE_NATIVE_DIALOG:
  65. case FEATURE_NATIVE_DIALOG_INPUT:
  66. case FEATURE_NATIVE_DIALOG_FILE:
  67. //case FEATURE_NATIVE_DIALOG_FILE_EXTRA:
  68. case FEATURE_NATIVE_DIALOG_FILE_MIME:
  69. //case FEATURE_NATIVE_ICON:
  70. case FEATURE_WINDOW_TRANSPARENCY:
  71. case FEATURE_CLIPBOARD:
  72. case FEATURE_KEEP_SCREEN_ON:
  73. case FEATURE_ORIENTATION:
  74. case FEATURE_TOUCHSCREEN:
  75. case FEATURE_VIRTUAL_KEYBOARD:
  76. case FEATURE_TEXT_TO_SPEECH:
  77. return true;
  78. default:
  79. return false;
  80. }
  81. }
  82. String DisplayServerAndroid::get_name() const {
  83. return "Android";
  84. }
  85. bool DisplayServerAndroid::tts_is_speaking() const {
  86. return TTS_Android::is_speaking();
  87. }
  88. bool DisplayServerAndroid::tts_is_paused() const {
  89. return TTS_Android::is_paused();
  90. }
  91. TypedArray<Dictionary> DisplayServerAndroid::tts_get_voices() const {
  92. return TTS_Android::get_voices();
  93. }
  94. void DisplayServerAndroid::tts_speak(const String &p_text, const String &p_voice, int p_volume, float p_pitch, float p_rate, int p_utterance_id, bool p_interrupt) {
  95. TTS_Android::speak(p_text, p_voice, p_volume, p_pitch, p_rate, p_utterance_id, p_interrupt);
  96. }
  97. void DisplayServerAndroid::tts_pause() {
  98. TTS_Android::pause();
  99. }
  100. void DisplayServerAndroid::tts_resume() {
  101. TTS_Android::resume();
  102. }
  103. void DisplayServerAndroid::tts_stop() {
  104. TTS_Android::stop();
  105. }
  106. bool DisplayServerAndroid::is_dark_mode_supported() const {
  107. GodotJavaWrapper *godot_java = OS_Android::get_singleton()->get_godot_java();
  108. ERR_FAIL_NULL_V(godot_java, false);
  109. return godot_java->is_dark_mode_supported();
  110. }
  111. bool DisplayServerAndroid::is_dark_mode() const {
  112. GodotJavaWrapper *godot_java = OS_Android::get_singleton()->get_godot_java();
  113. ERR_FAIL_NULL_V(godot_java, false);
  114. return godot_java->is_dark_mode();
  115. }
  116. void DisplayServerAndroid::set_system_theme_change_callback(const Callable &p_callable) {
  117. system_theme_changed = p_callable;
  118. }
  119. void DisplayServerAndroid::emit_system_theme_changed() {
  120. if (system_theme_changed.is_valid()) {
  121. system_theme_changed.call_deferred();
  122. }
  123. }
  124. void DisplayServerAndroid::set_hardware_keyboard_connection_change_callback(const Callable &p_callable) {
  125. hardware_keyboard_connection_changed = p_callable;
  126. }
  127. void DisplayServerAndroid::emit_hardware_keyboard_connection_changed(bool p_connected) {
  128. if (hardware_keyboard_connection_changed.is_valid()) {
  129. hardware_keyboard_connection_changed.call_deferred(p_connected);
  130. }
  131. }
  132. void DisplayServerAndroid::clipboard_set(const String &p_text) {
  133. GodotJavaWrapper *godot_java = OS_Android::get_singleton()->get_godot_java();
  134. ERR_FAIL_NULL(godot_java);
  135. if (godot_java->has_set_clipboard()) {
  136. godot_java->set_clipboard(p_text);
  137. } else {
  138. DisplayServer::clipboard_set(p_text);
  139. }
  140. }
  141. String DisplayServerAndroid::clipboard_get() const {
  142. GodotJavaWrapper *godot_java = OS_Android::get_singleton()->get_godot_java();
  143. ERR_FAIL_NULL_V(godot_java, String());
  144. if (godot_java->has_get_clipboard()) {
  145. return godot_java->get_clipboard();
  146. } else {
  147. return DisplayServer::clipboard_get();
  148. }
  149. }
  150. bool DisplayServerAndroid::clipboard_has() const {
  151. GodotJavaWrapper *godot_java = OS_Android::get_singleton()->get_godot_java();
  152. ERR_FAIL_NULL_V(godot_java, false);
  153. if (godot_java->has_has_clipboard()) {
  154. return godot_java->has_clipboard();
  155. } else {
  156. return DisplayServer::clipboard_has();
  157. }
  158. }
  159. Error DisplayServerAndroid::dialog_show(String p_title, String p_description, Vector<String> p_buttons, const Callable &p_callback) {
  160. GodotJavaWrapper *godot_java = OS_Android::get_singleton()->get_godot_java();
  161. ERR_FAIL_NULL_V(godot_java, FAILED);
  162. dialog_callback = p_callback;
  163. return godot_java->show_dialog(p_title, p_description, p_buttons);
  164. }
  165. void DisplayServerAndroid::emit_dialog_callback(int p_button_index) {
  166. if (dialog_callback.is_valid()) {
  167. dialog_callback.call_deferred(p_button_index);
  168. }
  169. }
  170. Error DisplayServerAndroid::dialog_input_text(String p_title, String p_description, String p_partial, const Callable &p_callback) {
  171. GodotJavaWrapper *godot_java = OS_Android::get_singleton()->get_godot_java();
  172. ERR_FAIL_NULL_V(godot_java, FAILED);
  173. input_dialog_callback = p_callback;
  174. return godot_java->show_input_dialog(p_title, p_description, p_partial);
  175. }
  176. void DisplayServerAndroid::emit_input_dialog_callback(String p_text) {
  177. if (input_dialog_callback.is_valid()) {
  178. input_dialog_callback.call_deferred(p_text);
  179. }
  180. }
  181. Error DisplayServerAndroid::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) {
  182. GodotJavaWrapper *godot_java = OS_Android::get_singleton()->get_godot_java();
  183. ERR_FAIL_NULL_V(godot_java, FAILED);
  184. file_picker_callback = p_callback;
  185. return godot_java->show_file_picker(p_current_directory, p_filename, p_mode, p_filters);
  186. }
  187. void DisplayServerAndroid::emit_file_picker_callback(bool p_ok, const Vector<String> &p_selected_paths) {
  188. if (file_picker_callback.is_valid()) {
  189. file_picker_callback.call_deferred(p_ok, p_selected_paths, 0);
  190. }
  191. }
  192. Color DisplayServerAndroid::get_accent_color() const {
  193. GodotJavaWrapper *godot_java = OS_Android::get_singleton()->get_godot_java();
  194. ERR_FAIL_NULL_V(godot_java, Color(0, 0, 0, 0));
  195. return godot_java->get_accent_color();
  196. }
  197. Color DisplayServerAndroid::get_base_color() const {
  198. GodotJavaWrapper *godot_java = OS_Android::get_singleton()->get_godot_java();
  199. ERR_FAIL_NULL_V(godot_java, Color(0, 0, 0, 0));
  200. return godot_java->get_base_color();
  201. }
  202. TypedArray<Rect2> DisplayServerAndroid::get_display_cutouts() const {
  203. GodotIOJavaWrapper *godot_io_java = OS_Android::get_singleton()->get_godot_io_java();
  204. ERR_FAIL_NULL_V(godot_io_java, Array());
  205. return godot_io_java->get_display_cutouts();
  206. }
  207. Rect2i DisplayServerAndroid::get_display_safe_area() const {
  208. GodotIOJavaWrapper *godot_io_java = OS_Android::get_singleton()->get_godot_io_java();
  209. ERR_FAIL_NULL_V(godot_io_java, Rect2i());
  210. return godot_io_java->get_display_safe_area();
  211. }
  212. void DisplayServerAndroid::screen_set_keep_on(bool p_enable) {
  213. GodotJavaWrapper *godot_java = OS_Android::get_singleton()->get_godot_java();
  214. ERR_FAIL_NULL(godot_java);
  215. godot_java->set_keep_screen_on(p_enable);
  216. keep_screen_on = p_enable;
  217. }
  218. bool DisplayServerAndroid::screen_is_kept_on() const {
  219. return keep_screen_on;
  220. }
  221. void DisplayServerAndroid::screen_set_orientation(DisplayServer::ScreenOrientation p_orientation, int p_screen) {
  222. p_screen = _get_screen_index(p_screen);
  223. int screen_count = get_screen_count();
  224. ERR_FAIL_INDEX(p_screen, screen_count);
  225. GodotIOJavaWrapper *godot_io_java = OS_Android::get_singleton()->get_godot_io_java();
  226. ERR_FAIL_NULL(godot_io_java);
  227. godot_io_java->set_screen_orientation(p_orientation);
  228. }
  229. DisplayServer::ScreenOrientation DisplayServerAndroid::screen_get_orientation(int p_screen) const {
  230. p_screen = _get_screen_index(p_screen);
  231. int screen_count = get_screen_count();
  232. ERR_FAIL_INDEX_V(p_screen, screen_count, SCREEN_LANDSCAPE);
  233. GodotIOJavaWrapper *godot_io_java = OS_Android::get_singleton()->get_godot_io_java();
  234. ERR_FAIL_NULL_V(godot_io_java, SCREEN_LANDSCAPE);
  235. const int orientation = godot_io_java->get_screen_orientation();
  236. ERR_FAIL_INDEX_V_MSG(orientation, 7, SCREEN_LANDSCAPE, "Unrecognized screen orientation");
  237. return (ScreenOrientation)orientation;
  238. }
  239. int DisplayServerAndroid::get_display_rotation() const {
  240. GodotIOJavaWrapper *godot_io_java = OS_Android::get_singleton()->get_godot_io_java();
  241. ERR_FAIL_NULL_V(godot_io_java, 0);
  242. return godot_io_java->get_display_rotation();
  243. }
  244. int DisplayServerAndroid::get_screen_count() const {
  245. return 1;
  246. }
  247. int DisplayServerAndroid::get_primary_screen() const {
  248. return 0;
  249. }
  250. Point2i DisplayServerAndroid::screen_get_position(int p_screen) const {
  251. p_screen = _get_screen_index(p_screen);
  252. int screen_count = get_screen_count();
  253. ERR_FAIL_INDEX_V(p_screen, screen_count, Point2i());
  254. return Point2i(0, 0);
  255. }
  256. Size2i DisplayServerAndroid::screen_get_size(int p_screen) const {
  257. p_screen = _get_screen_index(p_screen);
  258. int screen_count = get_screen_count();
  259. ERR_FAIL_INDEX_V(p_screen, screen_count, Size2i());
  260. return OS_Android::get_singleton()->get_display_size();
  261. }
  262. Rect2i DisplayServerAndroid::screen_get_usable_rect(int p_screen) const {
  263. p_screen = _get_screen_index(p_screen);
  264. int screen_count = get_screen_count();
  265. ERR_FAIL_INDEX_V(p_screen, screen_count, Rect2i());
  266. Size2i display_size = OS_Android::get_singleton()->get_display_size();
  267. return Rect2i(0, 0, display_size.width, display_size.height);
  268. }
  269. int DisplayServerAndroid::screen_get_dpi(int p_screen) const {
  270. p_screen = _get_screen_index(p_screen);
  271. int screen_count = get_screen_count();
  272. ERR_FAIL_INDEX_V(p_screen, screen_count, 160);
  273. GodotIOJavaWrapper *godot_io_java = OS_Android::get_singleton()->get_godot_io_java();
  274. ERR_FAIL_NULL_V(godot_io_java, 160);
  275. return godot_io_java->get_screen_dpi();
  276. }
  277. float DisplayServerAndroid::screen_get_scale(int p_screen) const {
  278. p_screen = _get_screen_index(p_screen);
  279. int screen_count = get_screen_count();
  280. ERR_FAIL_INDEX_V(p_screen, screen_count, 1.0f);
  281. GodotIOJavaWrapper *godot_io_java = OS_Android::get_singleton()->get_godot_io_java();
  282. ERR_FAIL_NULL_V(godot_io_java, 1.0f);
  283. float screen_scale = godot_io_java->get_scaled_density();
  284. // Update the scale to avoid cropping.
  285. Size2i screen_size = screen_get_size(p_screen);
  286. if (screen_size != Size2i()) {
  287. float width_scale = screen_size.width / (float)OS_Android::DEFAULT_WINDOW_WIDTH;
  288. float height_scale = screen_size.height / (float)OS_Android::DEFAULT_WINDOW_HEIGHT;
  289. screen_scale = MIN(screen_scale, MIN(width_scale, height_scale));
  290. }
  291. return screen_scale;
  292. }
  293. float DisplayServerAndroid::screen_get_refresh_rate(int p_screen) const {
  294. p_screen = _get_screen_index(p_screen);
  295. int screen_count = get_screen_count();
  296. ERR_FAIL_INDEX_V(p_screen, screen_count, SCREEN_REFRESH_RATE_FALLBACK);
  297. GodotIOJavaWrapper *godot_io_java = OS_Android::get_singleton()->get_godot_io_java();
  298. if (!godot_io_java) {
  299. ERR_PRINT("An error occurred while trying to get the screen refresh rate.");
  300. return SCREEN_REFRESH_RATE_FALLBACK;
  301. }
  302. return godot_io_java->get_screen_refresh_rate(SCREEN_REFRESH_RATE_FALLBACK);
  303. }
  304. bool DisplayServerAndroid::is_touchscreen_available() const {
  305. return true;
  306. }
  307. void DisplayServerAndroid::virtual_keyboard_show(const String &p_existing_text, const Rect2 &p_screen_rect, VirtualKeyboardType p_type, int p_max_length, int p_cursor_start, int p_cursor_end) {
  308. GodotIOJavaWrapper *godot_io_java = OS_Android::get_singleton()->get_godot_io_java();
  309. ERR_FAIL_NULL(godot_io_java);
  310. if (godot_io_java->has_vk()) {
  311. godot_io_java->show_vk(p_existing_text, (int)p_type, p_max_length, p_cursor_start, p_cursor_end);
  312. } else {
  313. ERR_PRINT("Virtual keyboard not available");
  314. }
  315. }
  316. void DisplayServerAndroid::virtual_keyboard_hide() {
  317. GodotIOJavaWrapper *godot_io_java = OS_Android::get_singleton()->get_godot_io_java();
  318. ERR_FAIL_NULL(godot_io_java);
  319. if (godot_io_java->has_vk()) {
  320. godot_io_java->hide_vk();
  321. } else {
  322. ERR_PRINT("Virtual keyboard not available");
  323. }
  324. }
  325. int DisplayServerAndroid::virtual_keyboard_get_height() const {
  326. GodotIOJavaWrapper *godot_io_java = OS_Android::get_singleton()->get_godot_io_java();
  327. ERR_FAIL_NULL_V(godot_io_java, 0);
  328. return godot_io_java->get_vk_height();
  329. }
  330. bool DisplayServerAndroid::has_hardware_keyboard() const {
  331. GodotIOJavaWrapper *godot_io_java = OS_Android::get_singleton()->get_godot_io_java();
  332. ERR_FAIL_NULL_V(godot_io_java, false);
  333. return godot_io_java->has_hardware_keyboard();
  334. }
  335. void DisplayServerAndroid::window_set_window_event_callback(const Callable &p_callable, DisplayServer::WindowID p_window) {
  336. window_event_callback = p_callable;
  337. }
  338. void DisplayServerAndroid::window_set_input_event_callback(const Callable &p_callable, DisplayServer::WindowID p_window) {
  339. input_event_callback = p_callable;
  340. }
  341. void DisplayServerAndroid::window_set_input_text_callback(const Callable &p_callable, DisplayServer::WindowID p_window) {
  342. input_text_callback = p_callable;
  343. }
  344. void DisplayServerAndroid::window_set_rect_changed_callback(const Callable &p_callable, DisplayServer::WindowID p_window) {
  345. rect_changed_callback = p_callable;
  346. }
  347. void DisplayServerAndroid::window_set_drop_files_callback(const Callable &p_callable, DisplayServer::WindowID p_window) {
  348. // Not supported on Android.
  349. }
  350. void DisplayServerAndroid::_window_callback(const Callable &p_callable, const Variant &p_arg, bool p_deferred) const {
  351. if (p_callable.is_valid()) {
  352. if (p_deferred) {
  353. p_callable.call_deferred(p_arg);
  354. } else {
  355. p_callable.call(p_arg);
  356. }
  357. }
  358. }
  359. void DisplayServerAndroid::send_window_event(DisplayServer::WindowEvent p_event, bool p_deferred) const {
  360. _window_callback(window_event_callback, int(p_event), p_deferred);
  361. }
  362. void DisplayServerAndroid::send_input_event(const Ref<InputEvent> &p_event) const {
  363. _window_callback(input_event_callback, p_event);
  364. }
  365. void DisplayServerAndroid::send_input_text(const String &p_text) const {
  366. _window_callback(input_text_callback, p_text);
  367. }
  368. void DisplayServerAndroid::_dispatch_input_events(const Ref<InputEvent> &p_event) {
  369. DisplayServerAndroid::get_singleton()->send_input_event(p_event);
  370. }
  371. Vector<DisplayServer::WindowID> DisplayServerAndroid::get_window_list() const {
  372. Vector<WindowID> ret;
  373. ret.push_back(MAIN_WINDOW_ID);
  374. return ret;
  375. }
  376. DisplayServer::WindowID DisplayServerAndroid::get_window_at_screen_position(const Point2i &p_position) const {
  377. return MAIN_WINDOW_ID;
  378. }
  379. int64_t DisplayServerAndroid::window_get_native_handle(HandleType p_handle_type, WindowID p_window) const {
  380. ERR_FAIL_COND_V(p_window != MAIN_WINDOW_ID, 0);
  381. switch (p_handle_type) {
  382. case WINDOW_HANDLE: {
  383. return reinterpret_cast<int64_t>(static_cast<OS_Android *>(OS::get_singleton())->get_godot_java()->get_activity());
  384. }
  385. case WINDOW_VIEW: {
  386. return 0; // Not supported.
  387. }
  388. #ifdef GLES3_ENABLED
  389. case DISPLAY_HANDLE: {
  390. if (rendering_driver == "opengl3") {
  391. return reinterpret_cast<int64_t>(eglGetCurrentDisplay());
  392. }
  393. return 0;
  394. }
  395. case OPENGL_CONTEXT: {
  396. if (rendering_driver == "opengl3") {
  397. return reinterpret_cast<int64_t>(eglGetCurrentContext());
  398. }
  399. return 0;
  400. }
  401. case EGL_DISPLAY: {
  402. // @todo Find a way to get this from the Java side.
  403. return 0;
  404. }
  405. case EGL_CONFIG: {
  406. // @todo Find a way to get this from the Java side.
  407. return 0;
  408. }
  409. #endif
  410. default: {
  411. return 0;
  412. }
  413. }
  414. }
  415. void DisplayServerAndroid::window_attach_instance_id(ObjectID p_instance, DisplayServer::WindowID p_window) {
  416. window_attached_instance_id = p_instance;
  417. }
  418. ObjectID DisplayServerAndroid::window_get_attached_instance_id(DisplayServer::WindowID p_window) const {
  419. return window_attached_instance_id;
  420. }
  421. void DisplayServerAndroid::window_set_title(const String &p_title, DisplayServer::WindowID p_window) {
  422. // Not supported on Android.
  423. }
  424. int DisplayServerAndroid::window_get_current_screen(DisplayServer::WindowID p_window) const {
  425. ERR_FAIL_COND_V(p_window != MAIN_WINDOW_ID, INVALID_SCREEN);
  426. return 0;
  427. }
  428. void DisplayServerAndroid::window_set_current_screen(int p_screen, DisplayServer::WindowID p_window) {
  429. // Not supported on Android.
  430. }
  431. Point2i DisplayServerAndroid::window_get_position(DisplayServer::WindowID p_window) const {
  432. return Point2i();
  433. }
  434. Point2i DisplayServerAndroid::window_get_position_with_decorations(DisplayServer::WindowID p_window) const {
  435. return Point2i();
  436. }
  437. void DisplayServerAndroid::window_set_position(const Point2i &p_position, DisplayServer::WindowID p_window) {
  438. // Not supported on Android.
  439. }
  440. void DisplayServerAndroid::window_set_transient(DisplayServer::WindowID p_window, DisplayServer::WindowID p_parent) {
  441. // Not supported on Android.
  442. }
  443. void DisplayServerAndroid::window_set_max_size(const Size2i p_size, DisplayServer::WindowID p_window) {
  444. // Not supported on Android.
  445. }
  446. Size2i DisplayServerAndroid::window_get_max_size(DisplayServer::WindowID p_window) const {
  447. return Size2i();
  448. }
  449. void DisplayServerAndroid::window_set_min_size(const Size2i p_size, DisplayServer::WindowID p_window) {
  450. // Not supported on Android.
  451. }
  452. Size2i DisplayServerAndroid::window_get_min_size(DisplayServer::WindowID p_window) const {
  453. return Size2i();
  454. }
  455. void DisplayServerAndroid::window_set_size(const Size2i p_size, DisplayServer::WindowID p_window) {
  456. // Not supported on Android.
  457. }
  458. Size2i DisplayServerAndroid::window_get_size(DisplayServer::WindowID p_window) const {
  459. return OS_Android::get_singleton()->get_display_size();
  460. }
  461. Size2i DisplayServerAndroid::window_get_size_with_decorations(DisplayServer::WindowID p_window) const {
  462. return OS_Android::get_singleton()->get_display_size();
  463. }
  464. void DisplayServerAndroid::window_set_mode(DisplayServer::WindowMode p_mode, DisplayServer::WindowID p_window) {
  465. OS_Android::get_singleton()->get_godot_java()->enable_immersive_mode(p_mode == WINDOW_MODE_FULLSCREEN || p_mode == WINDOW_MODE_EXCLUSIVE_FULLSCREEN);
  466. }
  467. DisplayServer::WindowMode DisplayServerAndroid::window_get_mode(DisplayServer::WindowID p_window) const {
  468. if (OS_Android::get_singleton()->get_godot_java()->is_in_immersive_mode()) {
  469. return WINDOW_MODE_FULLSCREEN;
  470. } else {
  471. return WINDOW_MODE_MAXIMIZED;
  472. }
  473. }
  474. bool DisplayServerAndroid::window_is_maximize_allowed(DisplayServer::WindowID p_window) const {
  475. return false;
  476. }
  477. void DisplayServerAndroid::window_set_flag(DisplayServer::WindowFlags p_flag, bool p_enabled, DisplayServer::WindowID p_window) {
  478. // Not supported on Android.
  479. }
  480. bool DisplayServerAndroid::window_get_flag(DisplayServer::WindowFlags p_flag, DisplayServer::WindowID p_window) const {
  481. switch (p_flag) {
  482. case WindowFlags::WINDOW_FLAG_TRANSPARENT:
  483. return is_window_transparency_available();
  484. default:
  485. return false;
  486. }
  487. }
  488. void DisplayServerAndroid::window_request_attention(DisplayServer::WindowID p_window) {
  489. // Not supported on Android.
  490. }
  491. void DisplayServerAndroid::window_move_to_foreground(DisplayServer::WindowID p_window) {
  492. // Not supported on Android.
  493. }
  494. bool DisplayServerAndroid::window_is_focused(WindowID p_window) const {
  495. return true;
  496. }
  497. bool DisplayServerAndroid::window_can_draw(DisplayServer::WindowID p_window) const {
  498. return true;
  499. }
  500. bool DisplayServerAndroid::can_any_window_draw() const {
  501. return true;
  502. }
  503. void DisplayServerAndroid::process_events() {
  504. Input::get_singleton()->flush_buffered_events();
  505. }
  506. Vector<String> DisplayServerAndroid::get_rendering_drivers_func() {
  507. Vector<String> drivers;
  508. #ifdef GLES3_ENABLED
  509. drivers.push_back("opengl3");
  510. #endif
  511. #ifdef VULKAN_ENABLED
  512. drivers.push_back("vulkan");
  513. #endif
  514. return drivers;
  515. }
  516. DisplayServer *DisplayServerAndroid::create_func(const String &p_rendering_driver, DisplayServer::WindowMode p_mode, DisplayServer::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) {
  517. DisplayServer *ds = memnew(DisplayServerAndroid(p_rendering_driver, p_mode, p_vsync_mode, p_flags, p_position, p_resolution, p_screen, p_context, p_parent_window, r_error));
  518. if (r_error != OK) {
  519. if (p_rendering_driver == "vulkan") {
  520. OS::get_singleton()->alert(
  521. "Your device seems not to support the required Vulkan version.\n\n"
  522. "Please try exporting your game using the 'gl_compatibility' renderer.",
  523. "Unable to initialize Vulkan video driver");
  524. } else {
  525. OS::get_singleton()->alert(
  526. "Your device seems not to support the required OpenGL ES 3.0 version.",
  527. "Unable to initialize OpenGL video driver");
  528. }
  529. }
  530. return ds;
  531. }
  532. void DisplayServerAndroid::register_android_driver() {
  533. register_create_function("android", create_func, get_rendering_drivers_func);
  534. }
  535. void DisplayServerAndroid::reset_window() {
  536. #if defined(RD_ENABLED)
  537. if (rendering_context) {
  538. if (rendering_device) {
  539. rendering_device->screen_free(MAIN_WINDOW_ID);
  540. }
  541. VSyncMode last_vsync_mode = rendering_context->window_get_vsync_mode(MAIN_WINDOW_ID);
  542. rendering_context->window_destroy(MAIN_WINDOW_ID);
  543. union {
  544. #ifdef VULKAN_ENABLED
  545. RenderingContextDriverVulkanAndroid::WindowPlatformData vulkan;
  546. #endif
  547. } wpd;
  548. #ifdef VULKAN_ENABLED
  549. if (rendering_driver == "vulkan") {
  550. ANativeWindow *native_window = OS_Android::get_singleton()->get_native_window();
  551. ERR_FAIL_NULL(native_window);
  552. wpd.vulkan.window = native_window;
  553. }
  554. #endif
  555. if (rendering_context->window_create(MAIN_WINDOW_ID, &wpd) != OK) {
  556. ERR_PRINT(vformat("Failed to reset %s window.", rendering_driver));
  557. memdelete(rendering_context);
  558. rendering_context = nullptr;
  559. return;
  560. }
  561. Size2i display_size = OS_Android::get_singleton()->get_display_size();
  562. rendering_context->window_set_size(MAIN_WINDOW_ID, display_size.width, display_size.height);
  563. rendering_context->window_set_vsync_mode(MAIN_WINDOW_ID, last_vsync_mode);
  564. if (rendering_device) {
  565. rendering_device->screen_create(MAIN_WINDOW_ID);
  566. }
  567. }
  568. #endif
  569. }
  570. void DisplayServerAndroid::notify_surface_changed(int p_width, int p_height) {
  571. if (rect_changed_callback.is_valid()) {
  572. rect_changed_callback.call(Rect2i(0, 0, p_width, p_height));
  573. }
  574. }
  575. DisplayServerAndroid::DisplayServerAndroid(const String &p_rendering_driver, DisplayServer::WindowMode p_mode, DisplayServer::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) {
  576. rendering_driver = p_rendering_driver;
  577. keep_screen_on = GLOBAL_GET("display/window/energy_saving/keep_screen_on");
  578. native_menu = memnew(NativeMenu);
  579. #if defined(RD_ENABLED)
  580. rendering_context = nullptr;
  581. rendering_device = nullptr;
  582. #if defined(VULKAN_ENABLED)
  583. if (rendering_driver == "vulkan") {
  584. rendering_context = memnew(RenderingContextDriverVulkanAndroid);
  585. }
  586. #endif
  587. if (rendering_context) {
  588. if (rendering_context->initialize() != OK) {
  589. memdelete(rendering_context);
  590. rendering_context = nullptr;
  591. #if defined(GLES3_ENABLED)
  592. bool fallback_to_opengl3 = GLOBAL_GET("rendering/rendering_device/fallback_to_opengl3");
  593. if (fallback_to_opengl3 && rendering_driver != "opengl3") {
  594. WARN_PRINT("Your device seem not to support Vulkan, switching to OpenGL 3.");
  595. rendering_driver = "opengl3";
  596. OS::get_singleton()->set_current_rendering_method("gl_compatibility");
  597. OS::get_singleton()->set_current_rendering_driver_name(rendering_driver);
  598. } else
  599. #endif
  600. {
  601. ERR_PRINT(vformat("Failed to initialize %s context", rendering_driver));
  602. r_error = ERR_UNAVAILABLE;
  603. return;
  604. }
  605. }
  606. }
  607. if (rendering_context) {
  608. union {
  609. #ifdef VULKAN_ENABLED
  610. RenderingContextDriverVulkanAndroid::WindowPlatformData vulkan;
  611. #endif
  612. } wpd;
  613. #ifdef VULKAN_ENABLED
  614. if (rendering_driver == "vulkan") {
  615. ANativeWindow *native_window = OS_Android::get_singleton()->get_native_window();
  616. ERR_FAIL_NULL(native_window);
  617. wpd.vulkan.window = native_window;
  618. }
  619. #endif
  620. if (rendering_context->window_create(MAIN_WINDOW_ID, &wpd) != OK) {
  621. ERR_PRINT(vformat("Failed to create %s window.", rendering_driver));
  622. memdelete(rendering_context);
  623. rendering_context = nullptr;
  624. r_error = ERR_UNAVAILABLE;
  625. return;
  626. }
  627. Size2i display_size = OS_Android::get_singleton()->get_display_size();
  628. rendering_context->window_set_size(MAIN_WINDOW_ID, display_size.width, display_size.height);
  629. rendering_context->window_set_vsync_mode(MAIN_WINDOW_ID, p_vsync_mode);
  630. rendering_device = memnew(RenderingDevice);
  631. if (rendering_device->initialize(rendering_context, MAIN_WINDOW_ID) != OK) {
  632. rendering_device = nullptr;
  633. memdelete(rendering_context);
  634. rendering_context = nullptr;
  635. r_error = ERR_UNAVAILABLE;
  636. return;
  637. }
  638. rendering_device->screen_create(MAIN_WINDOW_ID);
  639. RendererCompositorRD::make_current();
  640. }
  641. #endif
  642. #if defined(GLES3_ENABLED)
  643. if (rendering_driver == "opengl3") {
  644. RasterizerGLES3::make_current(false);
  645. }
  646. #endif
  647. Input::get_singleton()->set_event_dispatch_function(_dispatch_input_events);
  648. r_error = OK;
  649. }
  650. DisplayServerAndroid::~DisplayServerAndroid() {
  651. if (native_menu) {
  652. memdelete(native_menu);
  653. native_menu = nullptr;
  654. }
  655. #if defined(RD_ENABLED)
  656. if (rendering_device) {
  657. memdelete(rendering_device);
  658. }
  659. if (rendering_context) {
  660. memdelete(rendering_context);
  661. }
  662. #endif
  663. }
  664. void DisplayServerAndroid::process_accelerometer(const Vector3 &p_accelerometer) {
  665. Input::get_singleton()->set_accelerometer(p_accelerometer);
  666. }
  667. void DisplayServerAndroid::process_gravity(const Vector3 &p_gravity) {
  668. Input::get_singleton()->set_gravity(p_gravity);
  669. }
  670. void DisplayServerAndroid::process_magnetometer(const Vector3 &p_magnetometer) {
  671. Input::get_singleton()->set_magnetometer(p_magnetometer);
  672. }
  673. void DisplayServerAndroid::process_gyroscope(const Vector3 &p_gyroscope) {
  674. Input::get_singleton()->set_gyroscope(p_gyroscope);
  675. }
  676. void DisplayServerAndroid::_mouse_update_mode() {
  677. MouseMode wanted_mouse_mode = mouse_mode_override_enabled
  678. ? mouse_mode_override
  679. : mouse_mode_base;
  680. if (!OS_Android::get_singleton()->get_godot_java()->get_godot_view()->can_update_pointer_icon() || !OS_Android::get_singleton()->get_godot_java()->get_godot_view()->can_capture_pointer()) {
  681. return;
  682. }
  683. if (mouse_mode == wanted_mouse_mode) {
  684. return;
  685. }
  686. if (wanted_mouse_mode == MouseMode::MOUSE_MODE_HIDDEN) {
  687. OS_Android::get_singleton()->get_godot_java()->get_godot_view()->set_pointer_icon(CURSOR_TYPE_NULL);
  688. } else {
  689. cursor_set_shape(cursor_shape);
  690. }
  691. if (wanted_mouse_mode == MouseMode::MOUSE_MODE_CAPTURED) {
  692. OS_Android::get_singleton()->get_godot_java()->get_godot_view()->request_pointer_capture();
  693. } else {
  694. OS_Android::get_singleton()->get_godot_java()->get_godot_view()->release_pointer_capture();
  695. }
  696. mouse_mode = wanted_mouse_mode;
  697. }
  698. void DisplayServerAndroid::mouse_set_mode(MouseMode p_mode) {
  699. ERR_FAIL_INDEX(p_mode, MouseMode::MOUSE_MODE_MAX);
  700. if (p_mode == mouse_mode_base) {
  701. return;
  702. }
  703. mouse_mode_base = p_mode;
  704. _mouse_update_mode();
  705. }
  706. DisplayServer::MouseMode DisplayServerAndroid::mouse_get_mode() const {
  707. return mouse_mode;
  708. }
  709. void DisplayServerAndroid::mouse_set_mode_override(MouseMode p_mode) {
  710. ERR_FAIL_INDEX(p_mode, MouseMode::MOUSE_MODE_MAX);
  711. if (p_mode == mouse_mode_override) {
  712. return;
  713. }
  714. mouse_mode_override = p_mode;
  715. _mouse_update_mode();
  716. }
  717. DisplayServer::MouseMode DisplayServerAndroid::mouse_get_mode_override() const {
  718. return mouse_mode_override;
  719. }
  720. void DisplayServerAndroid::mouse_set_mode_override_enabled(bool p_override_enabled) {
  721. mouse_mode_override_enabled = p_override_enabled;
  722. _mouse_update_mode();
  723. }
  724. bool DisplayServerAndroid::mouse_is_mode_override_enabled() const {
  725. return mouse_mode_override_enabled;
  726. }
  727. Point2i DisplayServerAndroid::mouse_get_position() const {
  728. return Input::get_singleton()->get_mouse_position();
  729. }
  730. BitField<MouseButtonMask> DisplayServerAndroid::mouse_get_button_state() const {
  731. return Input::get_singleton()->get_mouse_button_mask();
  732. }
  733. void DisplayServerAndroid::_cursor_set_shape_helper(CursorShape p_shape, bool force) {
  734. if (!OS_Android::get_singleton()->get_godot_java()->get_godot_view()->can_update_pointer_icon()) {
  735. return;
  736. }
  737. if (cursor_shape == p_shape && !force) {
  738. return;
  739. }
  740. cursor_shape = p_shape;
  741. if (mouse_mode == MouseMode::MOUSE_MODE_VISIBLE || mouse_mode == MouseMode::MOUSE_MODE_CONFINED) {
  742. OS_Android::get_singleton()->get_godot_java()->get_godot_view()->set_pointer_icon(android_cursors[cursor_shape]);
  743. }
  744. }
  745. void DisplayServerAndroid::cursor_set_shape(DisplayServer::CursorShape p_shape) {
  746. ERR_FAIL_INDEX(p_shape, CURSOR_MAX);
  747. _cursor_set_shape_helper(p_shape);
  748. }
  749. DisplayServer::CursorShape DisplayServerAndroid::cursor_get_shape() const {
  750. return cursor_shape;
  751. }
  752. void DisplayServerAndroid::cursor_set_custom_image(const Ref<Resource> &p_cursor, CursorShape p_shape, const Vector2 &p_hotspot) {
  753. ERR_FAIL_INDEX(p_shape, CURSOR_MAX);
  754. String cursor_path = p_cursor.is_valid() ? p_cursor->get_path() : "";
  755. if (!cursor_path.is_empty()) {
  756. cursor_path = ProjectSettings::get_singleton()->globalize_path(cursor_path);
  757. }
  758. OS_Android::get_singleton()->get_godot_java()->get_godot_view()->configure_pointer_icon(android_cursors[cursor_shape], cursor_path, p_hotspot);
  759. _cursor_set_shape_helper(p_shape, true);
  760. }
  761. void DisplayServerAndroid::window_set_vsync_mode(DisplayServer::VSyncMode p_vsync_mode, WindowID p_window) {
  762. #if defined(RD_ENABLED)
  763. if (rendering_context) {
  764. rendering_context->window_set_vsync_mode(p_window, p_vsync_mode);
  765. }
  766. #endif
  767. }
  768. DisplayServer::VSyncMode DisplayServerAndroid::window_get_vsync_mode(WindowID p_window) const {
  769. #if defined(RD_ENABLED)
  770. if (rendering_context) {
  771. return rendering_context->window_get_vsync_mode(p_window);
  772. }
  773. #endif
  774. return DisplayServer::VSYNC_ENABLED;
  775. }
  776. void DisplayServerAndroid::reset_swap_buffers_flag() {
  777. swap_buffers_flag = false;
  778. }
  779. bool DisplayServerAndroid::should_swap_buffers() const {
  780. return swap_buffers_flag;
  781. }
  782. void DisplayServerAndroid::swap_buffers() {
  783. swap_buffers_flag = true;
  784. }
  785. void DisplayServerAndroid::set_native_icon(const String &p_filename) {
  786. // NOT SUPPORTED
  787. }
  788. void DisplayServerAndroid::set_icon(const Ref<Image> &p_icon) {
  789. // NOT SUPPORTED
  790. }
  791. bool DisplayServerAndroid::is_window_transparency_available() const {
  792. return GLOBAL_GET_CACHED(bool, "display/window/per_pixel_transparency/allowed");
  793. }