9c4dfb77b77114b0ef67b017bfa4bd223b3ab6a6
[WebKit-https.git] / Source / WebKit / chromium / public / platform / WebLayerTreeViewClient.h
1 /*
2  * Copyright (C) 2011 Google 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  *
8  * 1.  Redistributions of source code must retain the above copyright
9  *     notice, this list of conditions and the following disclaimer.
10  * 2.  Redistributions in binary form must reproduce the above copyright
11  *     notice, this list of conditions and the following disclaimer in the
12  *     documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
16  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
17  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
18  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
19  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
20  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
21  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
23  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #ifndef WebLayerTreeViewClient_h
27 #define WebLayerTreeViewClient_h
28
29 namespace WebKit {
30 class WebGraphicsContext3D;
31 struct WebSize;
32 class WebThread;
33
34 class WebLayerTreeViewClient {
35 public:
36     // Updates animation and layout. These are called before the compositing
37     // pass so that layers can be updated at the given frame time.
38     virtual void updateAnimations(double frameBeginTime) = 0;
39     virtual void layout() = 0;
40
41     // Applies a scroll delta to the root layer, which is bundled with a page
42     // scale factor that may apply a CSS transform on the whole document (used
43     // for mobile-device pinch zooming). This is triggered by events sent to the
44     // compositor thread through the WebCompositor interface.
45     virtual void applyScrollAndScale(const WebSize& scrollDelta, float scaleFactor) = 0;
46
47     // Creates a 3D context suitable for the compositing. This may be called
48     // more than once if the context gets lost.
49     virtual WebGraphicsContext3D* createContext3D() = 0;
50
51     // Signals a successful rebinding of the 3D context (e.g. after a lost
52     // context event).
53     virtual void didRebindGraphicsContext(bool success) = 0;
54
55     // Schedules a compositing pass, meaning the client should call
56     // WebLayerTreeView::composite at a later time. This is only called if the
57     // compositor thread is disabled; when enabled, the compositor will
58     // internally schedule a compositing pass when needed.
59     virtual void scheduleComposite() = 0;
60
61 protected:
62     virtual ~WebLayerTreeViewClient() { }
63 };
64
65 } // namespace WebKit
66
67 #endif // WebLayerTreeViewClient_h