godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
godot/platform/javascript/display_server_javascript.h

229 lines
11 KiB
C++
Raw Normal View History

DisplayServerJavaScript implementation.
2020-05-01 12:45:45 +00:00
/*************************************************************************/
/* display_server_javascript.h */
/*************************************************************************/
/* This file is part of: */
/* GODOT ENGINE */
/* https://godotengine.org */
/*************************************************************************/
Update copyright statements to 2022 Happy new year to the wonderful Godot community!
2022-01-03 20:27:34 +00:00
/* Copyright (c) 2007-2022 Juan Linietsky, Ariel Manzur. */
/* Copyright (c) 2014-2022 Godot Engine contributors (cf. AUTHORS.md). */
DisplayServerJavaScript implementation.
2020-05-01 12:45:45 +00:00
/* */
/* Permission is hereby granted, free of charge, to any person obtaining */
/* a copy of this software and associated documentation files (the */
/* "Software"), to deal in the Software without restriction, including */
/* without limitation the rights to use, copy, modify, merge, publish, */
/* distribute, sublicense, and/or sell copies of the Software, and to */
/* permit persons to whom the Software is furnished to do so, subject to */
/* the following conditions: */
/* */
/* The above copyright notice and this permission notice shall be */
/* included in all copies or substantial portions of the Software. */
/* */
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
/*************************************************************************/
#ifndef DISPLAY_SERVER_JAVASCRIPT_H
#define DISPLAY_SERVER_JAVASCRIPT_H
#include "servers/display_server.h"
#include <emscripten.h>
#include <emscripten/html5.h>
class DisplayServerJavaScript : public DisplayServer {
[HTML5] Port JavaScript inline code to libraries. The API is implemented in javascript, and generates C functions that can be called from godot. This allows much cleaner code replacing all `EM_ASM` calls in our C++ code with plain C function calls. This also gets rid of few hacks and comes with few optimizations (e.g. custom cursor shapes should be much faster now).
2020-10-23 16:33:20 +00:00
private:
[HTML5] Implement mouse/touch/key events in JS library. This makes us more independent from emscripten libraries, giving us more control on the application lifecycle.
2021-09-10 19:46:22 +00:00
struct JSTouchEvent {
uint32_t identifier[32] = { 0 };
double coords[64] = { 0 };
};
JSTouchEvent touch_event;
struct JSKeyEvent {
char code[32] = { 0 };
char key[32] = { 0 };
uint8_t modifiers[4] = { 0 };
};
JSKeyEvent key_event;
[HTML5] Add WebGL2 (GLES3) support using the OpenGL renderer. Note, the editor build requires the mbedtls module to be manually enabled, as it is currently needed as a ResourceUID dependency. This will need to be addressed in a separate PR.
2021-10-25 17:16:40 +00:00
#ifdef GLES3_ENABLED
EMSCRIPTEN_WEBGL_CONTEXT_HANDLE webgl_ctx = 0;
#endif
Replace most uses of Map by HashMap * Map is unnecessary and inefficient in almost every case. * Replaced by the new HashMap. * Renamed Map to RBMap and Set to RBSet for cases that still make sense (order matters) but use is discouraged. There were very few cases where replacing by HashMap was undesired because keeping the key order was intended. I tried to keep those (as RBMap) as much as possible, but might have missed some. Review appreciated!
2022-05-13 13:04:37 +00:00
HashMap<int, CharString> utterance_ids;
Implement text-to-speech support on Android, iOS, HTML5, Linux, macOS and Windows. Implement TextServer word break method.
2021-11-04 12:33:37 +00:00
[HTML5] Port JavaScript inline code to libraries. The API is implemented in javascript, and generates C functions that can be called from godot. This allows much cleaner code replacing all `EM_ASM` calls in our C++ code with plain C function calls. This also gets rid of few hacks and comes with few optimizations (e.g. custom cursor shapes should be much faster now).
2020-10-23 16:33:20 +00:00
WindowMode window_mode = WINDOW_MODE_WINDOWED;
DisplayServerJavaScript implementation.
2020-05-01 12:45:45 +00:00
ObjectID window_attached_instance_id = {};
[HTML5] Port JavaScript inline code to libraries. The API is implemented in javascript, and generates C functions that can be called from godot. This allows much cleaner code replacing all `EM_ASM` calls in our C++ code with plain C function calls. This also gets rid of few hacks and comes with few optimizations (e.g. custom cursor shapes should be much faster now).
2020-10-23 16:33:20 +00:00
Callable window_event_callback;
Callable input_event_callback;
Callable input_text_callback;
Callable drop_files_callback;
String clipboard;
DisplayServerJavaScript implementation.
2020-05-01 12:45:45 +00:00
Point2 touches[32];
Implement text-to-speech support on Android, iOS, HTML5, Linux, macOS and Windows. Implement TextServer word break method.
2021-11-04 12:33:37 +00:00
Array voices;
[HTML5] Port JavaScript inline code to libraries. The API is implemented in javascript, and generates C functions that can be called from godot. This allows much cleaner code replacing all `EM_ASM` calls in our C++ code with plain C function calls. This also gets rid of few hacks and comes with few optimizations (e.g. custom cursor shapes should be much faster now).
2020-10-23 16:33:20 +00:00
char canvas_id[256] = { 0 };
bool cursor_inside_canvas = true;
CursorShape cursor_shape = CURSOR_ARROW;
DisplayServerJavaScript implementation.
2020-05-01 12:45:45 +00:00
Point2i last_click_pos = Point2(-100, -100); // TODO check this again.
[HTML5] Implement mouse/touch/key events in JS library. This makes us more independent from emscripten libraries, giving us more control on the application lifecycle.
2021-09-10 19:46:22 +00:00
uint64_t last_click_ms = 0;
Use "enum class" for input enums
2021-08-13 21:31:57 +00:00
MouseButton last_click_button_index = MouseButton::NONE;
DisplayServerJavaScript implementation.
2020-05-01 12:45:45 +00:00
Implement HTML5 cancel/ok button swap on Windows. Platform is detected on init via the `navigator.platform` string.
2020-07-27 11:53:03 +00:00
bool swap_cancel_ok = false;
More static methods in DisplayServerJavaScript. Were static functions in cpp file, polluting global namespace.
2020-07-01 00:23:22 +00:00
// utilities
[HTML5] Implement mouse/touch/key events in JS library. This makes us more independent from emscripten libraries, giving us more control on the application lifecycle.
2021-09-10 19:46:22 +00:00
static void dom2godot_mod(Ref<InputEventWithModifiers> ev, int p_mod);
More static methods in DisplayServerJavaScript. Were static functions in cpp file, polluting global namespace.
2020-07-01 00:23:22 +00:00
static const char *godot2dom_cursor(DisplayServer::CursorShape p_shape);
// events
[HTML5] Implement fullscreenchange in JS library. Removes more emscripten HTML5 library dependencies.
2021-09-12 10:19:33 +00:00
static void fullscreen_change_callback(int p_fullscreen);
[HTML5] Implement mouse/touch/key events in JS library. This makes us more independent from emscripten libraries, giving us more control on the application lifecycle.
2021-09-10 19:46:22 +00:00
static int mouse_button_callback(int p_pressed, int p_button, double p_x, double p_y, int p_modifiers);
static void mouse_move_callback(double p_x, double p_y, double p_rel_x, double p_rel_y, int p_modifiers);
static int mouse_wheel_callback(double p_delta_x, double p_delta_y);
static void touch_callback(int p_type, int p_count);
static void key_callback(int p_pressed, int p_repeat, int p_modifiers);
[HTML5] Opt-in virtual keyboard support. Added as an export option "Experimental Virtual Keyboard". There is no zoom, so text/line edit must be in the top part of the screen, or it will get hidden by the virtual keyboard. UTF8/Latin-1 only (I think regular UTF-8 should work out of the box in 4.0 but I can't test it). It uses an hidden textarea or input, based on the multiline variable, and only gets activated if the device has a touchscreen. This could cause problems on devices with both touchscreen and a real keyboard (although input should still work in general with some minor focus issues). I'm thinking of a system to detect the first physical keystroke and disable it in case, but it might do more harm then good, so it must be well thought.
2021-03-08 22:16:51 +00:00
static void vk_input_text_callback(const char *p_text, int p_cursor);
[HTML5] Custom Gamepad library to allow remapping. No longer use emscripten functions for gamepads, implement them as library functions in library_godot_display.js instead. This allows us to do a better job at "guessing" vendorId, productId, OS, etc. thus allowing us to better find the remapping for the controller.
2020-12-27 13:15:43 +00:00
static void gamepad_callback(int p_index, int p_connected, const char *p_id, const char *p_guid);
DisplayServerJavaScript implementation.
2020-05-01 12:45:45 +00:00
void process_joypads();
Implement text-to-speech support on Android, iOS, HTML5, Linux, macOS and Windows. Implement TextServer word break method.
2021-11-04 12:33:37 +00:00
static void _js_utterance_callback(int p_event, int p_id, int p_pos);
DisplayServerJavaScript implementation.
2020-05-01 12:45:45 +00:00
static Vector<String> get_rendering_drivers_func();
[HTML5] Fix build (with module_webxr_enabled=no). The XR API changed a bit, and it's not just a rename, though probably an easy update for someone who is qualified :).
2021-07-07 14:31:06 +00:00
static DisplayServer *create_func(const String &p_rendering_driver, WindowMode p_window_mode, VSyncMode p_vsync_mode, uint32_t p_flags, const Vector2i &p_resolution, Error &r_error);
DisplayServerJavaScript implementation.
2020-05-01 12:45:45 +00:00
static void _dispatch_input_event(const Ref<InputEvent> &p_event);
[HTML5] Port JavaScript inline code to libraries. The API is implemented in javascript, and generates C functions that can be called from godot. This allows much cleaner code replacing all `EM_ASM` calls in our C++ code with plain C function calls. This also gets rid of few hacks and comes with few optimizations (e.g. custom cursor shapes should be much faster now).
2020-10-23 16:33:20 +00:00
static void request_quit_callback();
[HTML5] Implement window blur in JS library. Removes more emscripten HTML5 library dependencies.
2021-10-05 10:54:42 +00:00
static void window_blur_callback();
Implement text-to-speech support on Android, iOS, HTML5, Linux, macOS and Windows. Implement TextServer word break method.
2021-11-04 12:33:37 +00:00
static void update_voices_callback(int p_size, const char **p_voice);
[HTML5] Port JavaScript inline code to libraries. The API is implemented in javascript, and generates C functions that can be called from godot. This allows much cleaner code replacing all `EM_ASM` calls in our C++ code with plain C function calls. This also gets rid of few hacks and comes with few optimizations (e.g. custom cursor shapes should be much faster now).
2020-10-23 16:33:20 +00:00
static void update_clipboard_callback(const char *p_text);
static void send_window_event_callback(int p_notification);
static void drop_files_js_callback(char **p_filev, int p_filec);
DisplayServerJavaScript implementation.
2020-05-01 12:45:45 +00:00
protected:
[HTML5] Add override keyword, cleanup methods.
2020-08-06 14:20:05 +00:00
int get_current_video_driver() const;
DisplayServerJavaScript implementation.
2020-05-01 12:45:45 +00:00
public:
// Override return type to make writing static callbacks less tedious.
static DisplayServerJavaScript *get_singleton();
[JS] Check canvas size each loop, force redraw. Fix compatibility issues, achieve smoother resizing.
2020-06-29 16:54:20 +00:00
// utilities
bool check_size_force_redraw();
DisplayServerJavaScript implementation.
2020-05-01 12:45:45 +00:00
// from DisplayServer
Modernize Display server to use override keyword
2021-07-16 19:39:13 +00:00
virtual bool has_feature(Feature p_feature) const override;
virtual String get_name() const override;
DisplayServerJavaScript implementation.
2020-05-01 12:45:45 +00:00
Implement text-to-speech support on Android, iOS, HTML5, Linux, macOS and Windows. Implement TextServer word break method.
2021-11-04 12:33:37 +00:00
// tts
virtual bool tts_is_speaking() const override;
virtual bool tts_is_paused() const override;
virtual Array tts_get_voices() const override;
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) override;
virtual void tts_pause() override;
virtual void tts_resume() override;
virtual void tts_stop() override;
DisplayServerJavaScript implementation.
2020-05-01 12:45:45 +00:00
// cursor
Modernize Display server to use override keyword
2021-07-16 19:39:13 +00:00
virtual void cursor_set_shape(CursorShape p_shape) override;
virtual CursorShape cursor_get_shape() const override;
Remove `RES` and `REF` typedefs in favor of spelled out `Ref<>` These typedefs don't save much typing compared to the full `Ref<Resource>` and `Ref<RefCounted>`, yet they sometimes introduce confusion among new contributors.
2022-05-02 23:43:50 +00:00
virtual void cursor_set_custom_image(const Ref<Resource> &p_cursor, CursorShape p_shape = CURSOR_ARROW, const Vector2 &p_hotspot = Vector2()) override;
DisplayServerJavaScript implementation.
2020-05-01 12:45:45 +00:00
// mouse
Modernize Display server to use override keyword
2021-07-16 19:39:13 +00:00
virtual void mouse_set_mode(MouseMode p_mode) override;
virtual MouseMode mouse_get_mode() const override;
[HTML5] Add WebGL2 (GLES3) support using the OpenGL renderer. Note, the editor build requires the mbedtls module to be manually enabled, as it is currently needed as a ResourceUID dependency. This will need to be addressed in a separate PR.
2021-10-25 17:16:40 +00:00
virtual Point2i mouse_get_position() const override;
DisplayServerJavaScript implementation.
2020-05-01 12:45:45 +00:00
// touch
Modernize Display server to use override keyword
2021-07-16 19:39:13 +00:00
virtual bool screen_is_touchscreen(int p_screen = SCREEN_OF_MAIN_WINDOW) const override;
DisplayServerJavaScript implementation.
2020-05-01 12:45:45 +00:00
// clipboard
Modernize Display server to use override keyword
2021-07-16 19:39:13 +00:00
virtual void clipboard_set(const String &p_text) override;
virtual String clipboard_get() const override;
DisplayServerJavaScript implementation.
2020-05-01 12:45:45 +00:00
// screen
Modernize Display server to use override keyword
2021-07-16 19:39:13 +00:00
virtual int get_screen_count() const override;
virtual Point2i screen_get_position(int p_screen = SCREEN_OF_MAIN_WINDOW) const override;
virtual Size2i screen_get_size(int p_screen = SCREEN_OF_MAIN_WINDOW) const override;
virtual Rect2i screen_get_usable_rect(int p_screen = SCREEN_OF_MAIN_WINDOW) const override;
virtual int screen_get_dpi(int p_screen = SCREEN_OF_MAIN_WINDOW) const override;
virtual float screen_get_scale(int p_screen = SCREEN_OF_MAIN_WINDOW) const override;
Add screen_get_refresh_rate to DisplayServer
2022-01-27 19:46:57 +00:00
virtual float screen_get_refresh_rate(int p_screen = SCREEN_OF_MAIN_WINDOW) const override;
DisplayServerJavaScript implementation.
2020-05-01 12:45:45 +00:00
Add support for multiple virtual keyboard types
2022-07-07 18:20:10 +00:00
virtual void virtual_keyboard_show(const String &p_existing_text, const Rect2 &p_screen_rect = Rect2(), VirtualKeyboardType p_type = KEYBOARD_TYPE_DEFAULT, int p_max_input_length = -1, int p_cursor_start = -1, int p_cursor_end = -1) override;
Modernize Display server to use override keyword
2021-07-16 19:39:13 +00:00
virtual void virtual_keyboard_hide() override;
[HTML5] Opt-in virtual keyboard support. Added as an export option "Experimental Virtual Keyboard". There is no zoom, so text/line edit must be in the top part of the screen, or it will get hidden by the virtual keyboard. UTF8/Latin-1 only (I think regular UTF-8 should work out of the box in 4.0 but I can't test it). It uses an hidden textarea or input, based on the multiline variable, and only gets activated if the device has a touchscreen. This could cause problems on devices with both touchscreen and a real keyboard (although input should still work in general with some minor focus issues). I'm thinking of a system to detect the first physical keystroke and disable it in case, but it might do more harm then good, so it must be well thought.
2021-03-08 22:16:51 +00:00
DisplayServerJavaScript implementation.
2020-05-01 12:45:45 +00:00
// windows
Modernize Display server to use override keyword
2021-07-16 19:39:13 +00:00
virtual Vector<DisplayServer::WindowID> get_window_list() const override;
virtual WindowID get_window_at_screen_position(const Point2i &p_position) const override;
DisplayServerJavaScript implementation.
2020-05-01 12:45:45 +00:00
Modernize Display server to use override keyword
2021-07-16 19:39:13 +00:00
virtual void window_attach_instance_id(ObjectID p_instance, WindowID p_window = MAIN_WINDOW_ID) override;
virtual ObjectID window_get_attached_instance_id(WindowID p_window = MAIN_WINDOW_ID) const override;
DisplayServerJavaScript implementation.
2020-05-01 12:45:45 +00:00
Modernize Display server to use override keyword
2021-07-16 19:39:13 +00:00
virtual void window_set_rect_changed_callback(const Callable &p_callable, WindowID p_window = MAIN_WINDOW_ID) override;
DisplayServerJavaScript implementation.
2020-05-01 12:45:45 +00:00
Modernize Display server to use override keyword
2021-07-16 19:39:13 +00:00
virtual void window_set_window_event_callback(const Callable &p_callable, WindowID p_window = MAIN_WINDOW_ID) override;
virtual void window_set_input_event_callback(const Callable &p_callable, WindowID p_window = MAIN_WINDOW_ID) override;
virtual void window_set_input_text_callback(const Callable &p_callable, WindowID p_window = MAIN_WINDOW_ID) override;
DisplayServerJavaScript implementation.
2020-05-01 12:45:45 +00:00
Modernize Display server to use override keyword
2021-07-16 19:39:13 +00:00
virtual void window_set_drop_files_callback(const Callable &p_callable, WindowID p_window = MAIN_WINDOW_ID) override;
DisplayServerJavaScript implementation.
2020-05-01 12:45:45 +00:00
Modernize Display server to use override keyword
2021-07-16 19:39:13 +00:00
virtual void window_set_title(const String &p_title, WindowID p_window = MAIN_WINDOW_ID) override;
DisplayServerJavaScript implementation.
2020-05-01 12:45:45 +00:00
Modernize Display server to use override keyword
2021-07-16 19:39:13 +00:00
virtual int window_get_current_screen(WindowID p_window = MAIN_WINDOW_ID) const override;
virtual void window_set_current_screen(int p_screen, WindowID p_window = MAIN_WINDOW_ID) override;
DisplayServerJavaScript implementation.
2020-05-01 12:45:45 +00:00
Modernize Display server to use override keyword
2021-07-16 19:39:13 +00:00
virtual Point2i window_get_position(WindowID p_window = MAIN_WINDOW_ID) const override;
virtual void window_set_position(const Point2i &p_position, WindowID p_window = MAIN_WINDOW_ID) override;
DisplayServerJavaScript implementation.
2020-05-01 12:45:45 +00:00
Modernize Display server to use override keyword
2021-07-16 19:39:13 +00:00
virtual void window_set_transient(WindowID p_window, WindowID p_parent) override;
DisplayServerJavaScript implementation.
2020-05-01 12:45:45 +00:00
Modernize Display server to use override keyword
2021-07-16 19:39:13 +00:00
virtual void window_set_max_size(const Size2i p_size, WindowID p_window = MAIN_WINDOW_ID) override;
virtual Size2i window_get_max_size(WindowID p_window = MAIN_WINDOW_ID) const override;
DisplayServerJavaScript implementation.
2020-05-01 12:45:45 +00:00
Modernize Display server to use override keyword
2021-07-16 19:39:13 +00:00
virtual void window_set_min_size(const Size2i p_size, WindowID p_window = MAIN_WINDOW_ID) override;
virtual Size2i window_get_min_size(WindowID p_window = MAIN_WINDOW_ID) const override;
DisplayServerJavaScript implementation.
2020-05-01 12:45:45 +00:00
Modernize Display server to use override keyword
2021-07-16 19:39:13 +00:00
virtual void window_set_size(const Size2i p_size, WindowID p_window = MAIN_WINDOW_ID) override;
virtual Size2i window_get_size(WindowID p_window = MAIN_WINDOW_ID) const override;
virtual Size2i window_get_real_size(WindowID p_window = MAIN_WINDOW_ID) const override;
DisplayServerJavaScript implementation.
2020-05-01 12:45:45 +00:00
Modernize Display server to use override keyword
2021-07-16 19:39:13 +00:00
virtual void window_set_mode(WindowMode p_mode, WindowID p_window = MAIN_WINDOW_ID) override;
virtual WindowMode window_get_mode(WindowID p_window = MAIN_WINDOW_ID) const override;
DisplayServerJavaScript implementation.
2020-05-01 12:45:45 +00:00
Modernize Display server to use override keyword
2021-07-16 19:39:13 +00:00
virtual bool window_is_maximize_allowed(WindowID p_window = MAIN_WINDOW_ID) const override;
DisplayServerJavaScript implementation.
2020-05-01 12:45:45 +00:00
Modernize Display server to use override keyword
2021-07-16 19:39:13 +00:00
virtual void window_set_flag(WindowFlags p_flag, bool p_enabled, WindowID p_window = MAIN_WINDOW_ID) override;
virtual bool window_get_flag(WindowFlags p_flag, WindowID p_window = MAIN_WINDOW_ID) const override;
DisplayServerJavaScript implementation.
2020-05-01 12:45:45 +00:00
Modernize Display server to use override keyword
2021-07-16 19:39:13 +00:00
virtual void window_request_attention(WindowID p_window = MAIN_WINDOW_ID) override;
virtual void window_move_to_foreground(WindowID p_window = MAIN_WINDOW_ID) override;
DisplayServerJavaScript implementation.
2020-05-01 12:45:45 +00:00
Modernize Display server to use override keyword
2021-07-16 19:39:13 +00:00
virtual bool window_can_draw(WindowID p_window = MAIN_WINDOW_ID) const override;
DisplayServerJavaScript implementation.
2020-05-01 12:45:45 +00:00
Modernize Display server to use override keyword
2021-07-16 19:39:13 +00:00
virtual bool can_any_window_draw() const override;
DisplayServerJavaScript implementation.
2020-05-01 12:45:45 +00:00
// events
Modernize Display server to use override keyword
2021-07-16 19:39:13 +00:00
virtual void process_events() override;
DisplayServerJavaScript implementation.
2020-05-01 12:45:45 +00:00
// icon
Modernize Display server to use override keyword
2021-07-16 19:39:13 +00:00
virtual void set_icon(const Ref<Image> &p_icon) override;
DisplayServerJavaScript implementation.
2020-05-01 12:45:45 +00:00
// others
Modernize Display server to use override keyword
2021-07-16 19:39:13 +00:00
virtual bool get_swap_cancel_ok() override;
virtual void swap_buffers() override;
DisplayServerJavaScript implementation.
2020-05-01 12:45:45 +00:00
static void register_javascript_driver();
[HTML5] Fix build (with module_webxr_enabled=no). The XR API changed a bit, and it's not just a rename, though probably an easy update for someone who is qualified :).
2021-07-07 14:31:06 +00:00
DisplayServerJavaScript(const String &p_rendering_driver, WindowMode p_window_mode, VSyncMode p_vsync_mode, uint32_t p_flags, const Size2i &p_resolution, Error &r_error);
DisplayServerJavaScript implementation.
2020-05-01 12:45:45 +00:00
~DisplayServerJavaScript();
};
#endif // DISPLAY_SERVER_JAVASCRIPT_H