| 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 class | AbsorbOpacity { kYes , kNo }
Public Types inherited from impeller::FilterContents
enum class | BlurStyle { kNormal , kSolid , kOuter , kInner }
enum class | MorphType { kDilate , 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
void | SetInheritedOpacity (Scalar opacity) override
| Inherit the provided opacity. More...
std::optional< Rect > | GetFilterSourceCoverage (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< 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 area of the render pass that will be affected when this contents is rendered. 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, int32_t mip_count=1, std::string_view 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...
std::optional< Rect > | GetSourceCoverage (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 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 Matrix &transform) 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...
std::optional< Size > | GetColorSourceSize () const
| Return the color source's intrinsic size, if available. More...
void | SetColorSourceSize (Size size)
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 > | MakeGaussianBlur (const FilterInput::Ref &input, Sigma sigma_x, Sigma sigma_y, Entity::TileMode tile_mode=Entity::TileMode::kDecal, BlurStyle mask_blur_style=BlurStyle::kNormal, const Geometry *mask_geometry=nullptr)
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 std::shared_ptr< FilterContents > | MakeRuntimeEffect (FilterInput::Ref input, std::shared_ptr< RuntimeStage > runtime_stage, std::shared_ptr< std::vector< uint8_t >> uniforms, std::vector< RuntimeEffectContents::TextureInput > texture_inputs)
Static Public Member Functions inherited from impeller::Contents
static std::shared_ptr< Contents > | MakeAnonymous (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 37 of file blend_filter_contents.h.

## Constructor & Destructor Documentation

## ◆ BlendFilterContents()

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

Definition at line 86 of file blend_filter_contents.cc.

86 {
87 SetBlendMode(BlendMode::kSrcOver);
88 }
impeller::BlendFilterContents::SetBlendMode
void SetBlendMode(BlendMode blend_mode)
Definition: blend_filter_contents.cc:910
impeller::BlendMode::kSrcOver
@ kSrcOver

References impeller::kSrcOver, and SetBlendMode().

## ◆ ~BlendFilterContents()

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

## Member Function Documentation

## ◆ SetBlendMode()

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

Definition at line 910 of file blend_filter_contents.cc.

910 {
911 if (blend_mode > Entity::kLastAdvancedBlendMode) {
912 VALIDATION_LOG << "Invalid blend mode " << static_cast<int>(blend_mode)
913 << " assigned to BlendFilterContents.";
914 }
915
916 blend_mode_ = blend_mode;
917
918 if (blend_mode > Entity::kLastPipelineBlendMode) {
919 switch (blend_mode) {
920 BLEND_CASE(Screen)
921 BLEND_CASE(Overlay)
922 BLEND_CASE(Darken)
923 BLEND_CASE(Lighten)
924 BLEND_CASE(ColorDodge)
925 BLEND_CASE(ColorBurn)
926 BLEND_CASE(HardLight)
927 BLEND_CASE(SoftLight)
928 BLEND_CASE(Difference)
929 BLEND_CASE(Exclusion)
930 BLEND_CASE(Multiply)
931 BLEND_CASE(Hue)
932 BLEND_CASE(Saturation)
933 BLEND_CASE(Color)
934 BLEND_CASE(Luminosity)
935 default:
936 FML_UNREACHABLE();
937 }
938 }
939 }
BLEND_CASE
#define BLEND_CASE(mode)
Definition: blend_filter_contents.cc:895
impeller::Entity::kLastAdvancedBlendMode
static constexpr BlendMode kLastAdvancedBlendMode
Definition: entity.h:23
impeller::Entity::kLastPipelineBlendMode
static constexpr BlendMode kLastPipelineBlendMode
Definition: entity.h:22
impeller::Saturation
static constexpr Scalar Saturation(Vector3 color)
Definition: color.cc:89
impeller::Luminosity
static constexpr Scalar Luminosity(Vector3 color)
Definition: color.cc:63
VALIDATION_LOG
#define VALIDATION_LOG
Definition: validation.h:91

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

Referenced by BlendFilterContents(), and impeller::testing::TEST_P().

## ◆ 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 941 of file blend_filter_contents.cc.

941 {
942 foreground_color_ = color;
943 }

Referenced by impeller::testing::TEST_P().

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