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/geometry/point3_f.h"
33 #include "ui/gfx/geometry/rect.h"
34 #include "ui/gfx/geometry/rect_f.h"
35 #include "ui/gfx/geometry/scroll_offset.h"
36 #include "ui/gfx/transform.h"
44 class ConvertableToTraceFormat
;
51 class AnimationDelegate
;
52 struct AnimationEvent
;
53 class CopyOutputRequest
;
54 class LayerAnimationDelegate
;
55 class LayerAnimationEventObserver
;
60 class PriorityCalculator
;
61 class RenderingStatsInstrumentation
;
62 class ResourceUpdateQueue
;
63 class ScrollbarLayerInterface
;
64 class SimpleEnclosedRegion
;
65 struct AnimationEvent
;
66 template <typename LayerType
>
67 class OcclusionTracker
;
69 // Base class for composited layers. Special layer types are derived from
71 class CC_EXPORT Layer
: public base::RefCounted
<Layer
>,
72 public LayerAnimationValueObserver
,
73 public LayerAnimationValueProvider
{
75 typedef RenderSurfaceLayerList RenderSurfaceListType
;
76 typedef LayerList LayerListType
;
77 typedef RenderSurface RenderSurfaceType
;
83 static scoped_refptr
<Layer
> Create();
85 int id() const { return layer_id_
; }
88 Layer
* parent() { return parent_
; }
89 const Layer
* parent() const { return parent_
; }
90 void AddChild(scoped_refptr
<Layer
> child
);
91 void InsertChild(scoped_refptr
<Layer
> child
, size_t index
);
92 void ReplaceChild(Layer
* reference
, scoped_refptr
<Layer
> new_layer
);
93 void RemoveFromParent();
94 void RemoveAllChildren();
95 void SetChildren(const LayerList
& children
);
96 bool HasAncestor(const Layer
* ancestor
) const;
98 const LayerList
& children() const { return children_
; }
99 Layer
* child_at(size_t index
) { return children_
[index
].get(); }
101 // This requests the layer and its subtree be rendered and given to the
102 // callback. If the copy is unable to be produced (the layer is destroyed
103 // first), then the callback is called with a nullptr/empty result.
104 void RequestCopyOfOutput(scoped_ptr
<CopyOutputRequest
> request
);
105 bool HasCopyRequest() const {
106 return !copy_requests_
.empty();
109 virtual void SetBackgroundColor(SkColor background_color
);
110 SkColor
background_color() const { return background_color_
; }
111 // If contents_opaque(), return an opaque color else return a
112 // non-opaque color. Tries to return background_color(), if possible.
113 SkColor
SafeOpaqueBackgroundColor() const;
115 // A layer's bounds are in logical, non-page-scaled pixels (however, the
116 // root layer's bounds are in physical pixels).
117 void SetBounds(const gfx::Size
& bounds
);
118 gfx::Size
bounds() const { return bounds_
; }
120 void SetMasksToBounds(bool masks_to_bounds
);
121 bool masks_to_bounds() const { return masks_to_bounds_
; }
123 void SetMaskLayer(Layer
* mask_layer
);
124 Layer
* mask_layer() { return mask_layer_
.get(); }
125 const Layer
* mask_layer() const { return mask_layer_
.get(); }
127 virtual void SetNeedsDisplayRect(const gfx::Rect
& dirty_rect
);
128 void SetNeedsDisplay() { SetNeedsDisplayRect(gfx::Rect(bounds())); }
130 void SetOpacity(float opacity
);
131 float opacity() const { return opacity_
; }
132 bool OpacityIsAnimating() const;
133 virtual bool OpacityCanAnimateOnImplThread() const;
135 void SetBlendMode(SkXfermode::Mode blend_mode
);
136 SkXfermode::Mode
blend_mode() const { return blend_mode_
; }
138 bool uses_default_blend_mode() const {
139 return blend_mode_
== SkXfermode::kSrcOver_Mode
;
142 // A layer is root for an isolated group when it and all its descendants are
143 // drawn over a black and fully transparent background, creating an isolated
144 // group. It should be used along with SetBlendMode(), in order to restrict
145 // layers within the group to blend with layers outside this group.
146 void SetIsRootForIsolatedGroup(bool root
);
147 bool is_root_for_isolated_group() const {
148 return is_root_for_isolated_group_
;
151 void SetFilters(const FilterOperations
& filters
);
152 const FilterOperations
& filters() const { return filters_
; }
153 bool FilterIsAnimating() const;
155 // Background filters are filters applied to what is behind this layer, when
156 // they are viewed through non-opaque regions in this layer. They are used
157 // through the WebLayer interface, and are not exposed to HTML.
158 void SetBackgroundFilters(const FilterOperations
& filters
);
159 const FilterOperations
& background_filters() const {
160 return background_filters_
;
163 virtual void SetContentsOpaque(bool opaque
);
164 bool contents_opaque() const { return contents_opaque_
; }
166 void SetPosition(const gfx::PointF
& position
);
167 gfx::PointF
position() const { return position_
; }
169 void SetIsContainerForFixedPositionLayers(bool container
);
170 bool IsContainerForFixedPositionLayers() const;
172 void SetPositionConstraint(const LayerPositionConstraint
& constraint
);
173 const LayerPositionConstraint
& position_constraint() const {
174 return position_constraint_
;
177 void SetTransform(const gfx::Transform
& transform
);
178 const gfx::Transform
& transform() const { return transform_
; }
179 bool TransformIsAnimating() const;
180 bool transform_is_invertible() const { return transform_is_invertible_
; }
182 void SetTransformOrigin(const gfx::Point3F
&);
183 gfx::Point3F
transform_origin() { return transform_origin_
; }
185 void SetScrollParent(Layer
* parent
);
187 Layer
* scroll_parent() { return scroll_parent_
; }
188 const Layer
* scroll_parent() const { return scroll_parent_
; }
190 void AddScrollChild(Layer
* child
);
191 void RemoveScrollChild(Layer
* child
);
193 std::set
<Layer
*>* scroll_children() { return scroll_children_
.get(); }
194 const std::set
<Layer
*>* scroll_children() const {
195 return scroll_children_
.get();
198 void SetClipParent(Layer
* ancestor
);
200 Layer
* clip_parent() { return clip_parent_
; }
201 const Layer
* clip_parent() const {
205 void AddClipChild(Layer
* child
);
206 void RemoveClipChild(Layer
* child
);
208 std::set
<Layer
*>* clip_children() { return clip_children_
.get(); }
209 const std::set
<Layer
*>* clip_children() const {
210 return clip_children_
.get();
213 DrawProperties
<Layer
>& draw_properties() { return draw_properties_
; }
214 const DrawProperties
<Layer
>& draw_properties() const {
215 return draw_properties_
;
218 // The following are shortcut accessors to get various information from
220 const gfx::Transform
& draw_transform() const {
221 return draw_properties_
.target_space_transform
;
223 const gfx::Transform
& screen_space_transform() const {
224 return draw_properties_
.screen_space_transform
;
226 float draw_opacity() const { return draw_properties_
.opacity
; }
227 bool draw_opacity_is_animating() const {
228 return draw_properties_
.opacity_is_animating
;
230 bool draw_transform_is_animating() const {
231 return draw_properties_
.target_space_transform_is_animating
;
233 bool screen_space_transform_is_animating() const {
234 return draw_properties_
.screen_space_transform_is_animating
;
236 bool screen_space_opacity_is_animating() const {
237 return draw_properties_
.screen_space_opacity_is_animating
;
239 bool can_use_lcd_text() const { return draw_properties_
.can_use_lcd_text
; }
240 bool is_clipped() const { return draw_properties_
.is_clipped
; }
241 gfx::Rect
clip_rect() const { return draw_properties_
.clip_rect
; }
242 gfx::Rect
drawable_content_rect() const {
243 return draw_properties_
.drawable_content_rect
;
245 gfx::Rect
visible_content_rect() const {
246 return draw_properties_
.visible_content_rect
;
248 Layer
* render_target() {
249 DCHECK(!draw_properties_
.render_target
||
250 draw_properties_
.render_target
->render_surface());
251 return draw_properties_
.render_target
;
253 const Layer
* render_target() const {
254 DCHECK(!draw_properties_
.render_target
||
255 draw_properties_
.render_target
->render_surface());
256 return draw_properties_
.render_target
;
258 RenderSurface
* render_surface() const {
259 return draw_properties_
.render_surface
.get();
261 int num_unclipped_descendants() const {
262 return draw_properties_
.num_unclipped_descendants
;
265 void SetScrollOffset(const gfx::ScrollOffset
& scroll_offset
);
266 gfx::ScrollOffset
scroll_offset() const { return scroll_offset_
; }
267 void SetScrollOffsetFromImplSide(const gfx::ScrollOffset
& scroll_offset
);
269 void SetScrollClipLayerId(int clip_layer_id
);
270 bool scrollable() const { return scroll_clip_layer_id_
!= INVALID_ID
; }
272 void SetUserScrollable(bool horizontal
, bool vertical
);
273 bool user_scrollable_horizontal() const {
274 return user_scrollable_horizontal_
;
276 bool user_scrollable_vertical() const { return user_scrollable_vertical_
; }
278 void SetShouldScrollOnMainThread(bool should_scroll_on_main_thread
);
279 bool should_scroll_on_main_thread() const {
280 return should_scroll_on_main_thread_
;
283 void SetHaveWheelEventHandlers(bool have_wheel_event_handlers
);
284 bool have_wheel_event_handlers() const { return have_wheel_event_handlers_
; }
286 void SetHaveScrollEventHandlers(bool have_scroll_event_handlers
);
287 bool have_scroll_event_handlers() const {
288 return have_scroll_event_handlers_
;
291 void SetNonFastScrollableRegion(const Region
& non_fast_scrollable_region
);
292 const Region
& non_fast_scrollable_region() const {
293 return non_fast_scrollable_region_
;
296 void SetTouchEventHandlerRegion(const Region
& touch_event_handler_region
);
297 const Region
& touch_event_handler_region() const {
298 return touch_event_handler_region_
;
301 void set_did_scroll_callback(const base::Closure
& callback
) {
302 did_scroll_callback_
= callback
;
305 void SetDrawCheckerboardForMissingTiles(bool checkerboard
);
306 bool draw_checkerboard_for_missing_tiles() const {
307 return draw_checkerboard_for_missing_tiles_
;
310 void SetForceRenderSurface(bool force_render_surface
);
311 bool force_render_surface() const { return force_render_surface_
; }
313 gfx::Vector2dF
ScrollDelta() const { return gfx::Vector2dF(); }
314 gfx::ScrollOffset
TotalScrollOffset() const {
315 return ScrollOffsetWithDelta(scroll_offset(), ScrollDelta());
318 void SetDoubleSided(bool double_sided
);
319 bool double_sided() const { return double_sided_
; }
321 void SetShouldFlattenTransform(bool flatten
);
322 bool should_flatten_transform() const { return should_flatten_transform_
; }
324 bool Is3dSorted() const { return sorting_context_id_
!= 0; }
326 void set_use_parent_backface_visibility(bool use
) {
327 use_parent_backface_visibility_
= use
;
329 bool use_parent_backface_visibility() const {
330 return use_parent_backface_visibility_
;
333 virtual void SetLayerTreeHost(LayerTreeHost
* host
);
335 virtual bool HasDelegatedContent() const;
336 bool HasContributingDelegatedRenderPasses() const { return false; }
338 void SetIsDrawable(bool is_drawable
);
340 void SetHideLayerAndSubtree(bool hide
);
341 bool hide_layer_and_subtree() const { return hide_layer_and_subtree_
; }
343 void SetReplicaLayer(Layer
* layer
);
344 Layer
* replica_layer() { return replica_layer_
.get(); }
345 const Layer
* replica_layer() const { return replica_layer_
.get(); }
347 bool has_mask() const { return !!mask_layer_
.get(); }
348 bool has_replica() const { return !!replica_layer_
.get(); }
349 bool replica_has_mask() const {
350 return replica_layer_
.get() &&
351 (mask_layer_
.get() || replica_layer_
->mask_layer_
.get());
354 int NumDescendantsThatDrawContent() const;
356 // This is only virtual for tests.
357 // TODO(awoloszyn): Remove this once we no longer need it for tests
358 virtual bool DrawsContent() const;
360 // This methods typically need to be overwritten by derived classes.
361 virtual void SavePaintProperties();
362 // Returns true iff any resources were updated that need to be committed.
363 virtual bool Update(ResourceUpdateQueue
* queue
,
364 const OcclusionTracker
<Layer
>* occlusion
);
365 virtual bool NeedMoreUpdates();
366 virtual void SetIsMask(bool is_mask
) {}
367 virtual void ReduceMemoryUsage() {}
368 virtual void OnOutputSurfaceCreated() {}
369 virtual bool IsSuitableForGpuRasterization() const;
371 virtual scoped_refptr
<base::debug::ConvertableToTraceFormat
> TakeDebugInfo();
373 void SetLayerClient(LayerClient
* client
) { client_
= client
; }
375 virtual void PushPropertiesTo(LayerImpl
* layer
);
377 void CreateRenderSurface();
378 void ClearRenderSurface();
379 void ClearRenderSurfaceLayerList();
381 // The contents scale converts from logical, non-page-scaled pixels to target
382 // pixels. The contents scale is 1 for the root layer as it is already in
383 // physical pixels. By default contents scale is forced to be 1 except for
384 // subclasses of ContentsScalingLayer.
385 float contents_scale_x() const { return draw_properties_
.contents_scale_x
; }
386 float contents_scale_y() const { return draw_properties_
.contents_scale_y
; }
387 gfx::Size
content_bounds() const { return draw_properties_
.content_bounds
; }
389 virtual void CalculateContentsScale(float ideal_contents_scale
,
390 float* contents_scale_x
,
391 float* contents_scale_y
,
392 gfx::Size
* content_bounds
);
394 LayerTreeHost
* layer_tree_host() { return layer_tree_host_
; }
395 const LayerTreeHost
* layer_tree_host() const { return layer_tree_host_
; }
397 // Set the priority of all desired textures in this layer.
398 virtual void SetTexturePriorities(const PriorityCalculator
& priority_calc
) {}
400 bool AddAnimation(scoped_ptr
<Animation
> animation
);
401 void PauseAnimation(int animation_id
, double time_offset
);
402 void RemoveAnimation(int animation_id
);
404 LayerAnimationController
* layer_animation_controller() {
405 return layer_animation_controller_
.get();
407 void SetLayerAnimationControllerForTest(
408 scoped_refptr
<LayerAnimationController
> controller
);
410 void set_layer_animation_delegate(AnimationDelegate
* delegate
) {
411 layer_animation_controller_
->set_layer_animation_delegate(delegate
);
414 bool HasActiveAnimation() const;
416 void AddLayerAnimationEventObserver(
417 LayerAnimationEventObserver
* animation_observer
);
418 void RemoveLayerAnimationEventObserver(
419 LayerAnimationEventObserver
* animation_observer
);
421 virtual SimpleEnclosedRegion
VisibleContentOpaqueRegion() const;
423 virtual ScrollbarLayerInterface
* ToScrollbarLayer();
425 gfx::Rect
LayerRectToContentRect(const gfx::Rect
& layer_rect
) const;
427 virtual skia::RefPtr
<SkPicture
> GetPicture() const;
429 // Constructs a LayerImpl of the correct runtime type for this Layer type.
430 virtual scoped_ptr
<LayerImpl
> CreateLayerImpl(LayerTreeImpl
* tree_impl
);
432 bool NeedsDisplayForTesting() const { return !update_rect_
.IsEmpty(); }
433 void ResetNeedsDisplayForTesting() { update_rect_
= gfx::Rect(); }
435 RenderingStatsInstrumentation
* rendering_stats_instrumentation() const;
437 const PaintProperties
& paint_properties() const {
438 return paint_properties_
;
441 // The scale at which contents should be rastered, to match the scale at
442 // which they will drawn to the screen. This scale is a component of the
443 // contents scale but does not include page/device scale factors.
444 // TODO(danakj): This goes away when TiledLayer goes away.
445 void set_raster_scale(float scale
) { raster_scale_
= scale
; }
446 float raster_scale() const { return raster_scale_
; }
447 bool raster_scale_is_unknown() const { return raster_scale_
== 0.f
; }
449 virtual bool SupportsLCDText() const;
451 void SetNeedsPushProperties();
452 bool needs_push_properties() const { return needs_push_properties_
; }
453 bool descendant_needs_push_properties() const {
454 return num_dependents_need_push_properties_
> 0;
456 void reset_needs_push_properties_for_testing() {
457 needs_push_properties_
= false;
460 virtual void RunMicroBenchmark(MicroBenchmark
* benchmark
);
462 void Set3dSortingContextId(int id
);
463 int sorting_context_id() const { return sorting_context_id_
; }
466 friend class LayerImpl
;
467 friend class TreeSynchronizer
;
472 // These SetNeeds functions are in order of severity of update:
474 // Called when this layer has been modified in some way, but isn't sure
475 // that it needs a commit yet. It needs CalcDrawProperties and UpdateLayers
476 // before it knows whether or not a commit is required.
477 void SetNeedsUpdate();
478 // Called when a property has been modified in a way that the layer
479 // knows immediately that a commit is required. This implies SetNeedsUpdate
480 // as well as SetNeedsPushProperties to push that property.
481 void SetNeedsCommit();
482 // Called when there's been a change in layer structure. Implies both
483 // SetNeedsUpdate and SetNeedsCommit, but not SetNeedsPushProperties.
484 void SetNeedsFullTreeSync();
486 // Called when the next commit should wait until the pending tree is activated
487 // before finishing the commit and unblocking the main thread. Used to ensure
488 // unused resources on the impl thread are returned before commit completes.
489 void SetNextCommitWaitsForActivation();
491 // Will recalculate whether the layer draws content and set draws_content_
493 void UpdateDrawsContent(bool has_drawable_content
);
494 virtual bool HasDrawableContent() const;
496 // Called when the layer's number of drawable descendants changes.
497 void AddDrawableDescendants(int num
);
499 void AddDependentNeedsPushProperties();
500 void RemoveDependentNeedsPushProperties();
501 bool parent_should_know_need_push_properties() const {
502 return needs_push_properties() || descendant_needs_push_properties();
505 bool IsPropertyChangeAllowed() const;
507 void reset_raster_scale_to_unknown() { raster_scale_
= 0.f
; }
509 // This flag is set when the layer needs to push properties to the impl
511 bool needs_push_properties_
;
513 // The number of direct children or dependent layers that need to be recursed
514 // to in order for them or a descendent of them to push properties to the impl
516 int num_dependents_need_push_properties_
;
518 // Tracks whether this layer may have changed stacking order with its
520 bool stacking_order_changed_
;
522 // The update rect is the region of the compositor resource that was
523 // actually updated by the compositor. For layers that may do updating
524 // outside the compositor's control (i.e. plugin layers), this information
525 // is not available and the update rect will remain empty.
526 // Note this rect is in layer space (not content space).
527 gfx::Rect update_rect_
;
529 scoped_refptr
<Layer
> mask_layer_
;
533 // When true, the layer is about to perform an update. Any commit requests
534 // will be handled implicitly after the update completes.
535 bool ignore_set_needs_commit_
;
537 // Layers that share a sorting context id will be sorted together in 3d
538 // space. 0 is a special value that means this layer will not be sorted and
539 // will be drawn in paint order.
540 int sorting_context_id_
;
543 friend class base::RefCounted
<Layer
>;
545 void SetParent(Layer
* layer
);
546 bool DescendantIsFixedToContainerLayer() const;
548 // Returns the index of the child or -1 if not found.
549 int IndexOfChild(const Layer
* reference
);
551 // This should only be called from RemoveFromParent().
552 void RemoveChildOrDependent(Layer
* child
);
554 // LayerAnimationValueProvider implementation.
555 gfx::ScrollOffset
ScrollOffsetForAnimation() const override
;
557 // LayerAnimationValueObserver implementation.
558 void OnFilterAnimated(const FilterOperations
& filters
) override
;
559 void OnOpacityAnimated(float opacity
) override
;
560 void OnTransformAnimated(const gfx::Transform
& transform
) override
;
561 void OnScrollOffsetAnimated(const gfx::ScrollOffset
& scroll_offset
) override
;
562 void OnAnimationWaitingForDeletion() override
;
563 bool IsActive() const override
;
565 // If this layer has a scroll parent, it removes |this| from its list of
567 void RemoveFromScrollTree();
569 // If this layer has a clip parent, it removes |this| from its list of clip
571 void RemoveFromClipTree();
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::ScrollOffset 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_