Adopt CAMachPort-as-layer-contents
[WebKit-https.git] / Source / WebKit2 / Shared / mac / RemoteLayerBackingStore.h
1 /*
2  * Copyright (C) 2013 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. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #ifndef RemoteLayerBackingStore_h
27 #define RemoteLayerBackingStore_h
28
29 #include "ShareableBitmap.h"
30 #include <WebCore/FloatRect.h>
31 #include <WebCore/IOSurface.h>
32 #include <WebCore/MachSendRight.h>
33 #include <WebCore/Region.h>
34 #include <chrono>
35
36 OBJC_CLASS CALayer;
37
38 // FIXME: Make PlatformCALayerRemote.cpp Objective-C so we can include WebLayer.h here and share the typedef.
39 namespace WebCore {
40 typedef Vector<WebCore::FloatRect, 5> RepaintRectList;
41 }
42
43 namespace WebKit {
44
45 class PlatformCALayerRemote;
46
47 class RemoteLayerBackingStore {
48     WTF_MAKE_NONCOPYABLE(RemoteLayerBackingStore);
49     WTF_MAKE_FAST_ALLOCATED;
50 public:
51     RemoteLayerBackingStore(PlatformCALayerRemote*);
52     ~RemoteLayerBackingStore();
53
54     void ensureBackingStore(WebCore::FloatSize, float scale, bool acceleratesDrawing, bool isOpaque);
55
56     void setNeedsDisplay(const WebCore::IntRect);
57     void setNeedsDisplay();
58
59     bool display();
60
61     WebCore::FloatSize size() const { return m_size; }
62     float scale() const { return m_scale; }
63     bool acceleratesDrawing() const { return m_acceleratesDrawing; }
64     bool isOpaque() const { return m_isOpaque; }
65
66     PlatformCALayerRemote* layer() const { return m_layer; }
67
68     void applyBackingStoreToLayer(CALayer *);
69
70     void encode(IPC::ArgumentEncoder&) const;
71     static bool decode(IPC::ArgumentDecoder&, RemoteLayerBackingStore&);
72
73     void enumerateRectsBeingDrawn(CGContextRef, void (^)(CGRect));
74
75     bool hasFrontBuffer() const
76     {
77 #if USE(IOSURFACE)
78         if (m_acceleratesDrawing)
79             return !!m_frontBuffer.surface;
80 #endif
81         return !!m_frontBuffer.bitmap;
82     }
83
84     RetainPtr<CGContextRef> takeFrontContextPendingFlush();
85
86     enum class BufferType {
87         Front,
88         Back,
89         SecondaryBack
90     };
91
92     bool setBufferVolatility(BufferType type, bool isVolatile);
93
94     std::chrono::steady_clock::time_point lastDisplayTime() const { return m_lastDisplayTime; }
95
96 private:
97     void drawInContext(WebCore::GraphicsContext&, CGImageRef backImage);
98     void clearBackingStore();
99     void swapToValidFrontBuffer();
100     
101     WebCore::IntSize backingStoreSize() const;
102
103     PlatformCALayerRemote* m_layer;
104
105     WebCore::FloatSize m_size;
106     float m_scale;
107     bool m_isOpaque;
108
109     WebCore::Region m_dirtyRegion;
110
111     struct Buffer {
112         RefPtr<ShareableBitmap> bitmap;
113 #if USE(IOSURFACE)
114         std::unique_ptr<WebCore::IOSurface> surface;
115         bool isVolatile = false;
116 #endif
117
118         explicit operator bool() const
119         {
120 #if USE(IOSURFACE)
121             if (surface)
122                 return true;
123 #endif
124             if (bitmap)
125                 return true;
126
127             return false;
128         }
129
130         void discard();
131     };
132
133     Buffer m_frontBuffer;
134     Buffer m_backBuffer;
135 #if USE(IOSURFACE)
136     Buffer m_secondaryBackBuffer;
137     WebCore::MachSendRight m_frontBufferSendRight;
138 #endif
139
140     RetainPtr<CGContextRef> m_frontContextPendingFlush;
141
142     bool m_acceleratesDrawing;
143
144     WebCore::RepaintRectList m_paintingRects;
145
146     std::chrono::steady_clock::time_point m_lastDisplayTime;
147 };
148
149 } // namespace WebKit
150
151 #endif // RemoteLayerBackingStore_h