Merge pull request #7528 from livecodeian/bugfix-23085

livecodepanos · web-flow · commit 93ab7038961c · 2021-03-09T18:24:35.000+02:00
[[ Bug 23085 ]] Fix Macos Big Sur visual effect rendering
diff --git a/docs/notes/bugfix-23085.md b/docs/notes/bugfix-23085.md
@@ -0,0 +1 @@
+# Fix visual effect rendering on Macos Big Sur
diff --git a/engine/src/mac-core.mm b/engine/src/mac-core.mm
@@ -48,6 +48,7 @@
 {
 	kMCMacPlatformBreakEvent = 0,
 	kMCMacPlatformMouseSyncEvent = 1,
+	kMCMacPlatformDrawSyncEvent = 2,
 };
 
 ////////////////////////////////////////////////////////////////////////////////
@@ -73,6 +74,13 @@ bool MCMacPlatformApplicationSendEvent(NSEvent *p_event)
 		return true;
 	}
 
+    if ([p_event type] == NSApplicationDefined &&
+        [p_event subtype] == kMCMacPlatformDrawSyncEvent)
+	{
+		MCMacPlatformHandleDrawSync([p_event window]);
+		return true;
+	}
+
 	// MW-2014-08-14: [[ Bug 13016 ]] Whilst the windowserver moves a window
 	//   we intercept mouseDragged events so we can keep script informed.
 	NSWindow *t_window;
@@ -1982,6 +1990,21 @@ void MCMacPlatformSyncMouseBeforeDragging(void)
 	}
 }
 
+void MCMacPlatformSyncUpdateAfterDraw(NSInteger windowNumber)
+{
+	NSEvent *t_event;
+	t_event = [NSEvent otherEventWithType:NSApplicationDefined
+								 location:NSMakePoint(0,0)
+							modifierFlags:0
+								timestamp:0
+							 windowNumber:windowNumber
+								  context:NULL
+								  subtype:kMCMacPlatformDrawSyncEvent
+									data1:0
+									data2:0];
+	[NSApp postEvent:t_event atStart:YES];
+}
+
 void MCMacPlatformSyncMouseAfterTracking(void)
 {
 	NSEvent *t_event;
diff --git a/engine/src/mac-internal.h b/engine/src/mac-internal.h
@@ -505,6 +505,8 @@ class MCMacPlatformWindow: public MCPlatformWindow
 	// IM-2015-01-30: [[ Bug 14140 ]] Locking the frame will prevent the window from being moved or resized
 	void SetFrameLocked(bool p_locked);
 	
+	void DrawSync(void);
+	
 protected:
 	virtual void DoRealize(void);
 	virtual void DoSynchronize(void);
@@ -542,7 +544,7 @@ class MCMacPlatformWindow: public MCPlatformWindow
 	
     // The window's content view.
     MCWindowView *m_view;
-    
+	
 	struct
 	{
 		// When the mask changes and the window has a shadow we have to
@@ -559,6 +561,10 @@ class MCMacPlatformWindow: public MCPlatformWindow
 		
 		// When the frame is locked, any changes to the window rect will be prevented.
 		bool m_frame_locked : 1;
+
+		// This is used to signal to DoUpdate that a redraw has been performed
+		// in response to an update request.
+		bool m_waiting_for_draw : 1;
 	};
 	
 	// A window might map to one of several different classes, so we use a
@@ -578,6 +584,7 @@ class MCMacPlatformWindow: public MCPlatformWindow
 	static bool s_hiding;
 	static MCMacPlatformWindow *s_hiding_focused;
 	static MCMacPlatformWindow *s_hiding_unfocused;
+	static bool s_showing_sheet;
 };
 
 ////////////////////////////////////////////////////////////////////////////////
@@ -592,6 +599,7 @@ void MCMacPlatformHandleMousePress(uint32_t p_button, bool p_is_down);
 void MCMacPlatformHandleMouseMove(MCPoint p_screen_location);
 void MCMacPlatformHandleMouseScroll(CGFloat dx, CGFloat dy);
 void MCMacPlatformHandleMouseSync(void);
+void MCMacPlatformHandleDrawSync(NSWindow *window);
 void MCMacPlatformHandleMouseAfterWindowHidden(void);
 
 void MCMacPlatformHandleMouseForResizeStart(void);
@@ -600,6 +608,8 @@ void MCMacPlatformHandleMouseForResizeEnd(void);
 void MCMacPlatformSyncMouseBeforeDragging(void);
 void MCMacPlatformSyncMouseAfterTracking(void);
 
+void MCMacPlatformSyncUpdateAfterDraw(NSInteger windowNumber);
+
 void MCMacPlatformHandleModifiersChanged(MCPlatformModifiers modifiers);
 
 bool MCMacPlatformMapKeyCode(uint32_t mac_key_code, uint32_t modifier_flags, MCPlatformKeyCode& r_key_code);
diff --git a/engine/src/mac-window.mm b/engine/src/mac-window.mm
@@ -22,6 +22,7 @@
 #include "region.h"
 #include "graphics.h"
 #include "unicode.h"
+#include "globals.h"
 
 #include "platform.h"
 #include "platform-internal.h"
@@ -1588,6 +1589,13 @@ - (void)drawRect: (NSRect)dirtyRect
 	//////////
 	
 	MCGRegionDestroy(t_update_region);
+	
+	if (MCmajorosversion >= MCOSVersionMake(10,16,0))
+	{
+		// Send event to break wait in NSApp::nextEventMatchingMask in MCMacPlatformWindow::DoUpdate
+		t_window->DrawSync();
+		MCMacPlatformSyncUpdateAfterDraw(self.window.windowNumber);
+	}
 }
 
 //////////
@@ -1674,6 +1682,8 @@ - (void)setFrameSize: (NSSize)size
 	m_has_sheet = false;
 	m_frame_locked = false;
 	
+	m_waiting_for_draw = false;
+	
 	m_parent = nil;
 }
 
@@ -1693,6 +1703,7 @@ - (void)setFrameSize: (NSSize)size
 bool MCMacPlatformWindow::s_hiding = false;
 MCMacPlatformWindow *MCMacPlatformWindow::s_hiding_focused = nil;
 MCMacPlatformWindow *MCMacPlatformWindow::s_hiding_unfocused = nil;
+bool MCMacPlatformWindow::s_showing_sheet = false;
 
 ////////////////////////////////////////////////////////////////////////////////
 
@@ -2122,6 +2133,7 @@ - (void)setFrameSize: (NSSize)size
 	m_parent -> Retain();
 	((MCMacPlatformWindow *)m_parent) -> m_has_sheet = true;
 	
+	s_showing_sheet = true;
 	[NSApp beginSheet: m_window_handle modalForWindow: t_parent -> m_window_handle modalDelegate: m_delegate didEndSelector: @selector(didEndSheet:returnCode:contextInfo:) contextInfo: nil];
 }
 
@@ -2136,6 +2148,7 @@ - (void)setFrameSize: (NSSize)size
 		((MCMacPlatformWindow *)m_parent) -> m_has_sheet = false;
 		m_parent -> Release();
 		m_parent = nil;
+		s_showing_sheet = false;
 	}
 	else if (m_style == kMCPlatformWindowStyleDialog)
 	{
@@ -2198,8 +2211,19 @@ bool MCMacDoUpdateRegionCallback(void *p_context, const MCRectangle &p_rect)
 	
 	return true;
 }
+
+void MCMacPlatformHandleDrawSync(NSWindow *window)
+{
+	/* NOOP */
+}
+
+void MCMacPlatformWindow::DrawSync()
+{
+	m_waiting_for_draw = false;
+}
+
 void MCMacPlatformWindow::DoUpdate(void)
-{	
+{
 	// If the shadow has changed (due to the mask changing) we must disable
 	// screen updates otherwise we get a flicker.
 	// IM-2015-02-23: [[ WidgetPopup ]] Assume shadow changes when redrawing a non-opaque widget
@@ -2214,10 +2238,32 @@ bool MCMacDoUpdateRegionCallback(void *p_context, const MCRectangle &p_rect)
 	s_rect_count = 0;
 	MCRegionForEachRect(m_dirty_region, MCMacDoUpdateRegionCallback, m_view);
 	
-	// Force a re-display, this will cause drawRect to be invoked on our view
-	// which in term will result in a redraw window callback being sent.
-	[m_view displayIfNeededInRect: [m_view mapMCRectangleToNSRect:MCRegionGetBoundingBox(m_dirty_region)]];
-	
+	if (MCmajorosversion >= MCOSVersionMake(10,16,0))
+	{
+		// Frequent redraws with displayIfNeeded causes graphical glitches on Macos Big Sur, so instead
+		// we enter the runloop to trigger a redraw. This will cause drawRect to be invoked on our view
+		// which in turn will result in a redraw window callback being sent.
+		// The timeout value of 0.02ms is specified to avoid hitting the 60hz redraw limit.
+		if (!s_inside_focus_event && !s_showing_sheet && ![m_delegate inUserReshape])
+		{
+			m_waiting_for_draw = true;
+			while (m_waiting_for_draw)
+			{
+				NSEvent *t_event;
+				t_event = [NSApp nextEventMatchingMask: NSApplicationDefinedMask
+											 untilDate: [NSDate dateWithTimeIntervalSinceNow: 0.02]
+												inMode: NSEventTrackingRunLoopMode
+											   dequeue: NO];
+				t_event = nil;
+			}
+		}
+	}
+	else
+	{
+		// Use displayIfNeeded to trigger a redraw
+		[m_view displayIfNeeded];
+	}
+
 	// Re-enable screen updates if needed.
 	if (t_shadow_changed)
     {

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+# Fix visual effect rendering on Macos Big Sur`