Flutter Impeller
impeller::BlendFilterContents Class Reference

#include <blend_filter_contents.h>

Inheritance diagram for impeller::BlendFilterContents:
impeller::ColorFilterContents impeller::FilterContents impeller::Contents

Public Types

using AdvancedBlendProc = std::function< std::optional< Entity >(const FilterInput::Vector &inputs, const ContentContext &renderer, const Entity &entity, const Rect &coverage, BlendMode blend_mode, std::optional< Color > foreground_color, ColorFilterContents::AbsorbOpacity absorb_opacity, std::optional< Scalar > alpha)>
 
- Public Types inherited from impeller::ColorFilterContents
enum  AbsorbOpacity {
  AbsorbOpacity::kYes,
  AbsorbOpacity::kNo
}
 
- 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)>
 

Public Member Functions

 BlendFilterContents ()
 
 ~BlendFilterContents () override
 
void SetBlendMode (BlendMode blend_mode)
 
void SetForegroundColor (std::optional< Color > color)
 Sets a source color which is blended after all of the inputs have been blended. More...
 
- Public Member Functions inherited from impeller::ColorFilterContents
 ColorFilterContents ()
 
 ~ColorFilterContents () override
 
void SetAbsorbOpacity (AbsorbOpacity absorb_opacity)
 
AbsorbOpacity GetAbsorbOpacity () const
 
void SetAlpha (Scalar alpha)
 Sets an alpha that is applied to the final blended result. More...
 
std::optional< ScalarGetAlpha () const
 
std::optional< RectGetFilterSourceCoverage (const Matrix &effect_transform, const Rect &output_limit) const override
 Internal utility method for |GetSourceCoverage| that computes the inverse effect of this transform on the specified output coverage, ignoring the inputs which will be accommodated by the caller. More...
 
- 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 area of the render pass that will be affected when this contents is rendered. 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, int32_t mip_count=1, const std::string &label="Filter Snapshot") const override
 Render this contents to a snapshot, respecting the entity's transform, path, clip 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...
 
std::optional< RectGetSourceCoverage (const Matrix &effect_transform, const Rect &output_limit) const
 Determines the coverage of source pixels that will be needed to produce results for the specified |output_limit| under the specified |effect_transform|. This is essentially a reverse of the |GetCoverage| method computing a source coverage from an intended |output_limit| coverage. 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 transforms to the filtered content. For example: Rotating, scaling, and skewing are all basis transforms, 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 ClipCoverage GetClipCoverage (const Entity &entity, const std::optional< Rect > &current_clip_coverage) const
 Given the current pass space bounding rectangle of the clip buffer, return the expected clip coverage after this draw call. This should only be implemented for contents that may write to the clip buffer. More...
 
virtual bool ShouldRender (const Entity &entity, const std::optional< Rect > clip_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

- Static Public Member Functions inherited from impeller::ColorFilterContents
static std::shared_ptr< ColorFilterContentsMakeBlend (BlendMode blend_mode, FilterInput::Vector inputs, std::optional< Color > foreground_color=std::nullopt)
 the [inputs] are expected to be in the order of dst, src. More...
 
static std::shared_ptr< ColorFilterContentsMakeColorMatrix (FilterInput::Ref input, const ColorMatrix &color_matrix)
 
static std::shared_ptr< ColorFilterContentsMakeLinearToSrgbFilter (FilterInput::Ref input)
 
static std::shared_ptr< ColorFilterContentsMakeSrgbToLinearFilter (FilterInput::Ref input)
 
- Static Public Member Functions inherited from impeller::FilterContents
static std::shared_ptr< FilterContentsMakeGaussianBlur (const FilterInput::Ref &input, Sigma sigma_x, Sigma sigma_y, Entity::TileMode tile_mode=Entity::TileMode::kDecal, BlurStyle mask_blur_style=BlurStyle::kNormal, const std::shared_ptr< Geometry > &mask_geometry=nullptr)
 
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)
 
- Static Public Attributes inherited from impeller::FilterContents
static const int32_t kBlurFilterRequiredMipCount
 

Detailed Description

Definition at line 35 of file blend_filter_contents.h.

Member Typedef Documentation

◆ AdvancedBlendProc

using impeller::BlendFilterContents::AdvancedBlendProc = std::function<std::optional<Entity>( const FilterInput::Vector& inputs, const ContentContext& renderer, const Entity& entity, const Rect& coverage, BlendMode blend_mode, std::optional<Color> foreground_color, ColorFilterContents::AbsorbOpacity absorb_opacity, std::optional<Scalar> alpha)>

Definition at line 45 of file blend_filter_contents.h.

Constructor & Destructor Documentation

◆ BlendFilterContents()

impeller::BlendFilterContents::BlendFilterContents ( )

Definition at line 61 of file blend_filter_contents.cc.

61  {
63 }

References impeller::kSourceOver, and SetBlendMode().

◆ ~BlendFilterContents()

impeller::BlendFilterContents::~BlendFilterContents ( )
overridedefault

Member Function Documentation

◆ SetBlendMode()

void impeller::BlendFilterContents::SetBlendMode ( BlendMode  blend_mode)

Definition at line 562 of file blend_filter_contents.cc.

562  {
563  if (blend_mode > Entity::kLastAdvancedBlendMode) {
564  VALIDATION_LOG << "Invalid blend mode " << static_cast<int>(blend_mode)
565  << " assigned to BlendFilterContents.";
566  }
567 
568  blend_mode_ = blend_mode;
569 
570  if (blend_mode > Entity::kLastPipelineBlendMode) {
571  switch (blend_mode) {
572  BLEND_CASE(Screen)
573  BLEND_CASE(Overlay)
574  BLEND_CASE(Darken)
575  BLEND_CASE(Lighten)
576  BLEND_CASE(ColorDodge)
577  BLEND_CASE(ColorBurn)
578  BLEND_CASE(HardLight)
579  BLEND_CASE(SoftLight)
580  BLEND_CASE(Difference)
581  BLEND_CASE(Exclusion)
582  BLEND_CASE(Multiply)
583  BLEND_CASE(Hue)
585  BLEND_CASE(Color)
587  default:
588  FML_UNREACHABLE();
589  }
590  }
591 }

References BLEND_CASE, impeller::Entity::kLastAdvancedBlendMode, impeller::Entity::kLastPipelineBlendMode, impeller::Luminosity(), impeller::Saturation(), and VALIDATION_LOG.

Referenced by BlendFilterContents().

◆ SetForegroundColor()

void impeller::BlendFilterContents::SetForegroundColor ( std::optional< Color color)

Sets a source color which is blended after all of the inputs have been blended.

Definition at line 593 of file blend_filter_contents.cc.

593  {
594  foreground_color_ = color;
595 }

The documentation for this class was generated from the following files:
BLEND_CASE
#define BLEND_CASE(mode)
Definition: blend_filter_contents.cc:547
impeller::Entity::kLastPipelineBlendMode
static constexpr BlendMode kLastPipelineBlendMode
Definition: entity.h:23
impeller::BlendFilterContents::SetBlendMode
void SetBlendMode(BlendMode blend_mode)
Definition: blend_filter_contents.cc:562
impeller::Entity::kLastAdvancedBlendMode
static constexpr BlendMode kLastAdvancedBlendMode
Definition: entity.h:24
impeller::Luminosity
static constexpr Scalar Luminosity(Vector3 color)
Definition: color.cc:140
VALIDATION_LOG
#define VALIDATION_LOG
Definition: validation.h:73
impeller::BlendMode::kSourceOver
@ kSourceOver
impeller::Saturation
static constexpr Scalar Saturation(Vector3 color)
Definition: color.cc:166