Book a Demo!
CoCalc Logo Icon
StoreFeaturesDocsShareSupportNewsAboutPoliciesSign UpSign In
godotengine
GitHub Repository: godotengine/godot
Path: blob/master/platform/macos/display_server_macos.h
10277 views
1
/**************************************************************************/
2
/* display_server_macos.h */
3
/**************************************************************************/
4
/* This file is part of: */
5
/* GODOT ENGINE */
6
/* https://godotengine.org */
7
/**************************************************************************/
8
/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
9
/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
10
/* */
11
/* Permission is hereby granted, free of charge, to any person obtaining */
12
/* a copy of this software and associated documentation files (the */
13
/* "Software"), to deal in the Software without restriction, including */
14
/* without limitation the rights to use, copy, modify, merge, publish, */
15
/* distribute, sublicense, and/or sell copies of the Software, and to */
16
/* permit persons to whom the Software is furnished to do so, subject to */
17
/* the following conditions: */
18
/* */
19
/* The above copyright notice and this permission notice shall be */
20
/* included in all copies or substantial portions of the Software. */
21
/* */
22
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
23
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
24
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
25
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
26
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
27
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
28
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
29
/**************************************************************************/
30
31
#pragma once
32
33
#include "display_server_macos_base.h"
34
35
#if defined(GLES3_ENABLED)
36
#include "gl_manager_macos_angle.h"
37
#include "gl_manager_macos_legacy.h"
38
#endif // GLES3_ENABLED
39
40
#import "native_menu_macos.h"
41
42
#if defined(RD_ENABLED)
43
#include "servers/rendering/rendering_device.h"
44
45
#if defined(VULKAN_ENABLED)
46
#import "rendering_context_driver_vulkan_macos.h"
47
#endif // VULKAN_ENABLED
48
#if defined(METAL_ENABLED)
49
#import "drivers/metal/rendering_context_driver_metal.h"
50
#endif
51
#endif // RD_ENABLED
52
53
#define FontVariation __FontVariation
54
#define BitMap _QDBitMap // Suppress deprecated QuickDraw definition.
55
56
#import <AppKit/AppKit.h>
57
#import <AppKit/NSCursor.h>
58
#import <ApplicationServices/ApplicationServices.h>
59
#import <CoreVideo/CoreVideo.h>
60
#import <Foundation/Foundation.h>
61
#import <IOKit/pwr_mgt/IOPMLib.h>
62
63
@class GodotWindow;
64
@class GodotContentView;
65
@class GodotWindowDelegate;
66
@class GodotButtonView;
67
@class GodotEmbeddedView;
68
@class CALayerHost;
69
70
#undef BitMap
71
#undef CursorShape
72
#undef FontVariation
73
74
class EmbeddedProcessMacOS;
75
76
class DisplayServerMacOS : public DisplayServerMacOSBase {
77
GDSOFTCLASS(DisplayServerMacOS, DisplayServerMacOSBase);
78
79
public:
80
struct KeyEvent {
81
WindowID window_id = INVALID_WINDOW_ID;
82
unsigned int macos_state = false;
83
bool pressed = false;
84
bool echo = false;
85
bool raw = false;
86
Key keycode = Key::NONE;
87
Key physical_keycode = Key::NONE;
88
Key key_label = Key::NONE;
89
uint32_t unicode = 0;
90
KeyLocation location = KeyLocation::UNSPECIFIED;
91
};
92
93
struct WindowData {
94
GodotWindowDelegate *window_delegate;
95
GodotWindow *window_object;
96
GodotContentView *window_view;
97
GodotButtonView *window_button_view;
98
99
Vector<Vector2> mpath;
100
101
CGDirectDisplayID display_id = -1;
102
103
Point2i mouse_pos;
104
WindowResizeEdge edge = WINDOW_EDGE_MAX;
105
106
Size2i min_size;
107
Size2i max_size;
108
Size2i size;
109
Vector2i wb_offset = Vector2i(14, 14);
110
111
NSRect last_frame_rect = NSMakeRect(0, 0, 0, 0);
112
NSRect pre_zoom_rect = NSMakeRect(0, 0, 0, 0);
113
114
bool im_active = false;
115
Size2i im_position;
116
117
Callable rect_changed_callback;
118
Callable event_callback;
119
Callable input_event_callback;
120
Callable input_text_callback;
121
Callable drop_files_callback;
122
123
ObjectID instance_id;
124
bool fs_transition = false;
125
bool initial_size = true;
126
127
WindowID transient_parent = INVALID_WINDOW_ID;
128
bool exclusive = false;
129
HashSet<WindowID> transient_children;
130
131
bool layered_window = false;
132
bool fullscreen = false;
133
bool exclusive_fullscreen = false;
134
bool on_top = false;
135
bool borderless = false;
136
bool resize_disabled = false;
137
bool no_min_btn = false;
138
bool no_max_btn = false;
139
bool no_focus = false;
140
bool is_popup = false;
141
bool mpass = false;
142
bool focused = false;
143
bool is_visible = true;
144
bool extend_to_title = false;
145
bool hide_from_capture = false;
146
147
Rect2i parent_safe_rect;
148
};
149
150
List<WindowID> popup_list;
151
uint64_t time_since_popup = 0;
152
153
private:
154
#if defined(GLES3_ENABLED)
155
GLManagerLegacy_MacOS *gl_manager_legacy = nullptr;
156
GLManagerANGLE_MacOS *gl_manager_angle = nullptr;
157
#endif
158
#if defined(RD_ENABLED)
159
RenderingContextDriver *rendering_context = nullptr;
160
RenderingDevice *rendering_device = nullptr;
161
#endif
162
String rendering_driver;
163
164
struct WarpEvent {
165
NSTimeInterval timestamp;
166
NSPoint delta;
167
};
168
List<WarpEvent> warp_events;
169
NSTimeInterval last_warp = 0;
170
bool ignore_warp = false;
171
172
Vector<KeyEvent> key_event_buffer;
173
int key_event_pos = 0;
174
175
id menu_delegate = nullptr;
176
NativeMenuMacOS *native_menu = nullptr;
177
178
Point2i im_selection;
179
String im_text;
180
181
CGEventSourceRef event_source;
182
MouseMode mouse_mode = MOUSE_MODE_VISIBLE;
183
MouseMode mouse_mode_base = MOUSE_MODE_VISIBLE;
184
MouseMode mouse_mode_override = MOUSE_MODE_VISIBLE;
185
bool mouse_mode_override_enabled = false;
186
void _mouse_update_mode();
187
188
bool drop_events = false;
189
bool in_dispatch_input_event = false;
190
191
WindowID window_mouseover_id = INVALID_WINDOW_ID;
192
WindowID last_focused_window = INVALID_WINDOW_ID;
193
WindowID window_id_counter = MAIN_WINDOW_ID;
194
float display_max_scale = 1.f;
195
mutable Point2i origin;
196
mutable bool displays_arrangement_dirty = true;
197
bool is_resizing = false;
198
199
CursorShape cursor_shape = CURSOR_ARROW;
200
NSCursor *cursors[CURSOR_MAX];
201
HashMap<CursorShape, Vector<Variant>> cursors_cache;
202
203
HashMap<WindowID, WindowData> windows;
204
205
struct IndicatorData {
206
id delegate;
207
id item;
208
};
209
210
IndicatorID indicator_id_counter = 0;
211
HashMap<IndicatorID, IndicatorData> indicators;
212
213
IOPMAssertionID screen_keep_on_assertion = kIOPMNullAssertionID;
214
215
Callable help_search_callback;
216
Callable help_action_callback;
217
218
struct MenuCall {
219
Variant tag;
220
Callable callback;
221
};
222
List<MenuCall> deferred_menu_calls;
223
224
Callable system_theme_changed;
225
226
WindowID _create_window(WindowMode p_mode, VSyncMode p_vsync_mode, const Rect2i &p_rect);
227
void _update_window_style(WindowData p_wd, WindowID p_window);
228
229
void _update_displays_arrangement() const;
230
Point2i _get_native_screen_position(int p_screen) const;
231
static void _displays_arrangement_changed(CGDirectDisplayID display_id, CGDisplayChangeSummaryFlags flags, void *user_info);
232
233
static void _dispatch_input_events(const Ref<InputEvent> &p_event);
234
void _dispatch_input_event(const Ref<InputEvent> &p_event);
235
void _push_input(const Ref<InputEvent> &p_event);
236
void _process_key_events();
237
238
static NSCursor *_cursor_from_selector(SEL p_selector, SEL p_fallback = nil);
239
240
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, bool p_options_in_cb, WindowID p_window_id);
241
242
struct EmbeddedProcessData {
243
EmbeddedProcessMacOS *process;
244
WindowData *wd = nullptr;
245
CALayer *layer_host = nil;
246
};
247
HashMap<OS::ProcessID, EmbeddedProcessData> embedded_processes;
248
void _window_update_display_id(WindowData *p_wd);
249
250
public:
251
void menu_callback(id p_sender);
252
253
void emit_system_theme_changed();
254
255
bool has_window(WindowID p_window) const;
256
WindowData &get_window(WindowID p_window);
257
258
NSImage *_convert_to_nsimg(Ref<Image> &p_image) const;
259
Point2i _get_screens_origin() const;
260
261
void set_menu_delegate(NSMenu *p_menu);
262
263
void send_event(NSEvent *p_event);
264
void send_window_event(const WindowData &p_wd, WindowEvent p_event);
265
void release_pressed_events();
266
void sync_mouse_state();
267
void get_key_modifier_state(unsigned int p_macos_state, Ref<InputEventWithModifiers> r_state) const;
268
void update_mouse_pos(WindowData &p_wd, NSPoint p_location_in_window);
269
void push_to_key_event_buffer(const KeyEvent &p_event);
270
void pop_last_key_event();
271
void update_im_text(const Point2i &p_selection, const String &p_text);
272
void set_last_focused_window(WindowID p_window);
273
bool mouse_process_popups(bool p_close = false);
274
void popup_open(WindowID p_window);
275
void popup_close(WindowID p_window);
276
void set_is_resizing(bool p_is_resizing);
277
bool get_is_resizing() const;
278
void reparent_check(WindowID p_window);
279
WindowID _get_focused_window_or_popup() const;
280
void mouse_enter_window(WindowID p_window);
281
void mouse_exit_window(WindowID p_window);
282
void update_presentation_mode();
283
284
bool is_always_on_top_recursive(WindowID p_window) const;
285
286
/**
287
* Get the display ID of a window.
288
*/
289
uint32_t window_get_display_id(WindowID p_window) const;
290
void window_destroy(WindowID p_window);
291
void window_resize(WindowID p_window, int p_width, int p_height);
292
void window_set_custom_window_buttons(WindowData &p_wd, bool p_enabled);
293
void set_window_per_pixel_transparency_enabled(bool p_enabled, WindowID p_window);
294
295
virtual bool has_feature(Feature p_feature) const override;
296
virtual String get_name() const override;
297
298
virtual void help_set_search_callbacks(const Callable &p_search_callback = Callable(), const Callable &p_action_callback = Callable()) override;
299
Callable _help_get_search_callback() const;
300
Callable _help_get_action_callback() const;
301
302
virtual bool is_dark_mode_supported() const override;
303
virtual bool is_dark_mode() const override;
304
virtual Color get_accent_color() const override;
305
virtual Color get_base_color() const override;
306
virtual void set_system_theme_change_callback(const Callable &p_callable) override;
307
308
virtual Error dialog_show(String p_title, String p_description, Vector<String> p_buttons, const Callable &p_callback) override;
309
virtual Error dialog_input_text(String p_title, String p_description, String p_partial, const Callable &p_callback) override;
310
311
virtual 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;
312
virtual 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;
313
314
virtual void beep() const override;
315
316
virtual void mouse_set_mode(MouseMode p_mode) override;
317
virtual MouseMode mouse_get_mode() const override;
318
virtual void mouse_set_mode_override(MouseMode p_mode) override;
319
virtual MouseMode mouse_get_mode_override() const override;
320
virtual void mouse_set_mode_override_enabled(bool p_override_enabled) override;
321
virtual bool mouse_is_mode_override_enabled() const override;
322
323
bool update_mouse_wrap(WindowData &p_wd, NSPoint &r_delta, NSPoint &r_mpos, NSTimeInterval p_timestamp);
324
virtual void warp_mouse(const Point2i &p_position) override;
325
virtual Point2i mouse_get_position() const override;
326
virtual BitField<MouseButtonMask> mouse_get_button_state() const override;
327
328
virtual int get_screen_count() const override;
329
virtual int get_primary_screen() const override;
330
virtual int get_keyboard_focus_screen() const override;
331
virtual Point2i screen_get_position(int p_screen = SCREEN_OF_MAIN_WINDOW) const override;
332
virtual Size2i screen_get_size(int p_screen = SCREEN_OF_MAIN_WINDOW) const override;
333
virtual int screen_get_dpi(int p_screen = SCREEN_OF_MAIN_WINDOW) const override;
334
virtual float screen_get_scale(int p_screen = SCREEN_OF_MAIN_WINDOW) const override;
335
virtual float screen_get_max_scale() const override;
336
virtual Rect2i screen_get_usable_rect(int p_screen = SCREEN_OF_MAIN_WINDOW) const override;
337
virtual float screen_get_refresh_rate(int p_screen = SCREEN_OF_MAIN_WINDOW) const override;
338
virtual Color screen_get_pixel(const Point2i &p_position) const override;
339
virtual Ref<Image> screen_get_image(int p_screen = SCREEN_OF_MAIN_WINDOW) const override;
340
virtual Ref<Image> screen_get_image_rect(const Rect2i &p_rect) const override;
341
virtual void screen_set_keep_on(bool p_enable) override;
342
virtual bool screen_is_kept_on() const override;
343
344
virtual Vector<int> get_window_list() const override;
345
346
virtual 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;
347
virtual void show_window(WindowID p_id) override;
348
virtual void delete_sub_window(WindowID p_id) override;
349
350
virtual WindowID window_get_active_popup() const override;
351
virtual void window_set_popup_safe_rect(WindowID p_window, const Rect2i &p_rect) override;
352
virtual Rect2i window_get_popup_safe_rect(WindowID p_window) const override;
353
354
virtual void window_set_rect_changed_callback(const Callable &p_callable, WindowID p_window = MAIN_WINDOW_ID) override;
355
virtual void window_set_window_event_callback(const Callable &p_callable, WindowID p_window = MAIN_WINDOW_ID) override;
356
virtual void window_set_input_event_callback(const Callable &p_callable, WindowID p_window = MAIN_WINDOW_ID) override;
357
virtual void window_set_input_text_callback(const Callable &p_callable, WindowID p_window = MAIN_WINDOW_ID) override;
358
virtual void window_set_drop_files_callback(const Callable &p_callable, WindowID p_window = MAIN_WINDOW_ID) override;
359
360
virtual void window_set_title(const String &p_title, WindowID p_window = MAIN_WINDOW_ID) override;
361
virtual Size2i window_get_title_size(const String &p_title, WindowID p_window) const override;
362
virtual void window_set_mouse_passthrough(const Vector<Vector2> &p_region, WindowID p_window = MAIN_WINDOW_ID) override;
363
364
virtual int window_get_current_screen(WindowID p_window = MAIN_WINDOW_ID) const override;
365
virtual void window_set_current_screen(int p_screen, WindowID p_window = MAIN_WINDOW_ID) override;
366
367
virtual Point2i window_get_position(WindowID p_window = MAIN_WINDOW_ID) const override;
368
virtual Point2i window_get_position_with_decorations(WindowID p_window = MAIN_WINDOW_ID) const override;
369
virtual void window_set_position(const Point2i &p_position, WindowID p_window = MAIN_WINDOW_ID) override;
370
371
virtual void window_set_transient(WindowID p_window, WindowID p_parent) override;
372
virtual void window_set_exclusive(WindowID p_window, bool p_exclusive) override;
373
374
virtual void window_set_max_size(const Size2i p_size, WindowID p_window = MAIN_WINDOW_ID) override;
375
virtual Size2i window_get_max_size(WindowID p_window = MAIN_WINDOW_ID) const override;
376
377
virtual void window_set_min_size(const Size2i p_size, WindowID p_window = MAIN_WINDOW_ID) override;
378
virtual Size2i window_get_min_size(WindowID p_window = MAIN_WINDOW_ID) const override;
379
380
virtual void window_set_size(const Size2i p_size, WindowID p_window = MAIN_WINDOW_ID) override;
381
virtual Size2i window_get_size(WindowID p_window = MAIN_WINDOW_ID) const override;
382
virtual Size2i window_get_size_with_decorations(WindowID p_window = MAIN_WINDOW_ID) const override;
383
384
virtual void window_set_mode(WindowMode p_mode, WindowID p_window = MAIN_WINDOW_ID) override;
385
virtual WindowMode window_get_mode(WindowID p_window = MAIN_WINDOW_ID) const override;
386
387
virtual bool window_is_maximize_allowed(WindowID p_window = MAIN_WINDOW_ID) const override;
388
389
virtual void window_set_flag(WindowFlags p_flag, bool p_enabled, WindowID p_window = MAIN_WINDOW_ID) override;
390
virtual bool window_get_flag(WindowFlags p_flag, WindowID p_window = MAIN_WINDOW_ID) const override;
391
392
virtual void window_request_attention(WindowID p_window = MAIN_WINDOW_ID) override;
393
virtual void window_move_to_foreground(WindowID p_window = MAIN_WINDOW_ID) override;
394
virtual bool window_is_focused(WindowID p_window = MAIN_WINDOW_ID) const override;
395
396
virtual WindowID get_focused_window() const override;
397
398
virtual bool window_can_draw(WindowID p_window = MAIN_WINDOW_ID) const override;
399
400
virtual bool can_any_window_draw() const override;
401
402
virtual void window_set_ime_active(const bool p_active, WindowID p_window = MAIN_WINDOW_ID) override;
403
virtual void window_set_ime_position(const Point2i &p_pos, WindowID p_window = MAIN_WINDOW_ID) override;
404
405
virtual WindowID get_window_at_screen_position(const Point2i &p_position) const override;
406
407
virtual int64_t window_get_native_handle(HandleType p_handle_type, WindowID p_window = MAIN_WINDOW_ID) const override;
408
409
virtual void window_attach_instance_id(ObjectID p_instance, WindowID p_window = MAIN_WINDOW_ID) override;
410
virtual ObjectID window_get_attached_instance_id(WindowID p_window = MAIN_WINDOW_ID) const override;
411
virtual void gl_window_make_current(DisplayServer::WindowID p_window_id) override;
412
413
virtual void window_set_vsync_mode(DisplayServer::VSyncMode p_vsync_mode, WindowID p_window = MAIN_WINDOW_ID) override;
414
virtual DisplayServer::VSyncMode window_get_vsync_mode(WindowID p_vsync_mode) const override;
415
416
virtual bool window_maximize_on_title_dbl_click() const override;
417
virtual bool window_minimize_on_title_dbl_click() const override;
418
419
virtual void window_start_drag(WindowID p_window = MAIN_WINDOW_ID) override;
420
virtual void window_start_resize(WindowResizeEdge p_edge, WindowID p_window = MAIN_WINDOW_ID) override;
421
422
virtual void window_set_window_buttons_offset(const Vector2i &p_offset, WindowID p_window = MAIN_WINDOW_ID) override;
423
virtual Vector3i window_get_safe_title_margins(WindowID p_window = MAIN_WINDOW_ID) const override;
424
425
virtual int accessibility_should_increase_contrast() const override;
426
virtual int accessibility_should_reduce_animation() const override;
427
virtual int accessibility_should_reduce_transparency() const override;
428
virtual int accessibility_screen_reader_active() const override;
429
430
virtual Point2i ime_get_selection() const override;
431
virtual String ime_get_text() const override;
432
433
void cursor_update_shape();
434
virtual void cursor_set_shape(CursorShape p_shape) override;
435
virtual CursorShape cursor_get_shape() const override;
436
virtual void cursor_set_custom_image(const Ref<Resource> &p_cursor, CursorShape p_shape = CURSOR_ARROW, const Vector2 &p_hotspot = Vector2()) override;
437
438
virtual bool get_swap_cancel_ok() override;
439
440
virtual void enable_for_stealing_focus(OS::ProcessID pid) override;
441
#ifdef TOOLS_ENABLED
442
Error embed_process_update(WindowID p_window, EmbeddedProcessMacOS *p_process);
443
#endif
444
virtual Error request_close_embedded_process(OS::ProcessID p_pid) override;
445
virtual Error remove_embedded_process(OS::ProcessID p_pid) override;
446
447
void _process_events(bool p_pump);
448
virtual void process_events() override;
449
virtual void force_process_and_drop_events() override;
450
451
virtual void release_rendering_thread() override;
452
virtual void swap_buffers() override;
453
454
virtual void set_native_icon(const String &p_filename) override;
455
virtual void set_icon(const Ref<Image> &p_icon) override;
456
457
virtual IndicatorID create_status_indicator(const Ref<Texture2D> &p_icon, const String &p_tooltip, const Callable &p_callback) override;
458
virtual void status_indicator_set_icon(IndicatorID p_id, const Ref<Texture2D> &p_icon) override;
459
virtual void status_indicator_set_tooltip(IndicatorID p_id, const String &p_tooltip) override;
460
virtual void status_indicator_set_menu(IndicatorID p_id, const RID &p_menu_rid) override;
461
virtual void status_indicator_set_callback(IndicatorID p_id, const Callable &p_callback) override;
462
virtual Rect2 status_indicator_get_rect(IndicatorID p_id) const override;
463
virtual void delete_status_indicator(IndicatorID p_id) override;
464
465
virtual bool is_window_transparency_available() const override;
466
467
static 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);
468
static Vector<String> get_rendering_drivers_func();
469
470
static void register_macos_driver();
471
472
DisplayServerMacOS(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);
473
~DisplayServerMacOS();
474
};
475
476