cc/debug_rect_history.h

   1 // Copyright 2012 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef CC_DEBUG_RECT_HISTORY_H_
   6 #define CC_DEBUG_RECT_HISTORY_H_
   7
   8 #include "base/basictypes.h"
   9 #include "base/memory/scoped_ptr.h"
  10 #include "ui/gfx/rect.h"
  11 #include "ui/gfx/rect_f.h"
  12 #include <vector>
  13
  14 namespace cc {
  15
  16 class LayerImpl;
  17 struct LayerTreeSettings;
  18
  19 // There are currently six types of debug rects:
  20 //
  21 // - Paint rects (update rects): regions of a layer that needed to be re-uploaded to the
  22 //   texture resource; in most cases implying that they had to be repainted, too.
  23 //
  24 // - Property-changed rects: enclosing bounds of layers that cause changes to the screen
  25 //   even if the layer did not change internally. (For example, if the layer's opacity or
  26 //   position changes.)
  27 //
  28 // - Surface damage rects: the aggregate damage on a target surface that is caused by all
  29 //   layers and surfaces that contribute to it. This includes (1) paint rects, (2) property-
  30 //   changed rects, and (3) newly exposed areas.
  31 //
  32 // - Screen space rects: this is the region the contents occupy in screen space.
  33 //
  34 // - Replica screen space rects: this is the region the replica's contents occupy in screen space.
  35 //
  36 // - Occluding rects: these are the regions that contribute to the occluded region.
  37 //
  38 // - Non-Occluding rects: these are the regions of composited layers that do not
  39 //   contribute to the occluded region.
  40 //
  41 enum DebugRectType { PaintRectType, PropertyChangedRectType, SurfaceDamageRectType, ScreenSpaceRectType, ReplicaScreenSpaceRectType, OccludingRectType, NonOccludingRectType };
  42
  43 struct DebugRect {
  44     DebugRect(DebugRectType newType, gfx::RectF newRect)
  45             : type(newType)
  46             , rect(newRect) { }
  47
  48     DebugRectType type;
  49     gfx::RectF rect;
  50 };
  51
  52 // This class maintains a history of rects of various types that can be used
  53 // for debugging purposes. The overhead of collecting rects is performed only if
  54 // the appropriate LayerTreeSettings are enabled.
  55 class DebugRectHistory {
  56 public:
  57     static scoped_ptr<DebugRectHistory> create();
  58
  59     ~DebugRectHistory();
  60
  61     // Note: Saving debug rects must happen before layers' change tracking is reset.
  62     void saveDebugRectsForCurrentFrame(LayerImpl* rootLayer, const std::vector<LayerImpl*>& renderSurfaceLayerList, const std::vector<gfx::Rect>& occludingScreenSpaceRects, const std::vector<gfx::Rect>& nonOccludingScreenSpaceRects, const LayerTreeSettings&);
  63
  64     const std::vector<DebugRect>& debugRects() { return m_debugRects; }
  65
  66 private:
  67     DebugRectHistory();
  68
  69     void savePaintRects(LayerImpl*);
  70     void savePropertyChangedRects(const std::vector<LayerImpl*>& renderSurfaceLayerList);
  71     void saveSurfaceDamageRects(const std::vector<LayerImpl* >& renderSurfaceLayerList);
  72     void saveScreenSpaceRects(const std::vector<LayerImpl* >& renderSurfaceLayerList);
  73     void saveOccludingRects(const std::vector<gfx::Rect>& occludingScreenSpaceRects);
  74     void saveNonOccludingRects(const std::vector<gfx::Rect>& nonOccludingScreenSpaceRects);
  75
  76     std::vector<DebugRect> m_debugRects;
  77
  78     DISALLOW_COPY_AND_ASSIGN(DebugRectHistory);
  79 };
  80
  81 }  // namespace cc
  82
  83 #endif  // CC_DEBUG_RECT_HISTORY_H_