[go: nahoru, domu]

blob: 771431541fff3cb0ce806ff94a0269be6d58bd74 [file] [log] [blame]
enne@chromium.orgcd57cc5a2012-10-12 22:43:411// Copyright 2010 The Chromium Authors. All rights reserved.
enne@chromium.org0fb25002012-10-12 07:20:022// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
enne@chromium.orgcd57cc5a2012-10-12 22:43:414
jamesr@chromium.orgcc3cfaa2013-03-18 09:05:525#ifndef CC_LAYERS_LAYER_H_
6#define CC_LAYERS_LAYER_H_
enne@chromium.orgcd57cc5a2012-10-12 22:43:417
vollick@chromium.org0e98cdd2013-08-23 00:44:308#include <set>
shawnsingh@chromium.orgc8686a02012-11-27 08:29:009#include <string>
shawnsingh@chromium.orgc8686a02012-11-27 08:29:0010
danakj@chromium.org18a70192013-04-26 16:18:2511#include "base/callback.h"
tfarina@chromium.orga8461d82012-10-16 21:11:1412#include "base/memory/ref_counted.h"
ajuma@chromium.orge10cd022012-12-18 00:32:2613#include "base/observer_list.h"
jamesr@chromium.org95e4e1a02013-03-18 07:09:0914#include "cc/animation/layer_animation_controller.h"
jamesr@chromium.org95e4e1a02013-03-18 07:09:0915#include "cc/animation/layer_animation_value_observer.h"
ajuma@chromium.orgb8384e22013-12-03 02:20:4816#include "cc/animation/layer_animation_value_provider.h"
jamesr@chromium.org681ccff2013-03-18 06:13:5217#include "cc/base/cc_export.h"
18#include "cc/base/region.h"
danakj@chromium.org0e5f7142013-05-24 06:45:3619#include "cc/base/scoped_ptr_vector.h"
vmpstr@chromium.org666d7cf2013-10-12 01:30:2920#include "cc/debug/micro_benchmark.h"
jamesr@chromium.orgcc3cfaa2013-03-18 09:05:5221#include "cc/layers/draw_properties.h"
danakj@chromium.org50761e92013-03-29 20:51:2822#include "cc/layers/layer_lists.h"
trchen@chromium.orgfe956c9c42013-04-09 04:26:3323#include "cc/layers/layer_position_constraint.h"
reveman@chromium.org445881f2013-04-16 01:11:5924#include "cc/layers/paint_properties.h"
jamesr@chromium.orgcc3cfaa2013-03-18 09:05:5225#include "cc/layers/render_surface.h"
ajuma@chromium.orgae6b1a72013-06-25 18:49:2926#include "cc/output/filter_operations.h"
vollick51ed1a22014-12-17 02:03:0027#include "cc/trees/property_tree.h"
danakj@chromium.org1940c4e2012-12-04 05:08:1528#include "skia/ext/refptr.h"
tfarina@chromium.orgddf9df82012-10-16 06:52:4629#include "third_party/skia/include/core/SkColor.h"
danakj@chromium.org1940c4e2012-12-04 05:08:1530#include "third_party/skia/include/core/SkImageFilter.h"
alokp@chromium.orgf7837a92013-08-21 03:00:0531#include "third_party/skia/include/core/SkPicture.h"
rosca@adobe.com7bbeaf4e2013-11-26 10:27:2232#include "third_party/skia/include/core/SkXfermode.h"
heejin.r.chungd28506ba2014-10-23 16:36:2033#include "ui/gfx/geometry/point3_f.h"
34#include "ui/gfx/geometry/rect.h"
35#include "ui/gfx/geometry/rect_f.h"
miletusf57925d2014-10-01 19:38:1336#include "ui/gfx/geometry/scroll_offset.h"
shawnsingh@chromium.orgc8686a02012-11-27 08:29:0037#include "ui/gfx/transform.h"
enne@chromium.orgcd57cc5a2012-10-12 22:43:4138
ajuma@chromium.orgdb2586f2013-08-15 22:03:1439namespace gfx {
40class BoxF;
41}
42
chrishtr@gmail.com9f3be432013-12-03 03:53:2243namespace base {
44namespace debug {
45class ConvertableToTraceFormat;
46}
47}
48
enne@chromium.orgcd57cc5a2012-10-12 22:43:4149namespace cc {
50
vollick@chromium.org4d0786a2013-01-07 16:21:2051class Animation;
tfarina@chromium.org3cae03e2013-06-26 22:13:5252class AnimationDelegate;
enne@chromium.org96baf3e2012-10-22 23:09:5553struct AnimationEvent;
danakj@chromium.org0e5f7142013-05-24 06:45:3654class CopyOutputRequest;
enne@chromium.org96baf3e2012-10-22 23:09:5555class LayerAnimationDelegate;
ajuma@chromium.org7f5605c2013-04-08 18:08:3556class LayerAnimationEventObserver;
qiankun.miao@intel.comae716ce2013-08-16 13:04:2457class LayerClient;
enne@chromium.org96baf3e2012-10-22 23:09:5558class LayerImpl;
59class LayerTreeHost;
nduca@chromium.org8bef40572012-12-11 21:38:0860class LayerTreeImpl;
enne@chromium.org96baf3e2012-10-22 23:09:5561class PriorityCalculator;
egraether@chromium.orgd84116612013-03-29 05:32:4962class RenderingStatsInstrumentation;
reveman@google.comb4da2032012-10-25 21:22:5563class ResourceUpdateQueue;
wjmaclean@chromium.org80413d72013-08-30 20:25:3364class ScrollbarLayerInterface;
danakj@chromium.orgd5467eb2014-08-22 01:16:4365class SimpleEnclosedRegion;
enne@chromium.org96baf3e2012-10-22 23:09:5566struct AnimationEvent;
danakj@chromium.org34ba1ffb2014-03-05 06:55:0367template <typename LayerType>
68class OcclusionTracker;
enne@chromium.orgcd57cc5a2012-10-12 22:43:4169
70// Base class for composited layers. Special layer types are derived from
71// this class.
vollick@chromium.orgde4afb5e2012-12-20 00:11:3472class CC_EXPORT Layer : public base::RefCounted<Layer>,
ajuma@chromium.orgb8384e22013-12-03 02:20:4873 public LayerAnimationValueObserver,
74 public LayerAnimationValueProvider {
danakj@chromium.org7aba6662013-03-12 10:17:3475 public:
vollick@chromium.org44d8e84c2013-10-19 19:13:2276 typedef RenderSurfaceLayerList RenderSurfaceListType;
77 typedef LayerList LayerListType;
78 typedef RenderSurface RenderSurfaceType;
79
wjmaclean@chromium.orgb7c47832013-03-15 23:11:4280 enum LayerIdLabels {
wjmaclean@chromium.orgb7c47832013-03-15 23:11:4281 INVALID_ID = -1,
82 };
enne@chromium.orgcd57cc5a2012-10-12 22:43:4183
danakj@chromium.org7aba6662013-03-12 10:17:3484 static scoped_refptr<Layer> Create();
enne@chromium.orgcd57cc5a2012-10-12 22:43:4185
danakj@chromium.org7aba6662013-03-12 10:17:3486 int id() const { return layer_id_; }
enne@chromium.orgcd57cc5a2012-10-12 22:43:4187
danakj@chromium.org7aba6662013-03-12 10:17:3488 Layer* RootLayer();
89 Layer* parent() { return parent_; }
90 const Layer* parent() const { return parent_; }
91 void AddChild(scoped_refptr<Layer> child);
92 void InsertChild(scoped_refptr<Layer> child, size_t index);
93 void ReplaceChild(Layer* reference, scoped_refptr<Layer> new_layer);
94 void RemoveFromParent();
95 void RemoveAllChildren();
96 void SetChildren(const LayerList& children);
tfarina@chromium.orgf659521e2013-07-26 00:27:0697 bool HasAncestor(const Layer* ancestor) const;
enne@chromium.orgcd57cc5a2012-10-12 22:43:4198
danakj@chromium.org7aba6662013-03-12 10:17:3499 const LayerList& children() const { return children_; }
100 Layer* child_at(size_t index) { return children_[index].get(); }
danakj@chromium.org18a70192013-04-26 16:18:25101
danakj@chromium.org0e5f7142013-05-24 06:45:36102 // This requests the layer and its subtree be rendered and given to the
103 // callback. If the copy is unable to be produced (the layer is destroyed
kulkarni.a4015690f12014-10-10 13:50:06104 // first), then the callback is called with a nullptr/empty result.
danakj@chromium.org0e5f7142013-05-24 06:45:36105 void RequestCopyOfOutput(scoped_ptr<CopyOutputRequest> request);
106 bool HasCopyRequest() const {
107 return !copy_requests_.empty();
danakj@chromium.org18a70192013-04-26 16:18:25108 }
enne@chromium.orgcd57cc5a2012-10-12 22:43:41109
danakj@chromium.org7aba6662013-03-12 10:17:34110 virtual void SetBackgroundColor(SkColor background_color);
111 SkColor background_color() const { return background_color_; }
enne@chromium.org2c4cbec2013-06-04 21:14:50112 // If contents_opaque(), return an opaque color else return a
113 // non-opaque color. Tries to return background_color(), if possible.
114 SkColor SafeOpaqueBackgroundColor() const;
enne@chromium.orgcd57cc5a2012-10-12 22:43:41115
danakj@chromium.org7aba6662013-03-12 10:17:34116 // A layer's bounds are in logical, non-page-scaled pixels (however, the
117 // root layer's bounds are in physical pixels).
prashant.n@samsung.com64348ea2014-01-29 22:58:26118 void SetBounds(const gfx::Size& bounds);
danakj@chromium.org7aba6662013-03-12 10:17:34119 gfx::Size bounds() const { return bounds_; }
enne@chromium.orgcd57cc5a2012-10-12 22:43:41120
danakj@chromium.org7aba6662013-03-12 10:17:34121 void SetMasksToBounds(bool masks_to_bounds);
122 bool masks_to_bounds() const { return masks_to_bounds_; }
enne@chromium.orgcd57cc5a2012-10-12 22:43:41123
danakj@chromium.org7aba6662013-03-12 10:17:34124 void SetMaskLayer(Layer* mask_layer);
125 Layer* mask_layer() { return mask_layer_.get(); }
126 const Layer* mask_layer() const { return mask_layer_.get(); }
enne@chromium.orgcd57cc5a2012-10-12 22:43:41127
danakj19f0c9e2014-10-11 03:24:42128 virtual void SetNeedsDisplayRect(const gfx::Rect& dirty_rect);
129 void SetNeedsDisplay() { SetNeedsDisplayRect(gfx::Rect(bounds())); }
enne@chromium.orgcd57cc5a2012-10-12 22:43:41130
danakj@chromium.org7aba6662013-03-12 10:17:34131 void SetOpacity(float opacity);
132 float opacity() const { return opacity_; }
133 bool OpacityIsAnimating() const;
wjmaclean@chromium.orgb7c47832013-03-15 23:11:42134 virtual bool OpacityCanAnimateOnImplThread() const;
rosca@adobe.com7bbeaf4e2013-11-26 10:27:22135
136 void SetBlendMode(SkXfermode::Mode blend_mode);
137 SkXfermode::Mode blend_mode() const { return blend_mode_; }
138
139 bool uses_default_blend_mode() const {
140 return blend_mode_ == SkXfermode::kSrcOver_Mode;
141 }
142
143 // A layer is root for an isolated group when it and all its descendants are
144 // drawn over a black and fully transparent background, creating an isolated
145 // group. It should be used along with SetBlendMode(), in order to restrict
146 // layers within the group to blend with layers outside this group.
147 void SetIsRootForIsolatedGroup(bool root);
148 bool is_root_for_isolated_group() const {
149 return is_root_for_isolated_group_;
150 }
enne@chromium.orgcd57cc5a2012-10-12 22:43:41151
ajuma@chromium.orgae6b1a72013-06-25 18:49:29152 void SetFilters(const FilterOperations& filters);
153 const FilterOperations& filters() const { return filters_; }
ajuma@chromium.orgb4c6d812013-10-03 15:48:56154 bool FilterIsAnimating() const;
senorblanco@chromium.org4000abf2012-10-23 04:45:45155
danakj@chromium.org7aba6662013-03-12 10:17:34156 // Background filters are filters applied to what is behind this layer, when
157 // they are viewed through non-opaque regions in this layer. They are used
158 // through the WebLayer interface, and are not exposed to HTML.
ajuma@chromium.orgae6b1a72013-06-25 18:49:29159 void SetBackgroundFilters(const FilterOperations& filters);
160 const FilterOperations& background_filters() const {
danakj@chromium.org7aba6662013-03-12 10:17:34161 return background_filters_;
162 }
enne@chromium.orgcd57cc5a2012-10-12 22:43:41163
danakj@chromium.org7aba6662013-03-12 10:17:34164 virtual void SetContentsOpaque(bool opaque);
165 bool contents_opaque() const { return contents_opaque_; }
enne@chromium.orgcd57cc5a2012-10-12 22:43:41166
r.kasibhatla@samsung.com14bc5d682014-01-17 07:26:47167 void SetPosition(const gfx::PointF& position);
danakj@chromium.org7aba6662013-03-12 10:17:34168 gfx::PointF position() const { return position_; }
enne@chromium.orgcd57cc5a2012-10-12 22:43:41169
danakj@chromium.org7aba6662013-03-12 10:17:34170 void SetIsContainerForFixedPositionLayers(bool container);
trchen@chromium.orgfe956c9c42013-04-09 04:26:33171 bool IsContainerForFixedPositionLayers() const;
enne@chromium.orgcd57cc5a2012-10-12 22:43:41172
trchen@chromium.orgfe956c9c42013-04-09 04:26:33173 void SetPositionConstraint(const LayerPositionConstraint& constraint);
174 const LayerPositionConstraint& position_constraint() const {
175 return position_constraint_;
176 }
enne@chromium.orgcd57cc5a2012-10-12 22:43:41177
danakj@chromium.org7aba6662013-03-12 10:17:34178 void SetTransform(const gfx::Transform& transform);
179 const gfx::Transform& transform() const { return transform_; }
180 bool TransformIsAnimating() const;
avallee@chromium.org08bdf1b2014-04-16 23:23:29181 bool transform_is_invertible() const { return transform_is_invertible_; }
chrishtr@chromium.orga2566412014-06-05 03:14:20182
183 void SetTransformOrigin(const gfx::Point3F&);
vollick51ed1a22014-12-17 02:03:00184 gfx::Point3F transform_origin() const { return transform_origin_; }
vollick@chromium.org0e98cdd2013-08-23 00:44:30185
186 void SetScrollParent(Layer* parent);
187
188 Layer* scroll_parent() { return scroll_parent_; }
189 const Layer* scroll_parent() const { return scroll_parent_; }
190
191 void AddScrollChild(Layer* child);
192 void RemoveScrollChild(Layer* child);
193
194 std::set<Layer*>* scroll_children() { return scroll_children_.get(); }
195 const std::set<Layer*>* scroll_children() const {
196 return scroll_children_.get();
197 }
198
199 void SetClipParent(Layer* ancestor);
200
201 Layer* clip_parent() { return clip_parent_; }
202 const Layer* clip_parent() const {
203 return clip_parent_;
204 }
205
206 void AddClipChild(Layer* child);
207 void RemoveClipChild(Layer* child);
208
209 std::set<Layer*>* clip_children() { return clip_children_.get(); }
210 const std::set<Layer*>* clip_children() const {
211 return clip_children_.get();
212 }
enne@chromium.orgcd57cc5a2012-10-12 22:43:41213
vollick@chromium.org44d8e84c2013-10-19 19:13:22214 DrawProperties<Layer>& draw_properties() { return draw_properties_; }
215 const DrawProperties<Layer>& draw_properties() const {
danakj@chromium.org7aba6662013-03-12 10:17:34216 return draw_properties_;
217 }
shawnsingh@google.comd76806f82012-12-05 21:41:50218
danakj@chromium.org7aba6662013-03-12 10:17:34219 // The following are shortcut accessors to get various information from
220 // draw_properties_
221 const gfx::Transform& draw_transform() const {
222 return draw_properties_.target_space_transform;
223 }
224 const gfx::Transform& screen_space_transform() const {
225 return draw_properties_.screen_space_transform;
226 }
227 float draw_opacity() const { return draw_properties_.opacity; }
228 bool draw_opacity_is_animating() const {
229 return draw_properties_.opacity_is_animating;
230 }
231 bool draw_transform_is_animating() const {
232 return draw_properties_.target_space_transform_is_animating;
233 }
234 bool screen_space_transform_is_animating() const {
235 return draw_properties_.screen_space_transform_is_animating;
236 }
237 bool screen_space_opacity_is_animating() const {
238 return draw_properties_.screen_space_opacity_is_animating;
239 }
240 bool can_use_lcd_text() const { return draw_properties_.can_use_lcd_text; }
241 bool is_clipped() const { return draw_properties_.is_clipped; }
242 gfx::Rect clip_rect() const { return draw_properties_.clip_rect; }
243 gfx::Rect drawable_content_rect() const {
244 return draw_properties_.drawable_content_rect;
245 }
246 gfx::Rect visible_content_rect() const {
247 return draw_properties_.visible_content_rect;
248 }
249 Layer* render_target() {
250 DCHECK(!draw_properties_.render_target ||
251 draw_properties_.render_target->render_surface());
252 return draw_properties_.render_target;
253 }
254 const Layer* render_target() const {
255 DCHECK(!draw_properties_.render_target ||
256 draw_properties_.render_target->render_surface());
257 return draw_properties_.render_target;
258 }
259 RenderSurface* render_surface() const {
260 return draw_properties_.render_surface.get();
261 }
vollick@chromium.org420fdf6e2013-08-26 20:36:38262 int num_unclipped_descendants() const {
263 return draw_properties_.num_unclipped_descendants;
264 }
enne@chromium.orgcd57cc5a2012-10-12 22:43:41265
miletusf57925d2014-10-01 19:38:13266 void SetScrollOffset(const gfx::ScrollOffset& scroll_offset);
267 gfx::ScrollOffset scroll_offset() const { return scroll_offset_; }
268 void SetScrollOffsetFromImplSide(const gfx::ScrollOffset& scroll_offset);
enne@chromium.orgcd57cc5a2012-10-12 22:43:41269
wjmaclean@chromium.orgadeda572014-01-31 00:49:47270 void SetScrollClipLayerId(int clip_layer_id);
271 bool scrollable() const { return scroll_clip_layer_id_ != INVALID_ID; }
enne@chromium.orgcd57cc5a2012-10-12 22:43:41272
sadrul@chromium.org59a7d552013-10-22 03:36:43273 void SetUserScrollable(bool horizontal, bool vertical);
274 bool user_scrollable_horizontal() const {
275 return user_scrollable_horizontal_;
276 }
277 bool user_scrollable_vertical() const { return user_scrollable_vertical_; }
278
danakj@chromium.org7aba6662013-03-12 10:17:34279 void SetShouldScrollOnMainThread(bool should_scroll_on_main_thread);
280 bool should_scroll_on_main_thread() const {
281 return should_scroll_on_main_thread_;
282 }
enne@chromium.orgcd57cc5a2012-10-12 22:43:41283
danakj@chromium.org7aba6662013-03-12 10:17:34284 void SetHaveWheelEventHandlers(bool have_wheel_event_handlers);
285 bool have_wheel_event_handlers() const { return have_wheel_event_handlers_; }
enne@chromium.orgcd57cc5a2012-10-12 22:43:41286
skyostil@chromium.orgf998c532014-03-31 20:02:51287 void SetHaveScrollEventHandlers(bool have_scroll_event_handlers);
288 bool have_scroll_event_handlers() const {
289 return have_scroll_event_handlers_;
290 }
291
danakj@chromium.org7aba6662013-03-12 10:17:34292 void SetNonFastScrollableRegion(const Region& non_fast_scrollable_region);
293 const Region& non_fast_scrollable_region() const {
294 return non_fast_scrollable_region_;
295 }
enne@chromium.orgcd57cc5a2012-10-12 22:43:41296
danakj@chromium.org7aba6662013-03-12 10:17:34297 void SetTouchEventHandlerRegion(const Region& touch_event_handler_region);
298 const Region& touch_event_handler_region() const {
299 return touch_event_handler_region_;
300 }
yusufo@chromium.org23d56be2012-11-08 00:33:34301
tfarina@chromium.org28096ed2013-07-01 07:38:58302 void set_did_scroll_callback(const base::Closure& callback) {
303 did_scroll_callback_ = callback;
danakj@chromium.org7aba6662013-03-12 10:17:34304 }
enne@chromium.orgcd57cc5a2012-10-12 22:43:41305
danakj@chromium.org7aba6662013-03-12 10:17:34306 void SetDrawCheckerboardForMissingTiles(bool checkerboard);
danakj@chromium.orgb74241eb2014-03-08 11:35:02307 bool draw_checkerboard_for_missing_tiles() const {
danakj@chromium.org7aba6662013-03-12 10:17:34308 return draw_checkerboard_for_missing_tiles_;
309 }
enne@chromium.orgcd57cc5a2012-10-12 22:43:41310
danakj@chromium.org7aba6662013-03-12 10:17:34311 void SetForceRenderSurface(bool force_render_surface);
312 bool force_render_surface() const { return force_render_surface_; }
enne@chromium.orgcd57cc5a2012-10-12 22:43:41313
miletusf57925d2014-10-01 19:38:13314 gfx::Vector2dF ScrollDelta() const { return gfx::Vector2dF(); }
315 gfx::ScrollOffset TotalScrollOffset() const {
316 return ScrollOffsetWithDelta(scroll_offset(), ScrollDelta());
enne@chromium.org4ec78f82013-07-11 18:45:47317 }
enne@chromium.orgcd57cc5a2012-10-12 22:43:41318
danakj@chromium.org7aba6662013-03-12 10:17:34319 void SetDoubleSided(bool double_sided);
320 bool double_sided() const { return double_sided_; }
enne@chromium.orgcd57cc5a2012-10-12 22:43:41321
vollick@chromium.org56fffdd2014-02-11 19:50:57322 void SetShouldFlattenTransform(bool flatten);
323 bool should_flatten_transform() const { return should_flatten_transform_; }
324
thildebr@chromium.orga9d4d4f2014-06-19 06:49:28325 bool Is3dSorted() const { return sorting_context_id_ != 0; }
enne@chromium.orgcd57cc5a2012-10-12 22:43:41326
danakj@chromium.org7aba6662013-03-12 10:17:34327 void set_use_parent_backface_visibility(bool use) {
328 use_parent_backface_visibility_ = use;
329 }
330 bool use_parent_backface_visibility() const {
331 return use_parent_backface_visibility_;
332 }
enne@chromium.orgcd57cc5a2012-10-12 22:43:41333
danakj@chromium.org7aba6662013-03-12 10:17:34334 virtual void SetLayerTreeHost(LayerTreeHost* host);
enne@chromium.orgcd57cc5a2012-10-12 22:43:41335
awoloszyn@chromium.orgad63b2f2014-08-11 17:39:54336 virtual bool HasDelegatedContent() const;
danakj@chromium.org7aba6662013-03-12 10:17:34337 bool HasContributingDelegatedRenderPasses() const { return false; }
enne@chromium.orgcd57cc5a2012-10-12 22:43:41338
danakj@chromium.org7aba6662013-03-12 10:17:34339 void SetIsDrawable(bool is_drawable);
enne@chromium.orgcd57cc5a2012-10-12 22:43:41340
danakj@chromium.orgc0ae06c2013-06-24 18:32:19341 void SetHideLayerAndSubtree(bool hide);
342 bool hide_layer_and_subtree() const { return hide_layer_and_subtree_; }
343
danakj@chromium.org7aba6662013-03-12 10:17:34344 void SetReplicaLayer(Layer* layer);
345 Layer* replica_layer() { return replica_layer_.get(); }
346 const Layer* replica_layer() const { return replica_layer_.get(); }
enne@chromium.orgcd57cc5a2012-10-12 22:43:41347
rsleevi@chromium.org22898ed2013-06-01 04:52:30348 bool has_mask() const { return !!mask_layer_.get(); }
349 bool has_replica() const { return !!replica_layer_.get(); }
danakj@chromium.org7aba6662013-03-12 10:17:34350 bool replica_has_mask() const {
rsleevi@chromium.org22898ed2013-06-01 04:52:30351 return replica_layer_.get() &&
352 (mask_layer_.get() || replica_layer_->mask_layer_.get());
danakj@chromium.org7aba6662013-03-12 10:17:34353 }
enne@chromium.orgcd57cc5a2012-10-12 22:43:41354
awoloszyn@chromium.orgad63b2f2014-08-11 17:39:54355 int NumDescendantsThatDrawContent() const;
356
357 // This is only virtual for tests.
358 // TODO(awoloszyn): Remove this once we no longer need it for tests
danakj@chromium.org7aba6662013-03-12 10:17:34359 virtual bool DrawsContent() const;
awoloszyn@chromium.orgad63b2f2014-08-11 17:39:54360
361 // This methods typically need to be overwritten by derived classes.
reveman@chromium.org445881f2013-04-16 01:11:59362 virtual void SavePaintProperties();
enne@chromium.org49304bde2013-07-08 21:31:22363 // Returns true iff any resources were updated that need to be committed.
364 virtual bool Update(ResourceUpdateQueue* queue,
danakj@chromium.org34ba1ffb2014-03-05 06:55:03365 const OcclusionTracker<Layer>* occlusion);
danakj@chromium.org7aba6662013-03-12 10:17:34366 virtual bool NeedMoreUpdates();
367 virtual void SetIsMask(bool is_mask) {}
ccameron@chromium.org4830141f2013-05-18 01:36:05368 virtual void ReduceMemoryUsage() {}
ccameron@chromium.org039fa8c2013-10-09 22:37:28369 virtual void OnOutputSurfaceCreated() {}
alokp@chromium.orga6c1b232014-05-05 23:53:08370 virtual bool IsSuitableForGpuRasterization() const;
enne@chromium.orgcd57cc5a2012-10-12 22:43:41371
chrishtr@gmail.com9f3be432013-12-03 03:53:22372 virtual scoped_refptr<base::debug::ConvertableToTraceFormat> TakeDebugInfo();
qiankun.miao@intel.comae716ce2013-08-16 13:04:24373
374 void SetLayerClient(LayerClient* client) { client_ = client; }
375
danakj@chromium.org7aba6662013-03-12 10:17:34376 virtual void PushPropertiesTo(LayerImpl* layer);
377
danakj@chromium.org7aba6662013-03-12 10:17:34378 void CreateRenderSurface();
danakj@chromium.org50761e92013-03-29 20:51:28379 void ClearRenderSurface();
vollick@chromium.org7644fa22014-04-28 12:20:33380 void ClearRenderSurfaceLayerList();
danakj@chromium.org7aba6662013-03-12 10:17:34381
danakj@chromium.orged511b8d2013-03-25 03:29:29382 // The contents scale converts from logical, non-page-scaled pixels to target
383 // pixels. The contents scale is 1 for the root layer as it is already in
384 // physical pixels. By default contents scale is forced to be 1 except for
danakj@chromium.org7aba6662013-03-12 10:17:34385 // subclasses of ContentsScalingLayer.
386 float contents_scale_x() const { return draw_properties_.contents_scale_x; }
387 float contents_scale_y() const { return draw_properties_.contents_scale_y; }
388 gfx::Size content_bounds() const { return draw_properties_.content_bounds; }
enne@chromium.orgcd57cc5a2012-10-12 22:43:41389
danakj@chromium.org7aba6662013-03-12 10:17:34390 virtual void CalculateContentsScale(float ideal_contents_scale,
danakj@chromium.org7aba6662013-03-12 10:17:34391 float* contents_scale_x,
392 float* contents_scale_y,
393 gfx::Size* content_bounds);
danakj@chromium.org518ee582012-10-24 18:29:44394
danakj@chromium.org3698e792013-08-24 00:21:16395 LayerTreeHost* layer_tree_host() { return layer_tree_host_; }
396 const LayerTreeHost* layer_tree_host() const { return layer_tree_host_; }
enne@chromium.orgcd57cc5a2012-10-12 22:43:41397
danakj@chromium.org7aba6662013-03-12 10:17:34398 // Set the priority of all desired textures in this layer.
399 virtual void SetTexturePriorities(const PriorityCalculator& priority_calc) {}
enne@chromium.orgcd57cc5a2012-10-12 22:43:41400
danakj@chromium.org7aba6662013-03-12 10:17:34401 bool AddAnimation(scoped_ptr<Animation> animation);
402 void PauseAnimation(int animation_id, double time_offset);
403 void RemoveAnimation(int animation_id);
enne@chromium.orgcd57cc5a2012-10-12 22:43:41404
danakj@chromium.org7aba6662013-03-12 10:17:34405 LayerAnimationController* layer_animation_controller() {
406 return layer_animation_controller_.get();
407 }
ajuma@chromium.org7f5605c2013-04-08 18:08:35408 void SetLayerAnimationControllerForTest(
danakj@chromium.org7aba6662013-03-12 10:17:34409 scoped_refptr<LayerAnimationController> controller);
enne@chromium.orgcd57cc5a2012-10-12 22:43:41410
tfarina@chromium.org3cae03e2013-06-26 22:13:52411 void set_layer_animation_delegate(AnimationDelegate* delegate) {
ajuma@chromium.org7f5605c2013-04-08 18:08:35412 layer_animation_controller_->set_layer_animation_delegate(delegate);
danakj@chromium.org7aba6662013-03-12 10:17:34413 }
enne@chromium.orgcd57cc5a2012-10-12 22:43:41414
danakj@chromium.org7aba6662013-03-12 10:17:34415 bool HasActiveAnimation() const;
enne@chromium.orgcd57cc5a2012-10-12 22:43:41416
danakj@chromium.org7aba6662013-03-12 10:17:34417 void AddLayerAnimationEventObserver(
418 LayerAnimationEventObserver* animation_observer);
419 void RemoveLayerAnimationEventObserver(
420 LayerAnimationEventObserver* animation_observer);
enne@chromium.orgcd57cc5a2012-10-12 22:43:41421
danakj@chromium.orgd5467eb2014-08-22 01:16:43422 virtual SimpleEnclosedRegion VisibleContentOpaqueRegion() const;
ajuma@chromium.orge10cd022012-12-18 00:32:26423
wjmaclean@chromium.org80413d72013-08-30 20:25:33424 virtual ScrollbarLayerInterface* ToScrollbarLayer();
enne@chromium.orgcd57cc5a2012-10-12 22:43:41425
danakj19f0c9e2014-10-11 03:24:42426 gfx::Rect LayerRectToContentRect(const gfx::Rect& layer_rect) const;
enne@chromium.orgcd57cc5a2012-10-12 22:43:41427
alokp@chromium.orgf7837a92013-08-21 03:00:05428 virtual skia::RefPtr<SkPicture> GetPicture() const;
429
danakj@chromium.org7aba6662013-03-12 10:17:34430 // Constructs a LayerImpl of the correct runtime type for this Layer type.
431 virtual scoped_ptr<LayerImpl> CreateLayerImpl(LayerTreeImpl* tree_impl);
whunt@chromium.orgaedf4e52013-01-09 23:24:44432
enne@chromium.org44604642013-08-01 01:14:09433 bool NeedsDisplayForTesting() const { return !update_rect_.IsEmpty(); }
danakj19f0c9e2014-10-11 03:24:42434 void ResetNeedsDisplayForTesting() { update_rect_ = gfx::Rect(); }
egraether@chromium.org9d4f41f82013-03-28 01:34:23435
egraether@chromium.orgd84116612013-03-29 05:32:49436 RenderingStatsInstrumentation* rendering_stats_instrumentation() const;
437
reveman@chromium.org445881f2013-04-16 01:11:59438 const PaintProperties& paint_properties() const {
439 return paint_properties_;
440 }
441
danakj@chromium.org35a99a12013-05-09 23:52:29442 // The scale at which contents should be rastered, to match the scale at
443 // which they will drawn to the screen. This scale is a component of the
444 // contents scale but does not include page/device scale factors.
445 // TODO(danakj): This goes away when TiledLayer goes away.
446 void set_raster_scale(float scale) { raster_scale_ = scale; }
447 float raster_scale() const { return raster_scale_; }
448 bool raster_scale_is_unknown() const { return raster_scale_ == 0.f; }
449
hartmanng@chromium.org7924c1852013-05-24 16:18:43450 virtual bool SupportsLCDText() const;
451
ajuma@chromium.org7a5a9322014-02-25 12:54:57452 void SetNeedsPushProperties();
danakj@chromium.orgf4e25f92013-07-13 20:54:53453 bool needs_push_properties() const { return needs_push_properties_; }
454 bool descendant_needs_push_properties() const {
455 return num_dependents_need_push_properties_ > 0;
ajuma@chromium.org7a5a9322014-02-25 12:54:57456 }
457 void reset_needs_push_properties_for_testing() {
458 needs_push_properties_ = false;
danakj@chromium.orgf4e25f92013-07-13 20:54:53459 }
460
vmpstr@chromium.org666d7cf2013-10-12 01:30:29461 virtual void RunMicroBenchmark(MicroBenchmark* benchmark);
462
thildebr@chromium.orga9d4d4f2014-06-19 06:49:28463 void Set3dSortingContextId(int id);
464 int sorting_context_id() const { return sorting_context_id_; }
465
vollick51ed1a22014-12-17 02:03:00466 void set_transform_tree_index(int index) { transform_tree_index_ = index; }
467 void set_clip_tree_index(int index) { clip_tree_index_ = index; }
468 int clip_tree_index() const { return clip_tree_index_; }
469 int transform_tree_index() const { return transform_tree_index_; }
470
471 void set_offset_to_transform_parent(gfx::Vector2dF offset) {
472 offset_to_transform_parent_ = offset;
473 }
474 gfx::Vector2dF offset_to_transform_parent() const {
475 return offset_to_transform_parent_;
476 }
477
478 // TODO(vollick): Once we transition to transform and clip trees, rename these
479 // functions and related values. The "from property trees" functions below
480 // use the transform and clip trees. Eventually, we will use these functions
481 // to compute the official values, but these functions are retained for
482 // testing purposes until we've migrated.
483
484 const gfx::Rect& visible_rect_from_property_trees() const {
485 return visible_rect_from_property_trees_;
486 }
487 void set_visible_rect_from_property_trees(const gfx::Rect& rect) {
488 visible_rect_from_property_trees_ = rect;
489 }
490
491 gfx::Transform screen_space_transform_from_property_trees(
492 const TransformTree& tree) const;
493 gfx::Transform draw_transform_from_property_trees(
494 const TransformTree& tree) const;
495
496 // TODO(vollick): These values are temporary and will be removed as soon as
497 // render surface determinations are moved out of CDP. They only exist because
498 // certain logic depends on whether or not a layer would render to a separate
499 // surface, but CDP destroys surfaces and targets it doesn't need, so without
500 // this boolean, this is impossible to determine after the fact without
501 // wastefully recomputing it. This is public for the time being so that it can
502 // be accessed from CDP.
503 bool has_render_surface() const {
504 return has_render_surface_;
505 }
506 void SetHasRenderSurface(bool has_render_surface) {
507 has_render_surface_ = has_render_surface;
508 }
509
danakj@chromium.org7aba6662013-03-12 10:17:34510 protected:
511 friend class LayerImpl;
512 friend class TreeSynchronizer;
dcheng716bedf2014-10-21 09:51:08513 ~Layer() override;
danakj@chromium.org090e1a72013-01-29 07:07:45514
danakj@chromium.org7aba6662013-03-12 10:17:34515 Layer();
enne@chromium.orgcd57cc5a2012-10-12 22:43:41516
enne@chromium.org3519b872013-07-30 07:17:50517 // These SetNeeds functions are in order of severity of update:
518 //
519 // Called when this layer has been modified in some way, but isn't sure
520 // that it needs a commit yet. It needs CalcDrawProperties and UpdateLayers
521 // before it knows whether or not a commit is required.
522 void SetNeedsUpdate();
523 // Called when a property has been modified in a way that the layer
524 // knows immediately that a commit is required. This implies SetNeedsUpdate
525 // as well as SetNeedsPushProperties to push that property.
danakj@chromium.org7aba6662013-03-12 10:17:34526 void SetNeedsCommit();
enne@chromium.org3519b872013-07-30 07:17:50527 // Called when there's been a change in layer structure. Implies both
528 // SetNeedsUpdate and SetNeedsCommit, but not SetNeedsPushProperties.
danakj@chromium.org7aba6662013-03-12 10:17:34529 void SetNeedsFullTreeSync();
danakj@chromium.org74b43cc2013-08-30 06:29:27530
531 // Called when the next commit should wait until the pending tree is activated
532 // before finishing the commit and unblocking the main thread. Used to ensure
533 // unused resources on the impl thread are returned before commit completes.
534 void SetNextCommitWaitsForActivation();
danakj@chromium.org35a99a12013-05-09 23:52:29535
awoloszyn@chromium.orgad63b2f2014-08-11 17:39:54536 // Will recalculate whether the layer draws content and set draws_content_
537 // appropriately.
538 void UpdateDrawsContent(bool has_drawable_content);
539 virtual bool HasDrawableContent() const;
540
541 // Called when the layer's number of drawable descendants changes.
542 void AddDrawableDescendants(int num);
543
danakj@chromium.orgf4e25f92013-07-13 20:54:53544 void AddDependentNeedsPushProperties();
545 void RemoveDependentNeedsPushProperties();
546 bool parent_should_know_need_push_properties() const {
547 return needs_push_properties() || descendant_needs_push_properties();
548 }
danakj@chromium.orgb28272ee2013-08-29 23:05:13549
danakj@chromium.org74b43cc2013-08-30 06:29:27550 bool IsPropertyChangeAllowed() const;
551
danakj@chromium.org35a99a12013-05-09 23:52:29552 void reset_raster_scale_to_unknown() { raster_scale_ = 0.f; }
enne@chromium.orgcd57cc5a2012-10-12 22:43:41553
danakj@chromium.orgf4e25f92013-07-13 20:54:53554 // This flag is set when the layer needs to push properties to the impl
555 // side.
556 bool needs_push_properties_;
557
558 // The number of direct children or dependent layers that need to be recursed
559 // to in order for them or a descendent of them to push properties to the impl
560 // side.
561 int num_dependents_need_push_properties_;
562
danakj@chromium.org7aba6662013-03-12 10:17:34563 // Tracks whether this layer may have changed stacking order with its
564 // siblings.
565 bool stacking_order_changed_;
enne@chromium.orgcd57cc5a2012-10-12 22:43:41566
danakj@chromium.org7aba6662013-03-12 10:17:34567 // The update rect is the region of the compositor resource that was
568 // actually updated by the compositor. For layers that may do updating
569 // outside the compositor's control (i.e. plugin layers), this information
570 // is not available and the update rect will remain empty.
571 // Note this rect is in layer space (not content space).
danakj19f0c9e2014-10-11 03:24:42572 gfx::Rect update_rect_;
enne@chromium.orgcd57cc5a2012-10-12 22:43:41573
danakj@chromium.org7aba6662013-03-12 10:17:34574 scoped_refptr<Layer> mask_layer_;
enne@chromium.orgcd57cc5a2012-10-12 22:43:41575
danakj@chromium.org7aba6662013-03-12 10:17:34576 int layer_id_;
enne@chromium.orgcd57cc5a2012-10-12 22:43:41577
danakj@chromium.org7aba6662013-03-12 10:17:34578 // When true, the layer is about to perform an update. Any commit requests
enne@chromium.org3519b872013-07-30 07:17:50579 // will be handled implicitly after the update completes.
danakj@chromium.org7aba6662013-03-12 10:17:34580 bool ignore_set_needs_commit_;
enne@chromium.orgcd57cc5a2012-10-12 22:43:41581
thildebr@chromium.orga9d4d4f2014-06-19 06:49:28582 // Layers that share a sorting context id will be sorted together in 3d
583 // space. 0 is a special value that means this layer will not be sorted and
584 // will be drawn in paint order.
585 int sorting_context_id_;
586
danakj@chromium.org7aba6662013-03-12 10:17:34587 private:
588 friend class base::RefCounted<Layer>;
danakj@chromium.org29493a12012-12-20 01:42:42589
danakj@chromium.org7aba6662013-03-12 10:17:34590 void SetParent(Layer* layer);
danakj@chromium.org7aba6662013-03-12 10:17:34591 bool DescendantIsFixedToContainerLayer() const;
enne@chromium.orgcd57cc5a2012-10-12 22:43:41592
danakj@chromium.org7aba6662013-03-12 10:17:34593 // Returns the index of the child or -1 if not found.
594 int IndexOfChild(const Layer* reference);
enne@chromium.orgcd57cc5a2012-10-12 22:43:41595
danakj@chromium.org7aba6662013-03-12 10:17:34596 // This should only be called from RemoveFromParent().
597 void RemoveChildOrDependent(Layer* child);
enne@chromium.orgcd57cc5a2012-10-12 22:43:41598
ajuma@chromium.orgb8384e22013-12-03 02:20:48599 // LayerAnimationValueProvider implementation.
dcheng716bedf2014-10-21 09:51:08600 gfx::ScrollOffset ScrollOffsetForAnimation() const override;
ajuma@chromium.orgb8384e22013-12-03 02:20:48601
danakj@chromium.org7aba6662013-03-12 10:17:34602 // LayerAnimationValueObserver implementation.
dcheng716bedf2014-10-21 09:51:08603 void OnFilterAnimated(const FilterOperations& filters) override;
604 void OnOpacityAnimated(float opacity) override;
605 void OnTransformAnimated(const gfx::Transform& transform) override;
606 void OnScrollOffsetAnimated(const gfx::ScrollOffset& scroll_offset) override;
607 void OnAnimationWaitingForDeletion() override;
608 bool IsActive() const override;
enne@chromium.orgcd57cc5a2012-10-12 22:43:41609
vollick66133e82014-09-13 20:36:44610 // If this layer has a scroll parent, it removes |this| from its list of
611 // scroll children.
612 void RemoveFromScrollTree();
613
614 // If this layer has a clip parent, it removes |this| from its list of clip
615 // children.
616 void RemoveFromClipTree();
617
danakj@chromium.org7aba6662013-03-12 10:17:34618 LayerList children_;
619 Layer* parent_;
vollick@chromium.orgde4afb5e2012-12-20 00:11:34620
danakj@chromium.org7aba6662013-03-12 10:17:34621 // Layer instances have a weak pointer to their LayerTreeHost.
622 // This pointer value is nil when a Layer is not in a tree and is
623 // updated via SetLayerTreeHost() if a layer moves between trees.
624 LayerTreeHost* layer_tree_host_;
enne@chromium.orgcd57cc5a2012-10-12 22:43:41625
danakj@chromium.org7aba6662013-03-12 10:17:34626 scoped_refptr<LayerAnimationController> layer_animation_controller_;
vollick@chromium.orgde4afb5e2012-12-20 00:11:34627
danakj@chromium.org7aba6662013-03-12 10:17:34628 // Layer properties.
629 gfx::Size bounds_;
enne@chromium.orgcd57cc5a2012-10-12 22:43:41630
miletusf57925d2014-10-01 19:38:13631 gfx::ScrollOffset scroll_offset_;
wjmaclean@chromium.orgadeda572014-01-31 00:49:47632 // This variable indicates which ancestor layer (if any) whose size,
633 // transformed relative to this layer, defines the maximum scroll offset for
634 // this layer.
635 int scroll_clip_layer_id_;
awoloszyn@chromium.orgad63b2f2014-08-11 17:39:54636 int num_descendants_that_draw_content_;
vollick51ed1a22014-12-17 02:03:00637 int transform_tree_index_;
638 int opacity_tree_index_;
639 int clip_tree_index_;
640 gfx::Vector2dF offset_to_transform_parent_;
vivek.vg@samsung.comc55f3fc2013-12-10 05:48:48641 bool should_scroll_on_main_thread_ : 1;
642 bool have_wheel_event_handlers_ : 1;
skyostil@chromium.orgf998c532014-03-31 20:02:51643 bool have_scroll_event_handlers_ : 1;
vivek.vg@samsung.comc55f3fc2013-12-10 05:48:48644 bool user_scrollable_horizontal_ : 1;
645 bool user_scrollable_vertical_ : 1;
646 bool is_root_for_isolated_group_ : 1;
647 bool is_container_for_fixed_position_layers_ : 1;
648 bool is_drawable_ : 1;
awoloszyn@chromium.orgad63b2f2014-08-11 17:39:54649 bool draws_content_ : 1;
vivek.vg@samsung.comc55f3fc2013-12-10 05:48:48650 bool hide_layer_and_subtree_ : 1;
651 bool masks_to_bounds_ : 1;
652 bool contents_opaque_ : 1;
653 bool double_sided_ : 1;
vollick@chromium.org56fffdd2014-02-11 19:50:57654 bool should_flatten_transform_ : 1;
vivek.vg@samsung.comc55f3fc2013-12-10 05:48:48655 bool use_parent_backface_visibility_ : 1;
656 bool draw_checkerboard_for_missing_tiles_ : 1;
657 bool force_render_surface_ : 1;
avallee@chromium.org08bdf1b2014-04-16 23:23:29658 bool transform_is_invertible_ : 1;
vollick51ed1a22014-12-17 02:03:00659 bool has_render_surface_ : 1;
danakj@chromium.org7aba6662013-03-12 10:17:34660 Region non_fast_scrollable_region_;
661 Region touch_event_handler_region_;
662 gfx::PointF position_;
danakj@chromium.org7aba6662013-03-12 10:17:34663 SkColor background_color_;
danakj@chromium.org7aba6662013-03-12 10:17:34664 float opacity_;
rosca@adobe.com7bbeaf4e2013-11-26 10:27:22665 SkXfermode::Mode blend_mode_;
ajuma@chromium.orgae6b1a72013-06-25 18:49:29666 FilterOperations filters_;
667 FilterOperations background_filters_;
trchen@chromium.orgfe956c9c42013-04-09 04:26:33668 LayerPositionConstraint position_constraint_;
vollick@chromium.org0e98cdd2013-08-23 00:44:30669 Layer* scroll_parent_;
danakj6496cba2014-10-16 01:31:08670 scoped_ptr<std::set<Layer*>> scroll_children_;
vollick@chromium.org0e98cdd2013-08-23 00:44:30671
672 Layer* clip_parent_;
danakj6496cba2014-10-16 01:31:08673 scoped_ptr<std::set<Layer*>> clip_children_;
enne@chromium.orgcd57cc5a2012-10-12 22:43:41674
danakj@chromium.org7aba6662013-03-12 10:17:34675 gfx::Transform transform_;
chrishtr@chromium.orga2566412014-06-05 03:14:20676 gfx::Point3F transform_origin_;
enne@chromium.orgcd57cc5a2012-10-12 22:43:41677
danakj@chromium.org7aba6662013-03-12 10:17:34678 // Replica layer used for reflections.
679 scoped_refptr<Layer> replica_layer_;
enne@chromium.orgcd57cc5a2012-10-12 22:43:41680
danakj@chromium.org7aba6662013-03-12 10:17:34681 // Transient properties.
682 float raster_scale_;
danakj@chromium.org44e9a2f2013-04-26 13:13:21683
qiankun.miao@intel.comae716ce2013-08-16 13:04:24684 LayerClient* client_;
685
danakj@chromium.org0e5f7142013-05-24 06:45:36686 ScopedPtrVector<CopyOutputRequest> copy_requests_;
danakj@chromium.org18a70192013-04-26 16:18:25687
tfarina@chromium.org28096ed2013-07-01 07:38:58688 base::Closure did_scroll_callback_;
enne@chromium.orgcd57cc5a2012-10-12 22:43:41689
vollick@chromium.org44d8e84c2013-10-19 19:13:22690 DrawProperties<Layer> draw_properties_;
shawnsingh@google.comd76806f82012-12-05 21:41:50691
reveman@chromium.org445881f2013-04-16 01:11:59692 PaintProperties paint_properties_;
693
vollick51ed1a22014-12-17 02:03:00694 gfx::Rect visible_rect_from_property_trees_;
danakj@chromium.org7aba6662013-03-12 10:17:34695 DISALLOW_COPY_AND_ASSIGN(Layer);
enne@chromium.orgcd57cc5a2012-10-12 22:43:41696};
enne@chromium.orgcd57cc5a2012-10-12 22:43:41697
tfarina@chromium.orgddf9df82012-10-16 06:52:46698} // namespace cc
699
jamesr@chromium.orgcc3cfaa2013-03-18 09:05:52700#endif // CC_LAYERS_LAYER_H_