Flutter Engine
The Flutter Engine
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Private Member Functions | List of all members
impeller::FilterContents Class Referenceabstract

#include <filter_contents.h>

Inheritance diagram for impeller::FilterContents:
impeller::Contents impeller::BorderMaskBlurFilterContents impeller::ColorFilterContents impeller::DirectionalMorphologyFilterContents impeller::GaussianBlurFilterContents impeller::LocalMatrixFilterContents impeller::MatrixFilterContents impeller::YUVToRGBFilterContents impeller::BlendFilterContents impeller::ColorMatrixFilterContents impeller::LinearToSrgbFilterContents impeller::SrgbToLinearFilterContents

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< 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 ()
 
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< RectGetCoverage (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 > &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 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="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< 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 const FilterContentsAsFilter () 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< 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

static const int32_t kBlurFilterRequiredMipCount
 

Private Member Functions

virtual std::optional< RectGetFilterCoverage (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< RectGetFilterSourceCoverage (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< EntityRenderFilter (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...
 

Detailed Description

Definition at line 22 of file filter_contents.h.

Member Enumeration Documentation

◆ BlurStyle

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.

26 {
27 /// Blurred inside and outside.
28 kNormal,
29 /// Solid inside, blurred outside.
30 kSolid,
31 /// Nothing inside, blurred outside.
32 kOuter,
33 /// Blurred inside, nothing outside.
34 kInner,
35 };
@ kNormal
Default priority level.
Definition: embedder.h:262
@ kOuter
nothing inside, fuzzy outside
@ kInner
fuzzy inside, nothing outside

◆ MorphType

Enumerator
kDilate 
kErode 

Definition at line 37 of file filter_contents.h.

Constructor & Destructor Documentation

◆ FilterContents()

impeller::FilterContents::FilterContents ( )
default

◆ ~FilterContents()

impeller::FilterContents::~FilterContents ( )
overridedefault

Member Function Documentation

◆ AsFilter()

const FilterContents * impeller::FilterContents::AsFilter ( ) const
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.

268 {
269 return this;
270}

◆ GetCoverage()

std::optional< Rect > impeller::FilterContents::GetCoverage ( const Entity entity) const
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.

Returns
The coverage rectangle. An 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.

162 {
163 Entity entity_with_local_transform = entity.Clone();
164 entity_with_local_transform.SetTransform(GetTransform(entity.GetTransform()));
165
166 return GetLocalCoverage(entity_with_local_transform);
167}
Matrix GetTransform(const Matrix &parent_transform) const

◆ GetEntity()

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.

229 {
230 Entity entity_with_local_transform = entity.Clone();
231 entity_with_local_transform.SetTransform(GetTransform(entity.GetTransform()));
232
233 auto coverage = GetLocalCoverage(entity_with_local_transform);
234 if (!coverage.has_value() || coverage->IsEmpty()) {
235 return std::nullopt;
236 }
237
238 return RenderFilter(inputs_, renderer, entity_with_local_transform,
239 effect_transform_, coverage.value(), coverage_hint);
240}
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.

◆ GetFilterCoverage()

std::optional< Rect > impeller::FilterContents::GetFilterCoverage ( const FilterInput::Vector inputs,
const Entity entity,
const Matrix effect_transform 
) const
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.

180 {
181 // The default coverage of FilterContents is just the union of its inputs'
182 // coverage. FilterContents implementations may choose to adjust this
183 // coverage depending on the use case.
184
185 if (inputs_.empty()) {
186 return std::nullopt;
187 }
188
189 std::optional<Rect> result;
190 for (const auto& input : inputs) {
191 auto coverage = input->GetCoverage(entity);
192 if (!coverage.has_value()) {
193 continue;
194 }
195 if (!result.has_value()) {
197 continue;
198 }
199 result = result->Union(coverage.value());
200 }
201 return result;
202}
GAsyncResult * result

◆ GetFilterSourceCoverage()

virtual std::optional< Rect > impeller::FilterContents::GetFilterSourceCoverage ( const Matrix effect_transform,
const Rect output_limit 
) const
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.

◆ GetLocalTransform()

Matrix impeller::FilterContents::GetLocalTransform ( const Matrix parent_transform) const
virtual

Reimplemented in impeller::LocalMatrixFilterContents.

Definition at line 272 of file filter_contents.cc.

272 {
273 return Matrix();
274}
SK_API sk_sp< PrecompileColorFilter > Matrix()

◆ GetSourceCoverage()

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.

Returns
The coverage bounds in the transformed space of any source pixel that may be needed to produce output for the indicated filter that covers the indicated |output_limit|.

Definition at line 204 of file filter_contents.cc.

206 {
207 auto filter_input_coverage =
208 GetFilterSourceCoverage(effect_transform_, output_limit);
209
210 if (!filter_input_coverage.has_value()) {
211 return std::nullopt;
212 }
213
214 std::optional<Rect> inputs_coverage;
215 for (const auto& input : inputs_) {
216 auto input_coverage = input->GetSourceCoverage(
217 effect_transform, filter_input_coverage.value());
218 if (!input_coverage.has_value()) {
219 return std::nullopt;
220 }
221 inputs_coverage = Rect::Union(inputs_coverage, input_coverage.value());
222 }
223 return inputs_coverage;
224}
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...
constexpr TRect Union(const TRect &o) const
Definition: rect.h:504

◆ GetTransform()

Matrix impeller::FilterContents::GetTransform ( const Matrix parent_transform) const

Definition at line 276 of file filter_contents.cc.

276 {
277 return parent_transform * GetLocalTransform(parent_transform);
278}
virtual Matrix GetLocalTransform(const Matrix &parent_transform) const

◆ IsLeaf()

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.

288 {
289 for (auto& input : inputs_) {
290 if (!input->IsLeaf()) {
291 return false;
292 }
293 }
294 return true;
295}

◆ IsTranslationOnly()

bool impeller::FilterContents::IsTranslationOnly ( ) const
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.

279 {
280 for (auto& input : inputs_) {
281 if (!input->IsTranslationOnly()) {
282 return false;
283 }
284 }
285 return true;
286}

◆ MakeBorderMaskBlur()

std::shared_ptr< FilterContents > impeller::FilterContents::MakeBorderMaskBlur ( FilterInput::Ref  input,
Sigma  sigma_x,
Sigma  sigma_y,
BlurStyle  blur_style = BlurStyle::kNormal 
)
static

Definition at line 49 of file filter_contents.cc.

53 {
54 auto filter = std::make_shared<BorderMaskBlurFilterContents>();
55 filter->SetInputs({std::move(input)});
56 filter->SetSigma(sigma_x, sigma_y);
57 filter->SetBlurStyle(blur_style);
58 return filter;
59}

◆ MakeDirectionalMorphology()

std::shared_ptr< FilterContents > impeller::FilterContents::MakeDirectionalMorphology ( FilterInput::Ref  input,
Radius  radius,
Vector2  direction,
MorphType  morph_type 
)
static

Definition at line 61 of file filter_contents.cc.

65 {
66 auto filter = std::make_shared<DirectionalMorphologyFilterContents>();
67 filter->SetInputs({std::move(input)});
68 filter->SetRadius(radius);
69 filter->SetDirection(direction);
70 filter->SetMorphType(morph_type);
71 return filter;
72}

◆ MakeGaussianBlur()

std::shared_ptr< FilterContents > impeller::FilterContents::MakeGaussianBlur ( const FilterInput::Ref input,
Sigma  sigma_x,
Sigma  sigma_y,
Entity::TileMode  tile_mode = Entity::TileMode::kDecal,
FilterContents::BlurStyle  mask_blur_style = BlurStyle::kNormal,
const std::shared_ptr< Geometry > &  mask_geometry = nullptr 
)
static

Creates a gaussian blur that operates in 2 dimensions. See also: MakeDirectionalGaussianBlur

Definition at line 36 of file filter_contents.cc.

42 {
43 auto blur = std::make_shared<GaussianBlurFilterContents>(
44 sigma_x.sigma, sigma_y.sigma, tile_mode, mask_blur_style, mask_geometry);
45 blur->SetInputs({input});
46 return blur;
47}

◆ MakeLocalMatrixFilter()

std::shared_ptr< FilterContents > impeller::FilterContents::MakeLocalMatrixFilter ( FilterInput::Ref  input,
const Matrix matrix 
)
static

Definition at line 97 of file filter_contents.cc.

99 {
100 auto filter = std::make_shared<LocalMatrixFilterContents>();
101 filter->SetInputs({std::move(input)});
102 filter->SetMatrix(matrix);
103 return filter;
104}
unsigned useCenter Optional< SkMatrix > matrix
Definition: SkRecords.h:258

◆ MakeMatrixFilter()

std::shared_ptr< FilterContents > impeller::FilterContents::MakeMatrixFilter ( FilterInput::Ref  input,
const Matrix matrix,
const SamplerDescriptor desc 
)
static

Definition at line 86 of file filter_contents.cc.

89 {
90 auto filter = std::make_shared<MatrixFilterContents>();
91 filter->SetInputs({std::move(input)});
92 filter->SetMatrix(matrix);
93 filter->SetSamplerDescriptor(desc);
94 return filter;
95}

◆ MakeMorphology()

std::shared_ptr< FilterContents > impeller::FilterContents::MakeMorphology ( FilterInput::Ref  input,
Radius  radius_x,
Radius  radius_y,
MorphType  morph_type 
)
static

Definition at line 74 of file filter_contents.cc.

78 {
79 auto x_morphology = MakeDirectionalMorphology(std::move(input), radius_x,
80 Point(1, 0), morph_type);
81 auto y_morphology = MakeDirectionalMorphology(
82 FilterInput::Make(x_morphology), radius_y, Point(0, 1), morph_type);
83 return y_morphology;
84}
static std::shared_ptr< FilterContents > MakeDirectionalMorphology(FilterInput::Ref input, Radius radius, Vector2 direction, MorphType morph_type)
static FilterInput::Ref Make(Variant input, bool msaa_enabled=true)
Definition: filter_input.cc:19
TPoint< Scalar > Point
Definition: point.h:322

◆ MakeYUVToRGBFilter()

std::shared_ptr< FilterContents > impeller::FilterContents::MakeYUVToRGBFilter ( std::shared_ptr< Texture y_texture,
std::shared_ptr< Texture uv_texture,
YUVColorSpace  yuv_color_space 
)
static

Definition at line 106 of file filter_contents.cc.

109 {
110 auto filter = std::make_shared<impeller::YUVToRGBFilterContents>();
111 filter->SetInputs({impeller::FilterInput::Make(y_texture),
112 impeller::FilterInput::Make(uv_texture)});
113 filter->SetYUVColorSpace(yuv_color_space);
114 return filter;
115}

◆ PopulateGlyphAtlas()

void impeller::FilterContents::PopulateGlyphAtlas ( const std::shared_ptr< LazyGlyphAtlas > &  lazy_glyph_atlas,
Scalar  scale 
)
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.

171 {
172 for (auto& input : inputs_) {
173 input->PopulateGlyphAtlas(lazy_glyph_atlas, scale);
174 }
175}
const Scalar scale

◆ Render()

bool impeller::FilterContents::Render ( const ContentContext renderer,
const Entity entity,
RenderPass pass 
) const
overridevirtual

Implements impeller::Contents.

Definition at line 133 of file filter_contents.cc.

135 {
136 auto filter_coverage = GetCoverage(entity);
137 if (!filter_coverage.has_value()) {
138 return true;
139 }
140
141 // Run the filter.
142
143 auto maybe_entity = GetEntity(renderer, entity, GetCoverageHint());
144 if (!maybe_entity.has_value()) {
145 return true;
146 }
147 maybe_entity->SetClipDepth(entity.GetClipDepth());
148 return maybe_entity->Render(renderer, pass);
149}
const std::optional< Rect > & GetCoverageHint() const
Definition: contents.cc:173
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.
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.

◆ RenderFilter()

virtual std::optional< Entity > impeller::FilterContents::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
privatepure virtual

Converts zero or more filter inputs into a render instruction.

◆ RenderToSnapshot()

std::optional< Snapshot > impeller::FilterContents::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
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.

249 {
250 // Resolve the render instruction (entity) from the filter and render it to a
251 // snapshot.
252 if (std::optional<Entity> result =
253 GetEntity(renderer, entity, coverage_limit);
254 result.has_value()) {
255 return result->GetContents()->RenderToSnapshot(
256 renderer, // renderer
257 result.value(), // entity
258 coverage_limit, // coverage_limit
259 std::nullopt, // sampler_descriptor
260 true, // msaa_enabled
261 /*mip_count=*/mip_count,
262 label); // label
263 }
264
265 return std::nullopt;
266}

◆ SetEffectTransform()

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.

125 {
126 effect_transform_ = effect_transform;
127
128 for (auto& input : inputs_) {
129 input->SetEffectTransform(effect_transform);
130 }
131}

◆ SetInputs()

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.

121 {
122 inputs_ = std::move(inputs);
123}

◆ SetLeafInputs()

void impeller::FilterContents::SetLeafInputs ( const FilterInput::Vector inputs)

Replaces the set of all leaf FilterContents with a new set of FilterInputs.

See also
FilterContents::IsLeaf

Definition at line 297 of file filter_contents.cc.

297 {
298 if (IsLeaf()) {
299 inputs_ = inputs;
300 return;
301 }
302 for (auto& input : inputs_) {
303 input->SetLeafInputs(inputs);
304 }
305}
bool IsLeaf() const
Returns true if this filter does not have any FilterInput children.

◆ SetRenderingMode()

void impeller::FilterContents::SetRenderingMode ( Entity::RenderingMode  rendering_mode)
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.

307 {
308 for (auto& input : inputs_) {
309 input->SetRenderingMode(rendering_mode);
310 }
311}

Member Data Documentation

◆ kBlurFilterRequiredMipCount

const int32_t impeller::FilterContents::kBlurFilterRequiredMipCount
static

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