| Flutter Impeller |

Public Types | Public Member Functions | List of all members
impeller::BlendFilterContents Class Reference

`#include <blend_filter_contents.h>`

Inheritance diagram for impeller::BlendFilterContents:

## 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< Scalar > | GetAlpha () const
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< Entity > | GetEntity (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< Rect > | GetCoverage (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< Snapshot > | RenderToSnapshot (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 FilterContents * | AsFilter () 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 `FilterInput`s. 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< Size > | GetColorSourceSize () 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< Color > | AsBackgroundColor (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< ColorFilterContents > | MakeBlend (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< ColorFilterContents > | MakeColorMatrix (FilterInput::Ref input, const ColorMatrix &color_matrix)
static std::shared_ptr< ColorFilterContents > | MakeLinearToSrgbFilter (FilterInput::Ref input)
static std::shared_ptr< ColorFilterContents > | MakeSrgbToLinearFilter (FilterInput::Ref input)
Static Public Member Functions inherited from impeller::FilterContents
static std::shared_ptr< FilterContents > | MakeDirectionalGaussianBlur (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< FilterContents > | MakeGaussianBlur (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< FilterContents > | MakeBorderMaskBlur (FilterInput::Ref input, Sigma sigma_x, Sigma sigma_y, BlurStyle blur_style=BlurStyle::kNormal)
static std::shared_ptr< FilterContents > | MakeDirectionalMorphology (FilterInput::Ref input, Radius radius, Vector2 direction, MorphType morph_type)
static std::shared_ptr< FilterContents > | MakeMorphology (FilterInput::Ref input, Radius radius_x, Radius radius_y, MorphType morph_type)
static std::shared_ptr< FilterContents > | MakeMatrixFilter (FilterInput::Ref input, const Matrix &matrix, const SamplerDescriptor &desc)
static std::shared_ptr< FilterContents > | MakeLocalMatrixFilter (FilterInput::Ref input, const Matrix &matrix)
static std::shared_ptr< FilterContents > | MakeYUVToRGBFilter (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< Contents > | MakeAnonymous (RenderProc render_proc, CoverageProc coverage_proc)

## Detailed Description

Definition at line 34 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 44 of file blend_filter_contents.h.

## Constructor & Destructor Documentation

## ◆ BlendFilterContents()

impeller::BlendFilterContents::BlendFilterContents | ( |  | ) |

Definition at line 63 of file blend_filter_contents.cc.

63 {
64 SetBlendMode(BlendMode::kSourceOver);
65 }

References impeller::kSourceOver, and SetBlendMode().

## ◆ ~BlendFilterContents()

impeller::BlendFilterContents::~BlendFilterContents | ( |  | ) |
| override default

## Member Function Documentation

## ◆ SetBlendMode()

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

Definition at line 693 of file blend_filter_contents.cc.

693 {
694 if (blend_mode > Entity::kLastAdvancedBlendMode) {
695 VALIDATION_LOG << "Invalid blend mode " << static_cast<int>(blend_mode)
696 << " assigned to BlendFilterContents.";
697 }
698
699 blend_mode_ = blend_mode;
700
701 if (blend_mode > Entity::kLastPipelineBlendMode) {
702 switch (blend_mode) {
703 BLEND_CASE(Screen)
704 BLEND_CASE(Overlay)
705 BLEND_CASE(Darken)
706 BLEND_CASE(Lighten)
707 BLEND_CASE(ColorDodge)
708 BLEND_CASE(ColorBurn)
709 BLEND_CASE(HardLight)
710 BLEND_CASE(SoftLight)
711 BLEND_CASE(Difference)
712 BLEND_CASE(Exclusion)
713 BLEND_CASE(Multiply)
714 BLEND_CASE(Hue)
715 BLEND_CASE(Saturation)
716 BLEND_CASE(Color)
717 BLEND_CASE(Luminosity)
718 default:
719 FML_UNREACHABLE();
720 }
721 }
722 }

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 724 of file blend_filter_contents.cc.

724 {
725 foreground_color_ = color;
726 }

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

- impeller/entity/contents/filters/blend_filter_contents.h
- impeller/entity/contents/filters/blend_filter_contents.cc

BLEND_CASE
#define BLEND_CASE(mode)
Definition: blend_filter_contents.cc:678
impeller::Entity::kLastPipelineBlendMode
static constexpr BlendMode kLastPipelineBlendMode
Definition: entity.h:23
impeller::BlendFilterContents::SetBlendMode
void SetBlendMode(BlendMode blend_mode)
Definition: blend_filter_contents.cc:693
impeller::BlendMode::kSourceOver
@ kSourceOver
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:60
impeller::Saturation
static constexpr Scalar Saturation(Vector3 color)
Definition: color.cc:166