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

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

230 lines
12 KiB
C++
Raw Normal View History

One Copyright Update to rule them all As many open source projects have started doing it, we're removing the current year from the copyright notice, so that we don't need to bump it every year. It seems like only the first year of publication is technically relevant for copyright notices, and even that seems to be something that many companies stopped listing altogether (in a version controlled codebase, the commits are a much better source of date of publication than a hardcoded copyright statement). We also now list Godot Engine contributors first as we're collectively the current maintainers of the project, and we clarify that the "exclusive" copyright of the co-founders covers the timespan before opensourcing (their further contributions are included as part of Godot Engine contributors). Also fixed "cf." Frenchism - it's meant as "refer to / see".
2023-01-05 12:25:55 +00:00
/**************************************************************************/
/* display_server_android.h */
/**************************************************************************/
/* This file is part of: */
/* GODOT ENGINE */
/* https://godotengine.org */
/**************************************************************************/
/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
/* */
/* 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. */
/**************************************************************************/
Display Server support
2020-03-27 16:30:18 +00:00
#ifndef DISPLAY_SERVER_ANDROID_H
#define DISPLAY_SERVER_ANDROID_H
#include "servers/display_server.h"
#if defined(VULKAN_ENABLED)
class VulkanContextAndroid;
class RenderingDeviceVulkan;
#endif
class DisplayServerAndroid : public DisplayServer {
Don't expose mac specific display server.
2023-05-08 18:32:56 +00:00
// No need to register with GDCLASS, it's platform-specific and nothing is added.
Display Server support
2020-03-27 16:30:18 +00:00
String rendering_driver;
Android: Add support for cursor icons
2020-11-04 21:55:28 +00:00
// https://developer.android.com/reference/android/view/PointerIcon
// mapping between Godot's cursor shape to Android's'
int android_cursors[CURSOR_MAX] = {
1000, //CURSOR_ARROW
1008, //CURSOR_IBEAM
1002, //CURSOR_POINTIN
1007, //CURSOR_CROSS
1004, //CURSOR_WAIT
1004, //CURSOR_BUSY
1021, //CURSOR_DRAG
1021, //CURSOR_CAN_DRO
Style: Cleanup uses of double spaces between words Or after punctuation. Tried to leave third-party stuff alone, unless it has been heavily modified for Godot.
2021-06-07 08:17:32 +00:00
1000, //CURSOR_FORBIDD (no corresponding icon in Android's icon so fallback to default)
Android: Add support for cursor icons
2020-11-04 21:55:28 +00:00
1015, //CURSOR_VSIZE
1014, //CURSOR_HSIZE
1017, //CURSOR_BDIAGSI
1016, //CURSOR_FDIAGSI
1020, //CURSOR_MOVE
1015, //CURSOR_VSPLIT
1014, //CURSOR_HSPLIT
1003, //CURSOR_HELP
};
const int CURSOR_TYPE_NULL = 0;
Android: Initialize mouse mode
2021-07-02 15:00:33 +00:00
MouseMode mouse_mode = MouseMode::MOUSE_MODE_VISIBLE;
Android: Allow Mouse Capture
2020-11-01 01:30:40 +00:00
Display Server support
2020-03-27 16:30:18 +00:00
bool keep_screen_on;
Add missing display server overrides Improves the base functionality for the Android platform and helps reduce the amount of spurious error logs emitted.
2022-11-28 06:03:28 +00:00
bool swap_buffers_flag;
Display Server support
2020-03-27 16:30:18 +00:00
Android: Add support for cursor icons
2020-11-04 21:55:28 +00:00
CursorShape cursor_shape = CursorShape::CURSOR_ARROW;
Display Server support
2020-03-27 16:30:18 +00:00
#if defined(VULKAN_ENABLED)
Fix initialising of gl_manager and checking gl_manager and context_vulkan preventing crash issues.
2021-12-14 01:49:29 +00:00
VulkanContextAndroid *context_vulkan = nullptr;
RenderingDeviceVulkan *rendering_device_vulkan = nullptr;
Display Server support
2020-03-27 16:30:18 +00:00
#endif
ObjectID window_attached_instance_id;
Callable window_event_callback;
Callable input_event_callback;
Callable input_text_callback;
Fixed screen orientation on Android
2021-05-03 16:23:05 +00:00
Callable rect_changed_callback;
Display Server support
2020-03-27 16:30:18 +00:00
Switch to input buffering on Android Key, touch and joystick events will be passed directly from the UI thread to Godot, so they can benefit from agile input flushing. As another consequence of this new way of passing events, less Java object are created at runtime (`Runnable`), which is good since the garbage collector needs to run less. `AndroidInputHandler` is introduced to have a smaller cross-thread surface. `main_loop_request_go_back()` is removed in favor just inline calling `send_window_event()` at the most caller's convenience (i.e., leveraging the new `p_deferred`` parameter as appropriate). Lastly, `get_mouse_position()` and `get_mouse_button_state()` now just call through `Input` to avoid the need of sync of mouse data tracked on the UI thread.
2021-08-04 19:22:11 +00:00
void _window_callback(const Callable &p_callable, const Variant &p_arg, bool p_deferred = false) const;
Display Server support
2020-03-27 16:30:18 +00:00
static void _dispatch_input_events(const Ref<InputEvent> &p_event);
public:
static DisplayServerAndroid *get_singleton();
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;
Display Server support
2020-03-27 16:30:18 +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
virtual bool tts_is_speaking() const override;
virtual bool tts_is_paused() const override;
Replace Array return types with TypedArray
2022-08-05 01:41:48 +00:00
virtual TypedArray<Dictionary> tts_get_voices() const override;
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
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;
Support dark mode on Android and iOS.
2023-09-26 03:00:04 +00:00
virtual bool is_dark_mode_supported() const override;
virtual bool is_dark_mode() const override;
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;
Add `DisplayServer.clipboard_has()` to check clipboard content
2022-01-19 13:04:52 +00:00
virtual bool clipboard_has() const override;
Display Server support
2020-03-27 16:30:18 +00:00
Replace Array return types with TypedArray
2022-08-05 01:41:48 +00:00
virtual TypedArray<Rect2> get_display_cutouts() const override;
Fix screen_get_usable_rect returning display safe area
2022-04-26 09:40:57 +00:00
virtual Rect2i get_display_safe_area() const override;
Add a method for obtaining display cutouts on Android
2022-04-24 19:12:22 +00:00
Modernize Display server to use override keyword
2021-07-16 19:39:13 +00:00
virtual void screen_set_keep_on(bool p_enable) override;
virtual bool screen_is_kept_on() const override;
Display Server support
2020-03-27 16:30:18 +00:00
Modernize Display server to use override keyword
2021-07-16 19:39:13 +00:00
virtual void screen_set_orientation(ScreenOrientation p_orientation, int p_screen = SCREEN_OF_MAIN_WINDOW) override;
virtual ScreenOrientation screen_get_orientation(int p_screen = SCREEN_OF_MAIN_WINDOW) const override;
Display Server support
2020-03-27 16:30:18 +00:00
Modernize Display server to use override keyword
2021-07-16 19:39:13 +00:00
virtual int get_screen_count() const override;
Add support for the custom initial screen for the main window, fix primary screen detection.
2023-01-04 22:00:02 +00:00
virtual int get_primary_screen() const override;
Modernize Display server to use override keyword
2021-07-16 19:39:13 +00:00
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;
Update the editor display scale based on the device's scaled density
2022-04-04 09:22:51 +00:00
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;
Fix Determining Window for Touchscreen DisplayServer::screen_is_touchscreen will likely never utilize its parameter p_screen. This PR replaces this function by DisplayServer::is_touchscreen_available() with the same functionality. This solves the problem, that a SubViewport was used for determining the screen, which resulted in error messages.
2022-10-16 22:59:51 +00:00
virtual bool is_touchscreen_available() const override;
Display Server support
2020-03-27 16:30:18 +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_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;
virtual int virtual_keyboard_get_height() const override;
Display Server support
2020-03-27 16:30:18 +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;
virtual void window_set_rect_changed_callback(const Callable &p_callable, WindowID p_window = MAIN_WINDOW_ID) override;
virtual void window_set_drop_files_callback(const Callable &p_callable, WindowID p_window = MAIN_WINDOW_ID) override;
Display Server support
2020-03-27 16:30:18 +00:00
Switch to input buffering on Android Key, touch and joystick events will be passed directly from the UI thread to Godot, so they can benefit from agile input flushing. As another consequence of this new way of passing events, less Java object are created at runtime (`Runnable`), which is good since the garbage collector needs to run less. `AndroidInputHandler` is introduced to have a smaller cross-thread surface. `main_loop_request_go_back()` is removed in favor just inline calling `send_window_event()` at the most caller's convenience (i.e., leveraging the new `p_deferred`` parameter as appropriate). Lastly, `get_mouse_position()` and `get_mouse_button_state()` now just call through `Input` to avoid the need of sync of mouse data tracked on the UI thread.
2021-08-04 19:22:11 +00:00
void send_window_event(WindowEvent p_event, bool p_deferred = false) const;
Display Server support
2020-03-27 16:30:18 +00:00
void send_input_event(const Ref<InputEvent> &p_event) const;
void send_input_text(const String &p_text) const;
Modernize Display server to use override keyword
2021-07-16 19:39:13 +00:00
virtual Vector<WindowID> get_window_list() const override;
virtual WindowID get_window_at_screen_position(const Point2i &p_position) const override;
Add support for getting native display, window, and view handles.
2022-01-14 10:41:04 +00:00
virtual int64_t window_get_native_handle(HandleType p_handle_type, WindowID p_window = MAIN_WINDOW_ID) const override;
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;
virtual void window_set_title(const String &p_title, WindowID p_window = MAIN_WINDOW_ID) override;
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;
virtual Point2i window_get_position(WindowID p_window = MAIN_WINDOW_ID) const override;
Rename `window_get_real_size` to `window_get_size_with_decorations`, add `window_get_position_with_decorations`.
2022-11-30 08:28:16 +00:00
virtual Point2i window_get_position_with_decorations(WindowID p_window = MAIN_WINDOW_ID) const override;
Modernize Display server to use override keyword
2021-07-16 19:39:13 +00:00
virtual void window_set_position(const Point2i &p_position, WindowID p_window = MAIN_WINDOW_ID) override;
virtual void window_set_transient(WindowID p_window, WindowID p_parent) override;
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;
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;
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;
Rename `window_get_real_size` to `window_get_size_with_decorations`, add `window_get_position_with_decorations`.
2022-11-30 08:28:16 +00:00
virtual Size2i window_get_size_with_decorations(WindowID p_window = MAIN_WINDOW_ID) const override;
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;
virtual bool window_is_maximize_allowed(WindowID p_window = MAIN_WINDOW_ID) const override;
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;
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;
[DisplayServer] Add method to check if native window is focused.
2023-06-15 07:53:31 +00:00
virtual bool window_is_focused(WindowID p_window = MAIN_WINDOW_ID) const override;
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;
virtual bool can_any_window_draw() const override;
virtual void window_set_vsync_mode(DisplayServer::VSyncMode p_vsync_mode, WindowID p_window = MAIN_WINDOW_ID) override;
virtual DisplayServer::VSyncMode window_get_vsync_mode(WindowID p_vsync_mode) const override;
virtual void process_events() override;
Display Server support
2020-03-27 16:30:18 +00:00
void process_accelerometer(const Vector3 &p_accelerometer);
void process_gravity(const Vector3 &p_gravity);
void process_magnetometer(const Vector3 &p_magnetometer);
void process_gyroscope(const Vector3 &p_gyroscope);
Add missing display server overrides Improves the base functionality for the Android platform and helps reduce the amount of spurious error logs emitted.
2022-11-28 06:03:28 +00:00
void _cursor_set_shape_helper(CursorShape p_shape, bool force = false);
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;
Add missing display server overrides Improves the base functionality for the Android platform and helps reduce the amount of spurious error logs emitted.
2022-11-28 06:03:28 +00:00
virtual void cursor_set_custom_image(const Ref<Resource> &p_cursor, CursorShape p_shape = CURSOR_ARROW, const Vector2 &p_hotspot = Vector2()) override;
Android: Add support for cursor icons
2020-11-04 21:55:28 +00:00
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;
Android: Allow Mouse Capture
2020-11-01 01:30:40 +00:00
Add support for the custom initial screen for the main window, fix primary screen detection.
2023-01-04 22:00:02 +00:00
static DisplayServer *create_func(const String &p_rendering_driver, WindowMode p_mode, DisplayServer::VSyncMode p_vsync_mode, uint32_t p_flags, const Vector2i *p_position, const Vector2i &p_resolution, int p_screen, Error &r_error);
Display Server support
2020-03-27 16:30:18 +00:00
static Vector<String> get_rendering_drivers_func();
static void register_android_driver();
Proper surface reset when resuming app on Android Just re-creating the window instead of restarting the app entirely.
2020-05-24 08:04:59 +00:00
void reset_window();
Fixed screen orientation on Android
2021-05-03 16:23:05 +00:00
void notify_surface_changed(int p_width, int p_height);
Proper surface reset when resuming app on Android Just re-creating the window instead of restarting the app entirely.
2020-05-24 08:04:59 +00:00
Modernize Display server to use override keyword
2021-07-16 19:39:13 +00:00
virtual Point2i mouse_get_position() const override;
Use BitField<> in core type masks * All core types masks are now correctly marked as bitfields. * The enum hacks in MouseButtonMask and many other types are gone. This ensures that binders to other languages non C++ can actually implement type safe bitmasks. * Most bitmask operations replaced by functions in BitField<> * Key is still a problem because its enum and mask at the same time. While it kind of works in C++, this most likely can't be implemented safely in other languages and will have to be changed at some point. Mostly left as-is. * Documentation and API dump updated to reflect bitfields in core types.
2023-01-07 23:55:54 +00:00
virtual BitField<MouseButtonMask> mouse_get_button_state() const override;
Android: Mouse Implementation Implement mouse Move touch to inputManager Change to use android/input.h
2020-10-07 23:37:58 +00:00
Add missing display server overrides Improves the base functionality for the Android platform and helps reduce the amount of spurious error logs emitted.
2022-11-28 06:03:28 +00:00
void reset_swap_buffers_flag();
bool should_swap_buffers() const;
virtual void swap_buffers() override;
virtual void set_native_icon(const String &p_filename) override;
virtual void set_icon(const Ref<Image> &p_icon) override;
Add support for the custom initial screen for the main window, fix primary screen detection.
2023-01-04 22:00:02 +00:00
DisplayServerAndroid(const String &p_rendering_driver, WindowMode p_mode, DisplayServer::VSyncMode p_vsync_mode, uint32_t p_flags, const Vector2i *p_position, const Vector2i &p_resolution, int p_screen, Error &r_error);
Display Server support
2020-03-27 16:30:18 +00:00
~DisplayServerAndroid();
};
#endif // DISPLAY_SERVER_ANDROID_H