os_javascript.cpp 34 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153
  1. /*************************************************************************/
  2. /* os_javascript.cpp */
  3. /*************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /*************************************************************************/
  8. /* Copyright (c) 2007-2021 Juan Linietsky, Ariel Manzur. */
  9. /* Copyright (c) 2014-2021 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. #include "os_javascript.h"
  31. #include "core/io/json.h"
  32. #include "drivers/gles2/rasterizer_gles2.h"
  33. #include "drivers/gles3/rasterizer_gles3.h"
  34. #include "drivers/unix/dir_access_unix.h"
  35. #include "drivers/unix/file_access_unix.h"
  36. #include "main/main.h"
  37. #include "servers/visual/visual_server_raster.h"
  38. #ifndef NO_THREADS
  39. #include "servers/visual/visual_server_wrap_mt.h"
  40. #endif
  41. #include <dlfcn.h>
  42. #include <emscripten.h>
  43. #include <png.h>
  44. #include <stdlib.h>
  45. #include "dom_keys.inc"
  46. #include "godot_js.h"
  47. #define DOM_BUTTON_LEFT 0
  48. #define DOM_BUTTON_MIDDLE 1
  49. #define DOM_BUTTON_RIGHT 2
  50. #define DOM_BUTTON_XBUTTON1 3
  51. #define DOM_BUTTON_XBUTTON2 4
  52. // Quit
  53. void OS_JavaScript::request_quit_callback() {
  54. OS_JavaScript *os = get_singleton();
  55. if (os && os->get_main_loop()) {
  56. os->get_main_loop()->notification(MainLoop::NOTIFICATION_WM_QUIT_REQUEST);
  57. }
  58. }
  59. // Files drop (implemented in JS for now).
  60. void OS_JavaScript::drop_files_callback(char **p_filev, int p_filec) {
  61. OS_JavaScript *os = get_singleton();
  62. if (!os || !os->get_main_loop()) {
  63. return;
  64. }
  65. Vector<String> files;
  66. for (int i = 0; i < p_filec; i++) {
  67. files.push_back(String::utf8(p_filev[i]));
  68. }
  69. os->get_main_loop()->drop_files(files);
  70. }
  71. void OS_JavaScript::send_notification_callback(int p_notification) {
  72. OS_JavaScript *os = get_singleton();
  73. if (!os) {
  74. return;
  75. }
  76. if (p_notification == MainLoop::NOTIFICATION_WM_MOUSE_ENTER || p_notification == MainLoop::NOTIFICATION_WM_MOUSE_EXIT) {
  77. os->cursor_inside_canvas = p_notification == MainLoop::NOTIFICATION_WM_MOUSE_ENTER;
  78. }
  79. MainLoop *loop = os->get_main_loop();
  80. if (loop) {
  81. loop->notification(p_notification);
  82. }
  83. }
  84. // Window (canvas)
  85. bool OS_JavaScript::check_size_force_redraw() {
  86. return godot_js_display_size_update() != 0;
  87. }
  88. void OS_JavaScript::fullscreen_change_callback(int p_fullscreen) {
  89. OS_JavaScript *os = get_singleton();
  90. os->video_mode.fullscreen = p_fullscreen;
  91. if (os->video_mode.fullscreen) {
  92. os->entering_fullscreen = false;
  93. } else {
  94. // Restoring maximized window now will cause issues,
  95. // so delay until main_loop_iterate.
  96. os->just_exited_fullscreen = true;
  97. }
  98. }
  99. void OS_JavaScript::window_blur_callback() {
  100. get_singleton()->input->release_pressed_events();
  101. }
  102. void OS_JavaScript::set_video_mode(const VideoMode &p_video_mode, int p_screen) {
  103. video_mode = p_video_mode;
  104. }
  105. OS::VideoMode OS_JavaScript::get_video_mode(int p_screen) const {
  106. return video_mode;
  107. }
  108. Size2 OS_JavaScript::get_screen_size(int p_screen) const {
  109. int size[2];
  110. godot_js_display_screen_size_get(size, size + 1);
  111. return Size2(size[0], size[1]);
  112. }
  113. void OS_JavaScript::set_window_size(const Size2 p_size) {
  114. if (video_mode.fullscreen) {
  115. window_maximized = false;
  116. set_window_fullscreen(false);
  117. } else {
  118. if (window_maximized) {
  119. emscripten_exit_soft_fullscreen();
  120. window_maximized = false;
  121. }
  122. godot_js_display_desired_size_set(p_size.x, p_size.y);
  123. }
  124. }
  125. Size2 OS_JavaScript::get_window_size() const {
  126. int size[2];
  127. godot_js_display_window_size_get(size, size + 1);
  128. return Size2(size[0], size[1]);
  129. }
  130. void OS_JavaScript::set_window_maximized(bool p_enabled) {
  131. #ifndef TOOLS_ENABLED
  132. if (video_mode.fullscreen) {
  133. window_maximized = p_enabled;
  134. set_window_fullscreen(false);
  135. } else if (!p_enabled) {
  136. emscripten_exit_soft_fullscreen();
  137. window_maximized = false;
  138. } else if (!window_maximized) {
  139. // Prevent calling emscripten_enter_soft_fullscreen mutltiple times,
  140. // this would hide page elements permanently.
  141. EmscriptenFullscreenStrategy strategy;
  142. strategy.scaleMode = EMSCRIPTEN_FULLSCREEN_SCALE_STRETCH;
  143. strategy.canvasResolutionScaleMode = EMSCRIPTEN_FULLSCREEN_CANVAS_SCALE_STDDEF;
  144. strategy.filteringMode = EMSCRIPTEN_FULLSCREEN_FILTERING_DEFAULT;
  145. strategy.canvasResizedCallback = NULL;
  146. emscripten_enter_soft_fullscreen(canvas_id, &strategy);
  147. window_maximized = p_enabled;
  148. }
  149. #endif
  150. }
  151. bool OS_JavaScript::is_window_maximized() const {
  152. return window_maximized;
  153. }
  154. void OS_JavaScript::set_window_fullscreen(bool p_enabled) {
  155. if (p_enabled == video_mode.fullscreen) {
  156. return;
  157. }
  158. // Just request changes here, if successful, logic continues in
  159. // fullscreen_change_callback.
  160. if (p_enabled) {
  161. if (window_maximized) {
  162. // Soft fullsreen during real fullscreen can cause issues, so exit.
  163. // This must be called before requesting full screen.
  164. emscripten_exit_soft_fullscreen();
  165. }
  166. int result = godot_js_display_fullscreen_request();
  167. ERR_FAIL_COND_MSG(result, "The request was denied. Remember that enabling fullscreen is only possible from an input callback for the HTML5 platform.");
  168. entering_fullscreen = true;
  169. } else {
  170. // No logic allowed here, since exiting w/ ESC key won't use this function.
  171. ERR_FAIL_COND(godot_js_display_fullscreen_exit());
  172. }
  173. }
  174. bool OS_JavaScript::is_window_fullscreen() const {
  175. return video_mode.fullscreen;
  176. }
  177. void OS_JavaScript::get_fullscreen_mode_list(List<VideoMode> *p_list, int p_screen) const {
  178. Size2 screen = get_screen_size();
  179. p_list->push_back(OS::VideoMode(screen.width, screen.height, true));
  180. }
  181. bool OS_JavaScript::get_window_per_pixel_transparency_enabled() const {
  182. if (!is_layered_allowed()) {
  183. return false;
  184. }
  185. return transparency_enabled;
  186. }
  187. void OS_JavaScript::set_window_per_pixel_transparency_enabled(bool p_enabled) {
  188. if (!is_layered_allowed()) {
  189. return;
  190. }
  191. transparency_enabled = p_enabled;
  192. }
  193. // Keys
  194. static void dom2godot_mod(Ref<InputEventWithModifiers> ev, int p_mod) {
  195. ev->set_shift(p_mod & 1);
  196. ev->set_alt(p_mod & 2);
  197. ev->set_control(p_mod & 4);
  198. ev->set_metakey(p_mod & 8);
  199. }
  200. void OS_JavaScript::key_callback(int p_pressed, int p_repeat, int p_modifiers) {
  201. OS_JavaScript *os = get_singleton();
  202. JSKeyEvent &key_event = os->key_event;
  203. // Resume audio context after input in case autoplay was denied.
  204. os->resume_audio();
  205. Ref<InputEventKey> ev;
  206. ev.instance();
  207. ev->set_echo(p_repeat);
  208. ev->set_scancode(dom_code2godot_scancode(key_event.code, key_event.key, false));
  209. ev->set_physical_scancode(dom_code2godot_scancode(key_event.code, key_event.key, true));
  210. ev->set_pressed(p_pressed);
  211. dom2godot_mod(ev, p_modifiers);
  212. String unicode = String::utf8(key_event.key);
  213. if (unicode.length() == 1) {
  214. ev->set_unicode(unicode[0]);
  215. }
  216. os->input->parse_input_event(ev);
  217. // Make sure to flush all events so we can call restricted APIs inside the event.
  218. os->input->flush_buffered_events();
  219. }
  220. // Mouse
  221. Point2 OS_JavaScript::get_mouse_position() const {
  222. return input->get_mouse_position();
  223. }
  224. int OS_JavaScript::get_mouse_button_state() const {
  225. return input->get_mouse_button_mask();
  226. }
  227. int OS_JavaScript::mouse_button_callback(int p_pressed, int p_button, double p_x, double p_y, int p_modifiers) {
  228. OS_JavaScript *os = get_singleton();
  229. Ref<InputEventMouseButton> ev;
  230. ev.instance();
  231. ev->set_pressed(p_pressed);
  232. ev->set_position(Point2(p_x, p_y));
  233. ev->set_global_position(ev->get_position());
  234. ev->set_pressed(p_pressed);
  235. dom2godot_mod(ev, p_modifiers);
  236. switch (p_button) {
  237. case DOM_BUTTON_LEFT:
  238. ev->set_button_index(BUTTON_LEFT);
  239. break;
  240. case DOM_BUTTON_MIDDLE:
  241. ev->set_button_index(BUTTON_MIDDLE);
  242. break;
  243. case DOM_BUTTON_RIGHT:
  244. ev->set_button_index(BUTTON_RIGHT);
  245. break;
  246. case DOM_BUTTON_XBUTTON1:
  247. ev->set_button_index(BUTTON_XBUTTON1);
  248. break;
  249. case DOM_BUTTON_XBUTTON2:
  250. ev->set_button_index(BUTTON_XBUTTON2);
  251. break;
  252. default:
  253. return false;
  254. }
  255. if (p_pressed) {
  256. uint64_t diff = (OS::get_singleton()->get_ticks_usec() / 1000) - os->last_click_ms;
  257. if (ev->get_button_index() == os->last_click_button_index) {
  258. if (diff < 400 && Point2(os->last_click_pos).distance_to(ev->get_position()) < 5) {
  259. os->last_click_ms = 0;
  260. os->last_click_pos = Point2(-100, -100);
  261. os->last_click_button_index = -1;
  262. ev->set_doubleclick(true);
  263. }
  264. } else {
  265. os->last_click_button_index = ev->get_button_index();
  266. }
  267. if (!ev->is_doubleclick()) {
  268. os->last_click_ms += diff;
  269. os->last_click_pos = ev->get_position();
  270. }
  271. }
  272. int mask = os->input->get_mouse_button_mask();
  273. int button_flag = 1 << (ev->get_button_index() - 1);
  274. if (ev->is_pressed()) {
  275. mask |= button_flag;
  276. } else if (mask & button_flag) {
  277. mask &= ~button_flag;
  278. } else {
  279. // Received release event, but press was outside the canvas, so ignore.
  280. return false;
  281. }
  282. ev->set_button_mask(mask);
  283. os->input->parse_input_event(ev);
  284. // Resume audio context after input in case autoplay was denied.
  285. os->resume_audio();
  286. // Make sure to flush all events so we can call restricted APIs inside the event.
  287. os->input->flush_buffered_events();
  288. // Prevent multi-click text selection and wheel-click scrolling anchor.
  289. // Context menu is prevented through contextmenu event.
  290. return true;
  291. }
  292. void OS_JavaScript::mouse_move_callback(double p_x, double p_y, double p_rel_x, double p_rel_y, int p_modifiers) {
  293. OS_JavaScript *os = get_singleton();
  294. int input_mask = os->input->get_mouse_button_mask();
  295. // For motion outside the canvas, only read mouse movement if dragging
  296. // started inside the canvas; imitating desktop app behaviour.
  297. if (!os->cursor_inside_canvas && !input_mask)
  298. return;
  299. Ref<InputEventMouseMotion> ev;
  300. ev.instance();
  301. dom2godot_mod(ev, p_modifiers);
  302. ev->set_button_mask(input_mask);
  303. ev->set_position(Point2(p_x, p_y));
  304. ev->set_global_position(ev->get_position());
  305. ev->set_relative(Vector2(p_rel_x, p_rel_y));
  306. os->input->set_mouse_position(ev->get_position());
  307. ev->set_speed(os->input->get_last_mouse_speed());
  308. os->input->parse_input_event(ev);
  309. }
  310. static const char *godot2dom_cursor(OS::CursorShape p_shape) {
  311. switch (p_shape) {
  312. case OS::CURSOR_ARROW:
  313. default:
  314. return "auto";
  315. case OS::CURSOR_IBEAM:
  316. return "text";
  317. case OS::CURSOR_POINTING_HAND:
  318. return "pointer";
  319. case OS::CURSOR_CROSS:
  320. return "crosshair";
  321. case OS::CURSOR_WAIT:
  322. return "progress";
  323. case OS::CURSOR_BUSY:
  324. return "wait";
  325. case OS::CURSOR_DRAG:
  326. return "grab";
  327. case OS::CURSOR_CAN_DROP:
  328. return "grabbing";
  329. case OS::CURSOR_FORBIDDEN:
  330. return "no-drop";
  331. case OS::CURSOR_VSIZE:
  332. return "ns-resize";
  333. case OS::CURSOR_HSIZE:
  334. return "ew-resize";
  335. case OS::CURSOR_BDIAGSIZE:
  336. return "nesw-resize";
  337. case OS::CURSOR_FDIAGSIZE:
  338. return "nwse-resize";
  339. case OS::CURSOR_MOVE:
  340. return "move";
  341. case OS::CURSOR_VSPLIT:
  342. return "row-resize";
  343. case OS::CURSOR_HSPLIT:
  344. return "col-resize";
  345. case OS::CURSOR_HELP:
  346. return "help";
  347. }
  348. }
  349. void OS_JavaScript::set_cursor_shape(CursorShape p_shape) {
  350. ERR_FAIL_INDEX(p_shape, CURSOR_MAX);
  351. if (cursor_shape == p_shape) {
  352. return;
  353. }
  354. cursor_shape = p_shape;
  355. godot_js_display_cursor_set_shape(godot2dom_cursor(cursor_shape));
  356. }
  357. void OS_JavaScript::set_custom_mouse_cursor(const RES &p_cursor, CursorShape p_shape, const Vector2 &p_hotspot) {
  358. if (p_cursor.is_valid()) {
  359. Ref<Texture> texture = p_cursor;
  360. Ref<AtlasTexture> atlas_texture = p_cursor;
  361. Ref<Image> image;
  362. Size2 texture_size;
  363. Rect2 atlas_rect;
  364. if (texture.is_valid()) {
  365. image = texture->get_data();
  366. if (image.is_valid()) {
  367. image->duplicate();
  368. }
  369. }
  370. if (!image.is_valid() && atlas_texture.is_valid()) {
  371. texture = atlas_texture->get_atlas();
  372. atlas_rect.size.width = texture->get_width();
  373. atlas_rect.size.height = texture->get_height();
  374. atlas_rect.position.x = atlas_texture->get_region().position.x;
  375. atlas_rect.position.y = atlas_texture->get_region().position.y;
  376. texture_size.width = atlas_texture->get_region().size.x;
  377. texture_size.height = atlas_texture->get_region().size.y;
  378. } else if (image.is_valid()) {
  379. texture_size.width = texture->get_width();
  380. texture_size.height = texture->get_height();
  381. }
  382. ERR_FAIL_COND(!texture.is_valid());
  383. ERR_FAIL_COND(p_hotspot.x < 0 || p_hotspot.y < 0);
  384. ERR_FAIL_COND(texture_size.width > 256 || texture_size.height > 256);
  385. ERR_FAIL_COND(p_hotspot.x > texture_size.width || p_hotspot.y > texture_size.height);
  386. image = texture->get_data();
  387. ERR_FAIL_COND(!image.is_valid());
  388. image = image->duplicate();
  389. if (atlas_texture.is_valid())
  390. image->crop_from_point(
  391. atlas_rect.position.x,
  392. atlas_rect.position.y,
  393. texture_size.width,
  394. texture_size.height);
  395. if (image->get_format() != Image::FORMAT_RGBA8) {
  396. image->convert(Image::FORMAT_RGBA8);
  397. }
  398. png_image png_meta;
  399. memset(&png_meta, 0, sizeof png_meta);
  400. png_meta.version = PNG_IMAGE_VERSION;
  401. png_meta.width = texture_size.width;
  402. png_meta.height = texture_size.height;
  403. png_meta.format = PNG_FORMAT_RGBA;
  404. PoolByteArray png;
  405. size_t len;
  406. PoolByteArray::Read r = image->get_data().read();
  407. ERR_FAIL_COND(!png_image_write_get_memory_size(png_meta, len, 0, r.ptr(), 0, NULL));
  408. png.resize(len);
  409. PoolByteArray::Write w = png.write();
  410. ERR_FAIL_COND(!png_image_write_to_memory(&png_meta, w.ptr(), &len, 0, r.ptr(), 0, NULL));
  411. w = PoolByteArray::Write();
  412. r = png.read();
  413. godot_js_display_cursor_set_custom_shape(godot2dom_cursor(p_shape), r.ptr(), len, p_hotspot.x, p_hotspot.y);
  414. r = PoolByteArray::Read();
  415. } else {
  416. godot_js_display_cursor_set_custom_shape(godot2dom_cursor(p_shape), NULL, 0, 0, 0);
  417. }
  418. }
  419. void OS_JavaScript::set_mouse_mode(OS::MouseMode p_mode) {
  420. ERR_FAIL_COND_MSG(p_mode == MOUSE_MODE_CONFINED, "MOUSE_MODE_CONFINED is not supported for the HTML5 platform.");
  421. if (p_mode == get_mouse_mode())
  422. return;
  423. if (p_mode == MOUSE_MODE_VISIBLE) {
  424. godot_js_display_cursor_set_visible(1);
  425. godot_js_display_cursor_lock_set(false);
  426. } else if (p_mode == MOUSE_MODE_HIDDEN) {
  427. godot_js_display_cursor_set_visible(0);
  428. godot_js_display_cursor_lock_set(false);
  429. } else if (p_mode == MOUSE_MODE_CAPTURED) {
  430. godot_js_display_cursor_set_visible(1);
  431. godot_js_display_cursor_lock_set(true);
  432. }
  433. }
  434. OS::MouseMode OS_JavaScript::get_mouse_mode() const {
  435. if (godot_js_display_cursor_is_hidden()) {
  436. return MOUSE_MODE_HIDDEN;
  437. }
  438. if (godot_js_display_cursor_is_locked()) {
  439. return MOUSE_MODE_CAPTURED;
  440. }
  441. return MOUSE_MODE_VISIBLE;
  442. }
  443. // Wheel
  444. int OS_JavaScript::mouse_wheel_callback(double p_delta_x, double p_delta_y) {
  445. OS_JavaScript *os = get_singleton();
  446. if (!godot_js_display_canvas_is_focused()) {
  447. if (os->cursor_inside_canvas) {
  448. godot_js_display_canvas_focus();
  449. } else {
  450. return false;
  451. }
  452. }
  453. InputDefault *input = os->input;
  454. Ref<InputEventMouseButton> ev;
  455. ev.instance();
  456. ev->set_position(input->get_mouse_position());
  457. ev->set_global_position(ev->get_position());
  458. ev->set_shift(input->is_key_pressed(KEY_SHIFT));
  459. ev->set_alt(input->is_key_pressed(KEY_ALT));
  460. ev->set_control(input->is_key_pressed(KEY_CONTROL));
  461. ev->set_metakey(input->is_key_pressed(KEY_META));
  462. if (p_delta_y < 0) {
  463. ev->set_button_index(BUTTON_WHEEL_UP);
  464. } else if (p_delta_y > 0) {
  465. ev->set_button_index(BUTTON_WHEEL_DOWN);
  466. } else if (p_delta_x > 0) {
  467. ev->set_button_index(BUTTON_WHEEL_LEFT);
  468. } else if (p_delta_x < 0) {
  469. ev->set_button_index(BUTTON_WHEEL_RIGHT);
  470. } else {
  471. return false;
  472. }
  473. // Different browsers give wildly different delta values, and we can't
  474. // interpret deltaMode, so use default value for wheel events' factor.
  475. int button_flag = 1 << (ev->get_button_index() - 1);
  476. ev->set_pressed(true);
  477. ev->set_button_mask(input->get_mouse_button_mask() | button_flag);
  478. input->parse_input_event(ev);
  479. Ref<InputEventMouseButton> release = ev->duplicate();
  480. release->set_pressed(false);
  481. release->set_button_mask(input->get_mouse_button_mask() & ~button_flag);
  482. input->parse_input_event(release);
  483. return true;
  484. }
  485. // Touch
  486. bool OS_JavaScript::has_touchscreen_ui_hint() const {
  487. return godot_js_display_touchscreen_is_available();
  488. }
  489. void OS_JavaScript::touch_callback(int p_type, int p_count) {
  490. OS_JavaScript *os = get_singleton();
  491. // Resume audio context after input in case autoplay was denied.
  492. os->resume_audio();
  493. const JSTouchEvent &touch_event = os->touch_event;
  494. for (int i = 0; i < p_count; i++) {
  495. Point2 point(touch_event.coords[i * 2], touch_event.coords[i * 2 + 1]);
  496. if (p_type == 2) {
  497. // touchmove
  498. Ref<InputEventScreenDrag> ev;
  499. ev.instance();
  500. ev->set_index(touch_event.identifier[i]);
  501. ev->set_position(point);
  502. Point2 &prev = os->touches[i];
  503. ev->set_relative(ev->get_position() - prev);
  504. prev = ev->get_position();
  505. os->input->parse_input_event(ev);
  506. } else {
  507. // touchstart/touchend
  508. Ref<InputEventScreenTouch> ev;
  509. ev.instance();
  510. ev->set_index(touch_event.identifier[i]);
  511. ev->set_position(point);
  512. ev->set_pressed(p_type == 0);
  513. os->touches[i] = point;
  514. os->input->parse_input_event(ev);
  515. // Make sure to flush all events so we can call restricted APIs inside the event.
  516. os->input->flush_buffered_events();
  517. }
  518. }
  519. }
  520. // Gamepad
  521. void OS_JavaScript::gamepad_callback(int p_index, int p_connected, const char *p_id, const char *p_guid) {
  522. InputDefault *input = get_singleton()->input;
  523. if (p_connected) {
  524. input->joy_connection_changed(p_index, true, String::utf8(p_id), String::utf8(p_guid));
  525. } else {
  526. input->joy_connection_changed(p_index, false, "");
  527. }
  528. }
  529. void OS_JavaScript::process_joypads() {
  530. int32_t pads = godot_js_display_gamepad_sample_count();
  531. int32_t s_btns_num = 0;
  532. int32_t s_axes_num = 0;
  533. int32_t s_standard = 0;
  534. float s_btns[16];
  535. float s_axes[10];
  536. for (int idx = 0; idx < pads; idx++) {
  537. int err = godot_js_display_gamepad_sample_get(idx, s_btns, &s_btns_num, s_axes, &s_axes_num, &s_standard);
  538. if (err) {
  539. continue;
  540. }
  541. for (int b = 0; b < s_btns_num; b++) {
  542. float value = s_btns[b];
  543. // Buttons 6 and 7 in the standard mapping need to be
  544. // axis to be handled as JOY_ANALOG by Godot.
  545. if (s_standard && (b == 6 || b == 7)) {
  546. InputDefault::JoyAxis joy_axis;
  547. joy_axis.min = 0;
  548. joy_axis.value = value;
  549. int a = b == 6 ? JOY_ANALOG_L2 : JOY_ANALOG_R2;
  550. input->joy_axis(idx, a, joy_axis);
  551. } else {
  552. input->joy_button(idx, b, value);
  553. }
  554. }
  555. for (int a = 0; a < s_axes_num; a++) {
  556. InputDefault::JoyAxis joy_axis;
  557. joy_axis.min = -1;
  558. joy_axis.value = s_axes[a];
  559. input->joy_axis(idx, a, joy_axis);
  560. }
  561. }
  562. }
  563. bool OS_JavaScript::is_joy_known(int p_device) {
  564. return input->is_joy_mapped(p_device);
  565. }
  566. String OS_JavaScript::get_joy_guid(int p_device) const {
  567. return input->get_joy_guid_remapped(p_device);
  568. }
  569. // Video
  570. int OS_JavaScript::get_video_driver_count() const {
  571. return VIDEO_DRIVER_MAX;
  572. }
  573. const char *OS_JavaScript::get_video_driver_name(int p_driver) const {
  574. switch (p_driver) {
  575. case VIDEO_DRIVER_GLES3:
  576. return "GLES3";
  577. case VIDEO_DRIVER_GLES2:
  578. return "GLES2";
  579. }
  580. ERR_FAIL_V_MSG(NULL, "Invalid video driver index: " + itos(p_driver) + ".");
  581. }
  582. // Audio
  583. int OS_JavaScript::get_audio_driver_count() const {
  584. return audio_drivers.size();
  585. }
  586. const char *OS_JavaScript::get_audio_driver_name(int p_driver) const {
  587. if (audio_drivers.size() <= p_driver) {
  588. return "Unknown";
  589. }
  590. return audio_drivers[p_driver]->get_name();
  591. }
  592. // Clipboard
  593. void OS_JavaScript::update_clipboard_callback(const char *p_text) {
  594. // Only call set_clipboard from OS (sets local clipboard)
  595. get_singleton()->OS::set_clipboard(p_text);
  596. }
  597. void OS_JavaScript::set_clipboard(const String &p_text) {
  598. OS::set_clipboard(p_text);
  599. int err = godot_js_display_clipboard_set(p_text.utf8().get_data());
  600. ERR_FAIL_COND_MSG(err, "Clipboard API is not supported.");
  601. }
  602. String OS_JavaScript::get_clipboard() const {
  603. godot_js_display_clipboard_get(update_clipboard_callback);
  604. return this->OS::get_clipboard();
  605. }
  606. // Lifecycle
  607. int OS_JavaScript::get_current_video_driver() const {
  608. return video_driver_index;
  609. }
  610. void OS_JavaScript::initialize_core() {
  611. OS_Unix::initialize_core();
  612. }
  613. Error OS_JavaScript::initialize(const VideoMode &p_desired, int p_video_driver, int p_audio_driver) {
  614. video_mode = p_desired;
  615. // fullscreen_change_callback will correct this if the request is successful.
  616. video_mode.fullscreen = false;
  617. // Handle contextmenu, webglcontextlost, initial canvas setup.
  618. godot_js_display_setup_canvas(video_mode.width, video_mode.height, video_mode.fullscreen, is_hidpi_allowed() ? 1 : 0);
  619. swap_ok_cancel = godot_js_display_is_swap_ok_cancel() == 1;
  620. EmscriptenWebGLContextAttributes attributes;
  621. emscripten_webgl_init_context_attributes(&attributes);
  622. attributes.alpha = GLOBAL_GET("display/window/per_pixel_transparency/allowed");
  623. attributes.antialias = false;
  624. attributes.explicitSwapControl = true;
  625. ERR_FAIL_INDEX_V(p_video_driver, VIDEO_DRIVER_MAX, ERR_INVALID_PARAMETER);
  626. if (p_desired.layered) {
  627. set_window_per_pixel_transparency_enabled(true);
  628. }
  629. #ifdef TOOLS_ENABLED
  630. bool gles3 = false;
  631. #else
  632. bool gles3 = true;
  633. if (p_video_driver == VIDEO_DRIVER_GLES2) {
  634. gles3 = false;
  635. }
  636. #endif
  637. bool gl_initialization_error = false;
  638. while (true) {
  639. if (gles3) {
  640. if (godot_js_display_has_webgl(2) && RasterizerGLES3::is_viable() == OK) {
  641. attributes.majorVersion = 2;
  642. RasterizerGLES3::register_config();
  643. RasterizerGLES3::make_current();
  644. break;
  645. } else {
  646. if (GLOBAL_GET("rendering/quality/driver/fallback_to_gles2")) {
  647. p_video_driver = VIDEO_DRIVER_GLES2;
  648. gles3 = false;
  649. continue;
  650. } else {
  651. gl_initialization_error = true;
  652. break;
  653. }
  654. }
  655. } else {
  656. if (godot_js_display_has_webgl(1) && RasterizerGLES2::is_viable() == OK) {
  657. attributes.majorVersion = 1;
  658. RasterizerGLES2::register_config();
  659. RasterizerGLES2::make_current();
  660. break;
  661. } else {
  662. gl_initialization_error = true;
  663. break;
  664. }
  665. }
  666. }
  667. webgl_ctx = emscripten_webgl_create_context(canvas_id, &attributes);
  668. if (emscripten_webgl_make_context_current(webgl_ctx) != EMSCRIPTEN_RESULT_SUCCESS) {
  669. gl_initialization_error = true;
  670. }
  671. if (gl_initialization_error) {
  672. OS::get_singleton()->alert("Your browser does not support any of the supported WebGL versions.\n"
  673. "Please update your browser version.",
  674. "Unable to initialize Video driver");
  675. return ERR_UNAVAILABLE;
  676. }
  677. video_driver_index = p_video_driver;
  678. AudioDriverManager::initialize(p_audio_driver);
  679. visual_server = memnew(VisualServerRaster());
  680. #ifndef NO_THREADS
  681. visual_server = memnew(VisualServerWrapMT(visual_server, false));
  682. #endif
  683. input = memnew(InputDefault);
  684. godot_js_display_mouse_button_cb(&OS_JavaScript::mouse_button_callback);
  685. godot_js_display_mouse_move_cb(&OS_JavaScript::mouse_move_callback);
  686. godot_js_display_mouse_wheel_cb(&OS_JavaScript::mouse_wheel_callback);
  687. godot_js_display_touch_cb(&OS_JavaScript::touch_callback, touch_event.identifier, touch_event.coords);
  688. godot_js_display_key_cb(&OS_JavaScript::key_callback, key_event.code, key_event.key);
  689. godot_js_display_fullscreen_cb(&OS_JavaScript::fullscreen_change_callback);
  690. godot_js_display_window_blur_cb(&window_blur_callback);
  691. godot_js_display_notification_cb(&OS_JavaScript::send_notification_callback,
  692. MainLoop::NOTIFICATION_WM_MOUSE_ENTER,
  693. MainLoop::NOTIFICATION_WM_MOUSE_EXIT,
  694. MainLoop::NOTIFICATION_WM_FOCUS_IN,
  695. MainLoop::NOTIFICATION_WM_FOCUS_OUT);
  696. godot_js_display_paste_cb(&OS_JavaScript::update_clipboard_callback);
  697. godot_js_display_drop_files_cb(&OS_JavaScript::drop_files_callback);
  698. godot_js_display_gamepad_cb(&OS_JavaScript::gamepad_callback);
  699. godot_js_display_vk_cb(&input_text_callback);
  700. visual_server->init();
  701. return OK;
  702. }
  703. void OS_JavaScript::input_text_callback(const char *p_text, int p_cursor) {
  704. OS_JavaScript *os = OS_JavaScript::get_singleton();
  705. if (!os || !os->get_main_loop()) {
  706. return;
  707. }
  708. os->get_main_loop()->input_text(String::utf8(p_text));
  709. Ref<InputEventKey> k;
  710. for (int i = 0; i < p_cursor; i++) {
  711. k.instance();
  712. k->set_pressed(true);
  713. k->set_echo(false);
  714. k->set_scancode(KEY_RIGHT);
  715. os->input->parse_input_event(k);
  716. k.instance();
  717. k->set_pressed(false);
  718. k->set_echo(false);
  719. k->set_scancode(KEY_RIGHT);
  720. os->input->parse_input_event(k);
  721. }
  722. }
  723. bool OS_JavaScript::has_virtual_keyboard() const {
  724. return godot_js_display_vk_available() != 0;
  725. }
  726. void OS_JavaScript::show_virtual_keyboard(const String &p_existing_text, const Rect2 &p_screen_rect, bool p_multiline, int p_max_input_length, int p_cursor_start, int p_cursor_end) {
  727. godot_js_display_vk_show(p_existing_text.utf8().get_data(), p_multiline, p_cursor_start, p_cursor_end);
  728. }
  729. void OS_JavaScript::hide_virtual_keyboard() {
  730. godot_js_display_vk_hide();
  731. }
  732. bool OS_JavaScript::get_swap_ok_cancel() {
  733. return swap_ok_cancel;
  734. }
  735. void OS_JavaScript::swap_buffers() {
  736. emscripten_webgl_commit_frame();
  737. }
  738. void OS_JavaScript::set_main_loop(MainLoop *p_main_loop) {
  739. main_loop = p_main_loop;
  740. input->set_main_loop(p_main_loop);
  741. }
  742. MainLoop *OS_JavaScript::get_main_loop() const {
  743. return main_loop;
  744. }
  745. void OS_JavaScript::resume_audio() {
  746. AudioDriverJavaScript::resume();
  747. }
  748. void OS_JavaScript::fs_sync_callback() {
  749. get_singleton()->idb_is_syncing = false;
  750. }
  751. bool OS_JavaScript::main_loop_iterate() {
  752. if (is_userfs_persistent() && idb_needs_sync && !idb_is_syncing) {
  753. idb_is_syncing = true;
  754. idb_needs_sync = false;
  755. godot_js_os_fs_sync(&OS_JavaScript::fs_sync_callback);
  756. }
  757. input->flush_buffered_events();
  758. if (godot_js_display_gamepad_sample() == OK)
  759. process_joypads();
  760. if (just_exited_fullscreen) {
  761. if (window_maximized) {
  762. EmscriptenFullscreenStrategy strategy;
  763. strategy.scaleMode = EMSCRIPTEN_FULLSCREEN_SCALE_STRETCH;
  764. strategy.canvasResolutionScaleMode = EMSCRIPTEN_FULLSCREEN_CANVAS_SCALE_STDDEF;
  765. strategy.filteringMode = EMSCRIPTEN_FULLSCREEN_FILTERING_DEFAULT;
  766. strategy.canvasResizedCallback = NULL;
  767. emscripten_enter_soft_fullscreen(canvas_id, &strategy);
  768. } else {
  769. godot_js_display_size_update();
  770. }
  771. just_exited_fullscreen = false;
  772. }
  773. return Main::iteration();
  774. }
  775. int OS_JavaScript::get_screen_dpi(int p_screen) const {
  776. return godot_js_display_screen_dpi_get();
  777. }
  778. float OS_JavaScript::get_screen_scale(int p_screen) const {
  779. return godot_js_display_pixel_ratio_get();
  780. }
  781. float OS_JavaScript::get_screen_max_scale() const {
  782. return get_screen_scale();
  783. }
  784. void OS_JavaScript::delete_main_loop() {
  785. memdelete(main_loop);
  786. main_loop = NULL;
  787. }
  788. void OS_JavaScript::finalize() {
  789. memdelete(input);
  790. visual_server->finish();
  791. emscripten_webgl_commit_frame();
  792. memdelete(visual_server);
  793. emscripten_webgl_destroy_context(webgl_ctx);
  794. for (int i = 0; i < audio_drivers.size(); i++) {
  795. memdelete(audio_drivers[i]);
  796. }
  797. audio_drivers.clear();
  798. }
  799. // Miscellaneous
  800. Error OS_JavaScript::execute(const String &p_path, const List<String> &p_arguments, bool p_blocking, ProcessID *r_child_id, String *r_pipe, int *r_exitcode, bool read_stderr, Mutex *p_pipe_mutex) {
  801. Array args;
  802. for (const List<String>::Element *E = p_arguments.front(); E; E = E->next()) {
  803. args.push_back(E->get());
  804. }
  805. String json_args = JSON::print(args);
  806. int failed = godot_js_os_execute(json_args.utf8().get_data());
  807. ERR_FAIL_COND_V_MSG(failed, ERR_UNAVAILABLE, "OS::execute() must be implemented in Javascript via 'engine.setOnExecute' if required.");
  808. return OK;
  809. }
  810. Error OS_JavaScript::kill(const ProcessID &p_pid) {
  811. ERR_FAIL_V_MSG(ERR_UNAVAILABLE, "OS::kill() is not available on the HTML5 platform.");
  812. }
  813. int OS_JavaScript::get_process_id() const {
  814. ERR_FAIL_V_MSG(0, "OS::get_process_id() is not available on the HTML5 platform.");
  815. }
  816. int OS_JavaScript::get_processor_count() const {
  817. return godot_js_os_hw_concurrency_get();
  818. }
  819. bool OS_JavaScript::_check_internal_feature_support(const String &p_feature) {
  820. if (p_feature == "HTML5" || p_feature == "web") {
  821. return true;
  822. }
  823. #ifdef JAVASCRIPT_EVAL_ENABLED
  824. if (p_feature == "JavaScript") {
  825. return true;
  826. }
  827. #endif
  828. #ifndef NO_THREADS
  829. if (p_feature == "threads") {
  830. return true;
  831. }
  832. #endif
  833. #if WASM_GDNATIVE
  834. if (p_feature == "wasm32") {
  835. return true;
  836. }
  837. #endif
  838. return false;
  839. }
  840. void OS_JavaScript::alert(const String &p_alert, const String &p_title) {
  841. godot_js_display_alert(p_alert.utf8().get_data());
  842. }
  843. void OS_JavaScript::set_window_title(const String &p_title) {
  844. godot_js_display_window_title_set(p_title.utf8().get_data());
  845. }
  846. void OS_JavaScript::set_icon(const Ref<Image> &p_icon) {
  847. ERR_FAIL_COND(p_icon.is_null());
  848. Ref<Image> icon = p_icon;
  849. if (icon->is_compressed()) {
  850. icon = icon->duplicate();
  851. ERR_FAIL_COND(icon->decompress() != OK);
  852. }
  853. if (icon->get_format() != Image::FORMAT_RGBA8) {
  854. if (icon == p_icon)
  855. icon = icon->duplicate();
  856. icon->convert(Image::FORMAT_RGBA8);
  857. }
  858. png_image png_meta;
  859. memset(&png_meta, 0, sizeof png_meta);
  860. png_meta.version = PNG_IMAGE_VERSION;
  861. png_meta.width = icon->get_width();
  862. png_meta.height = icon->get_height();
  863. png_meta.format = PNG_FORMAT_RGBA;
  864. PoolByteArray png;
  865. size_t len;
  866. PoolByteArray::Read r = icon->get_data().read();
  867. ERR_FAIL_COND(!png_image_write_get_memory_size(png_meta, len, 0, r.ptr(), 0, NULL));
  868. png.resize(len);
  869. PoolByteArray::Write w = png.write();
  870. ERR_FAIL_COND(!png_image_write_to_memory(&png_meta, w.ptr(), &len, 0, r.ptr(), 0, NULL));
  871. w = PoolByteArray::Write();
  872. r = png.read();
  873. godot_js_display_window_icon_set(r.ptr(), len);
  874. }
  875. String OS_JavaScript::get_executable_path() const {
  876. return OS::get_executable_path();
  877. }
  878. Error OS_JavaScript::shell_open(String p_uri) {
  879. // Open URI in a new tab, browser will deal with it by protocol.
  880. godot_js_os_shell_open(p_uri.utf8().get_data());
  881. return OK;
  882. }
  883. String OS_JavaScript::get_name() const {
  884. return "HTML5";
  885. }
  886. bool OS_JavaScript::can_draw() const {
  887. return true; // Always?
  888. }
  889. String OS_JavaScript::get_user_data_dir() const {
  890. return "/userfs";
  891. };
  892. String OS_JavaScript::get_cache_path() const {
  893. return "/home/web_user/.cache";
  894. }
  895. String OS_JavaScript::get_config_path() const {
  896. return "/home/web_user/.config";
  897. }
  898. String OS_JavaScript::get_data_path() const {
  899. return "/home/web_user/.local/share";
  900. }
  901. OS::PowerState OS_JavaScript::get_power_state() {
  902. WARN_PRINT_ONCE("Power management is not supported for the HTML5 platform, defaulting to POWERSTATE_UNKNOWN");
  903. return OS::POWERSTATE_UNKNOWN;
  904. }
  905. int OS_JavaScript::get_power_seconds_left() {
  906. WARN_PRINT_ONCE("Power management is not supported for the HTML5 platform, defaulting to -1");
  907. return -1;
  908. }
  909. int OS_JavaScript::get_power_percent_left() {
  910. WARN_PRINT_ONCE("Power management is not supported for the HTML5 platform, defaulting to -1");
  911. return -1;
  912. }
  913. void OS_JavaScript::file_access_close_callback(const String &p_file, int p_flags) {
  914. OS_JavaScript *os = get_singleton();
  915. if (!(os->is_userfs_persistent() && p_flags & FileAccess::WRITE)) {
  916. return; // FS persistence is not working or we are not writing.
  917. }
  918. bool is_file_persistent = p_file.begins_with("/userfs");
  919. #ifdef TOOLS_ENABLED
  920. // Hack for editor persistence (can we track).
  921. is_file_persistent = is_file_persistent || p_file.begins_with("/home/web_user/");
  922. #endif
  923. if (is_file_persistent) {
  924. os->idb_needs_sync = true;
  925. }
  926. }
  927. bool OS_JavaScript::is_userfs_persistent() const {
  928. return idb_available;
  929. }
  930. Error OS_JavaScript::open_dynamic_library(const String p_path, void *&p_library_handle, bool p_also_set_library_path) {
  931. String path = p_path.get_file();
  932. p_library_handle = dlopen(path.utf8().get_data(), RTLD_NOW);
  933. ERR_FAIL_COND_V_MSG(!p_library_handle, ERR_CANT_OPEN, "Can't open dynamic library: " + p_path + ". Error: " + dlerror());
  934. return OK;
  935. }
  936. OS_JavaScript *OS_JavaScript::get_singleton() {
  937. return static_cast<OS_JavaScript *>(OS::get_singleton());
  938. }
  939. OS_JavaScript::OS_JavaScript() {
  940. // Expose method for requesting quit.
  941. godot_js_os_request_quit_cb(&request_quit_callback);
  942. // Set canvas ID
  943. godot_js_config_canvas_id_get(canvas_id, sizeof(canvas_id));
  944. cursor_inside_canvas = true;
  945. cursor_shape = OS::CURSOR_ARROW;
  946. last_click_button_index = -1;
  947. last_click_ms = 0;
  948. last_click_pos = Point2(-100, -100);
  949. window_maximized = false;
  950. entering_fullscreen = false;
  951. just_exited_fullscreen = false;
  952. transparency_enabled = false;
  953. main_loop = NULL;
  954. visual_server = NULL;
  955. swap_ok_cancel = false;
  956. idb_available = godot_js_os_fs_is_persistent() != 0;
  957. idb_needs_sync = false;
  958. idb_is_syncing = false;
  959. if (AudioDriverJavaScript::is_available()) {
  960. #ifdef NO_THREADS
  961. audio_drivers.push_back(memnew(AudioDriverScriptProcessor));
  962. #endif
  963. audio_drivers.push_back(memnew(AudioDriverWorklet));
  964. }
  965. for (int i = 0; i < audio_drivers.size(); i++) {
  966. AudioDriverManager::add_driver(audio_drivers[i]);
  967. }
  968. Vector<Logger *> loggers;
  969. loggers.push_back(memnew(StdLogger));
  970. _set_logger(memnew(CompositeLogger(loggers)));
  971. FileAccessUnix::close_notification_func = file_access_close_callback;
  972. }