Simplify WKCACFLayerRenderer's API
[WebKit.git] / Source / WebCore / platform / graphics / win / WKCACFLayerRenderer.h
1 /*
2  * Copyright (C) 2009 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 COMPUTER, 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 WKCACFLayerRenderer_h
27 #define WKCACFLayerRenderer_h
28
29 #if USE(ACCELERATED_COMPOSITING)
30
31 #include "COMPtr.h"
32 #include "Timer.h"
33
34 #include <wtf/HashSet.h>
35 #include <wtf/Noncopyable.h>
36 #include <wtf/PassOwnPtr.h>
37 #include <wtf/PassRefPtr.h>
38 #include <wtf/RefPtr.h>
39 #include <wtf/RetainPtr.h>
40 #include <wtf/Vector.h>
41
42 #include <CoreGraphics/CGGeometry.h>
43
44 interface IDirect3DDevice9;
45 struct WKCACFContext;
46
47 typedef struct CGImage* CGImageRef;
48
49 namespace WebCore {
50
51 class PlatformCALayer;
52
53 class WKCACFLayerRendererClient {
54 public:
55     virtual ~WKCACFLayerRendererClient() { }
56     virtual bool shouldRender() const = 0;
57     virtual void syncCompositingState() { }
58 };
59
60 // FIXME: Currently there is a WKCACFLayerRenderer for each WebView and each
61 // has its own CARenderOGLContext and Direct3DDevice9, which is inefficient.
62 // (https://bugs.webkit.org/show_bug.cgi?id=31855)
63 class WKCACFLayerRenderer : public Noncopyable {
64     friend PlatformCALayer;
65
66 public:
67     static PassOwnPtr<WKCACFLayerRenderer> create(WKCACFLayerRendererClient*);
68     ~WKCACFLayerRenderer();
69
70     static bool acceleratedCompositingAvailable();
71
72     void setRootChildLayer(PlatformCALayer*);
73     void layerTreeDidChange();
74     void setHostWindow(HWND);
75     void paint();
76     void resize();
77     void syncCompositingStateSoon();
78
79 protected:
80     PlatformCALayer* rootLayer() const;
81     void addPendingAnimatedLayer(PassRefPtr<PlatformCALayer>);
82
83 private:
84     WKCACFLayerRenderer(WKCACFLayerRendererClient*);
85
86     bool createRenderer();
87     void destroyRenderer();
88     void renderSoon();
89     void renderTimerFired(Timer<WKCACFLayerRenderer>*);
90
91     CGRect bounds() const;
92
93     void initD3DGeometry();
94
95     // Call this when the device window has changed size or when IDirect3DDevice9::Present returns
96     // D3DERR_DEVICELOST. Returns true if the device was recovered, false if rendering must be
97     // aborted and reattempted soon.
98     enum ResetReason { ChangedWindowSize, LostDevice };
99     bool resetDevice(ResetReason);
100
101     void render(const Vector<CGRect>& dirtyRects = Vector<CGRect>());
102
103     WKCACFLayerRendererClient* m_client;
104     bool m_mightBeAbleToCreateDeviceLater;
105     COMPtr<IDirect3DDevice9> m_d3dDevice;
106     RefPtr<PlatformCALayer> m_rootLayer;
107     RefPtr<PlatformCALayer> m_rootChildLayer;
108     WKCACFContext* m_context;
109     HWND m_hostWindow;
110     Timer<WKCACFLayerRenderer> m_renderTimer;
111     bool m_mustResetLostDeviceBeforeRendering;
112     bool m_syncLayerChanges;
113     HashSet<RefPtr<PlatformCALayer> > m_pendingAnimatedLayers;
114
115 #ifndef NDEBUG
116     bool m_printTree;
117 #endif
118 };
119
120 }
121
122 #endif // USE(ACCELERATED_COMPOSITING)
123
124 #endif // WKCACFLayerRenderer_h