Flutter Engine
The Flutter Engine
|
#include <filter_contents.h>
Public Types | |
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 | |
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... | |
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, 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 |
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 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 () |
virtual void | PopulateGlyphAtlas (const std::shared_ptr< LazyGlyphAtlas > &lazy_glyph_atlas, Scalar scale) |
Add any text data to the specified lazy atlas. The scale parameter must be used again later when drawing the text. More... | |
virtual bool | Render (const ContentContext &renderer, const Entity &entity, RenderPass &pass) const =0 |
virtual std::optional< Rect > | GetCoverage (const Entity &entity) const =0 |
Get the area of the render pass that will be affected when this contents is rendered. More... | |
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 > ¤t_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 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="Snapshot") const |
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... | |
virtual bool | ShouldRender (const Entity &entity, const std::optional< Rect > clip_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 const FilterContents * | AsFilter () const |
Cast to a filter. Returns nullptr if this Contents is not a filter. More... | |
virtual bool | ApplyColorFilter (const ColorFilterProc &color_filter_proc) |
If possible, applies a color filter to this contents inputs on the CPU. More... | |
Static Public Member Functions | |
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 std::shared_ptr< 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 | |
static const int32_t | kBlurFilterRequiredMipCount |
Private Member Functions | |
virtual std::optional< Rect > | GetFilterCoverage (const FilterInput::Vector &inputs, const Entity &entity, const Matrix &effect_transform) const |
Internal utility method for |GetLocalCoverage| that computes the output coverage of this filter across the specified inputs, ignoring the coverage hint. More... | |
virtual std::optional< Rect > | GetFilterSourceCoverage (const Matrix &effect_transform, const Rect &output_limit) const =0 |
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... | |
virtual std::optional< Entity > | RenderFilter (const FilterInput::Vector &inputs, const ContentContext &renderer, const Entity &entity, const Matrix &effect_transform, const Rect &coverage, const std::optional< Rect > &coverage_hint) const =0 |
Converts zero or more filter inputs into a render instruction. More... | |
Definition at line 22 of file filter_contents.h.
|
strong |
Enumerator | |
---|---|
kNormal | Blurred inside and outside. |
kSolid | Solid inside, blurred outside. |
kOuter | Nothing inside, blurred outside. |
kInner | Blurred inside, nothing outside. |
Definition at line 26 of file filter_contents.h.
|
strong |
|
default |
|
overridedefault |
|
overridevirtual |
Cast to a filter. Returns nullptr
if this Contents is not a filter.
Reimplemented from impeller::Contents.
Definition at line 268 of file filter_contents.cc.
|
overridevirtual |
Get the area of the render pass that will be affected when this contents is rendered.
During rendering, coverage coordinates count pixels from the top left corner of the framebuffer.
std::nullopt
result means that rendering this contents has no effect on the output color. Implements impeller::Contents.
Definition at line 162 of file filter_contents.cc.
std::optional< Entity > impeller::FilterContents::GetEntity | ( | const ContentContext & | renderer, |
const Entity & | entity, | ||
const std::optional< Rect > & | coverage_hint | ||
) | const |
Create an Entity that renders this filter's output.
Definition at line 226 of file filter_contents.cc.
|
privatevirtual |
Internal utility method for |GetLocalCoverage| that computes the output coverage of this filter across the specified inputs, ignoring the coverage hint.
Reimplemented in impeller::BorderMaskBlurFilterContents, impeller::GaussianBlurFilterContents, impeller::MatrixFilterContents, and impeller::DirectionalMorphologyFilterContents.
Definition at line 177 of file filter_contents.cc.
|
privatepure virtual |
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.
Implemented in impeller::BorderMaskBlurFilterContents, impeller::ColorFilterContents, impeller::GaussianBlurFilterContents, impeller::LocalMatrixFilterContents, and impeller::DirectionalMorphologyFilterContents.
Reimplemented in impeller::LocalMatrixFilterContents.
Definition at line 272 of file filter_contents.cc.
std::optional< Rect > impeller::FilterContents::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.
Both the |output_limit| and the return value are in the transformed coordinate space, and so do not need to be transformed or inverse transformed by the |effect_transform| but individual parameters on the filter might be in the untransformed space and should be transformed by the |effect_transform| before applying them to the coverages.
The method computes a result such that if the filter is applied to a set of pixels filling the computed source coverage, it should produce an output that covers the entire specified |output_limit|.
This is useful for subpass rendering scenarios where a filter will be applied to the output of the subpass and we need to determine how large of a render target to allocate in order to collect all pixels that might affect the supplied output coverage limit. While we might end up clipping the rendering of the subpass to its destination, we want to avoid clipping out any pixels that contribute to the output limit via the filtering operation.
Definition at line 204 of file filter_contents.cc.
Definition at line 276 of file filter_contents.cc.
bool impeller::FilterContents::IsLeaf | ( | ) | const |
Returns true
if this filter does not have any FilterInput
children.
Definition at line 288 of file filter_contents.cc.
|
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 in impeller::MatrixFilterContents.
Definition at line 279 of file filter_contents.cc.
|
static |
Definition at line 49 of file filter_contents.cc.
|
static |
Definition at line 61 of file filter_contents.cc.
|
static |
Creates a gaussian blur that operates in 2 dimensions. See also: MakeDirectionalGaussianBlur
Definition at line 36 of file filter_contents.cc.
|
static |
Definition at line 97 of file filter_contents.cc.
|
static |
Definition at line 86 of file filter_contents.cc.
|
static |
Definition at line 74 of file filter_contents.cc.
|
static |
Definition at line 106 of file filter_contents.cc.
|
overridevirtual |
Add any text data to the specified lazy atlas. The scale parameter must be used again later when drawing the text.
Reimplemented from impeller::Contents.
Definition at line 169 of file filter_contents.cc.
|
overridevirtual |
Implements impeller::Contents.
Definition at line 133 of file filter_contents.cc.
|
privatepure virtual |
Converts zero or more filter inputs into a render instruction.
|
overridevirtual |
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)
.
Reimplemented from impeller::Contents.
Definition at line 242 of file filter_contents.cc.
void impeller::FilterContents::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.
This is useful for subpass rendering scenarios where it's difficult to encode the current transform of the layer into the Entity being rendered.
Definition at line 125 of file filter_contents.cc.
void impeller::FilterContents::SetInputs | ( | FilterInput::Vector | inputs | ) |
The input texture sources for this filter. Each input's emitted texture is expected to have premultiplied alpha colors.
The number of required or optional textures depends on the particular filter's implementation.
Definition at line 121 of file filter_contents.cc.
void impeller::FilterContents::SetLeafInputs | ( | const FilterInput::Vector & | inputs | ) |
Replaces the set of all leaf FilterContents
with a new set of FilterInput
s.
FilterContents::IsLeaf
Definition at line 297 of file filter_contents.cc.
|
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 in impeller::MatrixFilterContents.
Definition at line 307 of file filter_contents.cc.
|
static |
Definition at line 24 of file filter_contents.h.