Rubber-banding should not affect the visibleRect of the TileCache
[WebKit-https.git] / Source / WebCore / platform / graphics / GraphicsLayerClient.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 GraphicsLayerClient_h
27 #define GraphicsLayerClient_h
28
29 #if USE(ACCELERATED_COMPOSITING)
30
31 namespace WebCore {
32
33 class FloatPoint;
34 class GraphicsContext;
35 class GraphicsLayer;
36 class IntPoint;
37 class IntRect;
38 class TransformationMatrix;
39
40 enum GraphicsLayerPaintingPhaseFlags {
41     GraphicsLayerPaintBackground = (1 << 0),
42     GraphicsLayerPaintForeground = (1 << 1),
43     GraphicsLayerPaintMask = (1 << 2),
44     GraphicsLayerPaintOverflowContents = (1 << 3),
45     GraphicsLayerPaintAllWithOverflowClip = (GraphicsLayerPaintBackground | GraphicsLayerPaintForeground | GraphicsLayerPaintMask)
46 };
47 typedef unsigned GraphicsLayerPaintingPhase;
48
49 enum AnimatedPropertyID {
50     AnimatedPropertyInvalid,
51     AnimatedPropertyWebkitTransform,
52     AnimatedPropertyOpacity,
53     AnimatedPropertyBackgroundColor,
54     AnimatedPropertyWebkitFilter
55 };
56
57 class GraphicsLayerClient {
58 public:
59     virtual ~GraphicsLayerClient() {}
60
61     virtual bool shouldUseTileCache(const GraphicsLayer*) const { return false; }
62     
63     // Callback for when hardware-accelerated animation started.
64     virtual void notifyAnimationStarted(const GraphicsLayer*, double time) = 0;
65
66     // Notification that a layer property changed that requires a subsequent call to flushCompositingState()
67     // to appear on the screen.
68     virtual void notifyFlushRequired(const GraphicsLayer*) = 0;
69     
70     // Notification that this layer requires a flush before the next display refresh.
71     virtual void notifyFlushBeforeDisplayRefresh(const GraphicsLayer*) { }
72
73     virtual void paintContents(const GraphicsLayer*, GraphicsContext&, GraphicsLayerPaintingPhase, const IntRect& inClip) = 0;
74     virtual void didCommitChangesForLayer(const GraphicsLayer*) const { }
75
76     // Provides current transform (taking transform-origin and animations into account). Input matrix has been
77     // initialized to identity already. Returns false if the layer has no transform.
78     virtual bool getCurrentTransform(const GraphicsLayer*, TransformationMatrix&) const { return false; }
79
80     // Allows the client to modify a layer position used during the visibleRect calculation, for example to ignore
81     // scroll overhang.
82     virtual void customPositionForVisibleRectComputation(const GraphicsLayer*, FloatPoint&) const { }
83
84     // Multiplier for backing store size, related to high DPI.
85     virtual float deviceScaleFactor() const { return 1; }
86     // Page scale factor.
87     virtual float pageScaleFactor() const { return 1; }
88
89     virtual bool isTrackingRepaints() const { return false; }
90
91 #ifndef NDEBUG
92     // RenderLayerBacking overrides this to verify that it is not
93     // currently painting contents. An ASSERT fails, if it is.
94     // This is executed in GraphicsLayer construction and destruction
95     // to verify that we don't create or destroy GraphicsLayers
96     // while painting.
97     virtual void verifyNotPainting() { }
98 #endif
99
100 #if PLATFORM(BLACKBERRY)
101     virtual bool contentsVisible(const GraphicsLayer*, const IntRect& contentRect) const { return false; }
102 #endif
103 };
104
105 } // namespace WebCore
106
107 #endif // USE(ACCELERATED_COMPOSITING)
108
109 #endif // GraphicsLayerClient_h