flutter::ClipShapeLayer< T > Class Template Reference

#include <clip_shape_layer.h>

Inheritance diagram for flutter::ClipShapeLayer< T >:

Public Types
using	ClipShape = T

Public Member Functions
	ClipShapeLayer (const ClipShape &clip_shape, Clip clip_behavior)
void	Diff (DiffContext *context, const Layer *old_layer) override
void	Preroll (PrerollContext *context) override
void	Paint (PaintContext &context) const override
bool	UsesSaveLayer () const
Public Member Functions inherited from flutter::CacheableContainerLayer
	CacheableContainerLayer (int layer_cached_threshold=RasterCacheUtil::kMinimumRendersBeforeCachingFilterLayer, bool can_cache_children=false)
const LayerRasterCacheItem *	raster_cache_item () const
Public Member Functions inherited from flutter::ContainerLayer
	ContainerLayer ()
void	Diff (DiffContext *context, const Layer *old_layer) override
void	PreservePaintRegion (DiffContext *context) override
virtual void	Add (std::shared_ptr< Layer > layer)
void	Preroll (PrerollContext *context) override
void	Paint (PaintContext &context) const override
const std::vector< std::shared_ptr< Layer > > &	layers () const
virtual void	DiffChildren (DiffContext *context, const ContainerLayer *old_layer)
void	PaintChildren (PaintContext &context) const override
const ContainerLayer *	as_container_layer () const override
const DlRect &	child_paint_bounds () const
void	set_child_paint_bounds (const DlRect &bounds)
int	children_renderable_state_flags () const
void	set_children_renderable_state_flags (int flags)
Public Member Functions inherited from flutter::Layer
	Layer ()
virtual	~Layer ()
void	AssignOldLayer (Layer *old_layer)
virtual bool	IsReplacing (DiffContext *context, const Layer *old_layer) 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 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

Protected Member Functions
virtual const DlRect	clip_shape_bounds () const =0
virtual void	ApplyClip (LayerStateStack::MutatorContext &mutator) const =0
virtual	~ClipShapeLayer ()=default
const ClipShape &	clip_shape () const
Clip	clip_behavior () const
Protected Member Functions inherited from flutter::ContainerLayer
void	PrerollChildren (PrerollContext *context, DlRect *child_paint_bounds)

Additional Inherited Members
Static Public Attributes inherited from flutter::Layer
static constexpr int	kSaveLayerRenderFlags
static constexpr int	kRasterCacheRenderFlags
Protected Attributes inherited from flutter::CacheableContainerLayer
std::unique_ptr< LayerRasterCacheItem >	layer_raster_cache_item_

Detailed Description

template<class T>
class flutter::ClipShapeLayer< T >

Definition at line 15 of file clip_shape_layer.h.

Member Typedef Documentation

ClipShape

template<class T >

using flutter::ClipShapeLayer< T >::ClipShape = T

Definition at line 17 of file clip_shape_layer.h.

Constructor & Destructor Documentation

ClipShapeLayer()

template<class T >

flutter::ClipShapeLayer< T >::ClipShapeLayer ( const ClipShape &  clip_shape, Clip  clip_behavior  )

inline

Definition at line 18 of file clip_shape_layer.h.

      : CacheableContainerLayer(),
        clip_shape_(clip_shape),
        clip_behavior_(clip_behavior) {
    FML_DCHECK(clip_behavior != Clip::kNone);
  }

References flutter::ClipShapeLayer< T >::clip_behavior(), FML_DCHECK, and flutter::kNone.

~ClipShapeLayer()

template<class T >

virtual flutter::ClipShapeLayer< T >::~ClipShapeLayer ( )

protectedvirtualdefault

Member Function Documentation

ApplyClip()

template<class T >

virtual void flutter::ClipShapeLayer< T >::ApplyClip ( LayerStateStack::MutatorContext &  mutator ) const

protectedpure virtual

Implemented in flutter::ClipPathLayer, flutter::ClipRectLayer, flutter::ClipRRectLayer, and flutter::ClipRSuperellipseLayer.

Referenced by flutter::ClipShapeLayer< T >::Paint(), and flutter::ClipShapeLayer< T >::Preroll().

clip_behavior()

template<class T >

Clip flutter::ClipShapeLayer< T >::clip_behavior ( ) const

inlineprotected

Definition at line 113 of file clip_shape_layer.h.

{ return clip_behavior_; }

Referenced by flutter::ClipShapeLayer< T >::ClipShapeLayer().

clip_shape()

template<class T >

const ClipShape & flutter::ClipShapeLayer< T >::clip_shape ( ) const

inlineprotected

Definition at line 112 of file clip_shape_layer.h.

{ return clip_shape_; }

clip_shape_bounds()

template<class T >

virtual const DlRect flutter::ClipShapeLayer< T >::clip_shape_bounds ( ) const

protectedpure virtual

Implemented in flutter::ClipPathLayer, flutter::ClipRectLayer, flutter::ClipRRectLayer, and flutter::ClipRSuperellipseLayer.

Referenced by flutter::ClipShapeLayer< T >::Diff(), and flutter::ClipShapeLayer< T >::Preroll().

Diff()

template<class T >

void flutter::ClipShapeLayer< T >::Diff ( DiffContext *  context, const Layer *  old_layer  )

inlineoverridevirtual

Reimplemented from flutter::Layer.

Definition at line 25 of file clip_shape_layer.h.

                                                                   {
    DiffContext::AutoSubtreeRestore subtree(context);
    auto* prev = static_cast<const ClipShapeLayer<ClipShape>*>(old_layer);
    if (!context->IsSubtreeDirty()) {
      FML_DCHECK(prev);
      if (clip_behavior_ != prev->clip_behavior_ ||
          clip_shape_ != prev->clip_shape_) {
        context->MarkSubtreeDirty(context->GetOldLayerPaintRegion(old_layer));
      }
    }
    if (UsesSaveLayer() && context->has_raster_cache()) {
      context->WillPaintWithIntegralTransform();
    }
    if (context->PushCullRect(clip_shape_bounds())) {
      DiffChildren(context, prev);
    }
    context->SetLayerPaintRegion(this, context->CurrentSubtreeRegion());
  }

References flutter::ClipShapeLayer< T >::clip_shape_bounds(), flutter::DiffContext::CurrentSubtreeRegion(), flutter::ContainerLayer::DiffChildren(), FML_DCHECK, flutter::DiffContext::GetOldLayerPaintRegion(), flutter::DiffContext::has_raster_cache(), flutter::DiffContext::IsSubtreeDirty(), flutter::DiffContext::MarkSubtreeDirty(), flutter::DiffContext::PushCullRect(), flutter::DiffContext::SetLayerPaintRegion(), flutter::ClipShapeLayer< T >::UsesSaveLayer(), and flutter::DiffContext::WillPaintWithIntegralTransform().

Paint()

template<class T >

void flutter::ClipShapeLayer< T >::Paint ( PaintContext &  context ) const

inlineoverridevirtual

Implements flutter::Layer.

Definition at line 74 of file clip_shape_layer.h.

                                                   {
    FML_DCHECK(needs_painting(context));
 
    auto mutator = context.state_stack.save();
    ApplyClip(mutator);
 
    if (!UsesSaveLayer()) {
      PaintChildren(context);
      return;
    }
 
#if !SLIMPELLER
    if (context.raster_cache) {
      mutator.integralTransform();
      auto restore_apply = context.state_stack.applyState(
          paint_bounds(), LayerStateStack::kCallerCanApplyOpacity);
 
      DlPaint paint;
      if (layer_raster_cache_item_->Draw(context,
                                         context.state_stack.fill(paint))) {
        return;
      }
    }
#endif  //  !SLIMPELLER
 
    mutator.saveLayer(paint_bounds());
    PaintChildren(context);
  }

References flutter::ClipShapeLayer< T >::ApplyClip(), flutter::LayerStateStack::applyState(), flutter::LayerStateStack::fill(), FML_DCHECK, flutter::LayerStateStack::kCallerCanApplyOpacity, flutter::CacheableContainerLayer::layer_raster_cache_item_, flutter::Layer::needs_painting(), flutter::Layer::paint_bounds(), flutter::ContainerLayer::PaintChildren(), flutter::LayerStateStack::save(), flutter::PaintContext::state_stack, and flutter::ClipShapeLayer< T >::UsesSaveLayer().

Preroll()

template<class T >

void flutter::ClipShapeLayer< T >::Preroll ( PrerollContext *  context )

inlineoverridevirtual

Implements flutter::Layer.

Definition at line 44 of file clip_shape_layer.h.

                                                 {
    bool uses_save_layer = UsesSaveLayer();
 
#if !SLIMPELLER
    // We can use the raster_cache for children only when the use_save_layer is
    // true so if use_save_layer is false we pass the layer_raster_item is
    // nullptr which mean we don't do raster cache logic.
    AutoCache cache =
        AutoCache(uses_save_layer ? layer_raster_cache_item_.get() : nullptr,
                  context, context->state_stack.matrix());
#endif  //  !SLIMPELLER
 
    Layer::AutoPrerollSaveLayerState save =
        Layer::AutoPrerollSaveLayerState::Create(context, UsesSaveLayer());
 
    auto mutator = context->state_stack.save();
    ApplyClip(mutator);
 
    DlRect child_paint_bounds;
    PrerollChildren(context, &child_paint_bounds);
    set_paint_bounds(
        child_paint_bounds.IntersectionOrEmpty(clip_shape_bounds()));
 
    // If we use a SaveLayer then we can accept opacity on behalf
    // of our children and apply it in the saveLayer.
    if (uses_save_layer) {
      context->renderable_state_flags = kSaveLayerRenderFlags;
    }
  }

References flutter::ClipShapeLayer< T >::ApplyClip(), flutter::ContainerLayer::child_paint_bounds(), flutter::ClipShapeLayer< T >::clip_shape_bounds(), flutter::Layer::AutoPrerollSaveLayerState::Create(), impeller::TRect< T >::IntersectionOrEmpty(), flutter::Layer::kSaveLayerRenderFlags, flutter::CacheableContainerLayer::layer_raster_cache_item_, flutter::LayerStateStack::matrix(), flutter::ContainerLayer::PrerollChildren(), flutter::PrerollContext::renderable_state_flags, flutter::LayerStateStack::save(), flutter::Layer::set_paint_bounds(), flutter::PrerollContext::state_stack, and flutter::ClipShapeLayer< T >::UsesSaveLayer().

UsesSaveLayer()

template<class T >

bool flutter::ClipShapeLayer< T >::UsesSaveLayer ( ) const

inline

Definition at line 103 of file clip_shape_layer.h.

                             {
    return clip_behavior_ == Clip::kAntiAliasWithSaveLayer;
  }

References flutter::kAntiAliasWithSaveLayer.

Referenced by flutter::ClipShapeLayer< T >::Diff(), flutter::ClipShapeLayer< T >::Paint(), and flutter::ClipShapeLayer< T >::Preroll().

---

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

• flow/layers/clip_shape_layer.h