layer.h revision 5d1f7b1de12d16ceb2c938c56701a3e8bfa558f7
1// Copyright (c) 2012 The Chromium Authors. All rights reserved. 2// Use of this source code is governed by a BSD-style license that can be 3// found in the LICENSE file. 4 5#ifndef UI_COMPOSITOR_LAYER_H_ 6#define UI_COMPOSITOR_LAYER_H_ 7 8#include <string> 9#include <vector> 10 11#include "base/compiler_specific.h" 12#include "base/memory/ref_counted.h" 13#include "base/memory/scoped_ptr.h" 14#include "base/message_loop/message_loop.h" 15#include "cc/animation/animation_events.h" 16#include "cc/animation/layer_animation_event_observer.h" 17#include "cc/base/scoped_ptr_vector.h" 18#include "cc/layers/content_layer_client.h" 19#include "cc/layers/layer_client.h" 20#include "cc/layers/texture_layer_client.h" 21#include "cc/resources/texture_mailbox.h" 22#include "third_party/skia/include/core/SkColor.h" 23#include "third_party/skia/include/core/SkRegion.h" 24#include "ui/compositor/compositor.h" 25#include "ui/compositor/layer_animation_delegate.h" 26#include "ui/compositor/layer_delegate.h" 27#include "ui/compositor/layer_type.h" 28#include "ui/gfx/rect.h" 29#include "ui/gfx/transform.h" 30 31class SkCanvas; 32 33namespace cc { 34class ContentLayer; 35class CopyOutputRequest; 36class DelegatedFrameProvider; 37class DelegatedRendererLayer; 38class Layer; 39class ResourceUpdateQueue; 40class SolidColorLayer; 41class TextureLayer; 42struct ReturnedResource; 43typedef std::vector<ReturnedResource> ReturnedResourceArray; 44} 45 46namespace ui { 47 48class Compositor; 49class LayerAnimator; 50class Texture; 51 52// Layer manages a texture, transform and a set of child Layers. Any View that 53// has enabled layers ends up creating a Layer to manage the texture. 54// A Layer can also be created without a texture, in which case it renders 55// nothing and is simply used as a node in a hierarchy of layers. 56// Coordinate system used in layers is DIP (Density Independent Pixel) 57// coordinates unless explicitly mentioned as pixel coordinates. 58// 59// NOTE: Unlike Views, each Layer does *not* own its child Layers. If you 60// delete a Layer and it has children, the parent of each child Layer is set to 61// NULL, but the children are not deleted. 62class COMPOSITOR_EXPORT Layer 63 : public LayerAnimationDelegate, 64 NON_EXPORTED_BASE(public cc::ContentLayerClient), 65 NON_EXPORTED_BASE(public cc::TextureLayerClient), 66 NON_EXPORTED_BASE(public cc::LayerClient), 67 NON_EXPORTED_BASE(public cc::LayerAnimationEventObserver) { 68 public: 69 Layer(); 70 explicit Layer(LayerType type); 71 virtual ~Layer(); 72 73 // Retrieves the Layer's compositor. The Layer will walk up its parent chain 74 // to locate it. Returns NULL if the Layer is not attached to a compositor. 75 Compositor* GetCompositor(); 76 77 // Called by the compositor when the Layer is set as its root Layer. This can 78 // only ever be called on the root layer. 79 void SetCompositor(Compositor* compositor); 80 81 LayerDelegate* delegate() { return delegate_; } 82 void set_delegate(LayerDelegate* delegate) { delegate_ = delegate; } 83 84 // Adds a new Layer to this Layer. 85 void Add(Layer* child); 86 87 // Removes a Layer from this Layer. 88 void Remove(Layer* child); 89 90 // Stacks |child| above all other children. 91 void StackAtTop(Layer* child); 92 93 // Stacks |child| directly above |other|. Both must be children of this 94 // layer. Note that if |child| is initially stacked even higher, calling this 95 // method will result in |child| being lowered in the stacking order. 96 void StackAbove(Layer* child, Layer* other); 97 98 // Stacks |child| below all other children. 99 void StackAtBottom(Layer* child); 100 101 // Stacks |child| directly below |other|. Both must be children of this 102 // layer. 103 void StackBelow(Layer* child, Layer* other); 104 105 // Returns the child Layers. 106 const std::vector<Layer*>& children() const { return children_; } 107 108 // The parent. 109 const Layer* parent() const { return parent_; } 110 Layer* parent() { return parent_; } 111 112 LayerType type() const { return type_; } 113 114 // Returns true if this Layer contains |other| somewhere in its children. 115 bool Contains(const Layer* other) const; 116 117 // The layer's animator is responsible for causing automatic animations when 118 // properties are set. It also manages a queue of pending animations and 119 // handles blending of animations. The layer takes ownership of the animator. 120 void SetAnimator(LayerAnimator* animator); 121 122 // Returns the layer's animator. Creates a default animator of one has not 123 // been set. Will not return NULL. 124 LayerAnimator* GetAnimator(); 125 126 // The transform, relative to the parent. 127 void SetTransform(const gfx::Transform& transform); 128 gfx::Transform transform() const; 129 130 // Return the target transform if animator is running, or the current 131 // transform otherwise. 132 gfx::Transform GetTargetTransform() const; 133 134 // The bounds, relative to the parent. 135 void SetBounds(const gfx::Rect& bounds); 136 const gfx::Rect& bounds() const { return bounds_; } 137 138 // Return the target bounds if animator is running, or the current bounds 139 // otherwise. 140 gfx::Rect GetTargetBounds() const; 141 142 // Sets/gets whether or not drawing of child layers should be clipped to the 143 // bounds of this layer. 144 void SetMasksToBounds(bool masks_to_bounds); 145 bool GetMasksToBounds() const; 146 147 // The opacity of the layer. The opacity is applied to each pixel of the 148 // texture (resulting alpha = opacity * alpha). 149 float opacity() const; 150 void SetOpacity(float opacity); 151 152 // Returns the actual opacity, which the opacity of this layer multipled by 153 // the combined opacity of the parent. 154 float GetCombinedOpacity() const; 155 156 // Blur pixels by this amount in anything below the layer and visible through 157 // the layer. 158 int background_blur() const { return background_blur_radius_; } 159 void SetBackgroundBlur(int blur_radius); 160 161 // Saturate all pixels of this layer by this amount. 162 // This effect will get "combined" with the inverted, 163 // brightness and grayscale setting. 164 float layer_saturation() const { return layer_saturation_; } 165 void SetLayerSaturation(float saturation); 166 167 // Change the brightness of all pixels from this layer by this amount. 168 // This effect will get "combined" with the inverted, saturate 169 // and grayscale setting. 170 float layer_brightness() const { return layer_brightness_; } 171 void SetLayerBrightness(float brightness); 172 173 // Return the target brightness if animator is running, or the current 174 // brightness otherwise. 175 float GetTargetBrightness() const; 176 177 // Change the grayscale of all pixels from this layer by this amount. 178 // This effect will get "combined" with the inverted, saturate 179 // and brightness setting. 180 float layer_grayscale() const { return layer_grayscale_; } 181 void SetLayerGrayscale(float grayscale); 182 183 // Return the target grayscale if animator is running, or the current 184 // grayscale otherwise. 185 float GetTargetGrayscale() const; 186 187 // Zoom the background by a factor of |zoom|. The effect is blended along the 188 // edge across |inset| pixels. 189 void SetBackgroundZoom(float zoom, int inset); 190 191 // Invert the layer. 192 bool layer_inverted() const { return layer_inverted_; } 193 void SetLayerInverted(bool inverted); 194 195 // Return the target opacity if animator is running, or the current opacity 196 // otherwise. 197 float GetTargetOpacity() const; 198 199 // Set a layer mask for a layer. 200 // Note the provided layer mask can neither have a layer mask itself nor can 201 // it have any children. The ownership of |layer_mask| will not be 202 // transferred with this call. 203 // Furthermore: A mask layer can only be set to one layer. 204 void SetMaskLayer(Layer* layer_mask); 205 Layer* layer_mask_layer() { return layer_mask_; } 206 207 // Sets the visibility of the Layer. A Layer may be visible but not 208 // drawn. This happens if any ancestor of a Layer is not visible. 209 void SetVisible(bool visible); 210 bool visible() const { return visible_; } 211 212 // Returns the target visibility if the animator is running. Otherwise, it 213 // returns the current visibility. 214 bool GetTargetVisibility() const; 215 216 // Returns true if this Layer is drawn. A Layer is drawn only if all ancestors 217 // are visible. 218 bool IsDrawn() const; 219 220 // Returns true if this layer can have a texture (has_texture_ is true) 221 // and is not completely obscured by a child. 222 bool ShouldDraw() const; 223 224 // Converts a point from the coordinates of |source| to the coordinates of 225 // |target|. Necessarily, |source| and |target| must inhabit the same Layer 226 // tree. 227 static void ConvertPointToLayer(const Layer* source, 228 const Layer* target, 229 gfx::Point* point); 230 231 // Converts a transform to be relative to the given |ancestor|. Returns 232 // whether success (that is, whether the given ancestor was really an 233 // ancestor of this layer). 234 bool GetTargetTransformRelativeTo(const Layer* ancestor, 235 gfx::Transform* transform) const; 236 237 // Converts a ui::Layer's transform to the transform on the corresponding 238 // cc::Layer. 239 static gfx::Transform ConvertTransformToCCTransform( 240 const gfx::Transform& transform, 241 float device_scale_factor); 242 243 // See description in View for details 244 void SetFillsBoundsOpaquely(bool fills_bounds_opaquely); 245 bool fills_bounds_opaquely() const { return fills_bounds_opaquely_; } 246 247 const std::string& name() const { return name_; } 248 void set_name(const std::string& name) { name_ = name; } 249 250 const ui::Texture* texture() const { return texture_.get(); } 251 252 // Assigns a new external texture. |texture| can be NULL to disable external 253 // updates. 254 void SetExternalTexture(ui::Texture* texture); 255 ui::Texture* external_texture() { return texture_.get(); } 256 257 // Set new TextureMailbox for this layer. Note that |mailbox| may hold a 258 // shared memory resource or an actual mailbox for a texture. 259 void SetTextureMailbox(const cc::TextureMailbox& mailbox, 260 scoped_ptr<cc::SingleReleaseCallback> release_callback, 261 float scale_factor); 262 cc::TextureMailbox GetTextureMailbox(float* scale_factor); 263 264 // Begins showing delegated frames from the |frame_provider|. 265 void SetShowDelegatedContent(cc::DelegatedFrameProvider* frame_provider, 266 gfx::Size frame_size_in_dip); 267 268 bool has_external_content() { 269 return texture_layer_.get() || delegated_renderer_layer_.get(); 270 } 271 272 void SetShowPaintedContent(); 273 274 // Sets the layer's fill color. May only be called for LAYER_SOLID_COLOR. 275 void SetColor(SkColor color); 276 277 // Adds |invalid_rect| to the Layer's pending invalid rect and calls 278 // ScheduleDraw(). Returns false if the paint request is ignored. 279 bool SchedulePaint(const gfx::Rect& invalid_rect); 280 281 // Schedules a redraw of the layer tree at the compositor. 282 // Note that this _does not_ invalidate any region of this layer; use 283 // SchedulePaint() for that. 284 void ScheduleDraw(); 285 286 // Uses damaged rectangles recorded in |damaged_region_| to invalidate the 287 // |cc_layer_|. 288 void SendDamagedRects(); 289 290 const SkRegion& damaged_region() const { return damaged_region_; } 291 292 // Suppresses painting the content by disconnecting |delegate_|. 293 void SuppressPaint(); 294 295 // Notifies the layer that the device scale factor has changed. 296 void OnDeviceScaleFactorChanged(float device_scale_factor); 297 298 // Sets whether the layer should scale its content. If true, the canvas will 299 // be scaled in software rendering mode before it is passed to 300 // |LayerDelegate::OnPaintLayer|. 301 // Set to false if the delegate handles scaling. 302 // NOTE: if this is called during |LayerDelegate::OnPaint|, the new value will 303 // not apply to the canvas passed to the pending draw. 304 void set_scale_content(bool scale_content) { scale_content_ = scale_content; } 305 306 // Returns true if the layer scales its content. 307 bool scale_content() const { return scale_content_; } 308 309 // Requets a copy of the layer's output as a texture or bitmap. 310 void RequestCopyOfOutput(scoped_ptr<cc::CopyOutputRequest> request); 311 312 // ContentLayerClient 313 virtual void PaintContents( 314 SkCanvas* canvas, const gfx::Rect& clip, gfx::RectF* opaque) OVERRIDE; 315 virtual void DidChangeLayerCanUseLCDText() OVERRIDE {} 316 317 cc::Layer* cc_layer() { return cc_layer_; } 318 319 // TextureLayerClient 320 virtual unsigned PrepareTexture() OVERRIDE; 321 virtual bool PrepareTextureMailbox( 322 cc::TextureMailbox* mailbox, 323 scoped_ptr<cc::SingleReleaseCallback>* release_callback, 324 bool use_shared_memory) OVERRIDE; 325 326 float device_scale_factor() const { return device_scale_factor_; } 327 328 // Forces a render surface to be used on this layer. This has no positive 329 // impact, and is only used for benchmarking/testing purpose. 330 void SetForceRenderSurface(bool force); 331 bool force_render_surface() const { return force_render_surface_; } 332 333 // LayerClient 334 virtual scoped_refptr<base::debug::ConvertableToTraceFormat> 335 TakeDebugInfo() OVERRIDE; 336 337 // LayerAnimationEventObserver 338 virtual void OnAnimationStarted(const cc::AnimationEvent& event) OVERRIDE; 339 340 // Whether this layer has animations waiting to get sent to its cc::Layer. 341 bool HasPendingThreadedAnimations() { 342 return pending_threaded_animations_.size() != 0; 343 } 344 345 // Triggers a call to SwitchToLayer. 346 void SwitchCCLayerForTest(); 347 348 private: 349 // Stacks |child| above or below |other|. Helper method for StackAbove() and 350 // StackBelow(). 351 void StackRelativeTo(Layer* child, Layer* other, bool above); 352 353 bool ConvertPointForAncestor(const Layer* ancestor, gfx::Point* point) const; 354 bool ConvertPointFromAncestor(const Layer* ancestor, gfx::Point* point) const; 355 356 // Implementation of LayerAnimatorDelegate 357 virtual void SetBoundsFromAnimation(const gfx::Rect& bounds) OVERRIDE; 358 virtual void SetTransformFromAnimation( 359 const gfx::Transform& transform) OVERRIDE; 360 virtual void SetOpacityFromAnimation(float opacity) OVERRIDE; 361 virtual void SetVisibilityFromAnimation(bool visibility) OVERRIDE; 362 virtual void SetBrightnessFromAnimation(float brightness) OVERRIDE; 363 virtual void SetGrayscaleFromAnimation(float grayscale) OVERRIDE; 364 virtual void SetColorFromAnimation(SkColor color) OVERRIDE; 365 virtual void ScheduleDrawForAnimation() OVERRIDE; 366 virtual const gfx::Rect& GetBoundsForAnimation() const OVERRIDE; 367 virtual gfx::Transform GetTransformForAnimation() const OVERRIDE; 368 virtual float GetOpacityForAnimation() const OVERRIDE; 369 virtual bool GetVisibilityForAnimation() const OVERRIDE; 370 virtual float GetBrightnessForAnimation() const OVERRIDE; 371 virtual float GetGrayscaleForAnimation() const OVERRIDE; 372 virtual SkColor GetColorForAnimation() const OVERRIDE; 373 virtual float GetDeviceScaleFactor() const OVERRIDE; 374 virtual void AddThreadedAnimation( 375 scoped_ptr<cc::Animation> animation) OVERRIDE; 376 virtual void RemoveThreadedAnimation(int animation_id) OVERRIDE; 377 378 // Creates a corresponding composited layer for |type_|. 379 void CreateWebLayer(); 380 381 // Recomputes and sets to |cc_layer_|. 382 void RecomputeCCTransformFromTransform(const gfx::Transform& transform); 383 void RecomputeDrawsContentAndUVRect(); 384 void RecomputePosition(); 385 386 // Set all filters which got applied to the layer. 387 void SetLayerFilters(); 388 389 // Set all filters which got applied to the layer background. 390 void SetLayerBackgroundFilters(); 391 392 // Cleanup |cc_layer_| and replaces it with |new_layer|. 393 void SwitchToLayer(scoped_refptr<cc::Layer> new_layer); 394 395 // We cannot send animations to our cc_layer_ until we have been added to a 396 // layer tree. Instead, we hold on to these animations in 397 // pending_threaded_animations_, and expect SendPendingThreadedAnimations to 398 // be called once we have been added to a tree. 399 void SendPendingThreadedAnimations(); 400 401 const LayerType type_; 402 403 Compositor* compositor_; 404 405 scoped_refptr<ui::Texture> texture_; 406 407 Layer* parent_; 408 409 // This layer's children, in bottom-to-top stacking order. 410 std::vector<Layer*> children_; 411 412 gfx::Rect bounds_; 413 414 // Visibility of this layer. See SetVisible/IsDrawn for more details. 415 bool visible_; 416 417 bool force_render_surface_; 418 419 bool fills_bounds_opaquely_; 420 421 // Union of damaged rects, in pixel coordinates, to be used when 422 // compositor is ready to paint the content. 423 SkRegion damaged_region_; 424 425 int background_blur_radius_; 426 427 // Several variables which will change the visible representation of 428 // the layer. 429 float layer_saturation_; 430 float layer_brightness_; 431 float layer_grayscale_; 432 bool layer_inverted_; 433 434 // The associated mask layer with this layer. 435 Layer* layer_mask_; 436 // The back link from the mask layer to it's associated masked layer. 437 // We keep this reference for the case that if the mask layer gets deleted 438 // while attached to the main layer before the main layer is deleted. 439 Layer* layer_mask_back_link_; 440 441 // The zoom factor to scale the layer by. Zooming is disabled when this is 442 // set to 1. 443 float zoom_; 444 445 // Width of the border in pixels, where the scaling is blended. 446 int zoom_inset_; 447 448 std::string name_; 449 450 LayerDelegate* delegate_; 451 452 scoped_refptr<LayerAnimator> animator_; 453 454 // Animations that are passed to AddThreadedAnimation before this layer is 455 // added to a tree. 456 cc::ScopedPtrVector<cc::Animation> pending_threaded_animations_; 457 458 // Ownership of the layer is held through one of the strongly typed layer 459 // pointers, depending on which sort of layer this is. 460 scoped_refptr<cc::ContentLayer> content_layer_; 461 scoped_refptr<cc::TextureLayer> texture_layer_; 462 scoped_refptr<cc::SolidColorLayer> solid_color_layer_; 463 scoped_refptr<cc::DelegatedRendererLayer> delegated_renderer_layer_; 464 cc::Layer* cc_layer_; 465 466 // If true, the layer scales the canvas and the texture with the device scale 467 // factor as apporpriate. When true, the texture size is in DIP. 468 bool scale_content_; 469 470 // A cached copy of |Compositor::device_scale_factor()|. 471 float device_scale_factor_; 472 473 // A cached copy of the TextureMailbox given texture_layer_. 474 cc::TextureMailbox mailbox_; 475 476 // Device scale factor in which mailbox_ was rendered in. 477 float mailbox_scale_factor_; 478 479 // The size of the delegated frame in DIP, set when SetShowDelegatedContent 480 // was called. 481 gfx::Size delegated_frame_size_in_dip_; 482 483 DISALLOW_COPY_AND_ASSIGN(Layer); 484}; 485 486} // namespace ui 487 488#endif // UI_COMPOSITOR_LAYER_H_ 489