<rdar://problem/10891801> BackingStore::scroll() unnecessarily copies pixels around
[WebKit-https.git] / Source / WebKit2 / UIProcess / BackingStore.h
1 /*
2  * Copyright (C) 2011 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #ifndef BackingStore_h
27 #define BackingStore_h
28
29 #include <WebCore/IntRect.h>
30 #include <wtf/Noncopyable.h>
31 #include <wtf/PassOwnPtr.h>
32
33 #if PLATFORM(MAC)
34 #include <wtf/RetainPtr.h>
35 #elif PLATFORM(WIN) || PLATFORM(WIN_CAIRO)
36 #include <wtf/OwnPtr.h>
37 #endif
38
39 #if PLATFORM(QT)
40 #include <QtGui/QPainter>
41 #include <QtGui/QPixmap>
42 #endif
43
44 #if USE(CAIRO) && !PLATFORM(WIN_CAIRO)
45 #include <RefPtrCairo.h>
46 #include <WebCore/WidgetBackingStore.h>
47 #endif
48
49 namespace WebKit {
50
51 class ShareableBitmap;
52 class UpdateInfo;
53 class WebPageProxy;
54
55 class BackingStore {
56     WTF_MAKE_NONCOPYABLE(BackingStore);
57
58 public:
59     static PassOwnPtr<BackingStore> create(const WebCore::IntSize&, float deviceScaleFactor, WebPageProxy*);
60     ~BackingStore();
61
62     const WebCore::IntSize& size() const { return m_size; }
63     float deviceScaleFactor() const { return m_deviceScaleFactor; }
64
65 #if PLATFORM(MAC)
66     typedef CGContextRef PlatformGraphicsContext;
67 #elif PLATFORM(WIN)
68     typedef HDC PlatformGraphicsContext;
69 #elif PLATFORM(QT)
70     typedef QPainter* PlatformGraphicsContext;
71 #elif USE(CAIRO)
72     typedef cairo_t* PlatformGraphicsContext;
73 #endif
74
75     void paint(PlatformGraphicsContext, const WebCore::IntRect&);
76     void incorporateUpdate(const UpdateInfo&);
77
78 private:
79     BackingStore(const WebCore::IntSize&, float deviceScaleFactor, WebPageProxy*);
80
81     void incorporateUpdate(ShareableBitmap*, const UpdateInfo&);
82     void scroll(const WebCore::IntRect& scrollRect, const WebCore::IntSize& scrollOffset);
83
84     WebCore::IntSize m_size;
85     float m_deviceScaleFactor;
86     WebPageProxy* m_webPageProxy;
87
88 #if PLATFORM(MAC)
89     CGContextRef backingStoreContext();
90
91     void performWithScrolledRectTransform(const WebCore::IntRect&, void (^)(const WebCore::IntRect&, const WebCore::IntSize&));
92     void resetScrolledRect();
93
94     RetainPtr<CGLayerRef> m_cgLayer;
95     RetainPtr<CGContextRef> m_bitmapContext;
96
97     // The rectange that was scrolled most recently.
98     WebCore::IntRect m_scrolledRect;
99
100     // Contents of m_scrolledRect are offset by this amount (and wrapped around) with respect to
101     // their original location.
102     WebCore::IntSize m_scrolledRectOffset;
103 #elif PLATFORM(WIN) || PLATFORM(WIN_CAIRO)
104     OwnPtr<HBITMAP> m_bitmap;
105 #elif PLATFORM(QT)
106     QPixmap m_pixmap;
107 #elif USE(CAIRO)
108     OwnPtr<WebCore::WidgetBackingStore> m_backingStore;
109 #endif
110 };
111
112 } // namespace WebKit
113
114 #endif // BackingStore_h