CoCalc -- display_server

GitHub Repository: godotengine/godot
Path: blob/master/platform/macos/display_server_macos.h
²¹⁰⁸⁵ 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
#ifdef TOOLS_ENABLED
68
@class GodotEmbeddedView;
69
@class CALayerHost;
70
#endif
71

72
#undef BitMap
73
#undef CursorShape
74
#undef FontVariation
75

76
#ifdef TOOLS_ENABLED
77
class EmbeddedProcessMacOS;
78
#endif
79

80
class DisplayServerMacOS : public DisplayServerMacOSBase {
81
	GDSOFTCLASS(DisplayServerMacOS, DisplayServerMacOSBase);
82

83
public:
84
	struct KeyEvent {
85
		WindowID window_id = INVALID_WINDOW_ID;
86
		unsigned int macos_state = false;
87
		bool pressed = false;
88
		bool echo = false;
89
		bool raw = false;
90
		Key keycode = Key::NONE;
91
		Key physical_keycode = Key::NONE;
92
		Key key_label = Key::NONE;
93
		uint32_t unicode = 0;
94
		KeyLocation location = KeyLocation::UNSPECIFIED;
95
	};
96

97
	struct WindowData {
98
		GodotWindowDelegate *window_delegate;
99
		GodotWindow *window_object;
100
		GodotContentView *window_view;
101
		GodotButtonView *window_button_view;
102

103
		Vector<Vector2> mpath;
104

105
		CGDirectDisplayID display_id = -1;
106

107
		Point2i mouse_pos;
108
		WindowResizeEdge edge = WINDOW_EDGE_MAX;
109

110
		Size2i min_size;
111
		Size2i max_size;
112
		Size2i size;
113
		Vector2i wb_offset = Vector2i(14, 14);
114

115
		NSRect last_frame_rect = NSMakeRect(0, 0, 0, 0);
116
		NSRect pre_zoom_rect = NSMakeRect(0, 0, 0, 0);
117

118
		bool im_active = false;
119
		Size2i im_position;
120

121
		Callable rect_changed_callback;
122
		Callable event_callback;
123
		Callable input_event_callback;
124
		Callable input_text_callback;
125
		Callable drop_files_callback;
126

127
		ObjectID instance_id;
128
		bool fs_transition = false;
129
		bool initial_size = true;
130

131
		WindowID transient_parent = INVALID_WINDOW_ID;
132
		bool exclusive = false;
133
		HashSet<WindowID> transient_children;
134

135
		bool layered_window = false;
136
		bool fullscreen = false;
137
		bool exclusive_fullscreen = false;
138
		bool on_top = false;
139
		bool borderless = false;
140
		bool resize_disabled = false;
141
		bool no_min_btn = false;
142
		bool no_max_btn = false;
143
		bool no_focus = false;
144
		bool is_popup = false;
145
		bool mpass = false;
146
		bool focused = false;
147
		bool is_visible = true;
148
		bool extend_to_title = false;
149
		bool hide_from_capture = false;
150

151
		Rect2i parent_safe_rect;
152
	};
153

154
	List<WindowID> popup_list;
155
	uint64_t time_since_popup = 0;
156

157
private:
158
#if defined(GLES3_ENABLED)
159
	GLManagerLegacy_MacOS *gl_manager_legacy = nullptr;
160
	GLManagerANGLE_MacOS *gl_manager_angle = nullptr;
161
#endif
162
#if defined(RD_ENABLED)
163
	RenderingContextDriver *rendering_context = nullptr;
164
	RenderingDevice *rendering_device = nullptr;
165
#endif
166
	String rendering_driver;
167

168
	struct WarpEvent {
169
		NSTimeInterval timestamp;
170
		NSPoint delta;
171
	};
172
	List<WarpEvent> warp_events;
173
	NSTimeInterval last_warp = 0;
174
	bool ignore_warp = false;
175

176
	Vector<KeyEvent> key_event_buffer;
177
	int key_event_pos = 0;
178

179
	id menu_delegate = nullptr;
180
	NativeMenuMacOS *native_menu = nullptr;
181

182
	Point2i im_selection;
183
	String im_text;
184

185
	CGEventSourceRef event_source;
186
	MouseMode mouse_mode = MOUSE_MODE_VISIBLE;
187
	MouseMode mouse_mode_base = MOUSE_MODE_VISIBLE;
188
	MouseMode mouse_mode_override = MOUSE_MODE_VISIBLE;
189
	bool mouse_mode_override_enabled = false;
190
	void _mouse_update_mode();
191

192
	bool drop_events = false;
193
	bool in_dispatch_input_event = false;
194

195
	WindowID window_mouseover_id = INVALID_WINDOW_ID;
196
	WindowID last_focused_window = INVALID_WINDOW_ID;
197
	WindowID window_id_counter = MAIN_WINDOW_ID;
198
	float display_max_scale = 1.f;
199
	mutable Point2i origin;
200
	mutable bool displays_arrangement_dirty = true;
201
	bool is_resizing = false;
202

203
	CursorShape cursor_shape = CURSOR_ARROW;
204
	NSCursor *cursors[CURSOR_MAX];
205
	HashMap<CursorShape, Vector<Variant>> cursors_cache;
206

207
	HashMap<WindowID, WindowData> windows;
208

209
	struct IndicatorData {
210
		id delegate;
211
		id item;
212
	};
213

214
	IndicatorID indicator_id_counter = 0;
215
	HashMap<IndicatorID, IndicatorData> indicators;
216

217
	IOPMAssertionID screen_keep_on_assertion = kIOPMNullAssertionID;
218

219
	Callable help_search_callback;
220
	Callable help_action_callback;
221

222
	struct MenuCall {
223
		Variant tag;
224
		Callable callback;
225
	};
226
	List<MenuCall> deferred_menu_calls;
227

228
	WindowID _create_window(WindowMode p_mode, VSyncMode p_vsync_mode, const Rect2i &p_rect);
229
	void _update_window_style(WindowData p_wd, WindowID p_window);
230

231
	void _update_displays_arrangement() const;
232
	Point2i _get_native_screen_position(int p_screen) const;
233
	static void _displays_arrangement_changed(CGDirectDisplayID display_id, CGDisplayChangeSummaryFlags flags, void *user_info);
234

235
	static void _dispatch_input_events(const Ref<InputEvent> &p_event);
236
	void _dispatch_input_event(const Ref<InputEvent> &p_event);
237
	void _push_input(const Ref<InputEvent> &p_event);
238
	void _process_key_events();
239

240
	static NSCursor *_cursor_from_selector(SEL p_selector, SEL p_fallback = nil);
241

242
	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);
243

244
#ifdef TOOLS_ENABLED
245
	struct EmbeddedProcessData {
246
		EmbeddedProcessMacOS *process = nullptr;
247
		WindowData *wd = nullptr;
248
		CALayer *layer_host = nil;
249
	};
250
	HashMap<OS::ProcessID, EmbeddedProcessData> embedded_processes;
251
#endif
252
	void _window_update_display_id(WindowData *p_wd);
253

254
public:
255
	void menu_callback(id p_sender);
256

257
	bool has_window(WindowID p_window) const;
258
	WindowData &get_window(WindowID p_window);
259

260
	NSImage *_convert_to_nsimg(Ref<Image> &p_image) const;
261
	Point2i _get_screens_origin() const;
262

263
	void set_menu_delegate(NSMenu *p_menu);
264

265
	void send_event(NSEvent *p_event);
266
	void send_window_event(const WindowData &p_wd, WindowEvent p_event);
267
	void release_pressed_events();
268
	void sync_mouse_state();
269
	void get_key_modifier_state(unsigned int p_macos_state, Ref<InputEventWithModifiers> r_state) const;
270
	void update_mouse_pos(WindowData &p_wd, NSPoint p_location_in_window);
271
	void push_to_key_event_buffer(const KeyEvent &p_event);
272
	void pop_last_key_event();
273
	void update_im_text(const Point2i &p_selection, const String &p_text);
274
	void set_last_focused_window(WindowID p_window);
275
	bool mouse_process_popups(bool p_close = false);
276
	void popup_open(WindowID p_window);
277
	void popup_close(WindowID p_window);
278
	void set_is_resizing(bool p_is_resizing);
279
	bool get_is_resizing() const;
280
	void reparent_check(WindowID p_window);
281
	WindowID _get_focused_window_or_popup() const;
282
	void mouse_enter_window(WindowID p_window);
283
	void mouse_exit_window(WindowID p_window);
284
	void update_presentation_mode();
285

286
	bool is_always_on_top_recursive(WindowID p_window) const;
287

288
	/**
289
	 * Get the display ID of a window.
290
	 */
291
	uint32_t window_get_display_id(WindowID p_window) const;
292
	void window_destroy(WindowID p_window);
293
	void window_resize(WindowID p_window, int p_width, int p_height);
294
	void window_set_custom_window_buttons(WindowData &p_wd, bool p_enabled);
295
	void set_window_per_pixel_transparency_enabled(bool p_enabled, WindowID p_window);
296

297
	virtual bool has_feature(Feature p_feature) const override;
298
	virtual String get_name() const override;
299

300
	virtual void help_set_search_callbacks(const Callable &p_search_callback = Callable(), const Callable &p_action_callback = Callable()) override;
301
	Callable _help_get_search_callback() const;
302
	Callable _help_get_action_callback() const;
303

304
	virtual Error dialog_show(String p_title, String p_description, Vector<String> p_buttons, const Callable &p_callback) override;
305
	virtual Error dialog_input_text(String p_title, String p_description, String p_partial, const Callable &p_callback) override;
306

307
	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;
308
	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;
309

310
	virtual void beep() const override;
311

312
	virtual void mouse_set_mode(MouseMode p_mode) override;
313
	virtual MouseMode mouse_get_mode() const override;
314
	virtual void mouse_set_mode_override(MouseMode p_mode) override;
315
	virtual MouseMode mouse_get_mode_override() const override;
316
	virtual void mouse_set_mode_override_enabled(bool p_override_enabled) override;
317
	virtual bool mouse_is_mode_override_enabled() const override;
318

319
	bool update_mouse_wrap(WindowData &p_wd, NSPoint &r_delta, NSPoint &r_mpos, NSTimeInterval p_timestamp);
320
	virtual void warp_mouse(const Point2i &p_position) override;
321
	virtual Point2i mouse_get_position() const override;
322
	virtual BitField<MouseButtonMask> mouse_get_button_state() const override;
323

324
	virtual int get_screen_count() const override;
325
	virtual int get_primary_screen() const override;
326
	virtual int get_keyboard_focus_screen() const override;
327
	virtual Point2i screen_get_position(int p_screen = SCREEN_OF_MAIN_WINDOW) const override;
328
	virtual Size2i screen_get_size(int p_screen = SCREEN_OF_MAIN_WINDOW) const override;
329
	virtual int screen_get_dpi(int p_screen = SCREEN_OF_MAIN_WINDOW) const override;
330
	virtual float screen_get_scale(int p_screen = SCREEN_OF_MAIN_WINDOW) const override;
331
	virtual float screen_get_max_scale() const override;
332
	virtual Rect2i screen_get_usable_rect(int p_screen = SCREEN_OF_MAIN_WINDOW) const override;
333
	virtual float screen_get_refresh_rate(int p_screen = SCREEN_OF_MAIN_WINDOW) const override;
334
	virtual Color screen_get_pixel(const Point2i &p_position) const override;
335
	virtual Ref<Image> screen_get_image(int p_screen = SCREEN_OF_MAIN_WINDOW) const override;
336
	virtual Ref<Image> screen_get_image_rect(const Rect2i &p_rect) const override;
337
	virtual void screen_set_keep_on(bool p_enable) override;
338
	virtual bool screen_is_kept_on() const override;
339

340
	virtual Vector<int> get_window_list() const override;
341

342
	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;
343
	virtual void show_window(WindowID p_id) override;
344
	virtual void delete_sub_window(WindowID p_id) override;
345

346
	virtual WindowID window_get_active_popup() const override;
347
	virtual void window_set_popup_safe_rect(WindowID p_window, const Rect2i &p_rect) override;
348
	virtual Rect2i window_get_popup_safe_rect(WindowID p_window) const override;
349

350
	virtual void window_set_rect_changed_callback(const Callable &p_callable, WindowID p_window = MAIN_WINDOW_ID) override;
351
	virtual void window_set_window_event_callback(const Callable &p_callable, WindowID p_window = MAIN_WINDOW_ID) override;
352
	virtual void window_set_input_event_callback(const Callable &p_callable, WindowID p_window = MAIN_WINDOW_ID) override;
353
	virtual void window_set_input_text_callback(const Callable &p_callable, WindowID p_window = MAIN_WINDOW_ID) override;
354
	virtual void window_set_drop_files_callback(const Callable &p_callable, WindowID p_window = MAIN_WINDOW_ID) override;
355

356
	virtual void window_set_title(const String &p_title, WindowID p_window = MAIN_WINDOW_ID) override;
357
	virtual Size2i window_get_title_size(const String &p_title, WindowID p_window) const override;
358
	virtual void window_set_mouse_passthrough(const Vector<Vector2> &p_region, WindowID p_window = MAIN_WINDOW_ID) override;
359

360
	virtual int window_get_current_screen(WindowID p_window = MAIN_WINDOW_ID) const override;
361
	virtual void window_set_current_screen(int p_screen, WindowID p_window = MAIN_WINDOW_ID) override;
362

363
	virtual Point2i window_get_position(WindowID p_window = MAIN_WINDOW_ID) const override;
364
	virtual Point2i window_get_position_with_decorations(WindowID p_window = MAIN_WINDOW_ID) const override;
365
	virtual void window_set_position(const Point2i &p_position, WindowID p_window = MAIN_WINDOW_ID) override;
366

367
	virtual void window_set_transient(WindowID p_window, WindowID p_parent) override;
368
	virtual void window_set_exclusive(WindowID p_window, bool p_exclusive) override;
369

370
	virtual void window_set_max_size(const Size2i p_size, WindowID p_window = MAIN_WINDOW_ID) override;
371
	virtual Size2i window_get_max_size(WindowID p_window = MAIN_WINDOW_ID) const override;
372

373
	virtual void window_set_min_size(const Size2i p_size, WindowID p_window = MAIN_WINDOW_ID) override;
374
	virtual Size2i window_get_min_size(WindowID p_window = MAIN_WINDOW_ID) const override;
375

376
	virtual void window_set_size(const Size2i p_size, WindowID p_window = MAIN_WINDOW_ID) override;
377
	virtual Size2i window_get_size(WindowID p_window = MAIN_WINDOW_ID) const override;
378
	virtual Size2i window_get_size_with_decorations(WindowID p_window = MAIN_WINDOW_ID) const override;
379

380
	virtual void window_set_mode(WindowMode p_mode, WindowID p_window = MAIN_WINDOW_ID) override;
381
	virtual WindowMode window_get_mode(WindowID p_window = MAIN_WINDOW_ID) const override;
382

383
	virtual bool window_is_maximize_allowed(WindowID p_window = MAIN_WINDOW_ID) const override;
384

385
	virtual void window_set_flag(WindowFlags p_flag, bool p_enabled, WindowID p_window = MAIN_WINDOW_ID) override;
386
	virtual bool window_get_flag(WindowFlags p_flag, WindowID p_window = MAIN_WINDOW_ID) const override;
387

388
	virtual void window_request_attention(WindowID p_window = MAIN_WINDOW_ID) override;
389
	virtual void window_move_to_foreground(WindowID p_window = MAIN_WINDOW_ID) override;
390
	virtual bool window_is_focused(WindowID p_window = MAIN_WINDOW_ID) const override;
391

392
	virtual WindowID get_focused_window() const override;
393

394
	virtual bool window_can_draw(WindowID p_window = MAIN_WINDOW_ID) const override;
395

396
	virtual bool can_any_window_draw() const override;
397

398
	virtual void window_set_ime_active(const bool p_active, WindowID p_window = MAIN_WINDOW_ID) override;
399
	virtual void window_set_ime_position(const Point2i &p_pos, WindowID p_window = MAIN_WINDOW_ID) override;
400

401
	virtual WindowID get_window_at_screen_position(const Point2i &p_position) const override;
402

403
	virtual int64_t window_get_native_handle(HandleType p_handle_type, WindowID p_window = MAIN_WINDOW_ID) const override;
404

405
	virtual void window_attach_instance_id(ObjectID p_instance, WindowID p_window = MAIN_WINDOW_ID) override;
406
	virtual ObjectID window_get_attached_instance_id(WindowID p_window = MAIN_WINDOW_ID) const override;
407
	virtual void gl_window_make_current(DisplayServer::WindowID p_window_id) override;
408

409
	virtual void window_set_vsync_mode(DisplayServer::VSyncMode p_vsync_mode, WindowID p_window = MAIN_WINDOW_ID) override;
410
	virtual DisplayServer::VSyncMode window_get_vsync_mode(WindowID p_vsync_mode) const override;
411

412
	virtual bool window_maximize_on_title_dbl_click() const override;
413
	virtual bool window_minimize_on_title_dbl_click() const override;
414

415
	virtual void window_start_drag(WindowID p_window = MAIN_WINDOW_ID) override;
416
	virtual void window_start_resize(WindowResizeEdge p_edge, WindowID p_window = MAIN_WINDOW_ID) override;
417

418
	virtual void window_set_window_buttons_offset(const Vector2i &p_offset, WindowID p_window = MAIN_WINDOW_ID) override;
419
	virtual Vector3i window_get_safe_title_margins(WindowID p_window = MAIN_WINDOW_ID) const override;
420

421
	virtual int accessibility_should_increase_contrast() const override;
422
	virtual int accessibility_should_reduce_animation() const override;
423
	virtual int accessibility_should_reduce_transparency() const override;
424
	virtual int accessibility_screen_reader_active() const override;
425

426
	virtual Point2i ime_get_selection() const override;
427
	virtual String ime_get_text() const override;
428

429
	void cursor_update_shape();
430
	virtual void cursor_set_shape(CursorShape p_shape) override;
431
	virtual CursorShape cursor_get_shape() const override;
432
	virtual void cursor_set_custom_image(const Ref<Resource> &p_cursor, CursorShape p_shape = CURSOR_ARROW, const Vector2 &p_hotspot = Vector2()) override;
433

434
	virtual bool get_swap_cancel_ok() override;
435

436
	virtual void enable_for_stealing_focus(OS::ProcessID pid) override;
437
#ifdef TOOLS_ENABLED
438
	Error embed_process_update(WindowID p_window, EmbeddedProcessMacOS *p_process);
439
	virtual Error request_close_embedded_process(OS::ProcessID p_pid) override;
440
	virtual Error remove_embedded_process(OS::ProcessID p_pid) override;
441
#endif
442

443
	void _process_events(bool p_pump);
444
	virtual void process_events() override;
445
	virtual void force_process_and_drop_events() override;
446

447
	virtual void release_rendering_thread() override;
448
	virtual void swap_buffers() override;
449

450
	virtual void set_native_icon(const String &p_filename) override;
451
	virtual void set_icon(const Ref<Image> &p_icon) override;
452

453
	virtual IndicatorID create_status_indicator(const Ref<Texture2D> &p_icon, const String &p_tooltip, const Callable &p_callback) override;
454
	virtual void status_indicator_set_icon(IndicatorID p_id, const Ref<Texture2D> &p_icon) override;
455
	virtual void status_indicator_set_tooltip(IndicatorID p_id, const String &p_tooltip) override;
456
	virtual void status_indicator_set_menu(IndicatorID p_id, const RID &p_menu_rid) override;
457
	virtual void status_indicator_set_callback(IndicatorID p_id, const Callable &p_callback) override;
458
	virtual Rect2 status_indicator_get_rect(IndicatorID p_id) const override;
459
	virtual void delete_status_indicator(IndicatorID p_id) override;
460

461
	virtual bool is_window_transparency_available() const override;
462

463
	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);
464
	static Vector<String> get_rendering_drivers_func();
465

466
	static void register_macos_driver();
467

468
	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);
469
	~DisplayServerMacOS();
470
};
471

472
Product

Resources

Company
