godotengine/godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
df50929043
godot/platform/ios/display_server_ios.h

228 lines
11 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_ios.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. */
/**************************************************************************/
iOS: Vulkan support Implemented Vulkan Support. Use DisplayServer for rendering and input handling Use single view for rendering in both GLES2 (not supported yet) and Vulkan Use @available checks where it's required (otherwise compiler would fail compilation) Simulator checks
2020-07-15 18:59:57 +00:00
Code quality: Fix header guards consistency Adds `header_guards.sh` bash script, used in CI to validate future changes. Can be run locally to fix invalid header guards.
2022-07-23 21:41:51 +00:00
#ifndef DISPLAY_SERVER_IOS_H
#define DISPLAY_SERVER_IOS_H
iOS: Vulkan support Implemented Vulkan Support. Use DisplayServer for rendering and input handling Use single view for rendering in both GLES2 (not supported yet) and Vulkan Use @available checks where it's required (otherwise compiler would fail compilation) Simulator checks
2020-07-15 18:59:57 +00:00
#include "core/input/input.h"
#include "servers/display_server.h"
#if defined(VULKAN_ENABLED)
#include "drivers/vulkan/rendering_device_vulkan.h"
RenderingServer reorganization
2020-12-04 18:26:24 +00:00
#include "servers/rendering/renderer_rd/renderer_compositor_rd.h"
iOS: Vulkan support Implemented Vulkan Support. Use DisplayServer for rendering and input handling Use single view for rendering in both GLES2 (not supported yet) and Vulkan Use @available checks where it's required (otherwise compiler would fail compilation) Simulator checks
2020-07-15 18:59:57 +00:00
Rename OSX to macOS and iPhoneOS to iOS.
2022-07-20 06:28:22 +00:00
#include "vulkan_context_ios.h"
iOS: Vulkan support Implemented Vulkan Support. Use DisplayServer for rendering and input handling Use single view for rendering in both GLES2 (not supported yet) and Vulkan Use @available checks where it's required (otherwise compiler would fail compilation) Simulator checks
2020-07-15 18:59:57 +00:00
Use "volk" instead of statically linked Vulkan loader.
2021-08-12 11:24:54 +00:00
#ifdef USE_VOLK
#include <volk.h>
#else
#include <vulkan/vulkan.h>
#endif
iOS: Vulkan support Implemented Vulkan Support. Use DisplayServer for rendering and input handling Use single view for rendering in both GLES2 (not supported yet) and Vulkan Use @available checks where it's required (otherwise compiler would fail compilation) Simulator checks
2020-07-15 18:59:57 +00:00
#endif
[iOS] Restore OpenGLES3 renderer support.
2023-01-20 22:20:30 +00:00
#if defined(GLES3_ENABLED)
#include "drivers/gles3/rasterizer_gles3.h"
#endif // GLES3_ENABLED
Fix build with Vulkan disabled and no Vulkan headers installed.
2022-10-25 19:20:54 +00:00
#import <Foundation/Foundation.h>
#import <QuartzCore/CAMetalLayer.h>
Rename OSX to macOS and iPhoneOS to iOS.
2022-07-20 06:28:22 +00:00
class DisplayServerIOS : public DisplayServer {
GDCLASS(DisplayServerIOS, DisplayServer)
iOS: Vulkan support Implemented Vulkan Support. Use DisplayServer for rendering and input handling Use single view for rendering in both GLES2 (not supported yet) and Vulkan Use @available checks where it's required (otherwise compiler would fail compilation) Simulator checks
2020-07-15 18:59:57 +00:00
_THREAD_SAFE_CLASS_
#if defined(VULKAN_ENABLED)
Rename OSX to macOS and iPhoneOS to iOS.
2022-07-20 06:28:22 +00:00
VulkanContextIOS *context_vulkan = nullptr;
Fix initialising of gl_manager and checking gl_manager and context_vulkan preventing crash issues.
2021-12-14 01:49:29 +00:00
RenderingDeviceVulkan *rendering_device_vulkan = nullptr;
iOS: Vulkan support Implemented Vulkan Support. Use DisplayServer for rendering and input handling Use single view for rendering in both GLES2 (not supported yet) and Vulkan Use @available checks where it's required (otherwise compiler would fail compilation) Simulator checks
2020-07-15 18:59:57 +00:00
#endif
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
id tts = nullptr;
iOS: Vulkan support Implemented Vulkan Support. Use DisplayServer for rendering and input handling Use single view for rendering in both GLES2 (not supported yet) and Vulkan Use @available checks where it's required (otherwise compiler would fail compilation) Simulator checks
2020-07-15 18:59:57 +00:00
DisplayServer::ScreenOrientation screen_orientation;
ObjectID window_attached_instance_id;
Callable window_event_callback;
Callable window_resize_callback;
Callable input_event_callback;
Callable input_text_callback;
int virtual_keyboard_height = 0;
void perform_event(const Ref<InputEvent> &p_event);
Add support for the custom initial screen for the main window, fix primary screen detection.
2023-01-04 22:00:02 +00:00
DisplayServerIOS(const String &p_rendering_driver, DisplayServer::WindowMode p_mode, DisplayServer::VSyncMode p_vsync_mode, uint32_t p_flags, const Vector2i *p_position, const Vector2i &p_resolution, int p_screen, Error &r_error);
Rename OSX to macOS and iPhoneOS to iOS.
2022-07-20 06:28:22 +00:00
~DisplayServerIOS();
iOS: Vulkan support Implemented Vulkan Support. Use DisplayServer for rendering and input handling Use single view for rendering in both GLES2 (not supported yet) and Vulkan Use @available checks where it's required (otherwise compiler would fail compilation) Simulator checks
2020-07-15 18:59:57 +00:00
public:
String rendering_driver;
Rename OSX to macOS and iPhoneOS to iOS.
2022-07-20 06:28:22 +00:00
static DisplayServerIOS *get_singleton();
iOS: Vulkan support Implemented Vulkan Support. Use DisplayServer for rendering and input handling Use single view for rendering in both GLES2 (not supported yet) and Vulkan Use @available checks where it's required (otherwise compiler would fail compilation) Simulator checks
2020-07-15 18:59:57 +00:00
Rename OSX to macOS and iPhoneOS to iOS.
2022-07-20 06:28:22 +00:00
static void register_ios_driver();
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);
iOS: Vulkan support Implemented Vulkan Support. Use DisplayServer for rendering and input handling Use single view for rendering in both GLES2 (not supported yet) and Vulkan Use @available checks where it's required (otherwise compiler would fail compilation) Simulator checks
2020-07-15 18:59:57 +00:00
static Vector<String> get_rendering_drivers_func();
// MARK: - Events
virtual void process_events() override;
virtual void window_set_rect_changed_callback(const Callable &p_callable, WindowID p_window = MAIN_WINDOW_ID) override;
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_drop_files_callback(const Callable &p_callable, WindowID p_window = MAIN_WINDOW_ID) override;
static void _dispatch_input_events(const Ref<InputEvent> &p_event);
void send_input_event(const Ref<InputEvent> &p_event) const;
void send_input_text(const String &p_text) const;
void send_window_event(DisplayServer::WindowEvent p_event) const;
void _window_callback(const Callable &p_callable, const Variant &p_arg) const;
// MARK: - Input
[iOS] Add Apple Pencil pressure and tilt support.
2022-12-23 15:37:45 +00:00
// MARK: Touches and Apple Pencil
iOS: Vulkan support Implemented Vulkan Support. Use DisplayServer for rendering and input handling Use single view for rendering in both GLES2 (not supported yet) and Vulkan Use @available checks where it's required (otherwise compiler would fail compilation) Simulator checks
2020-07-15 18:59:57 +00:00
Rename `doubleclick` to `double_click`
2021-04-13 08:25:44 +00:00
void touch_press(int p_idx, int p_x, int p_y, bool p_pressed, bool p_double_click);
[iOS] Add Apple Pencil pressure and tilt support.
2022-12-23 15:37:45 +00:00
void touch_drag(int p_idx, int p_prev_x, int p_prev_y, int p_x, int p_y, float p_pressure, Vector2 p_tilt);
Convert en_GB spelling to en_US with codespell
2023-01-21 11:25:29 +00:00
void touches_canceled(int p_idx);
iOS: Vulkan support Implemented Vulkan Support. Use DisplayServer for rendering and input handling Use single view for rendering in both GLES2 (not supported yet) and Vulkan Use @available checks where it's required (otherwise compiler would fail compilation) Simulator checks
2020-07-15 18:59:57 +00:00
// MARK: Keyboard
Cleanup and unify keyboard input. - Unify keycode values (secondary label printed on a key), remove unused hardcoded Latin-1 codes. - Unify IME behaviour, add inline composition string display on Windows and X11. - Add key_label (localized label printed on a key) value to the key events, and allow mapping actions to the unshifted Unicode events. - Add support for physical keyboard (Bluetooth or Sidecar) handling on iOS. - Add support for media key handling on macOS. Co-authored-by: Raul Santos <raulsntos@gmail.com>
2022-12-10 23:21:22 +00:00
void key(Key p_key, char32_t p_char, Key p_unshifted, Key p_physical, NSInteger p_modifier, bool p_pressed);
bool is_keyboard_active() const;
iOS: Vulkan support Implemented Vulkan Support. Use DisplayServer for rendering and input handling Use single view for rendering in both GLES2 (not supported yet) and Vulkan Use @available checks where it's required (otherwise compiler would fail compilation) Simulator checks
2020-07-15 18:59:57 +00:00
// MARK: Motion
void update_gravity(float p_x, float p_y, float p_z);
void update_accelerometer(float p_x, float p_y, float p_z);
void update_magnetometer(float p_x, float p_y, float p_z);
void update_gyroscope(float p_x, float p_y, float p_z);
// MARK: -
virtual bool has_feature(Feature p_feature) const override;
virtual String get_name() 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 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;
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;
iOS: Vulkan support Implemented Vulkan Support. Use DisplayServer for rendering and input handling Use single view for rendering in both GLES2 (not supported yet) and Vulkan Use @available checks where it's required (otherwise compiler would fail compilation) Simulator checks
2020-07-15 18:59:57 +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;
iOS: Vulkan support Implemented Vulkan Support. Use DisplayServer for rendering and input handling Use single view for rendering in both GLES2 (not supported yet) and Vulkan Use @available checks where it's required (otherwise compiler would fail compilation) Simulator checks
2020-07-15 18:59:57 +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;
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;
iOS: Vulkan support Implemented Vulkan Support. Use DisplayServer for rendering and input handling Use single view for rendering in both GLES2 (not supported yet) and Vulkan Use @available checks where it's required (otherwise compiler would fail compilation) Simulator checks
2020-07-15 18:59:57 +00:00
virtual Vector<DisplayServer::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;
iOS: Vulkan support Implemented Vulkan Support. Use DisplayServer for rendering and input handling Use single view for rendering in both GLES2 (not supported yet) and Vulkan Use @available checks where it's required (otherwise compiler would fail compilation) Simulator checks
2020-07-15 18:59:57 +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;
iOS: Vulkan support Implemented Vulkan Support. Use DisplayServer for rendering and input handling Use single view for rendering in both GLES2 (not supported yet) and Vulkan Use @available checks where it's required (otherwise compiler would fail compilation) Simulator checks
2020-07-15 18:59:57 +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;
iOS: Vulkan support Implemented Vulkan Support. Use DisplayServer for rendering and input handling Use single view for rendering in both GLES2 (not supported yet) and Vulkan Use @available checks where it's required (otherwise compiler would fail compilation) Simulator checks
2020-07-15 18:59:57 +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;
virtual float screen_get_max_scale() const override;
virtual void screen_set_orientation(DisplayServer::ScreenOrientation p_orientation, int p_screen) override;
virtual DisplayServer::ScreenOrientation screen_get_orientation(int p_screen) const override;
virtual bool window_can_draw(WindowID p_window = MAIN_WINDOW_ID) const override;
virtual bool can_any_window_draw() const override;
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
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;
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;
iOS: Vulkan support Implemented Vulkan Support. Use DisplayServer for rendering and input handling Use single view for rendering in both GLES2 (not supported yet) and Vulkan Use @available checks where it's required (otherwise compiler would fail compilation) Simulator checks
2020-07-15 18:59:57 +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, VirtualKeyboardType p_type, int p_max_length, int p_cursor_start, int p_cursor_end) override;
iOS: Vulkan support Implemented Vulkan Support. Use DisplayServer for rendering and input handling Use single view for rendering in both GLES2 (not supported yet) and Vulkan Use @available checks where it's required (otherwise compiler would fail compilation) Simulator checks
2020-07-15 18:59:57 +00:00
virtual void virtual_keyboard_hide() override;
void virtual_keyboard_set_height(int height);
virtual int virtual_keyboard_get_height() const override;
virtual void clipboard_set(const String &p_text) override;
virtual String clipboard_get() const override;
virtual void screen_set_keep_on(bool p_enable) override;
virtual bool screen_is_kept_on() const override;
void resize_window(CGSize size);
[iOS] Restore OpenGLES3 renderer support.
2023-01-20 22:20:30 +00:00
virtual void swap_buffers() override {}
iOS: Vulkan support Implemented Vulkan Support. Use DisplayServer for rendering and input handling Use single view for rendering in both GLES2 (not supported yet) and Vulkan Use @available checks where it's required (otherwise compiler would fail compilation) Simulator checks
2020-07-15 18:59:57 +00:00
};
Code quality: Fix header guards consistency Adds `header_guards.sh` bash script, used in CI to validate future changes. Can be run locally to fix invalid header guards.
2022-07-23 21:41:51 +00:00
#endif // DISPLAY_SERVER_IOS_H
Reference in New Issue Copy Permalink