| Flutter Impeller |

Public Member Functions | List of all members
impeller::MatrixFilterContents Class Referencefinal

`#include <matrix_filter_contents.h>`

Inheritance diagram for impeller::MatrixFilterContents:

## Public Member Functions
| MatrixFilterContents ()
| ~MatrixFilterContents () override
void | SetMatrix (Matrix matrix)
void | SetRenderingMode (Entity::RenderingMode rendering_mode) override
| Marks this filter chain as applying in a subpass scenario. More...
bool | IsTranslationOnly () const override
| 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...
void | SetSamplerDescriptor (SamplerDescriptor desc)
std::optional< Rect > | GetFilterCoverage (const FilterInput::Vector &inputs, const Entity &entity, const Matrix &effect_transform) const override
| Internal utility method for |GetLocalCoverage| that computes the output coverage of this filter across the specified inputs, ignoring the coverage hint. 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, 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 FilterContents * | AsFilter () const override
| Cast to a filter. Returns `nullptr` if this Contents is not a filter. 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
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...
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...
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...
std::optional< Size > | GetColorSourceSize () const
| Return the color source's intrinsic size, if available. More...
void | SetColorSourceSize (Size size)
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
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< 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 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 13 of file matrix_filter_contents.h.

## Constructor & Destructor Documentation

## ◆ MatrixFilterContents()

impeller::MatrixFilterContents::MatrixFilterContents | ( |  | ) |
| default

## ◆ ~MatrixFilterContents()

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

## Member Function Documentation

## ◆ GetFilterCoverage()

std::optional< Rect > impeller::MatrixFilterContents::GetFilterCoverage | ( | const FilterInput::Vector & | inputs,
|  | const Entity & | entity,
|  | const Matrix & | effect_transform
| ) |  | const
| override virtual

Internal utility method for |GetLocalCoverage| that computes the output coverage of this filter across the specified inputs, ignoring the coverage hint.

Reimplemented from impeller::FilterContents.

Definition at line 124 of file matrix_filter_contents.cc.

127 {
128 if (inputs.empty()) {
129 return std::nullopt;
130 }
131
132 std::optional<Rect> coverage = inputs[0]->GetCoverage(entity);
133 if (!coverage.has_value()) {
134 return std::nullopt;
135 }
136
137 Matrix input_transform = inputs[0]->GetTransform(entity);
138 if (rendering_mode_ ==
139 Entity::RenderingMode::kSubpassPrependSnapshotTransform ||
140 rendering_mode_ ==
141 Entity::RenderingMode::kSubpassAppendSnapshotTransform) {
142 Rect coverage_bounds = coverage->TransformBounds(input_transform.Invert());
143 Matrix transform = CalculateSubpassTransform(
144 input_transform, effect_transform, matrix_, rendering_mode_);
145 return coverage_bounds.TransformBounds(transform);
146 } else {
147 Matrix transform = input_transform * //
148 matrix_ * //
149 input_transform.Invert(); //
150 return coverage->TransformBounds(transform);
151 }
152 }

References impeller::Matrix::Invert(), impeller::Entity::kSubpassAppendSnapshotTransform, impeller::Entity::kSubpassPrependSnapshotTransform, transform, and impeller::TRect< T >::TransformBounds().

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

## ◆ IsTranslationOnly()

bool impeller::MatrixFilterContents::IsTranslationOnly | ( |  | ) | const
| override virtual

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.

This is useful for determining whether a filtered object's space is compatible enough with the parent pass space to perform certain subpass clipping optimizations.

Reimplemented from impeller::FilterContents.

Definition at line 23 of file matrix_filter_contents.cc.

23 {
24 return matrix_.Basis().IsIdentity() && FilterContents::IsTranslationOnly();
25 }

References impeller::Matrix::Basis(), impeller::Matrix::IsIdentity(), and impeller::FilterContents::IsTranslationOnly().

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

## ◆ SetMatrix()

void impeller::MatrixFilterContents::SetMatrix | ( | Matrix | matrix | ) |

Definition at line 13 of file matrix_filter_contents.cc.

13 {
14 matrix_ = matrix;
15 }

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

## ◆ SetRenderingMode()

void impeller::MatrixFilterContents::SetRenderingMode | ( | Entity::RenderingMode | rendering_mode | ) |
| override virtual

Marks this filter chain as applying in a subpass scenario.

        Subpasses render in screenspace, and this setting informs filters
        that the current transform matrix of the entity is not stored
        in the Entity transform matrix. Instead, the effect transform
        is used in this case.

Reimplemented from impeller::FilterContents.

Definition at line 17 of file matrix_filter_contents.cc.

18 {
19 rendering_mode_ = rendering_mode;
20 FilterContents::SetRenderingMode(rendering_mode);
21 }

References impeller::FilterContents::SetRenderingMode().

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

## ◆ SetSamplerDescriptor()

void impeller::MatrixFilterContents::SetSamplerDescriptor | ( | SamplerDescriptor | desc | ) |

Definition at line 27 of file matrix_filter_contents.cc.

27 {
28 sampler_descriptor_ = std::move(desc);
29 }

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

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

impeller::Entity::RenderingMode::kSubpassAppendSnapshotTransform
@ kSubpassAppendSnapshotTransform
impeller::TRect::TransformBounds
constexpr TRect TransformBounds(const Matrix &transform) const
Creates a new bounding box that contains this transformed rectangle.
Definition: rect.h:466
impeller::Matrix::Basis
constexpr Matrix Basis() const
The Matrix without its w components (without translation).
Definition: matrix.h:229
transform
Matrix transform
Definition: gaussian_blur_filter_contents.cc:213
impeller::FilterContents::IsTranslationOnly
virtual bool IsTranslationOnly() const
Returns true if this filter graph doesn't perform any basis transforms to the filtered content....
Definition: filter_contents.cc:271
impeller::Rect
TRect< Scalar > Rect
Definition: rect.h:776
impeller::Matrix::Invert
Matrix Invert() const
Definition: matrix.cc:97
impeller::Matrix::IsIdentity
constexpr bool IsIdentity() const
Definition: matrix.h:384
impeller::Entity::RenderingMode::kSubpassPrependSnapshotTransform
@ kSubpassPrependSnapshotTransform
impeller::FilterContents::SetRenderingMode
virtual void SetRenderingMode(Entity::RenderingMode rendering_mode)
Marks this filter chain as applying in a subpass scenario.
Definition: filter_contents.cc:299