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.
5 #ifndef CC_LAYERS_LAYER_H_
6 #define CC_LAYERS_LAYER_H_
11 #include "base/callback.h"
12 #include "base/memory/ref_counted.h"
13 #include "base/observer_list.h"
14 #include "cc/animation/layer_animation_controller.h"
15 #include "cc/animation/layer_animation_value_observer.h"
16 #include "cc/animation/layer_animation_value_provider.h"
17 #include "cc/base/cc_export.h"
18 #include "cc/base/region.h"
19 #include "cc/base/scoped_ptr_vector.h"
20 #include "cc/debug/micro_benchmark.h"
21 #include "cc/layers/draw_properties.h"
22 #include "cc/layers/layer_lists.h"
23 #include "cc/layers/layer_position_constraint.h"
24 #include "cc/layers/paint_properties.h"
25 #include "cc/layers/render_surface.h"
26 #include "cc/output/filter_operations.h"
27 #include "skia/ext/refptr.h"
28 #include "third_party/skia/include/core/SkColor.h"
29 #include "third_party/skia/include/core/SkImageFilter.h"
30 #include "third_party/skia/include/core/SkPicture.h"
31 #include "third_party/skia/include/core/SkXfermode.h"
32 #include "ui/gfx/point3_f.h"
33 #include "ui/gfx/rect.h"
34 #include "ui/gfx/rect_f.h"
35 #include "ui/gfx/transform.h"
43 class ConvertableToTraceFormat;
50 class AnimationDelegate;
51 struct AnimationEvent;
52 class CopyOutputRequest;
53 class LayerAnimationDelegate;
54 class LayerAnimationEventObserver;
59 class PriorityCalculator;
60 class RenderingStatsInstrumentation;
61 class ResourceUpdateQueue;
62 class ScrollbarLayerInterface;
63 struct AnimationEvent;
64 template <typename LayerType>
65 class OcclusionTracker;
67 // Base class for composited layers. Special layer types are derived from
69 class CC_EXPORT Layer : public base::RefCounted<Layer>,
70 public LayerAnimationValueObserver,
71 public LayerAnimationValueProvider {
73 typedef RenderSurfaceLayerList RenderSurfaceListType;
74 typedef LayerList LayerListType;
75 typedef RenderSurface RenderSurfaceType;
81 static scoped_refptr<Layer> Create();
83 int id() const { return layer_id_; }
86 Layer* parent() { return parent_; }
87 const Layer* parent() const { return parent_; }
88 void AddChild(scoped_refptr<Layer> child);
89 void InsertChild(scoped_refptr<Layer> child, size_t index);
90 void ReplaceChild(Layer* reference, scoped_refptr<Layer> new_layer);
91 void RemoveFromParent();
92 void RemoveAllChildren();
93 void SetChildren(const LayerList& children);
94 bool HasAncestor(const Layer* ancestor) const;
96 const LayerList& children() const { return children_; }
97 Layer* child_at(size_t index) { return children_[index].get(); }
99 // This requests the layer and its subtree be rendered and given to the
100 // callback. If the copy is unable to be produced (the layer is destroyed
101 // first), then the callback is called with a NULL/empty result.
102 void RequestCopyOfOutput(scoped_ptr<CopyOutputRequest> request);
103 bool HasCopyRequest() const {
104 return !copy_requests_.empty();
107 virtual void SetBackgroundColor(SkColor background_color);
108 SkColor background_color() const { return background_color_; }
109 // If contents_opaque(), return an opaque color else return a
110 // non-opaque color. Tries to return background_color(), if possible.
111 SkColor SafeOpaqueBackgroundColor() const;
113 // A layer's bounds are in logical, non-page-scaled pixels (however, the
114 // root layer's bounds are in physical pixels).
115 void SetBounds(const gfx::Size& bounds);
116 gfx::Size bounds() const { return bounds_; }
118 void SetMasksToBounds(bool masks_to_bounds);
119 bool masks_to_bounds() const { return masks_to_bounds_; }
121 void SetMaskLayer(Layer* mask_layer);
122 Layer* mask_layer() { return mask_layer_.get(); }
123 const Layer* mask_layer() const { return mask_layer_.get(); }
125 virtual void SetNeedsDisplayRect(const gfx::RectF& dirty_rect);
126 void SetNeedsDisplay() { SetNeedsDisplayRect(gfx::RectF(bounds())); }
128 void SetOpacity(float opacity);
129 float opacity() const { return opacity_; }
130 bool OpacityIsAnimating() const;
131 virtual bool OpacityCanAnimateOnImplThread() const;
133 void SetBlendMode(SkXfermode::Mode blend_mode);
134 SkXfermode::Mode blend_mode() const { return blend_mode_; }
136 bool uses_default_blend_mode() const {
137 return blend_mode_ == SkXfermode::kSrcOver_Mode;
140 // A layer is root for an isolated group when it and all its descendants are
141 // drawn over a black and fully transparent background, creating an isolated
142 // group. It should be used along with SetBlendMode(), in order to restrict
143 // layers within the group to blend with layers outside this group.
144 void SetIsRootForIsolatedGroup(bool root);
145 bool is_root_for_isolated_group() const {
146 return is_root_for_isolated_group_;
149 void SetFilters(const FilterOperations& filters);
150 const FilterOperations& filters() const { return filters_; }
151 bool FilterIsAnimating() const;
153 // Background filters are filters applied to what is behind this layer, when
154 // they are viewed through non-opaque regions in this layer. They are used
155 // through the WebLayer interface, and are not exposed to HTML.
156 void SetBackgroundFilters(const FilterOperations& filters);
157 const FilterOperations& background_filters() const {
158 return background_filters_;
161 virtual void SetContentsOpaque(bool opaque);
162 bool contents_opaque() const { return contents_opaque_; }
164 void SetPosition(const gfx::PointF& position);
165 gfx::PointF position() const { return position_; }
167 void SetIsContainerForFixedPositionLayers(bool container);
168 bool IsContainerForFixedPositionLayers() const;
170 void SetPositionConstraint(const LayerPositionConstraint& constraint);
171 const LayerPositionConstraint& position_constraint() const {
172 return position_constraint_;
175 void SetTransform(const gfx::Transform& transform);
176 const gfx::Transform& transform() const { return transform_; }
177 bool TransformIsAnimating() const;
178 bool transform_is_invertible() const { return transform_is_invertible_; }
180 void SetTransformOrigin(const gfx::Point3F&);
181 gfx::Point3F transform_origin() { return transform_origin_; }
183 void SetScrollParent(Layer* parent);
185 Layer* scroll_parent() { return scroll_parent_; }
186 const Layer* scroll_parent() const { return scroll_parent_; }
188 void AddScrollChild(Layer* child);
189 void RemoveScrollChild(Layer* child);
191 std::set<Layer*>* scroll_children() { return scroll_children_.get(); }
192 const std::set<Layer*>* scroll_children() const {
193 return scroll_children_.get();
196 void SetClipParent(Layer* ancestor);
198 Layer* clip_parent() { return clip_parent_; }
199 const Layer* clip_parent() const {
203 void AddClipChild(Layer* child);
204 void RemoveClipChild(Layer* child);
206 std::set<Layer*>* clip_children() { return clip_children_.get(); }
207 const std::set<Layer*>* clip_children() const {
208 return clip_children_.get();
211 DrawProperties<Layer>& draw_properties() { return draw_properties_; }
212 const DrawProperties<Layer>& draw_properties() const {
213 return draw_properties_;
216 // The following are shortcut accessors to get various information from
218 const gfx::Transform& draw_transform() const {
219 return draw_properties_.target_space_transform;
221 const gfx::Transform& screen_space_transform() const {
222 return draw_properties_.screen_space_transform;
224 float draw_opacity() const { return draw_properties_.opacity; }
225 bool draw_opacity_is_animating() const {
226 return draw_properties_.opacity_is_animating;
228 bool draw_transform_is_animating() const {
229 return draw_properties_.target_space_transform_is_animating;
231 bool screen_space_transform_is_animating() const {
232 return draw_properties_.screen_space_transform_is_animating;
234 bool screen_space_opacity_is_animating() const {
235 return draw_properties_.screen_space_opacity_is_animating;
237 bool can_use_lcd_text() const { return draw_properties_.can_use_lcd_text; }
238 bool is_clipped() const { return draw_properties_.is_clipped; }
239 gfx::Rect clip_rect() const { return draw_properties_.clip_rect; }
240 gfx::Rect drawable_content_rect() const {
241 return draw_properties_.drawable_content_rect;
243 gfx::Rect visible_content_rect() const {
244 return draw_properties_.visible_content_rect;
246 Layer* render_target() {
247 DCHECK(!draw_properties_.render_target ||
248 draw_properties_.render_target->render_surface());
249 return draw_properties_.render_target;
251 const Layer* render_target() const {
252 DCHECK(!draw_properties_.render_target ||
253 draw_properties_.render_target->render_surface());
254 return draw_properties_.render_target;
256 RenderSurface* render_surface() const {
257 return draw_properties_.render_surface.get();
259 int num_unclipped_descendants() const {
260 return draw_properties_.num_unclipped_descendants;
263 void SetScrollOffset(gfx::Vector2d scroll_offset);
264 gfx::Vector2d scroll_offset() const { return scroll_offset_; }
265 void SetScrollOffsetFromImplSide(const gfx::Vector2d& scroll_offset);
267 void SetScrollClipLayerId(int clip_layer_id);
268 bool scrollable() const { return scroll_clip_layer_id_ != INVALID_ID; }
270 void SetUserScrollable(bool horizontal, bool vertical);
271 bool user_scrollable_horizontal() const {
272 return user_scrollable_horizontal_;
274 bool user_scrollable_vertical() const { return user_scrollable_vertical_; }
276 void SetShouldScrollOnMainThread(bool should_scroll_on_main_thread);
277 bool should_scroll_on_main_thread() const {
278 return should_scroll_on_main_thread_;
281 void SetHaveWheelEventHandlers(bool have_wheel_event_handlers);
282 bool have_wheel_event_handlers() const { return have_wheel_event_handlers_; }
284 void SetHaveScrollEventHandlers(bool have_scroll_event_handlers);
285 bool have_scroll_event_handlers() const {
286 return have_scroll_event_handlers_;
289 void SetNonFastScrollableRegion(const Region& non_fast_scrollable_region);
290 const Region& non_fast_scrollable_region() const {
291 return non_fast_scrollable_region_;
294 void SetTouchEventHandlerRegion(const Region& touch_event_handler_region);
295 const Region& touch_event_handler_region() const {
296 return touch_event_handler_region_;
299 void set_did_scroll_callback(const base::Closure& callback) {
300 did_scroll_callback_ = callback;
303 void SetDrawCheckerboardForMissingTiles(bool checkerboard);
304 bool draw_checkerboard_for_missing_tiles() const {
305 return draw_checkerboard_for_missing_tiles_;
308 void SetForceRenderSurface(bool force_render_surface);
309 bool force_render_surface() const { return force_render_surface_; }
311 gfx::Vector2d ScrollDelta() const { return gfx::Vector2d(); }
312 gfx::Vector2dF TotalScrollOffset() const {
313 // Floating point to match the LayerImpl version.
314 return scroll_offset() + ScrollDelta();
317 void SetDoubleSided(bool double_sided);
318 bool double_sided() const { return double_sided_; }
320 void SetShouldFlattenTransform(bool flatten);
321 bool should_flatten_transform() const { return should_flatten_transform_; }
323 bool Is3dSorted() const { return sorting_context_id_ != 0; }
325 void set_use_parent_backface_visibility(bool use) {
326 use_parent_backface_visibility_ = use;
328 bool use_parent_backface_visibility() const {
329 return use_parent_backface_visibility_;
332 virtual void SetLayerTreeHost(LayerTreeHost* host);
334 virtual bool HasDelegatedContent() const;
335 bool HasContributingDelegatedRenderPasses() const { return false; }
337 void SetIsDrawable(bool is_drawable);
339 void SetHideLayerAndSubtree(bool hide);
340 bool hide_layer_and_subtree() const { return hide_layer_and_subtree_; }
342 void SetReplicaLayer(Layer* layer);
343 Layer* replica_layer() { return replica_layer_.get(); }
344 const Layer* replica_layer() const { return replica_layer_.get(); }
346 bool has_mask() const { return !!mask_layer_.get(); }
347 bool has_replica() const { return !!replica_layer_.get(); }
348 bool replica_has_mask() const {
349 return replica_layer_.get() &&
350 (mask_layer_.get() || replica_layer_->mask_layer_.get());
353 int NumDescendantsThatDrawContent() const;
355 // This is only virtual for tests.
356 // TODO(awoloszyn): Remove this once we no longer need it for tests
357 virtual bool DrawsContent() const;
359 // This methods typically need to be overwritten by derived classes.
360 virtual void SavePaintProperties();
361 // Returns true iff any resources were updated that need to be committed.
362 virtual bool Update(ResourceUpdateQueue* queue,
363 const OcclusionTracker<Layer>* occlusion);
364 virtual bool NeedMoreUpdates();
365 virtual void SetIsMask(bool is_mask) {}
366 virtual void ReduceMemoryUsage() {}
367 virtual void OnOutputSurfaceCreated() {}
368 virtual bool IsSuitableForGpuRasterization() const;
370 virtual scoped_refptr<base::debug::ConvertableToTraceFormat> TakeDebugInfo();
372 void SetLayerClient(LayerClient* client) { client_ = client; }
374 virtual void PushPropertiesTo(LayerImpl* layer);
376 void CreateRenderSurface();
377 void ClearRenderSurface();
378 void ClearRenderSurfaceLayerList();
380 // The contents scale converts from logical, non-page-scaled pixels to target
381 // pixels. The contents scale is 1 for the root layer as it is already in
382 // physical pixels. By default contents scale is forced to be 1 except for
383 // subclasses of ContentsScalingLayer.
384 float contents_scale_x() const { return draw_properties_.contents_scale_x; }
385 float contents_scale_y() const { return draw_properties_.contents_scale_y; }
386 gfx::Size content_bounds() const { return draw_properties_.content_bounds; }
388 virtual void CalculateContentsScale(float ideal_contents_scale,
389 float* contents_scale_x,
390 float* contents_scale_y,
391 gfx::Size* content_bounds);
393 LayerTreeHost* layer_tree_host() { return layer_tree_host_; }
394 const LayerTreeHost* layer_tree_host() const { return layer_tree_host_; }
396 // Set the priority of all desired textures in this layer.
397 virtual void SetTexturePriorities(const PriorityCalculator& priority_calc) {}
399 bool AddAnimation(scoped_ptr<Animation> animation);
400 void PauseAnimation(int animation_id, double time_offset);
401 void RemoveAnimation(int animation_id);
403 LayerAnimationController* layer_animation_controller() {
404 return layer_animation_controller_.get();
406 void SetLayerAnimationControllerForTest(
407 scoped_refptr<LayerAnimationController> controller);
409 void set_layer_animation_delegate(AnimationDelegate* delegate) {
410 layer_animation_controller_->set_layer_animation_delegate(delegate);
413 bool HasActiveAnimation() const;
415 void AddLayerAnimationEventObserver(
416 LayerAnimationEventObserver* animation_observer);
417 void RemoveLayerAnimationEventObserver(
418 LayerAnimationEventObserver* animation_observer);
420 virtual Region VisibleContentOpaqueRegion() const;
422 virtual ScrollbarLayerInterface* ToScrollbarLayer();
424 gfx::Rect LayerRectToContentRect(const gfx::RectF& layer_rect) const;
426 virtual skia::RefPtr<SkPicture> GetPicture() const;
428 // Constructs a LayerImpl of the correct runtime type for this Layer type.
429 virtual scoped_ptr<LayerImpl> CreateLayerImpl(LayerTreeImpl* tree_impl);
431 bool NeedsDisplayForTesting() const { return !update_rect_.IsEmpty(); }
432 void ResetNeedsDisplayForTesting() { update_rect_ = gfx::RectF(); }
434 RenderingStatsInstrumentation* rendering_stats_instrumentation() const;
436 const PaintProperties& paint_properties() const {
437 return paint_properties_;
440 // The scale at which contents should be rastered, to match the scale at
441 // which they will drawn to the screen. This scale is a component of the
442 // contents scale but does not include page/device scale factors.
443 // TODO(danakj): This goes away when TiledLayer goes away.
444 void set_raster_scale(float scale) { raster_scale_ = scale; }
445 float raster_scale() const { return raster_scale_; }
446 bool raster_scale_is_unknown() const { return raster_scale_ == 0.f; }
448 virtual bool SupportsLCDText() const;
450 void SetNeedsPushProperties();
451 bool needs_push_properties() const { return needs_push_properties_; }
452 bool descendant_needs_push_properties() const {
453 return num_dependents_need_push_properties_ > 0;
455 void reset_needs_push_properties_for_testing() {
456 needs_push_properties_ = false;
459 virtual void RunMicroBenchmark(MicroBenchmark* benchmark);
461 void Set3dSortingContextId(int id);
462 int sorting_context_id() const { return sorting_context_id_; }
465 friend class LayerImpl;
466 friend class TreeSynchronizer;
471 // These SetNeeds functions are in order of severity of update:
473 // Called when this layer has been modified in some way, but isn't sure
474 // that it needs a commit yet. It needs CalcDrawProperties and UpdateLayers
475 // before it knows whether or not a commit is required.
476 void SetNeedsUpdate();
477 // Called when a property has been modified in a way that the layer
478 // knows immediately that a commit is required. This implies SetNeedsUpdate
479 // as well as SetNeedsPushProperties to push that property.
480 void SetNeedsCommit();
481 // Called when there's been a change in layer structure. Implies both
482 // SetNeedsUpdate and SetNeedsCommit, but not SetNeedsPushProperties.
483 void SetNeedsFullTreeSync();
485 // Called when the next commit should wait until the pending tree is activated
486 // before finishing the commit and unblocking the main thread. Used to ensure
487 // unused resources on the impl thread are returned before commit completes.
488 void SetNextCommitWaitsForActivation();
490 // Will recalculate whether the layer draws content and set draws_content_
492 void UpdateDrawsContent(bool has_drawable_content);
493 virtual bool HasDrawableContent() const;
495 // Called when the layer's number of drawable descendants changes.
496 void AddDrawableDescendants(int num);
498 void AddDependentNeedsPushProperties();
499 void RemoveDependentNeedsPushProperties();
500 bool parent_should_know_need_push_properties() const {
501 return needs_push_properties() || descendant_needs_push_properties();
504 bool IsPropertyChangeAllowed() const;
506 // If this layer has a scroll parent, it removes |this| from its list of
508 void RemoveFromScrollTree();
510 // If this layer has a clip parent, it removes |this| from its list of clip
512 void RemoveFromClipTree();
514 void reset_raster_scale_to_unknown() { raster_scale_ = 0.f; }
516 // This flag is set when the layer needs to push properties to the impl
518 bool needs_push_properties_;
520 // The number of direct children or dependent layers that need to be recursed
521 // to in order for them or a descendent of them to push properties to the impl
523 int num_dependents_need_push_properties_;
525 // Tracks whether this layer may have changed stacking order with its
527 bool stacking_order_changed_;
529 // The update rect is the region of the compositor resource that was
530 // actually updated by the compositor. For layers that may do updating
531 // outside the compositor's control (i.e. plugin layers), this information
532 // is not available and the update rect will remain empty.
533 // Note this rect is in layer space (not content space).
534 gfx::RectF update_rect_;
536 scoped_refptr<Layer> mask_layer_;
540 // When true, the layer is about to perform an update. Any commit requests
541 // will be handled implicitly after the update completes.
542 bool ignore_set_needs_commit_;
544 // Layers that share a sorting context id will be sorted together in 3d
545 // space. 0 is a special value that means this layer will not be sorted and
546 // will be drawn in paint order.
547 int sorting_context_id_;
550 friend class base::RefCounted<Layer>;
552 void SetParent(Layer* layer);
553 bool DescendantIsFixedToContainerLayer() const;
555 // Returns the index of the child or -1 if not found.
556 int IndexOfChild(const Layer* reference);
558 // This should only be called from RemoveFromParent().
559 void RemoveChildOrDependent(Layer* child);
561 // LayerAnimationValueProvider implementation.
562 virtual gfx::Vector2dF ScrollOffsetForAnimation() const OVERRIDE;
564 // LayerAnimationValueObserver implementation.
565 virtual void OnFilterAnimated(const FilterOperations& filters) OVERRIDE;
566 virtual void OnOpacityAnimated(float opacity) OVERRIDE;
567 virtual void OnTransformAnimated(const gfx::Transform& transform) OVERRIDE;
568 virtual void OnScrollOffsetAnimated(
569 const gfx::Vector2dF& scroll_offset) OVERRIDE;
570 virtual void OnAnimationWaitingForDeletion() OVERRIDE;
571 virtual bool IsActive() const OVERRIDE;
576 // Layer instances have a weak pointer to their LayerTreeHost.
577 // This pointer value is nil when a Layer is not in a tree and is
578 // updated via SetLayerTreeHost() if a layer moves between trees.
579 LayerTreeHost* layer_tree_host_;
581 scoped_refptr<LayerAnimationController> layer_animation_controller_;
586 gfx::Vector2d scroll_offset_;
587 // This variable indicates which ancestor layer (if any) whose size,
588 // transformed relative to this layer, defines the maximum scroll offset for
590 int scroll_clip_layer_id_;
591 int num_descendants_that_draw_content_;
592 bool should_scroll_on_main_thread_ : 1;
593 bool have_wheel_event_handlers_ : 1;
594 bool have_scroll_event_handlers_ : 1;
595 bool user_scrollable_horizontal_ : 1;
596 bool user_scrollable_vertical_ : 1;
597 bool is_root_for_isolated_group_ : 1;
598 bool is_container_for_fixed_position_layers_ : 1;
599 bool is_drawable_ : 1;
600 bool draws_content_ : 1;
601 bool hide_layer_and_subtree_ : 1;
602 bool masks_to_bounds_ : 1;
603 bool contents_opaque_ : 1;
604 bool double_sided_ : 1;
605 bool should_flatten_transform_ : 1;
606 bool use_parent_backface_visibility_ : 1;
607 bool draw_checkerboard_for_missing_tiles_ : 1;
608 bool force_render_surface_ : 1;
609 bool transform_is_invertible_ : 1;
610 Region non_fast_scrollable_region_;
611 Region touch_event_handler_region_;
612 gfx::PointF position_;
613 SkColor background_color_;
615 SkXfermode::Mode blend_mode_;
616 FilterOperations filters_;
617 FilterOperations background_filters_;
618 LayerPositionConstraint position_constraint_;
619 Layer* scroll_parent_;
620 scoped_ptr<std::set<Layer*> > scroll_children_;
623 scoped_ptr<std::set<Layer*> > clip_children_;
625 gfx::Transform transform_;
626 gfx::Point3F transform_origin_;
628 // Replica layer used for reflections.
629 scoped_refptr<Layer> replica_layer_;
631 // Transient properties.
634 LayerClient* client_;
636 ScopedPtrVector<CopyOutputRequest> copy_requests_;
638 base::Closure did_scroll_callback_;
640 DrawProperties<Layer> draw_properties_;
642 PaintProperties paint_properties_;
644 DISALLOW_COPY_AND_ASSIGN(Layer);
649 #endif // CC_LAYERS_LAYER_H_