Changeset 14480 in webkit

Timestamp:

May 18, 2006 2:28:47 PM (18 years ago)

Author:

tomernic

Message:

Reviewed by John Sullivan.

<rdar://problem/4551938> More options needed for window display throttle

We decided to play it safe and leave our window flushing behavior unchanged from the previous
public release. By default, CoreGraphics deferred updates are once again OFF, and the window
display throttle is OFF.

Individual applications should set the WebKitThrottleWindowDisplayPreferenceKey and
WebKitEnableDeferredUpdatesPreferenceKey defaults to suit their needs.

Old behavior (like 10.4.6): WebKitThrottleWindowDisplayPreferenceKey=0 (or unset),
WebKitEnableDeferredUpdatesPreferenceKey (or unset).

Tear-free scrolling/animations: WebKitThrottleWindowDisplayPreferenceKey=0 (or unset),
WebKitEnableDeferredUpdatesPreferenceKey=1. While this configuration fixes the tearing issues
caused by over-flushing, some applications will experience performance problems as over-flushing
with CG deferred updates enabled will cause the app to block.

Tear-free scrolling/animations, high performance: WebKitThrottleWindowDisplayPreferenceKey=1,
WebKitEnableDeferredUpdatesPreferenceKey=1. This is the riskiest configuration in that it
enables the window display throttle "feature", potentially breaking applications' assumptions
about when displays occur. However, it provides the "best of both worlds", in that updates
are tear-free, and performance impact should me minimal.

• WebView/WebPreferenceKeysPrivate.h: Declared WebKitThrottleWindowDisplayPreferenceKey and WebKitEnableDeferredUpdatesPreferenceKey.

• WebView/WebFrameView.m: (-[WebFrameView initWithFrame:]): Turn off CG deferred updates if WebKitEnableDeferredUpdatesPreferenceKey is NO or has no value. Added some comments.

Location:

trunk/WebKit

Files:

• ChangeLog (modified) (1 diff)
• WebView/WebFrameView.m (modified) (4 diffs)
• WebView/WebPreferenceKeysPrivate.h (modified) (1 diff)

trunk/WebKit/ChangeLog

@@ +1 @@
+2006-05-18  Tim Omernick  <timo@apple.com>
+
+        Reviewed by John Sullivan.
+
+        <rdar://problem/4551938> More options needed for window display throttle
+
+        We decided to play it safe and leave our window flushing behavior unchanged from the previous
+        public release.  By default, CoreGraphics deferred updates are once again OFF, and the window
+        display throttle is OFF.
+
+        Individual applications should set the WebKitThrottleWindowDisplayPreferenceKey and 
+        WebKitEnableDeferredUpdatesPreferenceKey defaults to suit their needs.
+
+        Old behavior (like 10.4.6): WebKitThrottleWindowDisplayPreferenceKey=0 (or unset), 
+        WebKitEnableDeferredUpdatesPreferenceKey (or unset).
+
+        Tear-free scrolling/animations: WebKitThrottleWindowDisplayPreferenceKey=0 (or unset),
+        WebKitEnableDeferredUpdatesPreferenceKey=1.  While this configuration fixes the tearing issues
+        caused by over-flushing, some applications will experience performance problems as over-flushing
+        with CG deferred updates enabled will cause the app to block.
+
+        Tear-free scrolling/animations, high performance: WebKitThrottleWindowDisplayPreferenceKey=1, 
+        WebKitEnableDeferredUpdatesPreferenceKey=1.  This is the riskiest configuration in that it
+        enables the window display throttle "feature", potentially breaking applications' assumptions
+        about when displays occur.  However, it provides the "best of both worlds", in that updates
+        are tear-free, and performance impact should me minimal.
+
+        * WebView/WebPreferenceKeysPrivate.h:
+        Declared WebKitThrottleWindowDisplayPreferenceKey and WebKitEnableDeferredUpdatesPreferenceKey.
+
+        * WebView/WebFrameView.m:
+        (-[WebFrameView initWithFrame:]):
+        Turn off CG deferred updates if WebKitEnableDeferredUpdatesPreferenceKey is NO or has no value.
+        Added some comments.
+
 2006-05-18  John Sullivan  <sullivan@apple.com>
 

trunk/WebKit/WebView/WebFrameView.m

@@ -47 +47 @@
 #import "WebNSWindowExtras.h"
 #import "WebPDFView.h"
+#import "WebPreferenceKeysPrivate.h"
 #import "WebSystemInterface.h"
 #import "WebViewFactory.h"
@@ -55 +56 @@
 #import <WebCore/WebCoreFrameView.h>
 #import <WebCore/WebCoreView.h>
+#import <WebKitSystemInterface.h>
 
 @interface NSClipView (AppKitSecretsIKnow)
@@ -63 +65 @@
     SpaceKey = 0x0020
 };
-
-static NSString *WebKitThrottleWindowDisplayPreferenceKey = @"WebKitThrottleWindowDisplay";
 
 @interface WebFrameView (WebFrameViewFileInternal) <WebCoreBridgeHolder>
@@ -309 +309 @@
         [WebImageRendererFactory createSharedFactory];
         [WebKeyGenerator createSharedGenerator];
-        if ([[NSUserDefaults standardUserDefaults] boolForKey:WebKitThrottleWindowDisplayPreferenceKey])
+
+        NSUserDefaults *defaults = [NSUserDefaults standardUserDefaults];
+        
+        // Window display is throttled to 60 frames per second if WebKitThrottleWindowDisplayPreferenceKey
+        // is set to YES.  The window display throttle is OFF by default for compatibility with Mac OS X
+        // 10.4.6.
+        if ([defaults boolForKey:WebKitThrottleWindowDisplayPreferenceKey])
             [NSWindow _webkit_enableWindowDisplayThrottle];
+        
+        // CoreGraphics deferred updates are disabled if WebKitEnableCoalescedUpdatesPreferenceKey is set
+        // to NO, or has no value.  For compatibility with Mac OS X 10.4.6, deferred updates are OFF by
+        // default.
+        if (![defaults boolForKey:WebKitEnableDeferredUpdatesPreferenceKey])
+            WKDisableCGDeferredUpdates();
     }
     

trunk/WebKit/WebView/WebPreferenceKeysPrivate.h

@@ -65 +65 @@
 #define WebKitPDFDisplayModePreferenceKey @"WebKitPDFDisplayMode"
 #define WebKitPDFScaleFactorPreferenceKey @"WebKitPDFScaleFactor"
+
+
+// Window display is throttled to 60 frames per second if WebKitThrottleWindowDisplayPreferenceKey
+// is set to YES.  The window display throttle is OFF by default for compatibility with Mac OS X
+// 10.4.6.
+#define WebKitThrottleWindowDisplayPreferenceKey @"WebKitThrottleWindowDisplay"
+
+// CoreGraphics deferred updates are disabled if WebKitEnableCoalescedUpdatesPreferenceKey is set
+// to NO, or has no value.  For compatibility with Mac OS X 10.4.6, deferred updates are OFF by
+// default.
+#define WebKitEnableDeferredUpdatesPreferenceKey @"WebKitEnableDeferredUpdates"