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 "cc/trees/occlusion_tracker.h"
28 #include "skia/ext/refptr.h"
29 #include "third_party/skia/include/core/SkColor.h"
30 #include "third_party/skia/include/core/SkImageFilter.h"
31 #include "third_party/skia/include/core/SkPicture.h"
32 #include "third_party/skia/include/core/SkXfermode.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
;
65 // Base class for composited layers. Special layer types are derived from
67 class CC_EXPORT Layer
: public base::RefCounted
<Layer
>,
68 public LayerAnimationValueObserver
,
69 public LayerAnimationValueProvider
{
71 typedef RenderSurfaceLayerList RenderSurfaceListType
;
72 typedef LayerList LayerListType
;
73 typedef RenderSurface RenderSurfaceType
;
79 static scoped_refptr
<Layer
> Create();
81 int id() const { return layer_id_
; }
84 Layer
* parent() { return parent_
; }
85 const Layer
* parent() const { return parent_
; }
86 void AddChild(scoped_refptr
<Layer
> child
);
87 void InsertChild(scoped_refptr
<Layer
> child
, size_t index
);
88 void ReplaceChild(Layer
* reference
, scoped_refptr
<Layer
> new_layer
);
89 void RemoveFromParent();
90 void RemoveAllChildren();
91 void SetChildren(const LayerList
& children
);
92 bool HasAncestor(const Layer
* ancestor
) const;
94 const LayerList
& children() const { return children_
; }
95 Layer
* child_at(size_t index
) { return children_
[index
].get(); }
97 // This requests the layer and its subtree be rendered and given to the
98 // callback. If the copy is unable to be produced (the layer is destroyed
99 // first), then the callback is called with a NULL/empty result.
100 void RequestCopyOfOutput(scoped_ptr
<CopyOutputRequest
> request
);
101 bool HasCopyRequest() const {
102 return !copy_requests_
.empty();
105 void SetAnchorPoint(const gfx::PointF
& anchor_point
);
106 gfx::PointF
anchor_point() const { return anchor_point_
; }
108 void SetAnchorPointZ(float anchor_point_z
);
109 float anchor_point_z() const { return anchor_point_z_
; }
111 virtual void SetBackgroundColor(SkColor background_color
);
112 SkColor
background_color() const { return background_color_
; }
113 // If contents_opaque(), return an opaque color else return a
114 // non-opaque color. Tries to return background_color(), if possible.
115 SkColor
SafeOpaqueBackgroundColor() const;
117 // A layer's bounds are in logical, non-page-scaled pixels (however, the
118 // root layer's bounds are in physical pixels).
119 void SetBounds(const gfx::Size
& bounds
);
120 gfx::Size
bounds() const { return bounds_
; }
122 void SetMasksToBounds(bool masks_to_bounds
);
123 bool masks_to_bounds() const { return masks_to_bounds_
; }
125 void SetMaskLayer(Layer
* mask_layer
);
126 Layer
* mask_layer() { return mask_layer_
.get(); }
127 const Layer
* mask_layer() const { return mask_layer_
.get(); }
129 virtual void SetNeedsDisplayRect(const gfx::RectF
& dirty_rect
);
130 void SetNeedsDisplay() { SetNeedsDisplayRect(gfx::RectF(bounds())); }
132 void SetOpacity(float opacity
);
133 float opacity() const { return opacity_
; }
134 bool OpacityIsAnimating() const;
135 virtual bool OpacityCanAnimateOnImplThread() const;
137 void SetBlendMode(SkXfermode::Mode blend_mode
);
138 SkXfermode::Mode
blend_mode() const { return blend_mode_
; }
140 bool uses_default_blend_mode() const {
141 return blend_mode_
== SkXfermode::kSrcOver_Mode
;
144 // A layer is root for an isolated group when it and all its descendants are
145 // drawn over a black and fully transparent background, creating an isolated
146 // group. It should be used along with SetBlendMode(), in order to restrict
147 // layers within the group to blend with layers outside this group.
148 void SetIsRootForIsolatedGroup(bool root
);
149 bool is_root_for_isolated_group() const {
150 return is_root_for_isolated_group_
;
153 void SetFilters(const FilterOperations
& filters
);
154 const FilterOperations
& filters() const { return filters_
; }
155 bool FilterIsAnimating() const;
157 // Background filters are filters applied to what is behind this layer, when
158 // they are viewed through non-opaque regions in this layer. They are used
159 // through the WebLayer interface, and are not exposed to HTML.
160 void SetBackgroundFilters(const FilterOperations
& filters
);
161 const FilterOperations
& background_filters() const {
162 return background_filters_
;
165 virtual void SetContentsOpaque(bool opaque
);
166 bool contents_opaque() const { return contents_opaque_
; }
168 void SetPosition(const gfx::PointF
& position
);
169 gfx::PointF
position() const { return position_
; }
171 void SetIsContainerForFixedPositionLayers(bool container
);
172 bool IsContainerForFixedPositionLayers() const;
174 void SetPositionConstraint(const LayerPositionConstraint
& constraint
);
175 const LayerPositionConstraint
& position_constraint() const {
176 return position_constraint_
;
179 void SetTransform(const gfx::Transform
& transform
);
180 const gfx::Transform
& transform() const { return transform_
; }
181 bool TransformIsAnimating() const;
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 gfx::Vector2d
MaxScrollOffset() const;
268 void SetScrollClipLayerId(int clip_layer_id
);
269 bool scrollable() const { return scroll_clip_layer_id_
!= INVALID_ID
; }
271 void SetUserScrollable(bool horizontal
, bool vertical
);
272 bool user_scrollable_horizontal() const {
273 return user_scrollable_horizontal_
;
275 bool user_scrollable_vertical() const { return user_scrollable_vertical_
; }
277 void SetShouldScrollOnMainThread(bool should_scroll_on_main_thread
);
278 bool should_scroll_on_main_thread() const {
279 return should_scroll_on_main_thread_
;
282 void SetHaveWheelEventHandlers(bool have_wheel_event_handlers
);
283 bool have_wheel_event_handlers() const { return have_wheel_event_handlers_
; }
285 void SetNonFastScrollableRegion(const Region
& non_fast_scrollable_region
);
286 const Region
& non_fast_scrollable_region() const {
287 return non_fast_scrollable_region_
;
290 void SetTouchEventHandlerRegion(const Region
& touch_event_handler_region
);
291 const Region
& touch_event_handler_region() const {
292 return touch_event_handler_region_
;
295 void set_did_scroll_callback(const base::Closure
& callback
) {
296 did_scroll_callback_
= callback
;
299 void SetDrawCheckerboardForMissingTiles(bool checkerboard
);
300 bool DrawCheckerboardForMissingTiles() const {
301 return draw_checkerboard_for_missing_tiles_
;
304 void SetForceRenderSurface(bool force_render_surface
);
305 bool force_render_surface() const { return force_render_surface_
; }
307 gfx::Vector2d
ScrollDelta() const { return gfx::Vector2d(); }
308 gfx::Vector2dF
TotalScrollOffset() const {
309 // Floating point to match the LayerImpl version.
310 return scroll_offset() + ScrollDelta();
313 void SetDoubleSided(bool double_sided
);
314 bool double_sided() const { return double_sided_
; }
316 void SetShouldFlattenTransform(bool flatten
);
317 bool should_flatten_transform() const { return should_flatten_transform_
; }
319 void SetIs3dSorted(bool sorted
);
320 bool is_3d_sorted() const { return is_3d_sorted_
; }
322 void set_use_parent_backface_visibility(bool use
) {
323 use_parent_backface_visibility_
= use
;
325 bool use_parent_backface_visibility() const {
326 return use_parent_backface_visibility_
;
329 virtual void SetLayerTreeHost(LayerTreeHost
* host
);
331 bool HasDelegatedContent() const { return false; }
332 bool HasContributingDelegatedRenderPasses() const { return false; }
334 void SetIsDrawable(bool is_drawable
);
336 void SetHideLayerAndSubtree(bool hide
);
337 bool hide_layer_and_subtree() const { return hide_layer_and_subtree_
; }
339 void SetReplicaLayer(Layer
* layer
);
340 Layer
* replica_layer() { return replica_layer_
.get(); }
341 const Layer
* replica_layer() const { return replica_layer_
.get(); }
343 bool has_mask() const { return !!mask_layer_
.get(); }
344 bool has_replica() const { return !!replica_layer_
.get(); }
345 bool replica_has_mask() const {
346 return replica_layer_
.get() &&
347 (mask_layer_
.get() || replica_layer_
->mask_layer_
.get());
350 // These methods typically need to be overwritten by derived classes.
351 virtual bool DrawsContent() const;
352 virtual void SavePaintProperties();
353 // Returns true iff any resources were updated that need to be committed.
354 virtual bool Update(ResourceUpdateQueue
* queue
,
355 const OcclusionTracker
* occlusion
);
356 virtual bool NeedMoreUpdates();
357 virtual void SetIsMask(bool is_mask
) {}
358 virtual void ReduceMemoryUsage() {}
359 virtual void OnOutputSurfaceCreated() {}
361 virtual scoped_refptr
<base::debug::ConvertableToTraceFormat
> TakeDebugInfo();
363 void SetLayerClient(LayerClient
* client
) { client_
= client
; }
365 virtual void PushPropertiesTo(LayerImpl
* layer
);
367 void CreateRenderSurface();
368 void ClearRenderSurface();
370 // The contents scale converts from logical, non-page-scaled pixels to target
371 // pixels. The contents scale is 1 for the root layer as it is already in
372 // physical pixels. By default contents scale is forced to be 1 except for
373 // subclasses of ContentsScalingLayer.
374 float contents_scale_x() const { return draw_properties_
.contents_scale_x
; }
375 float contents_scale_y() const { return draw_properties_
.contents_scale_y
; }
376 gfx::Size
content_bounds() const { return draw_properties_
.content_bounds
; }
378 virtual void CalculateContentsScale(float ideal_contents_scale
,
379 float device_scale_factor
,
380 float page_scale_factor
,
381 bool animating_transform_to_screen
,
382 float* contents_scale_x
,
383 float* contents_scale_y
,
384 gfx::Size
* content_bounds
);
386 LayerTreeHost
* layer_tree_host() { return layer_tree_host_
; }
387 const LayerTreeHost
* layer_tree_host() const { return layer_tree_host_
; }
389 // Set the priority of all desired textures in this layer.
390 virtual void SetTexturePriorities(const PriorityCalculator
& priority_calc
) {}
392 bool AddAnimation(scoped_ptr
<Animation
> animation
);
393 void PauseAnimation(int animation_id
, double time_offset
);
394 void RemoveAnimation(int animation_id
);
396 LayerAnimationController
* layer_animation_controller() {
397 return layer_animation_controller_
.get();
399 void SetLayerAnimationControllerForTest(
400 scoped_refptr
<LayerAnimationController
> controller
);
402 void set_layer_animation_delegate(AnimationDelegate
* delegate
) {
403 layer_animation_controller_
->set_layer_animation_delegate(delegate
);
406 bool HasActiveAnimation() const;
408 void AddLayerAnimationEventObserver(
409 LayerAnimationEventObserver
* animation_observer
);
410 void RemoveLayerAnimationEventObserver(
411 LayerAnimationEventObserver
* animation_observer
);
413 virtual Region
VisibleContentOpaqueRegion() const;
415 virtual ScrollbarLayerInterface
* ToScrollbarLayer();
417 gfx::Rect
LayerRectToContentRect(const gfx::RectF
& layer_rect
) const;
419 virtual skia::RefPtr
<SkPicture
> GetPicture() const;
421 // Constructs a LayerImpl of the correct runtime type for this Layer type.
422 virtual scoped_ptr
<LayerImpl
> CreateLayerImpl(LayerTreeImpl
* tree_impl
);
424 bool NeedsDisplayForTesting() const { return !update_rect_
.IsEmpty(); }
425 void ResetNeedsDisplayForTesting() { update_rect_
= gfx::RectF(); }
427 RenderingStatsInstrumentation
* rendering_stats_instrumentation() const;
429 const PaintProperties
& paint_properties() const {
430 return paint_properties_
;
433 // The scale at which contents should be rastered, to match the scale at
434 // which they will drawn to the screen. This scale is a component of the
435 // contents scale but does not include page/device scale factors.
436 // TODO(danakj): This goes away when TiledLayer goes away.
437 void set_raster_scale(float scale
) { raster_scale_
= scale
; }
438 float raster_scale() const { return raster_scale_
; }
439 bool raster_scale_is_unknown() const { return raster_scale_
== 0.f
; }
441 virtual bool SupportsLCDText() const;
443 void SetNeedsPushProperties();
444 bool needs_push_properties() const { return needs_push_properties_
; }
445 bool descendant_needs_push_properties() const {
446 return num_dependents_need_push_properties_
> 0;
448 void reset_needs_push_properties_for_testing() {
449 needs_push_properties_
= false;
452 virtual void RunMicroBenchmark(MicroBenchmark
* benchmark
);
455 friend class LayerImpl
;
456 friend class TreeSynchronizer
;
461 // These SetNeeds functions are in order of severity of update:
463 // Called when this layer has been modified in some way, but isn't sure
464 // that it needs a commit yet. It needs CalcDrawProperties and UpdateLayers
465 // before it knows whether or not a commit is required.
466 void SetNeedsUpdate();
467 // Called when a property has been modified in a way that the layer
468 // knows immediately that a commit is required. This implies SetNeedsUpdate
469 // as well as SetNeedsPushProperties to push that property.
470 void SetNeedsCommit();
471 // Called when there's been a change in layer structure. Implies both
472 // SetNeedsUpdate and SetNeedsCommit, but not SetNeedsPushProperties.
473 void SetNeedsFullTreeSync();
475 // Called when the next commit should wait until the pending tree is activated
476 // before finishing the commit and unblocking the main thread. Used to ensure
477 // unused resources on the impl thread are returned before commit completes.
478 void SetNextCommitWaitsForActivation();
480 // Called when the blend mode or filters have been changed.
481 void SetNeedsFilterContextIfNeeded();
483 void AddDependentNeedsPushProperties();
484 void RemoveDependentNeedsPushProperties();
485 bool parent_should_know_need_push_properties() const {
486 return needs_push_properties() || descendant_needs_push_properties();
489 bool IsPropertyChangeAllowed() const;
491 // If this layer has a scroll parent, it removes |this| from its list of
493 void RemoveFromScrollTree();
495 // If this layer has a clip parent, it removes |this| from its list of clip
497 void RemoveFromClipTree();
499 void reset_raster_scale_to_unknown() { raster_scale_
= 0.f
; }
501 // This flag is set when the layer needs to push properties to the impl
503 bool needs_push_properties_
;
505 // The number of direct children or dependent layers that need to be recursed
506 // to in order for them or a descendent of them to push properties to the impl
508 int num_dependents_need_push_properties_
;
510 // Tracks whether this layer may have changed stacking order with its
512 bool stacking_order_changed_
;
514 // The update rect is the region of the compositor resource that was
515 // actually updated by the compositor. For layers that may do updating
516 // outside the compositor's control (i.e. plugin layers), this information
517 // is not available and the update rect will remain empty.
518 // Note this rect is in layer space (not content space).
519 gfx::RectF update_rect_
;
521 scoped_refptr
<Layer
> mask_layer_
;
525 // When true, the layer is about to perform an update. Any commit requests
526 // will be handled implicitly after the update completes.
527 bool ignore_set_needs_commit_
;
530 friend class base::RefCounted
<Layer
>;
532 void SetParent(Layer
* layer
);
533 bool DescendantIsFixedToContainerLayer() const;
535 // Returns the index of the child or -1 if not found.
536 int IndexOfChild(const Layer
* reference
);
538 // This should only be called from RemoveFromParent().
539 void RemoveChildOrDependent(Layer
* child
);
541 // LayerAnimationValueProvider implementation.
542 virtual gfx::Vector2dF
ScrollOffsetForAnimation() const OVERRIDE
;
544 // LayerAnimationValueObserver implementation.
545 virtual void OnFilterAnimated(const FilterOperations
& filters
) OVERRIDE
;
546 virtual void OnOpacityAnimated(float opacity
) OVERRIDE
;
547 virtual void OnTransformAnimated(const gfx::Transform
& transform
) OVERRIDE
;
548 virtual void OnScrollOffsetAnimated(
549 const gfx::Vector2dF
& scroll_offset
) OVERRIDE
;
550 virtual void OnAnimationWaitingForDeletion() OVERRIDE
;
551 virtual bool IsActive() const OVERRIDE
;
556 // Layer instances have a weak pointer to their LayerTreeHost.
557 // This pointer value is nil when a Layer is not in a tree and is
558 // updated via SetLayerTreeHost() if a layer moves between trees.
559 LayerTreeHost
* layer_tree_host_
;
561 scoped_refptr
<LayerAnimationController
> layer_animation_controller_
;
566 gfx::Vector2d scroll_offset_
;
567 // This variable indicates which ancestor layer (if any) whose size,
568 // transformed relative to this layer, defines the maximum scroll offset for
570 int scroll_clip_layer_id_
;
571 bool scrollable_
: 1;
572 bool should_scroll_on_main_thread_
: 1;
573 bool have_wheel_event_handlers_
: 1;
574 bool user_scrollable_horizontal_
: 1;
575 bool user_scrollable_vertical_
: 1;
576 bool is_root_for_isolated_group_
: 1;
577 bool is_container_for_fixed_position_layers_
: 1;
578 bool is_drawable_
: 1;
579 bool hide_layer_and_subtree_
: 1;
580 bool masks_to_bounds_
: 1;
581 bool contents_opaque_
: 1;
582 bool double_sided_
: 1;
583 bool should_flatten_transform_
: 1;
584 bool use_parent_backface_visibility_
: 1;
585 bool draw_checkerboard_for_missing_tiles_
: 1;
586 bool force_render_surface_
: 1;
587 bool is_3d_sorted_
: 1;
588 Region non_fast_scrollable_region_
;
589 Region touch_event_handler_region_
;
590 gfx::PointF position_
;
591 gfx::PointF anchor_point_
;
592 SkColor background_color_
;
594 SkXfermode::Mode blend_mode_
;
595 FilterOperations filters_
;
596 FilterOperations background_filters_
;
597 float anchor_point_z_
;
598 LayerPositionConstraint position_constraint_
;
599 Layer
* scroll_parent_
;
600 scoped_ptr
<std::set
<Layer
*> > scroll_children_
;
603 scoped_ptr
<std::set
<Layer
*> > clip_children_
;
605 gfx::Transform transform_
;
607 // Replica layer used for reflections.
608 scoped_refptr
<Layer
> replica_layer_
;
610 // Transient properties.
613 LayerClient
* client_
;
615 ScopedPtrVector
<CopyOutputRequest
> copy_requests_
;
617 base::Closure did_scroll_callback_
;
619 DrawProperties
<Layer
> draw_properties_
;
621 PaintProperties paint_properties_
;
623 DISALLOW_COPY_AND_ASSIGN(Layer
);
628 #endif // CC_LAYERS_LAYER_H_