cc/layers/layer.h

   1 // Copyright 2010 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_LAYERS_LAYER_H_
   6 #define CC_LAYERS_LAYER_H_
   7
   8 #include <set>
   9 #include <string>
  10 #include <vector>
  11
  12 #include "base/callback.h"
  13 #include "base/memory/ref_counted.h"
  14 #include "base/observer_list.h"
  15 #include "cc/animation/layer_animation_controller.h"
  16 #include "cc/animation/layer_animation_value_observer.h"
  17 #include "cc/animation/layer_animation_value_provider.h"
  18 #include "cc/base/cc_export.h"
  19 #include "cc/base/region.h"
  20 #include "cc/base/scoped_ptr_vector.h"
  21 #include "cc/debug/frame_timing_request.h"
  22 #include "cc/debug/micro_benchmark.h"
  23 #include "cc/layers/draw_properties.h"
  24 #include "cc/layers/layer_lists.h"
  25 #include "cc/layers/layer_position_constraint.h"
  26 #include "cc/layers/paint_properties.h"
  27 #include "cc/layers/render_surface.h"
  28 #include "cc/layers/scroll_blocks_on.h"
  29 #include "cc/output/filter_operations.h"
  30 #include "cc/trees/property_tree.h"
  31 #include "skia/ext/refptr.h"
  32 #include "third_party/skia/include/core/SkColor.h"
  33 #include "third_party/skia/include/core/SkImageFilter.h"
  34 #include "third_party/skia/include/core/SkPicture.h"
  35 #include "third_party/skia/include/core/SkXfermode.h"
  36 #include "ui/gfx/geometry/point3_f.h"
  37 #include "ui/gfx/geometry/rect.h"
  38 #include "ui/gfx/geometry/rect_f.h"
  39 #include "ui/gfx/geometry/scroll_offset.h"
  40 #include "ui/gfx/transform.h"
  41
  42 namespace gfx {
  43 class BoxF;
  44 }
  45
  46 namespace base {
  47 namespace trace_event {
  48 class ConvertableToTraceFormat;
  49 }
  50 }
  51
  52 namespace cc {
  53
  54 class Animation;
  55 class AnimationDelegate;
  56 struct AnimationEvent;
  57 class CopyOutputRequest;
  58 class LayerAnimationEventObserver;
  59 class LayerClient;
  60 class LayerImpl;
  61 class LayerSettings;
  62 class LayerTreeHost;
  63 class LayerTreeHostCommon;
  64 class LayerTreeImpl;
  65 class LayerTreeSettings;
  66 class PriorityCalculator;
  67 class RenderingStatsInstrumentation;
  68 class ResourceUpdateQueue;
  69 class ScrollbarLayerInterface;
  70 class SimpleEnclosedRegion;
  71 struct AnimationEvent;
  72
  73 // Base class for composited layers. Special layer types are derived from
  74 // this class.
  75 class CC_EXPORT Layer : public base::RefCounted<Layer>,
  76                         public LayerAnimationValueObserver,
  77                         public LayerAnimationValueProvider {
  78  public:
  79   typedef RenderSurfaceLayerList RenderSurfaceListType;
  80   typedef LayerList LayerListType;
  81   typedef RenderSurface RenderSurfaceType;
  82
  83   enum LayerIdLabels {
  84     INVALID_ID = -1,
  85   };
  86
  87   static scoped_refptr<Layer> Create(const LayerSettings& settings);
  88
  89   int id() const { return layer_id_; }
  90
  91   Layer* RootLayer();
  92   Layer* parent() { return parent_; }
  93   const Layer* parent() const { return parent_; }
  94   void AddChild(scoped_refptr<Layer> child);
  95   void InsertChild(scoped_refptr<Layer> child, size_t index);
  96   void ReplaceChild(Layer* reference, scoped_refptr<Layer> new_layer);
  97   void RemoveFromParent();
  98   void RemoveAllChildren();
  99   void SetChildren(const LayerList& children);
 100   bool HasAncestor(const Layer* ancestor) const;
 101
 102   const LayerList& children() const { return children_; }
 103   Layer* child_at(size_t index) { return children_[index].get(); }
 104
 105   // This requests the layer and its subtree be rendered and given to the
 106   // callback. If the copy is unable to be produced (the layer is destroyed
 107   // first), then the callback is called with a nullptr/empty result. If the
 108   // request's source property is set, any prior uncommitted requests having the
 109   // same source will be aborted.
 110   void RequestCopyOfOutput(scoped_ptr<CopyOutputRequest> request);
 111   bool HasCopyRequest() const {
 112     return !copy_requests_.empty();
 113   }
 114
 115   virtual void SetBackgroundColor(SkColor background_color);
 116   SkColor background_color() const { return background_color_; }
 117   // If contents_opaque(), return an opaque color else return a
 118   // non-opaque color.  Tries to return background_color(), if possible.
 119   SkColor SafeOpaqueBackgroundColor() const;
 120
 121   // A layer's bounds are in logical, non-page-scaled pixels (however, the
 122   // root layer's bounds are in physical pixels).
 123   void SetBounds(const gfx::Size& bounds);
 124   gfx::Size bounds() const { return bounds_; }
 125
 126   void SetMasksToBounds(bool masks_to_bounds);
 127   bool masks_to_bounds() const { return masks_to_bounds_; }
 128
 129   void SetMaskLayer(Layer* mask_layer);
 130   Layer* mask_layer() { return mask_layer_.get(); }
 131   const Layer* mask_layer() const { return mask_layer_.get(); }
 132
 133   virtual void SetNeedsDisplayRect(const gfx::Rect& dirty_rect);
 134   void SetNeedsDisplay() { SetNeedsDisplayRect(gfx::Rect(bounds())); }
 135
 136   void SetOpacity(float opacity);
 137   float opacity() const { return opacity_; }
 138   bool OpacityIsAnimating() const;
 139   virtual bool OpacityCanAnimateOnImplThread() const;
 140
 141   void SetBlendMode(SkXfermode::Mode blend_mode);
 142   SkXfermode::Mode blend_mode() const { return blend_mode_; }
 143
 144   bool uses_default_blend_mode() const {
 145     return blend_mode_ == SkXfermode::kSrcOver_Mode;
 146   }
 147
 148   // A layer is root for an isolated group when it and all its descendants are
 149   // drawn over a black and fully transparent background, creating an isolated
 150   // group. It should be used along with SetBlendMode(), in order to restrict
 151   // layers within the group to blend with layers outside this group.
 152   void SetIsRootForIsolatedGroup(bool root);
 153   bool is_root_for_isolated_group() const {
 154     return is_root_for_isolated_group_;
 155   }
 156
 157   void SetFilters(const FilterOperations& filters);
 158   const FilterOperations& filters() const { return filters_; }
 159   bool FilterIsAnimating() const;
 160
 161   // Background filters are filters applied to what is behind this layer, when
 162   // they are viewed through non-opaque regions in this layer. They are used
 163   // through the WebLayer interface, and are not exposed to HTML.
 164   void SetBackgroundFilters(const FilterOperations& filters);
 165   const FilterOperations& background_filters() const {
 166     return background_filters_;
 167   }
 168
 169   virtual void SetContentsOpaque(bool opaque);
 170   bool contents_opaque() const { return contents_opaque_; }
 171
 172   void SetPosition(const gfx::PointF& position);
 173   gfx::PointF position() const { return position_; }
 174
 175   // A layer that is a container for fixed position layers cannot be both
 176   // scrollable and have a non-identity transform.
 177   void SetIsContainerForFixedPositionLayers(bool container);
 178   bool IsContainerForFixedPositionLayers() const;
 179
 180   gfx::Vector2dF FixedContainerSizeDelta() const {
 181     return gfx::Vector2dF();
 182   }
 183
 184   void SetPositionConstraint(const LayerPositionConstraint& constraint);
 185   const LayerPositionConstraint& position_constraint() const {
 186     return position_constraint_;
 187   }
 188
 189   void SetTransform(const gfx::Transform& transform);
 190   const gfx::Transform& transform() const { return transform_; }
 191   bool TransformIsAnimating() const;
 192   bool AnimationsPreserveAxisAlignment() const;
 193   bool transform_is_invertible() const { return transform_is_invertible_; }
 194
 195   void SetTransformOrigin(const gfx::Point3F&);
 196   gfx::Point3F transform_origin() const { return transform_origin_; }
 197
 198   void SetScrollParent(Layer* parent);
 199
 200   Layer* scroll_parent() { return scroll_parent_; }
 201   const Layer* scroll_parent() const { return scroll_parent_; }
 202
 203   void AddScrollChild(Layer* child);
 204   void RemoveScrollChild(Layer* child);
 205
 206   std::set<Layer*>* scroll_children() { return scroll_children_.get(); }
 207   const std::set<Layer*>* scroll_children() const {
 208     return scroll_children_.get();
 209   }
 210
 211   void SetClipParent(Layer* ancestor);
 212
 213   Layer* clip_parent() { return clip_parent_; }
 214   const Layer* clip_parent() const {
 215     return clip_parent_;
 216   }
 217
 218   void AddClipChild(Layer* child);
 219   void RemoveClipChild(Layer* child);
 220
 221   std::set<Layer*>* clip_children() { return clip_children_.get(); }
 222   const std::set<Layer*>* clip_children() const {
 223     return clip_children_.get();
 224   }
 225
 226   DrawProperties<Layer>& draw_properties() { return draw_properties_; }
 227   const DrawProperties<Layer>& draw_properties() const {
 228     return draw_properties_;
 229   }
 230
 231   // The following are shortcut accessors to get various information from
 232   // draw_properties_
 233   const gfx::Transform& draw_transform() const {
 234     return draw_properties_.target_space_transform;
 235   }
 236   const gfx::Transform& screen_space_transform() const {
 237     return draw_properties_.screen_space_transform;
 238   }
 239   float draw_opacity() const { return draw_properties_.opacity; }
 240   bool draw_opacity_is_animating() const {
 241     return draw_properties_.opacity_is_animating;
 242   }
 243   bool draw_transform_is_animating() const {
 244     return draw_properties_.target_space_transform_is_animating;
 245   }
 246   bool screen_space_transform_is_animating() const {
 247     return draw_properties_.screen_space_transform_is_animating;
 248   }
 249   bool screen_space_opacity_is_animating() const {
 250     return draw_properties_.screen_space_opacity_is_animating;
 251   }
 252   bool is_clipped() const { return draw_properties_.is_clipped; }
 253   gfx::Rect clip_rect() const { return draw_properties_.clip_rect; }
 254   gfx::Rect drawable_content_rect() const {
 255     return draw_properties_.drawable_content_rect;
 256   }
 257   gfx::Rect visible_content_rect() const {
 258     return draw_properties_.visible_content_rect;
 259   }
 260   Layer* render_target() {
 261     DCHECK(!draw_properties_.render_target ||
 262            draw_properties_.render_target->render_surface());
 263     return draw_properties_.render_target;
 264   }
 265   const Layer* render_target() const {
 266     DCHECK(!draw_properties_.render_target ||
 267            draw_properties_.render_target->render_surface());
 268     return draw_properties_.render_target;
 269   }
 270   size_t num_unclipped_descendants() const {
 271     return draw_properties_.num_unclipped_descendants;
 272   }
 273
 274   RenderSurface* render_surface() const { return render_surface_.get(); }
 275   void SetScrollOffset(const gfx::ScrollOffset& scroll_offset);
 276   void SetScrollCompensationAdjustment(
 277       const gfx::Vector2dF& scroll_compensation_adjustment);
 278   gfx::Vector2dF ScrollCompensationAdjustment() const;
 279
 280   gfx::ScrollOffset scroll_offset() const { return scroll_offset_; }
 281   void SetScrollOffsetFromImplSide(const gfx::ScrollOffset& scroll_offset);
 282
 283   void SetScrollClipLayerId(int clip_layer_id);
 284   bool scrollable() const { return scroll_clip_layer_id_ != INVALID_ID; }
 285
 286   void SetUserScrollable(bool horizontal, bool vertical);
 287   bool user_scrollable_horizontal() const {
 288     return user_scrollable_horizontal_;
 289   }
 290   bool user_scrollable_vertical() const { return user_scrollable_vertical_; }
 291
 292   void SetShouldScrollOnMainThread(bool should_scroll_on_main_thread);
 293   bool should_scroll_on_main_thread() const {
 294     return should_scroll_on_main_thread_;
 295   }
 296
 297   void SetHaveWheelEventHandlers(bool have_wheel_event_handlers);
 298   bool have_wheel_event_handlers() const { return have_wheel_event_handlers_; }
 299
 300   void SetHaveScrollEventHandlers(bool have_scroll_event_handlers);
 301   bool have_scroll_event_handlers() const {
 302     return have_scroll_event_handlers_;
 303   }
 304
 305   void SetNonFastScrollableRegion(const Region& non_fast_scrollable_region);
 306   const Region& non_fast_scrollable_region() const {
 307     return non_fast_scrollable_region_;
 308   }
 309
 310   void SetTouchEventHandlerRegion(const Region& touch_event_handler_region);
 311   const Region& touch_event_handler_region() const {
 312     return touch_event_handler_region_;
 313   }
 314
 315   void SetScrollBlocksOn(ScrollBlocksOn scroll_blocks_on);
 316   ScrollBlocksOn scroll_blocks_on() const { return scroll_blocks_on_; }
 317
 318   void set_did_scroll_callback(const base::Closure& callback) {
 319     did_scroll_callback_ = callback;
 320   }
 321
 322   void SetDrawCheckerboardForMissingTiles(bool checkerboard);
 323   bool draw_checkerboard_for_missing_tiles() const {
 324     return draw_checkerboard_for_missing_tiles_;
 325   }
 326
 327   void SetForceRenderSurface(bool force_render_surface);
 328   bool force_render_surface() const { return force_render_surface_; }
 329
 330   gfx::Vector2dF ScrollDelta() const { return gfx::Vector2dF(); }
 331   gfx::ScrollOffset CurrentScrollOffset() const { return scroll_offset_; }
 332
 333   void SetDoubleSided(bool double_sided);
 334   bool double_sided() const { return double_sided_; }
 335
 336   void SetShouldFlattenTransform(bool flatten);
 337   bool should_flatten_transform() const { return should_flatten_transform_; }
 338
 339   bool Is3dSorted() const { return sorting_context_id_ != 0; }
 340
 341   void set_use_parent_backface_visibility(bool use) {
 342     use_parent_backface_visibility_ = use;
 343   }
 344   bool use_parent_backface_visibility() const {
 345     return use_parent_backface_visibility_;
 346   }
 347
 348   virtual void SetLayerTreeHost(LayerTreeHost* host);
 349
 350   virtual bool HasDelegatedContent() const;
 351   bool HasContributingDelegatedRenderPasses() const { return false; }
 352
 353   void SetIsDrawable(bool is_drawable);
 354
 355   void SetHideLayerAndSubtree(bool hide);
 356   bool hide_layer_and_subtree() const { return hide_layer_and_subtree_; }
 357
 358   void SetReplicaLayer(Layer* layer);
 359   Layer* replica_layer() { return replica_layer_.get(); }
 360   const Layer* replica_layer() const { return replica_layer_.get(); }
 361
 362   bool has_mask() const { return !!mask_layer_.get(); }
 363   bool has_replica() const { return !!replica_layer_.get(); }
 364   bool replica_has_mask() const {
 365     return replica_layer_.get() &&
 366            (mask_layer_.get() || replica_layer_->mask_layer_.get());
 367   }
 368
 369   int NumDescendantsThatDrawContent() const;
 370
 371   // This is only virtual for tests.
 372   // TODO(awoloszyn): Remove this once we no longer need it for tests
 373   virtual bool DrawsContent() const;
 374
 375   // This methods typically need to be overwritten by derived classes.
 376   virtual void SavePaintProperties();
 377   // Returns true iff any resources were updated that need to be committed.
 378   virtual bool Update(ResourceUpdateQueue* queue);
 379   virtual bool NeedMoreUpdates();
 380   virtual void SetIsMask(bool is_mask) {}
 381   virtual void ReduceMemoryUsage() {}
 382   virtual void OnOutputSurfaceCreated() {}
 383   virtual bool IsSuitableForGpuRasterization() const;
 384
 385   virtual scoped_refptr<base::trace_event::ConvertableToTraceFormat>
 386   TakeDebugInfo();
 387
 388   void SetLayerClient(LayerClient* client) { client_ = client; }
 389
 390   virtual void PushPropertiesTo(LayerImpl* layer);
 391
 392   void CreateRenderSurface();
 393   void ClearRenderSurface();
 394
 395   void ClearRenderSurfaceLayerList();
 396
 397   LayerTreeHost* layer_tree_host() { return layer_tree_host_; }
 398   const LayerTreeHost* layer_tree_host() const { return layer_tree_host_; }
 399
 400   // Set the priority of all desired textures in this layer.
 401   virtual void SetTexturePriorities(const PriorityCalculator& priority_calc) {}
 402
 403   bool AddAnimation(scoped_ptr<Animation> animation);
 404   void PauseAnimation(int animation_id, double time_offset);
 405   void RemoveAnimation(int animation_id);
 406   void RemoveAnimation(int animation_id, Animation::TargetProperty property);
 407
 408   LayerAnimationController* layer_animation_controller() {
 409     return layer_animation_controller_.get();
 410   }
 411   void SetLayerAnimationControllerForTest(
 412       scoped_refptr<LayerAnimationController> controller);
 413
 414   void set_layer_animation_delegate(AnimationDelegate* delegate) {
 415     DCHECK(layer_animation_controller_);
 416     layer_animation_controller_->set_layer_animation_delegate(delegate);
 417   }
 418
 419   bool HasActiveAnimation() const;
 420   void RegisterForAnimations(AnimationRegistrar* registrar);
 421
 422   void AddLayerAnimationEventObserver(
 423       LayerAnimationEventObserver* animation_observer);
 424   void RemoveLayerAnimationEventObserver(
 425       LayerAnimationEventObserver* animation_observer);
 426
 427   virtual SimpleEnclosedRegion VisibleContentOpaqueRegion() const;
 428
 429   virtual ScrollbarLayerInterface* ToScrollbarLayer();
 430
 431   virtual skia::RefPtr<SkPicture> GetPicture() const;
 432
 433   // Constructs a LayerImpl of the correct runtime type for this Layer type.
 434   virtual scoped_ptr<LayerImpl> CreateLayerImpl(LayerTreeImpl* tree_impl);
 435
 436   bool NeedsDisplayForTesting() const { return !update_rect_.IsEmpty(); }
 437   void ResetNeedsDisplayForTesting() { update_rect_ = gfx::Rect(); }
 438
 439   RenderingStatsInstrumentation* rendering_stats_instrumentation() const;
 440
 441   const PaintProperties& paint_properties() const {
 442     return paint_properties_;
 443   }
 444
 445   // The scale at which contents should be rastered, to match the scale at
 446   // which they will drawn to the screen. This scale is a component of the
 447   // contents scale but does not include page/device scale factors.
 448   // TODO(danakj): This goes away when TiledLayer goes away.
 449   void set_raster_scale(float scale) { raster_scale_ = scale; }
 450   float raster_scale() const { return raster_scale_; }
 451   bool raster_scale_is_unknown() const { return raster_scale_ == 0.f; }
 452
 453   void SetNeedsPushProperties();
 454   bool needs_push_properties() const { return needs_push_properties_; }
 455   bool descendant_needs_push_properties() const {
 456     return num_dependents_need_push_properties_ > 0;
 457   }
 458   void reset_needs_push_properties_for_testing() {
 459     needs_push_properties_ = false;
 460   }
 461
 462   virtual void RunMicroBenchmark(MicroBenchmark* benchmark);
 463
 464   void Set3dSortingContextId(int id);
 465   int sorting_context_id() const { return sorting_context_id_; }
 466
 467   void set_property_tree_sequence_number(int sequence_number) {
 468     property_tree_sequence_number_ = sequence_number;
 469   }
 470
 471   void SetTransformTreeIndex(int index);
 472   int transform_tree_index() const;
 473
 474   void SetClipTreeIndex(int index);
 475   int clip_tree_index() const;
 476
 477   void SetOpacityTreeIndex(int index);
 478   int opacity_tree_index() const;
 479
 480   void set_offset_to_transform_parent(gfx::Vector2dF offset) {
 481     if (offset_to_transform_parent_ == offset)
 482       return;
 483     offset_to_transform_parent_ = offset;
 484     SetNeedsPushProperties();
 485   }
 486   gfx::Vector2dF offset_to_transform_parent() const {
 487     return offset_to_transform_parent_;
 488   }
 489
 490   // TODO(vollick): Once we transition to transform and clip trees, rename these
 491   // functions and related values.  The "from property trees" functions below
 492   // use the transform and clip trees.  Eventually, we will use these functions
 493   // to compute the official values, but these functions are retained for
 494   // testing purposes until we've migrated.
 495
 496   const gfx::Rect& visible_rect_from_property_trees() const {
 497     return visible_rect_from_property_trees_;
 498   }
 499   void set_visible_rect_from_property_trees(const gfx::Rect& rect) {
 500     // No push properties here, as this acts like a draw property.
 501     visible_rect_from_property_trees_ = rect;
 502   }
 503
 504   void set_should_flatten_transform_from_property_tree(bool should_flatten) {
 505     if (should_flatten_transform_from_property_tree_ == should_flatten)
 506       return;
 507     should_flatten_transform_from_property_tree_ = should_flatten;
 508     SetNeedsPushProperties();
 509   }
 510   bool should_flatten_transform_from_property_tree() const {
 511     return should_flatten_transform_from_property_tree_;
 512   }
 513
 514   // TODO(vollick): These values are temporary and will be removed as soon as
 515   // render surface determinations are moved out of CDP. They only exist because
 516   // certain logic depends on whether or not a layer would render to a separate
 517   // surface, but CDP destroys surfaces and targets it doesn't need, so without
 518   // this boolean, this is impossible to determine after the fact without
 519   // wastefully recomputing it. This is public for the time being so that it can
 520   // be accessed from CDP.
 521   bool has_render_surface() const {
 522     return has_render_surface_;
 523   }
 524
 525   // Sets new frame timing requests for this layer.
 526   void SetFrameTimingRequests(const std::vector<FrameTimingRequest>& requests);
 527
 528   // Accessor for unit tests
 529   const std::vector<FrameTimingRequest>& FrameTimingRequests() const {
 530     return frame_timing_requests_;
 531   }
 532
 533   void DidBeginTracing();
 534   void set_num_layer_or_descandant_with_copy_request(
 535       int num_layer_or_descendants_with_copy_request) {
 536     num_layer_or_descendants_with_copy_request_ =
 537         num_layer_or_descendants_with_copy_request;
 538   }
 539
 540   void set_num_layer_or_descandant_with_input_handler(
 541       int num_layer_or_descendants_with_input_handler) {
 542     num_layer_or_descendants_with_input_handler_ =
 543         num_layer_or_descendants_with_input_handler;
 544   }
 545
 546   int num_layer_or_descendants_with_input_handler() {
 547     return num_layer_or_descendants_with_input_handler_;
 548   }
 549
 550   void set_num_children_with_scroll_parent(
 551       int num_children_with_scroll_parent) {
 552     num_children_with_scroll_parent_ = num_children_with_scroll_parent;
 553   }
 554
 555   int num_children_with_scroll_parent() {
 556     return num_children_with_scroll_parent_;
 557   }
 558
 559   void set_visited(bool visited);
 560   bool visited();
 561   void set_layer_or_descendant_is_drawn(bool layer_or_descendant_is_drawn);
 562   bool layer_or_descendant_is_drawn();
 563   void set_sorted_for_recursion(bool sorted_for_recursion);
 564   bool sorted_for_recursion();
 565
 566  protected:
 567   friend class LayerImpl;
 568   friend class TreeSynchronizer;
 569   ~Layer() override;
 570
 571   explicit Layer(const LayerSettings& settings);
 572
 573   // These SetNeeds functions are in order of severity of update:
 574   //
 575   // Called when this layer has been modified in some way, but isn't sure
 576   // that it needs a commit yet.  It needs CalcDrawProperties and UpdateLayers
 577   // before it knows whether or not a commit is required.
 578   void SetNeedsUpdate();
 579   // Called when a property has been modified in a way that the layer
 580   // knows immediately that a commit is required.  This implies SetNeedsUpdate
 581   // as well as SetNeedsPushProperties to push that property.
 582   void SetNeedsCommit();
 583   // This is identical to SetNeedsCommit, but the former requests a rebuild of
 584   // the property trees.
 585   void SetNeedsCommitNoRebuild();
 586   // Called when there's been a change in layer structure.  Implies both
 587   // SetNeedsUpdate and SetNeedsCommit, but not SetNeedsPushProperties.
 588   void SetNeedsFullTreeSync();
 589
 590   // Called when the next commit should wait until the pending tree is activated
 591   // before finishing the commit and unblocking the main thread. Used to ensure
 592   // unused resources on the impl thread are returned before commit completes.
 593   void SetNextCommitWaitsForActivation();
 594
 595   // Will recalculate whether the layer draws content and set draws_content_
 596   // appropriately.
 597   void UpdateDrawsContent(bool has_drawable_content);
 598   virtual bool HasDrawableContent() const;
 599
 600   // Called when the layer's number of drawable descendants changes.
 601   void AddDrawableDescendants(int num);
 602
 603   void AddDependentNeedsPushProperties();
 604   void RemoveDependentNeedsPushProperties();
 605   bool parent_should_know_need_push_properties() const {
 606     return needs_push_properties() || descendant_needs_push_properties();
 607   }
 608
 609   bool IsPropertyChangeAllowed() const;
 610
 611   void reset_raster_scale_to_unknown() { raster_scale_ = 0.f; }
 612
 613   // This flag is set when the layer needs to push properties to the impl
 614   // side.
 615   bool needs_push_properties_;
 616
 617   // The number of direct children or dependent layers that need to be recursed
 618   // to in order for them or a descendent of them to push properties to the impl
 619   // side.
 620   int num_dependents_need_push_properties_;
 621
 622   // Tracks whether this layer may have changed stacking order with its
 623   // siblings.
 624   bool stacking_order_changed_;
 625
 626   // The update rect is the region of the compositor resource that was
 627   // actually updated by the compositor. For layers that may do updating
 628   // outside the compositor's control (i.e. plugin layers), this information
 629   // is not available and the update rect will remain empty.
 630   // Note this rect is in layer space (not content space).
 631   gfx::Rect update_rect_;
 632
 633   scoped_refptr<Layer> mask_layer_;
 634
 635   int layer_id_;
 636
 637   // When true, the layer is about to perform an update. Any commit requests
 638   // will be handled implicitly after the update completes.
 639   bool ignore_set_needs_commit_;
 640
 641   // Layers that share a sorting context id will be sorted together in 3d
 642   // space.  0 is a special value that means this layer will not be sorted and
 643   // will be drawn in paint order.
 644   int sorting_context_id_;
 645
 646  private:
 647   friend class base::RefCounted<Layer>;
 648   friend class LayerTreeHostCommon;
 649   void SetParent(Layer* layer);
 650   bool DescendantIsFixedToContainerLayer() const;
 651
 652   // This should only be called during BeginMainFrame since it does not
 653   // trigger a Commit.
 654   void SetHasRenderSurface(bool has_render_surface);
 655
 656   // This should only be called from RemoveFromParent().
 657   void RemoveChildOrDependent(Layer* child);
 658
 659   // LayerAnimationValueProvider implementation.
 660   gfx::ScrollOffset ScrollOffsetForAnimation() const override;
 661
 662   // LayerAnimationValueObserver implementation.
 663   void OnFilterAnimated(const FilterOperations& filters) override;
 664   void OnOpacityAnimated(float opacity) override;
 665   void OnTransformAnimated(const gfx::Transform& transform) override;
 666   void OnScrollOffsetAnimated(const gfx::ScrollOffset& scroll_offset) override;
 667   void OnAnimationWaitingForDeletion() override;
 668   bool IsActive() const override;
 669
 670   // If this layer has a scroll parent, it removes |this| from its list of
 671   // scroll children.
 672   void RemoveFromScrollTree();
 673
 674   // If this layer has a clip parent, it removes |this| from its list of clip
 675   // children.
 676   void RemoveFromClipTree();
 677
 678   // When we detach or attach layer to new LayerTreeHost, all property trees'
 679   // indices becomes invalid.
 680   void InvalidatePropertyTreesIndices();
 681
 682   void UpdateNumCopyRequestsForSubtree(bool add);
 683   void UpdateNumInputHandlersForSubtree(bool add);
 684
 685   LayerList children_;
 686   Layer* parent_;
 687
 688   // Layer instances have a weak pointer to their LayerTreeHost.
 689   // This pointer value is nil when a Layer is not in a tree and is
 690   // updated via SetLayerTreeHost() if a layer moves between trees.
 691   LayerTreeHost* layer_tree_host_;
 692
 693   scoped_refptr<LayerAnimationController> layer_animation_controller_;
 694
 695   // Layer properties.
 696   gfx::Size bounds_;
 697
 698   gfx::ScrollOffset scroll_offset_;
 699   gfx::Vector2dF scroll_compensation_adjustment_;
 700   // This variable indicates which ancestor layer (if any) whose size,
 701   // transformed relative to this layer, defines the maximum scroll offset for
 702   // this layer.
 703   int scroll_clip_layer_id_;
 704   int num_descendants_that_draw_content_;
 705   int transform_tree_index_;
 706   int opacity_tree_index_;
 707   int clip_tree_index_;
 708   int property_tree_sequence_number_;
 709   int num_layer_or_descendants_with_copy_request_;
 710   int num_layer_or_descendants_with_input_handler_;
 711   int num_children_with_scroll_parent_;
 712   gfx::Vector2dF offset_to_transform_parent_;
 713   bool should_flatten_transform_from_property_tree_ : 1;
 714   bool should_scroll_on_main_thread_ : 1;
 715   bool have_wheel_event_handlers_ : 1;
 716   bool have_scroll_event_handlers_ : 1;
 717   bool user_scrollable_horizontal_ : 1;
 718   bool user_scrollable_vertical_ : 1;
 719   bool is_root_for_isolated_group_ : 1;
 720   bool is_container_for_fixed_position_layers_ : 1;
 721   bool is_drawable_ : 1;
 722   bool draws_content_ : 1;
 723   bool hide_layer_and_subtree_ : 1;
 724   bool masks_to_bounds_ : 1;
 725   bool contents_opaque_ : 1;
 726   bool double_sided_ : 1;
 727   bool should_flatten_transform_ : 1;
 728   bool use_parent_backface_visibility_ : 1;
 729   bool draw_checkerboard_for_missing_tiles_ : 1;
 730   bool force_render_surface_ : 1;
 731   bool transform_is_invertible_ : 1;
 732   bool has_render_surface_ : 1;
 733   ScrollBlocksOn scroll_blocks_on_ : 3;
 734   Region non_fast_scrollable_region_;
 735   Region touch_event_handler_region_;
 736   gfx::PointF position_;
 737   SkColor background_color_;
 738   float opacity_;
 739   SkXfermode::Mode blend_mode_;
 740   FilterOperations filters_;
 741   FilterOperations background_filters_;
 742   LayerPositionConstraint position_constraint_;
 743   Layer* scroll_parent_;
 744   scoped_ptr<std::set<Layer*>> scroll_children_;
 745
 746   // The following three variables are tracker variables. They are bools
 747   // wrapped inside an integer variable. If true, their value equals the
 748   // LayerTreeHost's meta_information_sequence_number. This wrapping of bools
 749   // inside ints is done to avoid a layer tree treewalk to reset their values.
 750   int layer_or_descendant_is_drawn_tracker_;
 751   int sorted_for_recursion_tracker_;
 752   int visited_tracker_;
 753
 754   Layer* clip_parent_;
 755   scoped_ptr<std::set<Layer*>> clip_children_;
 756
 757   gfx::Transform transform_;
 758   gfx::Point3F transform_origin_;
 759
 760   // Replica layer used for reflections.
 761   scoped_refptr<Layer> replica_layer_;
 762
 763   // Transient properties.
 764   float raster_scale_;
 765
 766   LayerClient* client_;
 767
 768   ScopedPtrVector<CopyOutputRequest> copy_requests_;
 769
 770   base::Closure did_scroll_callback_;
 771
 772   DrawProperties<Layer> draw_properties_;
 773
 774   PaintProperties paint_properties_;
 775   // TODO(awoloszyn): This is redundant with has_render_surface_,
 776   // and should get removed once it is no longer needed on main thread.
 777   scoped_ptr<RenderSurface> render_surface_;
 778
 779   gfx::Rect visible_rect_from_property_trees_;
 780
 781   std::vector<FrameTimingRequest> frame_timing_requests_;
 782   bool frame_timing_requests_dirty_;
 783
 784   DISALLOW_COPY_AND_ASSIGN(Layer);
 785 };
 786
 787 }  // namespace cc
 788
 789 #endif  // CC_LAYERS_LAYER_H_