flutter::Layer Class Reference

#include <layer.h>

Inheritance diagram for flutter::Layer:

Classes
class	AutoPrerollSaveLayerState

Public Member Functions
	Layer ()
virtual	~Layer ()
void	AssignOldLayer (Layer *old_layer)
virtual bool	IsReplacing (DiffContext *context, const Layer *old_layer) const
virtual void	Diff (DiffContext *context, const Layer *old_layer)
virtual void	PreservePaintRegion (DiffContext *context)
virtual void	Preroll (PrerollContext *context)=0
virtual void	Paint (PaintContext &context) const =0
virtual void	PaintChildren (PaintContext &context) const
bool	subtree_has_platform_view () const
void	set_subtree_has_platform_view (bool value)
const DlRect &	paint_bounds () const
void	set_paint_bounds (const DlRect &paint_bounds)
bool	is_empty () const
bool	needs_painting (PaintContext &context) const
uint64_t	original_layer_id () const
uint64_t	unique_id () const
virtual RasterCacheKeyID	caching_key_id () const
virtual const ContainerLayer *	as_container_layer () const
virtual const DisplayListLayer *	as_display_list_layer () const
virtual const TextureLayer *	as_texture_layer () const
virtual const PerformanceOverlayLayer *	as_performance_overlay_layer () const
virtual const testing::MockLayer *	as_mock_layer () const

Static Public Attributes
static constexpr int	kSaveLayerRenderFlags
static constexpr int	kRasterCacheRenderFlags

Detailed Description

Definition at line 113 of file layer.h.

Constructor & Destructor Documentation

Layer()

flutter::Layer::Layer

(

)

Definition at line 11 of file layer.cc.

: unique_id_(NextUniqueID()), original_layer_id_(unique_id_) {}

~Layer()

flutter::Layer::~Layer ( )

virtualdefault

Member Function Documentation

as_container_layer()

virtual const ContainerLayer * flutter::Layer::as_container_layer ( ) const

inlinevirtual

Reimplemented in flutter::ContainerLayer.

Definition at line 244 of file layer.h.

{ return nullptr; }

Referenced by flutter::RasterCacheKeyID::LayerChildrenIds().

as_display_list_layer()

virtual const DisplayListLayer * flutter::Layer::as_display_list_layer ( ) const

inlinevirtual

Reimplemented in flutter::DisplayListLayer.

Definition at line 245 of file layer.h.

                                                                {
    return nullptr;
  }

Referenced by flutter::DisplayListLayer::Diff(), and flutter::DisplayListLayer::IsReplacing().

as_mock_layer()

virtual const testing::MockLayer * flutter::Layer::as_mock_layer ( ) const

inlinevirtual

Reimplemented in flutter::testing::MockLayer.

Definition at line 252 of file layer.h.

{ return nullptr; }

Referenced by flutter::testing::MockLayer::IsReplacing().

as_performance_overlay_layer()

virtual const PerformanceOverlayLayer * flutter::Layer::as_performance_overlay_layer ( ) const

inlinevirtual

Reimplemented in flutter::PerformanceOverlayLayer.

Definition at line 249 of file layer.h.

                                                                              {
    return nullptr;
  }

Referenced by flutter::PerformanceOverlayLayer::Diff(), and flutter::PerformanceOverlayLayer::IsReplacing().

as_texture_layer()

virtual const TextureLayer * flutter::Layer::as_texture_layer ( ) const

inlinevirtual

Reimplemented in flutter::TextureLayer.

Definition at line 248 of file layer.h.

{ return nullptr; }

Referenced by flutter::TextureLayer::Diff(), and flutter::TextureLayer::IsReplacing().

AssignOldLayer()

void flutter::Layer::AssignOldLayer ( Layer *  old_layer )

inline

Definition at line 132 of file layer.h.

                                        {
    original_layer_id_ = old_layer->original_layer_id_;
  }

caching_key_id()

virtual RasterCacheKeyID flutter::Layer::caching_key_id ( ) const

inlinevirtual

Reimplemented in flutter::DisplayListLayer.

Definition at line 240 of file layer.h.

                                                  {
    return RasterCacheKeyID(unique_id_, RasterCacheKeyType::kLayer);
  }

References flutter::kLayer.

Diff()

virtual void flutter::Layer::Diff ( DiffContext *  context, const Layer *  old_layer  )

inlinevirtual

Reimplemented in flutter::BackdropFilterLayer, flutter::ClipShapeLayer< T >, flutter::ClipShapeLayer< DlPath >, flutter::ClipShapeLayer< DlRect >, flutter::ClipShapeLayer< DlRoundRect >, flutter::ClipShapeLayer< DlRoundSuperellipse >, flutter::ColorFilterLayer, flutter::ContainerLayer, flutter::DisplayListLayer, flutter::ImageFilterLayer, flutter::OpacityLayer, flutter::PerformanceOverlayLayer, flutter::ShaderMaskLayer, flutter::TextureLayer, flutter::TransformLayer, and flutter::testing::MockLayer.

Definition at line 144 of file layer.h.

{}

Referenced by flutter::FrameDamage::ComputeClipRect().

is_empty()

bool flutter::Layer::is_empty ( ) const

inline

Definition at line 214 of file layer.h.

{ return paint_bounds_.IsEmpty(); }

References impeller::TRect< T >::IsEmpty().

IsReplacing()

virtual bool flutter::Layer::IsReplacing ( DiffContext *  context, const Layer *  old_layer  ) const

inlinevirtual

Reimplemented in flutter::DisplayListLayer, flutter::PerformanceOverlayLayer, flutter::TextureLayer, and flutter::testing::MockLayer.

Definition at line 139 of file layer.h.

                                                                               {
    return original_layer_id_ == old_layer->original_layer_id_;
  }

Referenced by flutter::ContainerLayer::DiffChildren().

needs_painting()

bool flutter::Layer::needs_painting ( PaintContext &  context ) const

inline

Definition at line 218 of file layer.h.

                                                   {
    if (subtree_has_platform_view_) {
      // Workaround for the iOS embedder. The iOS embedder expects that
      // if we preroll it, then we will later call its Paint() method.
      // Now that we preroll all layers without any culling, we may
      // call its Preroll() without calling its Paint(). For now, we
      // will not perform paint culling on any subtree that has a
      // platform view.
      // See https://github.com/flutter/flutter/issues/81419
      return true;
    }
    return !context.state_stack.painting_is_nop() &&
           !context.state_stack.content_culled(paint_bounds_);
  }

References flutter::LayerStateStack::content_culled(), flutter::LayerStateStack::painting_is_nop(), and flutter::PaintContext::state_stack.

Referenced by flutter::BackdropFilterLayer::Paint(), flutter::ClipShapeLayer< T >::Paint(), flutter::ColorFilterLayer::Paint(), flutter::ContainerLayer::Paint(), flutter::DisplayListLayer::Paint(), flutter::ImageFilterLayer::Paint(), flutter::OpacityLayer::Paint(), flutter::ShaderMaskLayer::Paint(), flutter::TextureLayer::Paint(), flutter::TransformLayer::Paint(), flutter::testing::MockLayer::Paint(), and flutter::Rasterize().

original_layer_id()

uint64_t flutter::Layer::original_layer_id ( ) const

inline

Definition at line 235 of file layer.h.

{ return original_layer_id_; }

Paint()

virtual void flutter::Layer::Paint ( PaintContext &  context ) const

pure virtual

Implemented in flutter::BackdropFilterLayer, flutter::ClipShapeLayer< T >, flutter::ClipShapeLayer< DlPath >, flutter::ClipShapeLayer< DlRect >, flutter::ClipShapeLayer< DlRoundRect >, flutter::ClipShapeLayer< DlRoundSuperellipse >, flutter::ColorFilterLayer, flutter::ContainerLayer, flutter::DisplayListLayer, flutter::ImageFilterLayer, flutter::OpacityLayer, flutter::PerformanceOverlayLayer, flutter::PlatformViewLayer, flutter::ShaderMaskLayer, flutter::TextureLayer, flutter::TransformLayer, and flutter::testing::MockLayer.

Referenced by flutter::Rasterize().

paint_bounds()

const DlRect & flutter::Layer::paint_bounds ( ) const

inline

Definition at line 196 of file layer.h.

{ return paint_bounds_; }

Referenced by flutter::testing::MockRasterCache::AddMockLayer(), flutter::BackdropFilterLayer::Diff(), flutter::PerformanceOverlayLayer::Diff(), flutter::BackdropFilterLayer::Paint(), flutter::ClipShapeLayer< T >::Paint(), flutter::ColorFilterLayer::Paint(), flutter::PerformanceOverlayLayer::Paint(), flutter::ShaderMaskLayer::Paint(), flutter::TextureLayer::Paint(), flutter::OpacityLayer::Preroll(), and set_paint_bounds().

PaintChildren()

virtual void flutter::Layer::PaintChildren ( PaintContext &  context ) const

inlinevirtual

Reimplemented in flutter::ContainerLayer.

Definition at line 185 of file layer.h.

{ FML_DCHECK(false); }

References FML_DCHECK.

Referenced by flutter::Rasterize().

Preroll()

virtual void flutter::Layer::Preroll ( PrerollContext *  context )

pure virtual

Implemented in flutter::BackdropFilterLayer, flutter::ClipShapeLayer< T >, flutter::ClipShapeLayer< DlPath >, flutter::ClipShapeLayer< DlRect >, flutter::ClipShapeLayer< DlRoundRect >, flutter::ClipShapeLayer< DlRoundSuperellipse >, flutter::ColorFilterLayer, flutter::ContainerLayer, flutter::ImageFilterLayer, flutter::OpacityLayer, flutter::PerformanceOverlayLayer, flutter::PlatformViewLayer, flutter::ShaderMaskLayer, flutter::TextureLayer, flutter::TransformLayer, flutter::testing::MockLayer, flutter::testing::MockCacheableContainerLayer, flutter::testing::MockCacheableLayer, and flutter::DisplayListLayer.

PreservePaintRegion()

virtual void flutter::Layer::PreservePaintRegion ( DiffContext *  context )

inlinevirtual

Reimplemented in flutter::ContainerLayer.

Definition at line 149 of file layer.h.

                                                         {
    // retained layer means same instance so 'this' is used to index into both
    // current and old region
    context->SetLayerPaintRegion(this, context->GetOldLayerPaintRegion(this));
  }

References flutter::DiffContext::GetOldLayerPaintRegion(), and flutter::DiffContext::SetLayerPaintRegion().

Referenced by flutter::ContainerLayer::PreservePaintRegion().

set_paint_bounds()

void flutter::Layer::set_paint_bounds ( const DlRect &  paint_bounds )

inline

Definition at line 209 of file layer.h.

                                                    {
    paint_bounds_ = paint_bounds;
  }

References paint_bounds().

Referenced by flutter::BackdropFilterLayer::Preroll(), flutter::ClipShapeLayer< T >::Preroll(), flutter::ContainerLayer::Preroll(), flutter::ImageFilterLayer::Preroll(), flutter::OpacityLayer::Preroll(), flutter::PlatformViewLayer::Preroll(), flutter::TextureLayer::Preroll(), flutter::TransformLayer::Preroll(), flutter::testing::MockLayer::Preroll(), and flutter::DisplayListLayer::Preroll().

set_subtree_has_platform_view()

void flutter::Layer::set_subtree_has_platform_view ( bool  value )

inline

Definition at line 188 of file layer.h.

                                                 {
    subtree_has_platform_view_ = value;
  }

References value.

Referenced by flutter::PlatformViewLayer::Preroll(), and flutter::ContainerLayer::PrerollChildren().

subtree_has_platform_view()

bool flutter::Layer::subtree_has_platform_view ( ) const

inline

Definition at line 187 of file layer.h.

{ return subtree_has_platform_view_; }

unique_id()

uint64_t flutter::Layer::unique_id ( ) const

inline

Definition at line 237 of file layer.h.

{ return unique_id_; }

Referenced by flutter::testing::MockRasterCache::AddMockLayer(), flutter::DisplayListLayer::caching_key_id(), flutter::DiffContext::GetOldLayerPaintRegion(), and flutter::DiffContext::SetLayerPaintRegion().

Member Data Documentation

kRasterCacheRenderFlags

constexpr int flutter::Layer::kRasterCacheRenderFlags

staticconstexpr

Initial value:

=
      LayerStateStack::kCallerCanApplyOpacity

Definition at line 126 of file layer.h.

kSaveLayerRenderFlags

constexpr int flutter::Layer::kSaveLayerRenderFlags

staticconstexpr

Initial value:

=
      LayerStateStack::kCallerCanApplyOpacity |
      LayerStateStack::kCallerCanApplyColorFilter |
      LayerStateStack::kCallerCanApplyImageFilter

Definition at line 118 of file layer.h.

Referenced by flutter::BackdropFilterLayer::Preroll(), flutter::ClipShapeLayer< T >::Preroll(), flutter::ShaderMaskLayer::Preroll(), and flutter::testing::TEST_F().

---

The documentation for this class was generated from the following files:

• flow/layers/layer.h
• flow/layers/layer.cc