Path: blob/master/platform/macos/display_server_macos.h
10277 views
/**************************************************************************/1/* display_server_macos.h */2/**************************************************************************/3/* This file is part of: */4/* GODOT ENGINE */5/* https://godotengine.org */6/**************************************************************************/7/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */8/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */9/* */10/* Permission is hereby granted, free of charge, to any person obtaining */11/* a copy of this software and associated documentation files (the */12/* "Software"), to deal in the Software without restriction, including */13/* without limitation the rights to use, copy, modify, merge, publish, */14/* distribute, sublicense, and/or sell copies of the Software, and to */15/* permit persons to whom the Software is furnished to do so, subject to */16/* the following conditions: */17/* */18/* The above copyright notice and this permission notice shall be */19/* included in all copies or substantial portions of the Software. */20/* */21/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */22/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */23/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */24/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */25/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */26/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */27/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */28/**************************************************************************/2930#pragma once3132#include "display_server_macos_base.h"3334#if defined(GLES3_ENABLED)35#include "gl_manager_macos_angle.h"36#include "gl_manager_macos_legacy.h"37#endif // GLES3_ENABLED3839#import "native_menu_macos.h"4041#if defined(RD_ENABLED)42#include "servers/rendering/rendering_device.h"4344#if defined(VULKAN_ENABLED)45#import "rendering_context_driver_vulkan_macos.h"46#endif // VULKAN_ENABLED47#if defined(METAL_ENABLED)48#import "drivers/metal/rendering_context_driver_metal.h"49#endif50#endif // RD_ENABLED5152#define FontVariation __FontVariation53#define BitMap _QDBitMap // Suppress deprecated QuickDraw definition.5455#import <AppKit/AppKit.h>56#import <AppKit/NSCursor.h>57#import <ApplicationServices/ApplicationServices.h>58#import <CoreVideo/CoreVideo.h>59#import <Foundation/Foundation.h>60#import <IOKit/pwr_mgt/IOPMLib.h>6162@class GodotWindow;63@class GodotContentView;64@class GodotWindowDelegate;65@class GodotButtonView;66@class GodotEmbeddedView;67@class CALayerHost;6869#undef BitMap70#undef CursorShape71#undef FontVariation7273class EmbeddedProcessMacOS;7475class DisplayServerMacOS : public DisplayServerMacOSBase {76GDSOFTCLASS(DisplayServerMacOS, DisplayServerMacOSBase);7778public:79struct KeyEvent {80WindowID window_id = INVALID_WINDOW_ID;81unsigned int macos_state = false;82bool pressed = false;83bool echo = false;84bool raw = false;85Key keycode = Key::NONE;86Key physical_keycode = Key::NONE;87Key key_label = Key::NONE;88uint32_t unicode = 0;89KeyLocation location = KeyLocation::UNSPECIFIED;90};9192struct WindowData {93GodotWindowDelegate *window_delegate;94GodotWindow *window_object;95GodotContentView *window_view;96GodotButtonView *window_button_view;9798Vector<Vector2> mpath;99100CGDirectDisplayID display_id = -1;101102Point2i mouse_pos;103WindowResizeEdge edge = WINDOW_EDGE_MAX;104105Size2i min_size;106Size2i max_size;107Size2i size;108Vector2i wb_offset = Vector2i(14, 14);109110NSRect last_frame_rect = NSMakeRect(0, 0, 0, 0);111NSRect pre_zoom_rect = NSMakeRect(0, 0, 0, 0);112113bool im_active = false;114Size2i im_position;115116Callable rect_changed_callback;117Callable event_callback;118Callable input_event_callback;119Callable input_text_callback;120Callable drop_files_callback;121122ObjectID instance_id;123bool fs_transition = false;124bool initial_size = true;125126WindowID transient_parent = INVALID_WINDOW_ID;127bool exclusive = false;128HashSet<WindowID> transient_children;129130bool layered_window = false;131bool fullscreen = false;132bool exclusive_fullscreen = false;133bool on_top = false;134bool borderless = false;135bool resize_disabled = false;136bool no_min_btn = false;137bool no_max_btn = false;138bool no_focus = false;139bool is_popup = false;140bool mpass = false;141bool focused = false;142bool is_visible = true;143bool extend_to_title = false;144bool hide_from_capture = false;145146Rect2i parent_safe_rect;147};148149List<WindowID> popup_list;150uint64_t time_since_popup = 0;151152private:153#if defined(GLES3_ENABLED)154GLManagerLegacy_MacOS *gl_manager_legacy = nullptr;155GLManagerANGLE_MacOS *gl_manager_angle = nullptr;156#endif157#if defined(RD_ENABLED)158RenderingContextDriver *rendering_context = nullptr;159RenderingDevice *rendering_device = nullptr;160#endif161String rendering_driver;162163struct WarpEvent {164NSTimeInterval timestamp;165NSPoint delta;166};167List<WarpEvent> warp_events;168NSTimeInterval last_warp = 0;169bool ignore_warp = false;170171Vector<KeyEvent> key_event_buffer;172int key_event_pos = 0;173174id menu_delegate = nullptr;175NativeMenuMacOS *native_menu = nullptr;176177Point2i im_selection;178String im_text;179180CGEventSourceRef event_source;181MouseMode mouse_mode = MOUSE_MODE_VISIBLE;182MouseMode mouse_mode_base = MOUSE_MODE_VISIBLE;183MouseMode mouse_mode_override = MOUSE_MODE_VISIBLE;184bool mouse_mode_override_enabled = false;185void _mouse_update_mode();186187bool drop_events = false;188bool in_dispatch_input_event = false;189190WindowID window_mouseover_id = INVALID_WINDOW_ID;191WindowID last_focused_window = INVALID_WINDOW_ID;192WindowID window_id_counter = MAIN_WINDOW_ID;193float display_max_scale = 1.f;194mutable Point2i origin;195mutable bool displays_arrangement_dirty = true;196bool is_resizing = false;197198CursorShape cursor_shape = CURSOR_ARROW;199NSCursor *cursors[CURSOR_MAX];200HashMap<CursorShape, Vector<Variant>> cursors_cache;201202HashMap<WindowID, WindowData> windows;203204struct IndicatorData {205id delegate;206id item;207};208209IndicatorID indicator_id_counter = 0;210HashMap<IndicatorID, IndicatorData> indicators;211212IOPMAssertionID screen_keep_on_assertion = kIOPMNullAssertionID;213214Callable help_search_callback;215Callable help_action_callback;216217struct MenuCall {218Variant tag;219Callable callback;220};221List<MenuCall> deferred_menu_calls;222223Callable system_theme_changed;224225WindowID _create_window(WindowMode p_mode, VSyncMode p_vsync_mode, const Rect2i &p_rect);226void _update_window_style(WindowData p_wd, WindowID p_window);227228void _update_displays_arrangement() const;229Point2i _get_native_screen_position(int p_screen) const;230static void _displays_arrangement_changed(CGDirectDisplayID display_id, CGDisplayChangeSummaryFlags flags, void *user_info);231232static void _dispatch_input_events(const Ref<InputEvent> &p_event);233void _dispatch_input_event(const Ref<InputEvent> &p_event);234void _push_input(const Ref<InputEvent> &p_event);235void _process_key_events();236237static NSCursor *_cursor_from_selector(SEL p_selector, SEL p_fallback = nil);238239Error _file_dialog_with_options_show(const String &p_title, const String &p_current_directory, const String &p_root, const String &p_filename, bool p_show_hidden, FileDialogMode p_mode, const Vector<String> &p_filters, const TypedArray<Dictionary> &p_options, const Callable &p_callback, bool p_options_in_cb, WindowID p_window_id);240241struct EmbeddedProcessData {242EmbeddedProcessMacOS *process;243WindowData *wd = nullptr;244CALayer *layer_host = nil;245};246HashMap<OS::ProcessID, EmbeddedProcessData> embedded_processes;247void _window_update_display_id(WindowData *p_wd);248249public:250void menu_callback(id p_sender);251252void emit_system_theme_changed();253254bool has_window(WindowID p_window) const;255WindowData &get_window(WindowID p_window);256257NSImage *_convert_to_nsimg(Ref<Image> &p_image) const;258Point2i _get_screens_origin() const;259260void set_menu_delegate(NSMenu *p_menu);261262void send_event(NSEvent *p_event);263void send_window_event(const WindowData &p_wd, WindowEvent p_event);264void release_pressed_events();265void sync_mouse_state();266void get_key_modifier_state(unsigned int p_macos_state, Ref<InputEventWithModifiers> r_state) const;267void update_mouse_pos(WindowData &p_wd, NSPoint p_location_in_window);268void push_to_key_event_buffer(const KeyEvent &p_event);269void pop_last_key_event();270void update_im_text(const Point2i &p_selection, const String &p_text);271void set_last_focused_window(WindowID p_window);272bool mouse_process_popups(bool p_close = false);273void popup_open(WindowID p_window);274void popup_close(WindowID p_window);275void set_is_resizing(bool p_is_resizing);276bool get_is_resizing() const;277void reparent_check(WindowID p_window);278WindowID _get_focused_window_or_popup() const;279void mouse_enter_window(WindowID p_window);280void mouse_exit_window(WindowID p_window);281void update_presentation_mode();282283bool is_always_on_top_recursive(WindowID p_window) const;284285/**286* Get the display ID of a window.287*/288uint32_t window_get_display_id(WindowID p_window) const;289void window_destroy(WindowID p_window);290void window_resize(WindowID p_window, int p_width, int p_height);291void window_set_custom_window_buttons(WindowData &p_wd, bool p_enabled);292void set_window_per_pixel_transparency_enabled(bool p_enabled, WindowID p_window);293294virtual bool has_feature(Feature p_feature) const override;295virtual String get_name() const override;296297virtual void help_set_search_callbacks(const Callable &p_search_callback = Callable(), const Callable &p_action_callback = Callable()) override;298Callable _help_get_search_callback() const;299Callable _help_get_action_callback() const;300301virtual bool is_dark_mode_supported() const override;302virtual bool is_dark_mode() const override;303virtual Color get_accent_color() const override;304virtual Color get_base_color() const override;305virtual void set_system_theme_change_callback(const Callable &p_callable) override;306307virtual Error dialog_show(String p_title, String p_description, Vector<String> p_buttons, const Callable &p_callback) override;308virtual Error dialog_input_text(String p_title, String p_description, String p_partial, const Callable &p_callback) override;309310virtual Error file_dialog_show(const String &p_title, const String &p_current_directory, const String &p_filename, bool p_show_hidden, FileDialogMode p_mode, const Vector<String> &p_filters, const Callable &p_callback, WindowID p_window_id) override;311virtual Error file_dialog_with_options_show(const String &p_title, const String &p_current_directory, const String &p_root, const String &p_filename, bool p_show_hidden, FileDialogMode p_mode, const Vector<String> &p_filters, const TypedArray<Dictionary> &p_options, const Callable &p_callback, WindowID p_window_id) override;312313virtual void beep() const override;314315virtual void mouse_set_mode(MouseMode p_mode) override;316virtual MouseMode mouse_get_mode() const override;317virtual void mouse_set_mode_override(MouseMode p_mode) override;318virtual MouseMode mouse_get_mode_override() const override;319virtual void mouse_set_mode_override_enabled(bool p_override_enabled) override;320virtual bool mouse_is_mode_override_enabled() const override;321322bool update_mouse_wrap(WindowData &p_wd, NSPoint &r_delta, NSPoint &r_mpos, NSTimeInterval p_timestamp);323virtual void warp_mouse(const Point2i &p_position) override;324virtual Point2i mouse_get_position() const override;325virtual BitField<MouseButtonMask> mouse_get_button_state() const override;326327virtual int get_screen_count() const override;328virtual int get_primary_screen() const override;329virtual int get_keyboard_focus_screen() const override;330virtual Point2i screen_get_position(int p_screen = SCREEN_OF_MAIN_WINDOW) const override;331virtual Size2i screen_get_size(int p_screen = SCREEN_OF_MAIN_WINDOW) const override;332virtual int screen_get_dpi(int p_screen = SCREEN_OF_MAIN_WINDOW) const override;333virtual float screen_get_scale(int p_screen = SCREEN_OF_MAIN_WINDOW) const override;334virtual float screen_get_max_scale() const override;335virtual Rect2i screen_get_usable_rect(int p_screen = SCREEN_OF_MAIN_WINDOW) const override;336virtual float screen_get_refresh_rate(int p_screen = SCREEN_OF_MAIN_WINDOW) const override;337virtual Color screen_get_pixel(const Point2i &p_position) const override;338virtual Ref<Image> screen_get_image(int p_screen = SCREEN_OF_MAIN_WINDOW) const override;339virtual Ref<Image> screen_get_image_rect(const Rect2i &p_rect) const override;340virtual void screen_set_keep_on(bool p_enable) override;341virtual bool screen_is_kept_on() const override;342343virtual Vector<int> get_window_list() const override;344345virtual WindowID create_sub_window(WindowMode p_mode, VSyncMode p_vsync_mode, uint32_t p_flags, const Rect2i &p_rect = Rect2i(), bool p_exclusive = false, WindowID p_transient_parent = INVALID_WINDOW_ID) override;346virtual void show_window(WindowID p_id) override;347virtual void delete_sub_window(WindowID p_id) override;348349virtual WindowID window_get_active_popup() const override;350virtual void window_set_popup_safe_rect(WindowID p_window, const Rect2i &p_rect) override;351virtual Rect2i window_get_popup_safe_rect(WindowID p_window) const override;352353virtual void window_set_rect_changed_callback(const Callable &p_callable, WindowID p_window = MAIN_WINDOW_ID) override;354virtual void window_set_window_event_callback(const Callable &p_callable, WindowID p_window = MAIN_WINDOW_ID) override;355virtual void window_set_input_event_callback(const Callable &p_callable, WindowID p_window = MAIN_WINDOW_ID) override;356virtual void window_set_input_text_callback(const Callable &p_callable, WindowID p_window = MAIN_WINDOW_ID) override;357virtual void window_set_drop_files_callback(const Callable &p_callable, WindowID p_window = MAIN_WINDOW_ID) override;358359virtual void window_set_title(const String &p_title, WindowID p_window = MAIN_WINDOW_ID) override;360virtual Size2i window_get_title_size(const String &p_title, WindowID p_window) const override;361virtual void window_set_mouse_passthrough(const Vector<Vector2> &p_region, WindowID p_window = MAIN_WINDOW_ID) override;362363virtual int window_get_current_screen(WindowID p_window = MAIN_WINDOW_ID) const override;364virtual void window_set_current_screen(int p_screen, WindowID p_window = MAIN_WINDOW_ID) override;365366virtual Point2i window_get_position(WindowID p_window = MAIN_WINDOW_ID) const override;367virtual Point2i window_get_position_with_decorations(WindowID p_window = MAIN_WINDOW_ID) const override;368virtual void window_set_position(const Point2i &p_position, WindowID p_window = MAIN_WINDOW_ID) override;369370virtual void window_set_transient(WindowID p_window, WindowID p_parent) override;371virtual void window_set_exclusive(WindowID p_window, bool p_exclusive) override;372373virtual void window_set_max_size(const Size2i p_size, WindowID p_window = MAIN_WINDOW_ID) override;374virtual Size2i window_get_max_size(WindowID p_window = MAIN_WINDOW_ID) const override;375376virtual void window_set_min_size(const Size2i p_size, WindowID p_window = MAIN_WINDOW_ID) override;377virtual Size2i window_get_min_size(WindowID p_window = MAIN_WINDOW_ID) const override;378379virtual void window_set_size(const Size2i p_size, WindowID p_window = MAIN_WINDOW_ID) override;380virtual Size2i window_get_size(WindowID p_window = MAIN_WINDOW_ID) const override;381virtual Size2i window_get_size_with_decorations(WindowID p_window = MAIN_WINDOW_ID) const override;382383virtual void window_set_mode(WindowMode p_mode, WindowID p_window = MAIN_WINDOW_ID) override;384virtual WindowMode window_get_mode(WindowID p_window = MAIN_WINDOW_ID) const override;385386virtual bool window_is_maximize_allowed(WindowID p_window = MAIN_WINDOW_ID) const override;387388virtual void window_set_flag(WindowFlags p_flag, bool p_enabled, WindowID p_window = MAIN_WINDOW_ID) override;389virtual bool window_get_flag(WindowFlags p_flag, WindowID p_window = MAIN_WINDOW_ID) const override;390391virtual void window_request_attention(WindowID p_window = MAIN_WINDOW_ID) override;392virtual void window_move_to_foreground(WindowID p_window = MAIN_WINDOW_ID) override;393virtual bool window_is_focused(WindowID p_window = MAIN_WINDOW_ID) const override;394395virtual WindowID get_focused_window() const override;396397virtual bool window_can_draw(WindowID p_window = MAIN_WINDOW_ID) const override;398399virtual bool can_any_window_draw() const override;400401virtual void window_set_ime_active(const bool p_active, WindowID p_window = MAIN_WINDOW_ID) override;402virtual void window_set_ime_position(const Point2i &p_pos, WindowID p_window = MAIN_WINDOW_ID) override;403404virtual WindowID get_window_at_screen_position(const Point2i &p_position) const override;405406virtual int64_t window_get_native_handle(HandleType p_handle_type, WindowID p_window = MAIN_WINDOW_ID) const override;407408virtual void window_attach_instance_id(ObjectID p_instance, WindowID p_window = MAIN_WINDOW_ID) override;409virtual ObjectID window_get_attached_instance_id(WindowID p_window = MAIN_WINDOW_ID) const override;410virtual void gl_window_make_current(DisplayServer::WindowID p_window_id) override;411412virtual void window_set_vsync_mode(DisplayServer::VSyncMode p_vsync_mode, WindowID p_window = MAIN_WINDOW_ID) override;413virtual DisplayServer::VSyncMode window_get_vsync_mode(WindowID p_vsync_mode) const override;414415virtual bool window_maximize_on_title_dbl_click() const override;416virtual bool window_minimize_on_title_dbl_click() const override;417418virtual void window_start_drag(WindowID p_window = MAIN_WINDOW_ID) override;419virtual void window_start_resize(WindowResizeEdge p_edge, WindowID p_window = MAIN_WINDOW_ID) override;420421virtual void window_set_window_buttons_offset(const Vector2i &p_offset, WindowID p_window = MAIN_WINDOW_ID) override;422virtual Vector3i window_get_safe_title_margins(WindowID p_window = MAIN_WINDOW_ID) const override;423424virtual int accessibility_should_increase_contrast() const override;425virtual int accessibility_should_reduce_animation() const override;426virtual int accessibility_should_reduce_transparency() const override;427virtual int accessibility_screen_reader_active() const override;428429virtual Point2i ime_get_selection() const override;430virtual String ime_get_text() const override;431432void cursor_update_shape();433virtual void cursor_set_shape(CursorShape p_shape) override;434virtual CursorShape cursor_get_shape() const override;435virtual void cursor_set_custom_image(const Ref<Resource> &p_cursor, CursorShape p_shape = CURSOR_ARROW, const Vector2 &p_hotspot = Vector2()) override;436437virtual bool get_swap_cancel_ok() override;438439virtual void enable_for_stealing_focus(OS::ProcessID pid) override;440#ifdef TOOLS_ENABLED441Error embed_process_update(WindowID p_window, EmbeddedProcessMacOS *p_process);442#endif443virtual Error request_close_embedded_process(OS::ProcessID p_pid) override;444virtual Error remove_embedded_process(OS::ProcessID p_pid) override;445446void _process_events(bool p_pump);447virtual void process_events() override;448virtual void force_process_and_drop_events() override;449450virtual void release_rendering_thread() override;451virtual void swap_buffers() override;452453virtual void set_native_icon(const String &p_filename) override;454virtual void set_icon(const Ref<Image> &p_icon) override;455456virtual IndicatorID create_status_indicator(const Ref<Texture2D> &p_icon, const String &p_tooltip, const Callable &p_callback) override;457virtual void status_indicator_set_icon(IndicatorID p_id, const Ref<Texture2D> &p_icon) override;458virtual void status_indicator_set_tooltip(IndicatorID p_id, const String &p_tooltip) override;459virtual void status_indicator_set_menu(IndicatorID p_id, const RID &p_menu_rid) override;460virtual void status_indicator_set_callback(IndicatorID p_id, const Callable &p_callback) override;461virtual Rect2 status_indicator_get_rect(IndicatorID p_id) const override;462virtual void delete_status_indicator(IndicatorID p_id) override;463464virtual bool is_window_transparency_available() const override;465466static DisplayServer *create_func(const String &p_rendering_driver, WindowMode p_mode, VSyncMode p_vsync_mode, uint32_t p_flags, const Vector2i *p_position, const Vector2i &p_resolution, int p_screen, Context p_context, int64_t p_parent_window, Error &r_error);467static Vector<String> get_rendering_drivers_func();468469static void register_macos_driver();470471DisplayServerMacOS(const String &p_rendering_driver, WindowMode p_mode, VSyncMode p_vsync_mode, uint32_t p_flags, const Vector2i *p_position, const Vector2i &p_resolution, int p_screen, Context p_context, int64_t p_parent_window, Error &r_error);472~DisplayServerMacOS();473};474475476