489ca569c5255389ccf302a4c38cd87f620cc1f4
[WebKit-https.git] / Source / WebCore / platform / graphics / chromium / cc / CCOverdrawMetrics.h
1 /*
2  * Copyright (C) 2012 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  * 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'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
15  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
16  * DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY
17  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
18  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
19  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
20  * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
21  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
22  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
23  */
24
25 #ifndef CCOverdrawMetrics_h
26 #define CCOverdrawMetrics_h
27
28 #include <wtf/PassOwnPtr.h>
29
30 namespace WebCore {
31 class IntRect;
32 class TransformationMatrix;
33 class CCLayerTreeHost;
34 class CCLayerTreeHostImpl;
35
36 // FIXME: compute overdraw metrics only occasionally, not every frame.
37 class CCOverdrawMetrics {
38 public:
39     static PassOwnPtr<CCOverdrawMetrics> create() { return adoptPtr(new CCOverdrawMetrics()); }
40
41     void didCull(const TransformationMatrix& transformToTarget, const IntRect& beforeCullRect, const IntRect& afterCullRect);
42     void didDraw(const TransformationMatrix& transformToTarget, const IntRect& afterCullRect, const IntRect& opaqueRect);
43
44     void recordMetrics(const CCLayerTreeHost*) const;
45     void recordMetrics(const CCLayerTreeHostImpl*) const;
46
47     // Accessors for tests.
48     float pixelsDrawnOpaque() const { return m_pixelsDrawnOpaque; }
49     float pixelsDrawnTranslucent() const { return m_pixelsDrawnTranslucent; }
50     float pixelsCulled() const { return m_pixelsCulled; }
51
52 private:
53     CCOverdrawMetrics();
54
55     enum MetricsType {
56         DRAWING,
57         UPLOADING
58     };
59
60     template<typename LayerTreeHostType>
61     void recordMetricsInternal(MetricsType, const LayerTreeHostType*) const;
62
63     // Count of pixels that are opaque (and thus occlude). Ideally this is no more
64     // than wiewport width x height.
65     float m_pixelsDrawnOpaque;
66     // Count of pixels that are possibly translucent, and cannot occlude.
67     float m_pixelsDrawnTranslucent;
68     // Count of pixels not drawn as they are occluded by somthing opaque.
69     float m_pixelsCulled;
70 };
71
72 } // namespace WebCore
73
74 #endif