cc/debug/debug_rect_history.cc

   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 #include "cc/debug/debug_rect_history.h"
   6
   7 #include "cc/base/math_util.h"
   8 #include "cc/layers/layer_impl.h"
   9 #include "cc/layers/layer_iterator.h"
  10 #include "cc/layers/layer_utils.h"
  11 #include "cc/layers/render_surface_impl.h"
  12 #include "cc/trees/damage_tracker.h"
  13 #include "cc/trees/layer_tree_host.h"
  14 #include "cc/trees/layer_tree_host_common.h"
  15 #include "ui/gfx/geometry/rect_conversions.h"
  16
  17 namespace cc {
  18
  19 // static
  20 scoped_ptr<DebugRectHistory> DebugRectHistory::Create() {
  21   return make_scoped_ptr(new DebugRectHistory());
  22 }
  23
  24 DebugRectHistory::DebugRectHistory() {}
  25
  26 DebugRectHistory::~DebugRectHistory() {}
  27
  28 void DebugRectHistory::SaveDebugRectsForCurrentFrame(
  29     LayerImpl* root_layer,
  30     LayerImpl* hud_layer,
  31     const LayerImplList& render_surface_layer_list,
  32     const LayerTreeDebugState& debug_state) {
  33   // For now, clear all rects from previous frames. In the future we may want to
  34   // store all debug rects for a history of many frames.
  35   debug_rects_.clear();
  36
  37   if (debug_state.show_touch_event_handler_rects)
  38     SaveTouchEventHandlerRects(root_layer);
  39
  40   if (debug_state.show_wheel_event_handler_rects)
  41     SaveWheelEventHandlerRects(root_layer);
  42
  43   if (debug_state.show_scroll_event_handler_rects)
  44     SaveScrollEventHandlerRects(root_layer);
  45
  46   if (debug_state.show_non_fast_scrollable_rects)
  47     SaveNonFastScrollableRects(root_layer);
  48
  49   if (debug_state.show_paint_rects)
  50     SavePaintRects(root_layer);
  51
  52   if (debug_state.show_property_changed_rects)
  53     SavePropertyChangedRects(render_surface_layer_list, hud_layer);
  54
  55   if (debug_state.show_surface_damage_rects)
  56     SaveSurfaceDamageRects(render_surface_layer_list);
  57
  58   if (debug_state.show_screen_space_rects)
  59     SaveScreenSpaceRects(render_surface_layer_list);
  60
  61   if (debug_state.show_layer_animation_bounds_rects)
  62     SaveLayerAnimationBoundsRects(render_surface_layer_list);
  63 }
  64
  65 void DebugRectHistory::SavePaintRects(LayerImpl* layer) {
  66   // We would like to visualize where any layer's paint rect (update rect) has
  67   // changed, regardless of whether this layer is skipped for actual drawing or
  68   // not. Therefore we traverse recursively over all layers, not just the render
  69   // surface list.
  70
  71   if (!layer->update_rect().IsEmpty() && layer->DrawsContent()) {
  72     float width_scale = layer->content_bounds().width() /
  73                         static_cast<float>(layer->bounds().width());
  74     float height_scale = layer->content_bounds().height() /
  75                          static_cast<float>(layer->bounds().height());
  76     gfx::Rect update_content_rect = gfx::ScaleToEnclosingRect(
  77         layer->update_rect(), width_scale, height_scale);
  78     debug_rects_.push_back(
  79         DebugRect(PAINT_RECT_TYPE,
  80                   MathUtil::MapEnclosingClippedRect(
  81                       layer->screen_space_transform(), update_content_rect)));
  82   }
  83
  84   for (unsigned i = 0; i < layer->children().size(); ++i)
  85     SavePaintRects(layer->children()[i]);
  86 }
  87
  88 void DebugRectHistory::SavePropertyChangedRects(
  89     const LayerImplList& render_surface_layer_list,
  90     LayerImpl* hud_layer) {
  91   for (int surface_index = render_surface_layer_list.size() - 1;
  92        surface_index >= 0;
  93        --surface_index) {
  94     LayerImpl* render_surface_layer = render_surface_layer_list[surface_index];
  95     RenderSurfaceImpl* render_surface = render_surface_layer->render_surface();
  96     DCHECK(render_surface);
  97
  98     const LayerImplList& layer_list = render_surface->layer_list();
  99     for (unsigned layer_index = 0;
 100          layer_index < layer_list.size();
 101          ++layer_index) {
 102       LayerImpl* layer = layer_list[layer_index];
 103
 104       if (LayerTreeHostCommon::RenderSurfaceContributesToTarget<LayerImpl>(
 105               layer, render_surface_layer->id()))
 106         continue;
 107
 108       if (layer == hud_layer)
 109         continue;
 110
 111       if (!layer->LayerPropertyChanged())
 112         continue;
 113
 114       debug_rects_.push_back(
 115           DebugRect(PROPERTY_CHANGED_RECT_TYPE,
 116                     MathUtil::MapEnclosingClippedRect(
 117                         layer->screen_space_transform(),
 118                         gfx::Rect(layer->content_bounds()))));
 119     }
 120   }
 121 }
 122
 123 void DebugRectHistory::SaveSurfaceDamageRects(
 124     const LayerImplList& render_surface_layer_list) {
 125   for (int surface_index = render_surface_layer_list.size() - 1;
 126        surface_index >= 0;
 127        --surface_index) {
 128     LayerImpl* render_surface_layer = render_surface_layer_list[surface_index];
 129     RenderSurfaceImpl* render_surface = render_surface_layer->render_surface();
 130     DCHECK(render_surface);
 131
 132     debug_rects_.push_back(DebugRect(
 133         SURFACE_DAMAGE_RECT_TYPE,
 134         MathUtil::MapEnclosingClippedRect(
 135             render_surface->screen_space_transform(),
 136             render_surface->damage_tracker()->current_damage_rect())));
 137   }
 138 }
 139
 140 void DebugRectHistory::SaveScreenSpaceRects(
 141     const LayerImplList& render_surface_layer_list) {
 142   for (int surface_index = render_surface_layer_list.size() - 1;
 143        surface_index >= 0;
 144        --surface_index) {
 145     LayerImpl* render_surface_layer = render_surface_layer_list[surface_index];
 146     RenderSurfaceImpl* render_surface = render_surface_layer->render_surface();
 147     DCHECK(render_surface);
 148
 149     debug_rects_.push_back(
 150         DebugRect(SCREEN_SPACE_RECT_TYPE,
 151                   MathUtil::MapEnclosingClippedRect(
 152                       render_surface->screen_space_transform(),
 153                       render_surface->content_rect())));
 154
 155     if (render_surface_layer->replica_layer()) {
 156       debug_rects_.push_back(
 157           DebugRect(REPLICA_SCREEN_SPACE_RECT_TYPE,
 158                     MathUtil::MapEnclosingClippedRect(
 159                         render_surface->replica_screen_space_transform(),
 160                         render_surface->content_rect())));
 161     }
 162   }
 163 }
 164
 165 void DebugRectHistory::SaveTouchEventHandlerRects(LayerImpl* layer) {
 166   LayerTreeHostCommon::CallFunctionForSubtree<LayerImpl>(
 167       layer,
 168       base::Bind(&DebugRectHistory::SaveTouchEventHandlerRectsCallback,
 169                  base::Unretained(this)));
 170 }
 171
 172 void DebugRectHistory::SaveTouchEventHandlerRectsCallback(LayerImpl* layer) {
 173   for (Region::Iterator iter(layer->touch_event_handler_region());
 174        iter.has_rect();
 175        iter.next()) {
 176     gfx::Rect touch_rect = gfx::ScaleToEnclosingRect(
 177         iter.rect(), layer->contents_scale_x(), layer->contents_scale_y());
 178     debug_rects_.push_back(
 179         DebugRect(TOUCH_EVENT_HANDLER_RECT_TYPE,
 180                   MathUtil::MapEnclosingClippedRect(
 181                       layer->screen_space_transform(), touch_rect)));
 182   }
 183 }
 184
 185 void DebugRectHistory::SaveWheelEventHandlerRects(LayerImpl* layer) {
 186   LayerTreeHostCommon::CallFunctionForSubtree<LayerImpl>(
 187       layer,
 188       base::Bind(&DebugRectHistory::SaveWheelEventHandlerRectsCallback,
 189                  base::Unretained(this)));
 190 }
 191
 192 void DebugRectHistory::SaveWheelEventHandlerRectsCallback(LayerImpl* layer) {
 193   if (!layer->have_wheel_event_handlers())
 194     return;
 195
 196   gfx::Rect wheel_rect =
 197       gfx::ScaleToEnclosingRect(gfx::Rect(layer->content_bounds()),
 198                                 layer->contents_scale_x(),
 199                                 layer->contents_scale_y());
 200   debug_rects_.push_back(
 201       DebugRect(WHEEL_EVENT_HANDLER_RECT_TYPE,
 202                 MathUtil::MapEnclosingClippedRect(
 203                     layer->screen_space_transform(), wheel_rect)));
 204 }
 205
 206 void DebugRectHistory::SaveScrollEventHandlerRects(LayerImpl* layer) {
 207   LayerTreeHostCommon::CallFunctionForSubtree<LayerImpl>(
 208       layer,
 209       base::Bind(&DebugRectHistory::SaveScrollEventHandlerRectsCallback,
 210                  base::Unretained(this)));
 211 }
 212
 213 void DebugRectHistory::SaveScrollEventHandlerRectsCallback(LayerImpl* layer) {
 214   if (!layer->have_scroll_event_handlers())
 215     return;
 216
 217   gfx::Rect scroll_rect =
 218       gfx::ScaleToEnclosingRect(gfx::Rect(layer->content_bounds()),
 219                                 layer->contents_scale_x(),
 220                                 layer->contents_scale_y());
 221   debug_rects_.push_back(
 222       DebugRect(SCROLL_EVENT_HANDLER_RECT_TYPE,
 223                 MathUtil::MapEnclosingClippedRect(
 224                     layer->screen_space_transform(), scroll_rect)));
 225 }
 226
 227 void DebugRectHistory::SaveNonFastScrollableRects(LayerImpl* layer) {
 228   LayerTreeHostCommon::CallFunctionForSubtree<LayerImpl>(
 229       layer,
 230       base::Bind(&DebugRectHistory::SaveNonFastScrollableRectsCallback,
 231                  base::Unretained(this)));
 232 }
 233
 234 void DebugRectHistory::SaveNonFastScrollableRectsCallback(LayerImpl* layer) {
 235   for (Region::Iterator iter(layer->non_fast_scrollable_region());
 236        iter.has_rect();
 237        iter.next()) {
 238     gfx::Rect scroll_rect = gfx::ScaleToEnclosingRect(
 239         iter.rect(), layer->contents_scale_x(), layer->contents_scale_y());
 240     debug_rects_.push_back(
 241         DebugRect(NON_FAST_SCROLLABLE_RECT_TYPE,
 242                   MathUtil::MapEnclosingClippedRect(
 243                       layer->screen_space_transform(), scroll_rect)));
 244   }
 245 }
 246
 247 void DebugRectHistory::SaveLayerAnimationBoundsRects(
 248     const LayerImplList& render_surface_layer_list) {
 249   typedef LayerIterator<LayerImpl> LayerIteratorType;
 250   LayerIteratorType end = LayerIteratorType::End(&render_surface_layer_list);
 251   for (LayerIteratorType it =
 252            LayerIteratorType::Begin(&render_surface_layer_list);
 253        it != end; ++it) {
 254     if (!it.represents_itself())
 255       continue;
 256
 257     // TODO(avallee): Figure out if we should show something for a layer who's
 258     // animating bounds but that we can't compute them.
 259     gfx::BoxF inflated_bounds;
 260     if (!LayerUtils::GetAnimationBounds(**it, &inflated_bounds))
 261       continue;
 262
 263     debug_rects_.push_back(
 264         DebugRect(ANIMATION_BOUNDS_RECT_TYPE,
 265                   gfx::ToEnclosingRect(gfx::RectF(inflated_bounds.x(),
 266                                                   inflated_bounds.y(),
 267                                                   inflated_bounds.width(),
 268                                                   inflated_bounds.height()))));
 269   }
 270 }
 271
 272 }  // namespace cc