Add CompositingReasons to compositor layer types.

cc/layers/layer_impl.cc

 // Copyright 2011 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #include "cc/layers/layer_impl.h"
 
 #include "base/debug/trace_event.h"
 #include "base/stringprintf.h"
 #include "cc/animation/animation_registrar.h"
 #include "cc/animation/scrollbar_animation_controller.h"
@@ skipping 36 matching lines @@
       masks_to_bounds_(false),
       contents_opaque_(false),
       opacity_(1.0),
       preserves_3d_(false),
       use_parent_backface_visibility_(false),
       draw_checkerboard_for_missing_tiles_(false),
       draws_content_(false),
       force_render_surface_(false),
       is_container_for_fixed_position_layers_(false),
       draw_depth_(0.f),
+      compositing_reasons_(kCompositingReasonUnknown),
 #ifndef NDEBUG
       between_will_draw_and_did_draw_(false),
 #endif
       horizontal_scrollbar_layer_(NULL),
       vertical_scrollbar_layer_(NULL) {
   DCHECK_GT(layer_id_, 0);
   DCHECK(layer_tree_impl_);
   layer_tree_impl_->RegisterLayer(this);
   AnimationRegistrar* registrar = layer_tree_impl_->animationRegistrar();
   layer_animation_controller_ =
@@ skipping 278 matching lines @@
 }
 
 void LayerImpl::PushPropertiesTo(LayerImpl* layer) {
   layer->SetAnchorPoint(anchor_point_);
   layer->SetAnchorPointZ(anchor_point_z_);
   layer->SetBackgroundColor(background_color_);
   layer->SetBounds(bounds_);
   layer->SetContentBounds(content_bounds());
   layer->SetContentsScale(contents_scale_x(), contents_scale_y());
   layer->SetDebugName(debug_name_);
+  layer->SetCompositingReasons(compositing_reasons_);
   layer->SetDoubleSided(double_sided_);
   layer->SetDrawCheckerboardForMissingTiles(
       draw_checkerboard_for_missing_tiles_);
   layer->SetForceRenderSurface(force_render_surface_);
   layer->SetDrawsContent(DrawsContent());
   layer->SetFilters(filters());
   layer->SetFilter(filter());
   layer->SetBackgroundFilters(background_filters());
   layer->SetMasksToBounds(masks_to_bounds_);
   layer->SetShouldScrollOnMainThread(should_scroll_on_main_thread_);
@@ skipping 629 matching lines @@
   if (horizontal_scrollbar_layer_)
     horizontal_scrollbar_layer_->set_scroll_layer_id(id());
 }
 
 void LayerImpl::SetVerticalScrollbarLayer(ScrollbarLayerImpl* scrollbar_layer) {
   vertical_scrollbar_layer_ = scrollbar_layer;
   if (vertical_scrollbar_layer_)
     vertical_scrollbar_layer_->set_scroll_layer_id(id());
 }
 
+scoped_ptr<base::Value>
+CompositingReasonsAsValue(CompositingReasons reasons) {

[danakj, 2013/05/25 13:34:00]

Is this method supposed to be static? Maybe it should be in the compositing
reasons header/cc file instead of here?

[shawnsingh, 2013/05/28 07:20:49]

For the sake of landing, I'm making it static but keeping it here.

Moving it to the reasons header/cc has some style issues that would require
another review; I'm happy to do it in a separate patch though.

+  scoped_ptr<base::ListValue> reason_list(new base::ListValue());
+
+  if (reasons == kCompositingReasonUnknown) {
+    reason_list->AppendString("No reasons given");
+    return reason_list.PassAs<base::Value>();
+  }
+
+  if (reasons & kCompositingReason3DTransform)
+    reason_list->AppendString("Has a 3d Transform");
+
+  if (reasons & kCompositingReasonVideo)
+    reason_list->AppendString("Is accelerated video");
+
+  if (reasons & kCompositingReasonCanvas)
+    reason_list->AppendString("Is accelerated canvas");
+
+  if (reasons & kCompositingReasonPlugin)
+    reason_list->AppendString("Is accelerated plugin");
+
+  if (reasons & kCompositingReasonIFrame)
+    reason_list->AppendString("Is accelerated iframe");
+
+  if (reasons & kCompositingReasonBackfaceVisibilityHidden)
+    reason_list->AppendString("Has backface-visibility: hidden");
+
+  if (reasons & kCompositingReasonAnimation)
+    reason_list->AppendString("Has accelerated animation or transition");
+
+  if (reasons & kCompositingReasonFilters)
+    reason_list->AppendString("Has accelerated filters");
+
+  if (reasons & kCompositingReasonPositionFixed)
+    reason_list->AppendString("Is fixed position");
+
+  if (reasons & kCompositingReasonPositionSticky)
+    reason_list->AppendString("Is sticky position");
+
+  if (reasons & kCompositingReasonOverflowScrollingTouch)
+    reason_list->AppendString("Is a scrollable overflow element");
+
+  if (reasons & kCompositingReasonBlending)
+    reason_list->AppendString("Has a blend mode");
+
+  if (reasons & kCompositingReasonAssumedOverlap)
+    reason_list->AppendString("Might overlap a composited animation");
+
+  if (reasons & kCompositingReasonOverlap)
+    reason_list->AppendString("Overlaps other composited content");
+
+  if (reasons & kCompositingReasonNegativeZIndexChildren) {
+    reason_list->AppendString("Might overlap negative z-index "
+                              "composited content");
+  }
+
+  if (reasons & kCompositingReasonTransformWithCompositedDescendants) {
+    reason_list->AppendString("Has transform needed by a "
+                              "composited descendant");
+  }
+
+  if (reasons & kCompositingReasonOpacityWithCompositedDescendants)
+    reason_list->AppendString("Has opacity needed by a composited descendant");
+
+  if (reasons & kCompositingReasonMaskWithCompositedDescendants)
+    reason_list->AppendString("Has a mask needed by a composited descendant");
+
+  if (reasons & kCompositingReasonReflectionWithCompositedDescendants)
+    reason_list->AppendString("Has a reflection with a composited descendant");
+
+  if (reasons & kCompositingReasonFilterWithCompositedDescendants)
+    reason_list->AppendString("Has filter effect with a composited descendant");
+
+  if (reasons & kCompositingReasonBlendingWithCompositedDescendants)
+    reason_list->AppendString("Has a blend mode with a composited descendant");
+
+  if (reasons & kCompositingReasonClipsCompositingDescendants)
+    reason_list->AppendString("Clips a composited descendant");
+
+  if (reasons & kCompositingReasonPerspective) {
+    reason_list->AppendString("Has a perspective transform needed by a "
+                              "composited 3d descendant");
+  }
+
+  if (reasons & kCompositingReasonPreserve3D) {
+    reason_list->AppendString("Has preserves-3d style with composited "
+                              "3d descendant");
+  }
+
+  if (reasons & kCompositingReasonReflectionOfCompositedParent)
+    reason_list->AppendString("Is the reflection of a composited layer");
+
+  if (reasons & kCompositingReasonRoot)
+    reason_list->AppendString("Is the root");
+
+  if (reasons & kCompositingReasonLayerForClip)
+    reason_list->AppendString("Convenience layer, to clip subtree");
+
+  if (reasons & kCompositingReasonLayerForScrollbar)
+    reason_list->AppendString("Convenience layer for rendering scrollbar");
+
+  if (reasons & kCompositingReasonLayerForScrollingContainer)
+    reason_list->AppendString("Convenience layer, the scrolling container");
+
+  if (reasons & kCompositingReasonLayerForForeground) {
+    reason_list->AppendString("Convenience layer, foreground when main layer "
+                              "has negative z-index composited content");
+  }
+
+  if (reasons & kCompositingReasonLayerForBackground) {
+    reason_list->AppendString("Convenience layer, background when main layer "
+                              "has a composited background");
+  }
+
+  if (reasons & kCompositingReasonLayerForMask)
+    reason_list->AppendString("Is a mask layer");
+
+  return reason_list.PassAs<base::Value>();
+}
+
 void LayerImpl::AsValueInto(base::DictionaryValue* state) const {
   TracedValue::MakeDictIntoImplicitSnapshot(state, LayerTypeAsString(), this);
   state->SetInteger("layer_id", id());
   state->Set("bounds", MathUtil::AsValue(bounds()).release());
   state->SetInteger("draws_content", DrawsContent());
   state->SetInteger("gpu_memory_usage", GPUMemoryUsageInBytes());
+  state->Set("compositing_reasons",
+             CompositingReasonsAsValue(compositing_reasons_).release());
 
   bool clipped;
   gfx::QuadF layer_quad = MathUtil::MapQuad(
       screen_space_transform(),
       gfx::QuadF(gfx::Rect(content_bounds())),
       &clipped);
   state->Set("layer_quad", MathUtil::AsValue(layer_quad).release());
 
 
   scoped_ptr<base::ListValue> children_list(new base::ListValue());
   for (size_t i = 0; i < children_.size(); ++i)
     children_list->Append(children_[i]->AsValue().release());
   state->Set("children", children_list.release());
   if (mask_layer_)
     state->Set("mask_layer", mask_layer_->AsValue().release());
   if (replica_layer_)
     state->Set("replica_layer", replica_layer_->AsValue().release());
 }
 
 size_t LayerImpl::GPUMemoryUsageInBytes() const { return 0; }
 
 scoped_ptr<base::Value> LayerImpl::AsValue() const {
   scoped_ptr<base::DictionaryValue> state(new base::DictionaryValue());
   AsValueInto(state.get());
   return state.PassAs<base::Value>();
 }
 
 }  // namespace cc