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

194 lines
9.5 KiB
C++
Raw Normal View History

Display Server support
2020-03-27 16:30:18 +00:00
/*************************************************************************/
/* display_server_android.h */
/*************************************************************************/
/* This file is part of: */
/* GODOT ENGINE */
/* https://godotengine.org */
/*************************************************************************/
Update copyright statements to 2021 Happy new year to the wonderful Godot community! 2020 has been a tough year for most of us personally, but a good year for Godot development nonetheless with a huge amount of work done towards Godot 4.0 and great improvements backported to the long-lived 3.2 branch. We've had close to 400 contributors to engine code this year, authoring near 7,000 commit! (And that's only for the `master` branch and for the engine code, there's a lot more when counting docs, demos and other first-party repos.) Here's to a great year 2021 for all Godot users 🎆
2021-01-01 19:13:46 +00:00
/* Copyright (c) 2007-2021 Juan Linietsky, Ariel Manzur. */
/* Copyright (c) 2014-2021 Godot Engine contributors (cf. AUTHORS.md). */
Display Server support
2020-03-27 16:30:18 +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_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 {
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;
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)
VulkanContextAndroid *context_vulkan;
RenderingDeviceVulkan *rendering_device_vulkan;
#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
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;
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_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;
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 bool screen_is_touchscreen(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 void virtual_keyboard_show(const String &p_existing_text, const Rect2 &p_screen_rect = Rect2(), bool p_multiline = false, int p_max_length = -1, int p_cursor_start = -1, int p_cursor_end = -1) override;
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;
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;
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;
virtual Size2i window_get_real_size(WindowID p_window = MAIN_WINDOW_ID) const override;
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;
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);
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;
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
Restructure and reimplement vsync options -Add a v-sync mode setting which allows to choose between DISABLED, ON, ADAPTIVE and MAILBOX -Removed the V-Sync via Compositor option
2021-06-19 15:44:59 +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_resolution, 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;
virtual MouseButton 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
Restructure and reimplement vsync options -Add a v-sync mode setting which allows to choose between DISABLED, ON, ADAPTIVE and MAILBOX -Removed the V-Sync via Compositor option
2021-06-19 15:44:59 +00:00
DisplayServerAndroid(const String &p_rendering_driver, WindowMode p_mode, DisplayServer::VSyncMode p_vsync_mode, uint32_t p_flags, const Vector2i &p_resolution, Error &r_error);
Display Server support
2020-03-27 16:30:18 +00:00
~DisplayServerAndroid();
};
#endif // DISPLAY_SERVER_ANDROID_H