Flutter Impeller
impeller::DirectionalMorphologyFilterContents Class Referencefinal

#include <morphology_filter_contents.h>

Inheritance diagram for impeller::DirectionalMorphologyFilterContents:
impeller::FilterContents impeller::Contents

Public Member Functions

 DirectionalMorphologyFilterContents ()
 
 ~DirectionalMorphologyFilterContents () override
 
void SetRadius (Radius radius)
 
void SetDirection (Vector2 direction)
 
void SetMorphType (MorphType morph_type)
 
std::optional< RectGetFilterCoverage (const FilterInput::Vector &inputs, const Entity &entity, const Matrix &effect_transform) const override
 
- Public Member Functions inherited from impeller::FilterContents
 FilterContents ()
 
 ~FilterContents () override
 
void SetInputs (FilterInput::Vector inputs)
 The input texture sources for this filter. Each input's emitted texture is expected to have premultiplied alpha colors. More...
 
void SetEffectTransform (const Matrix &effect_transform)
 Sets the transform which gets appended to the effect of this filter. Note that this is in addition to the entity's transform. More...
 
std::optional< EntityGetEntity (const ContentContext &renderer, const Entity &entity, const std::optional< Rect > &coverage_hint) const
 Create an Entity that renders this filter's output. More...
 
bool Render (const ContentContext &renderer, const Entity &entity, RenderPass &pass) const override
 
std::optional< RectGetCoverage (const Entity &entity) const override
 Get the screen space bounding rectangle that this contents affects. More...
 
void PopulateGlyphAtlas (const std::shared_ptr< LazyGlyphAtlas > &lazy_glyph_atlas, Scalar scale) override
 Add any text data to the specified lazy atlas. The scale parameter must be used again later when drawing the text. More...
 
std::optional< SnapshotRenderToSnapshot (const ContentContext &renderer, const Entity &entity, std::optional< Rect > coverage_limit=std::nullopt, const std::optional< SamplerDescriptor > &sampler_descriptor=std::nullopt, bool msaa_enabled=true, const std::string &label="Filter Snapshot") const override
 Render this contents to a snapshot, respecting the entity's transform, path, stencil depth, and blend mode. The result texture size is always the size of GetCoverage(entity). More...
 
const FilterContentsAsFilter () const override
 Cast to a filter. Returns nullptr if this Contents is not a filter. More...
 
virtual Matrix GetLocalTransform (const Matrix &parent_transform) const
 
Matrix GetTransform (const Matrix &parent_transform) const
 
virtual bool IsTranslationOnly () const
 Returns true if this filter graph doesn't perform any basis transformations to the filtered content. For example: Rotating, scaling, and skewing are all basis transformations, but translating is not. More...
 
bool IsLeaf () const
 Returns true if this filter does not have any FilterInput children. More...
 
void SetLeafInputs (const FilterInput::Vector &inputs)
 Replaces the set of all leaf FilterContents with a new set of FilterInputs. More...
 
virtual void SetRenderingMode (Entity::RenderingMode rendering_mode)
 Marks this filter chain as applying in a subpass scenario. More...
 
- Public Member Functions inherited from impeller::Contents
 Contents ()
 
virtual ~Contents ()
 
void SetCoverageHint (std::optional< Rect > coverage_hint)
 Hint that specifies the coverage area of this Contents that will actually be used during rendering. This is for optimization purposes only and can not be relied on as a clip. May optionally affect the result of GetCoverage(). More...
 
const std::optional< Rect > & GetCoverageHint () const
 
virtual bool IsOpaque () const
 Whether this Contents only emits opaque source colors from the fragment stage. This value does not account for any entity properties (e.g. the blend mode), clips/visibility culling, or inherited opacity. More...
 
virtual StencilCoverage GetStencilCoverage (const Entity &entity, const std::optional< Rect > &current_stencil_coverage) const
 Given the current screen space bounding rectangle of the stencil, return the expected stencil coverage after this draw call. This should only be implemented for contents that may write to the stencil buffer. More...
 
virtual bool ShouldRender (const Entity &entity, const std::optional< Rect > &stencil_coverage) const
 
std::optional< SizeGetColorSourceSize () const
 Return the color source's intrinsic size, if available. More...
 
void SetColorSourceSize (Size size)
 
virtual bool CanInheritOpacity (const Entity &entity) const
 Whether or not this contents can accept the opacity peephole optimization. More...
 
virtual void SetInheritedOpacity (Scalar opacity)
 Inherit the provided opacity. More...
 
virtual std::optional< ColorAsBackgroundColor (const Entity &entity, ISize target_size) const
 Returns a color if this Contents will flood the given target_size with a color. This output color is the "Source" color that will be used for the Entity's blend operation. More...
 
virtual bool ApplyColorFilter (const ColorFilterProc &color_filter_proc)
 If possible, applies a color filter to this contents inputs on the CPU. More...
 

Additional Inherited Members

- Public Types inherited from impeller::FilterContents
enum  BlurStyle {
  BlurStyle::kNormal,
  BlurStyle::kSolid,
  BlurStyle::kOuter,
  BlurStyle::kInner
}
 
enum  MorphType {
  MorphType::kDilate,
  MorphType::kErode
}
 
- Public Types inherited from impeller::Contents
using ColorFilterProc = std::function< Color(Color)>
 
using RenderProc = std::function< bool(const ContentContext &renderer, const Entity &entity, RenderPass &pass)>
 
using CoverageProc = std::function< std::optional< Rect >(const Entity &entity)>
 
- Static Public Member Functions inherited from impeller::FilterContents
static std::shared_ptr< FilterContentsMakeDirectionalGaussianBlur (FilterInput::Ref input, Sigma sigma, Vector2 direction, BlurStyle blur_style=BlurStyle::kNormal, Entity::TileMode tile_mode=Entity::TileMode::kDecal, bool is_second_pass=false, Sigma secondary_sigma={})
 
static std::shared_ptr< FilterContentsMakeGaussianBlur (const FilterInput::Ref &input, Sigma sigma_x, Sigma sigma_y, BlurStyle blur_style=BlurStyle::kNormal, Entity::TileMode tile_mode=Entity::TileMode::kDecal)
 
static std::shared_ptr< FilterContentsMakeBorderMaskBlur (FilterInput::Ref input, Sigma sigma_x, Sigma sigma_y, BlurStyle blur_style=BlurStyle::kNormal)
 
static std::shared_ptr< FilterContentsMakeDirectionalMorphology (FilterInput::Ref input, Radius radius, Vector2 direction, MorphType morph_type)
 
static std::shared_ptr< FilterContentsMakeMorphology (FilterInput::Ref input, Radius radius_x, Radius radius_y, MorphType morph_type)
 
static std::shared_ptr< FilterContentsMakeMatrixFilter (FilterInput::Ref input, const Matrix &matrix, const SamplerDescriptor &desc)
 
static std::shared_ptr< FilterContentsMakeLocalMatrixFilter (FilterInput::Ref input, const Matrix &matrix)
 
static std::shared_ptr< FilterContentsMakeYUVToRGBFilter (std::shared_ptr< Texture > y_texture, std::shared_ptr< Texture > uv_texture, YUVColorSpace yuv_color_space)
 
- Static Public Member Functions inherited from impeller::Contents
static std::shared_ptr< ContentsMakeAnonymous (RenderProc render_proc, CoverageProc coverage_proc)
 

Detailed Description

Definition at line 14 of file morphology_filter_contents.h.

Constructor & Destructor Documentation

◆ DirectionalMorphologyFilterContents()

impeller::DirectionalMorphologyFilterContents::DirectionalMorphologyFilterContents ( )
default

◆ ~DirectionalMorphologyFilterContents()

impeller::DirectionalMorphologyFilterContents::~DirectionalMorphologyFilterContents ( )
overridedefault

Member Function Documentation

◆ GetFilterCoverage()

std::optional< Rect > impeller::DirectionalMorphologyFilterContents::GetFilterCoverage ( const FilterInput::Vector inputs,
const Entity entity,
const Matrix effect_transform 
) const
overridevirtual

Reimplemented from impeller::FilterContents.

Definition at line 159 of file morphology_filter_contents.cc.

162  {
163  if (inputs.empty()) {
164  return std::nullopt;
165  }
166 
167  auto coverage = inputs[0]->GetCoverage(entity);
168  if (!coverage.has_value()) {
169  return std::nullopt;
170  }
171  auto transform = inputs[0]->GetTransform(entity) * effect_transform.Basis();
172  auto transformed_vector =
173  transform.TransformDirection(direction_ * radius_.radius).Abs();
174 
175  auto origin = coverage->origin;
176  auto size = Vector2(coverage->size);
177  switch (morph_type_) {
179  origin -= transformed_vector;
180  size += transformed_vector * 2;
181  break;
183  origin += transformed_vector;
184  size -= transformed_vector * 2;
185  break;
186  }
187  if (size.x < 0 || size.y < 0) {
188  return Rect::MakeSize(Size(0, 0));
189  }
190  return Rect(origin, Size(size.x, size.y));
191 }

References impeller::Matrix::Basis(), impeller::FilterContents::kDilate, impeller::FilterContents::kErode, impeller::TRect< Scalar >::MakeSize(), impeller::TRect< T >::origin, impeller::Radius::radius, impeller::TRect< T >::size, and impeller::Matrix::TransformDirection().

◆ SetDirection()

void impeller::DirectionalMorphologyFilterContents::SetDirection ( Vector2  direction)

Definition at line 26 of file morphology_filter_contents.cc.

26  {
27  direction_ = direction.Normalize();
28  if (direction_.IsZero()) {
29  direction_ = Vector2(0, 1);
30  }
31 }

References impeller::TPoint< T >::IsZero(), and impeller::TPoint< T >::Normalize().

◆ SetMorphType()

void impeller::DirectionalMorphologyFilterContents::SetMorphType ( MorphType  morph_type)

Definition at line 33 of file morphology_filter_contents.cc.

33  {
34  morph_type_ = morph_type;
35 }

◆ SetRadius()

void impeller::DirectionalMorphologyFilterContents::SetRadius ( Radius  radius)

Definition at line 22 of file morphology_filter_contents.cc.

22  {
23  radius_ = radius;
24 }

The documentation for this class was generated from the following files:
impeller::Radius::radius
Scalar radius
Definition: sigma.h:48
impeller::FilterContents::MorphType::kErode
@ kErode
impeller::Vector2
Point Vector2
Definition: point.h:310
impeller::Size
TSize< Scalar > Size
Definition: size.h:135
impeller::TPoint::IsZero
constexpr bool IsZero() const
Definition: point.h:227
impeller::Rect
TRect< Scalar > Rect
Definition: rect.h:306
impeller::TRect< Scalar >::MakeSize
constexpr static TRect MakeSize(const TSize< U > &size)
Definition: rect.h:52
impeller::FilterContents::MorphType::kDilate
@ kDilate
impeller::TPoint::Normalize
constexpr TPoint Normalize() const
Definition: point.h:201