Flutter Impeller
impeller::MatrixFilterContents Class Referencefinal

#include <matrix_filter_contents.h>

Inheritance diagram for impeller::MatrixFilterContents:
impeller::FilterContents impeller::Contents

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...
 
void SetSamplerDescriptor (const SamplerDescriptor &desc)
 
std::optional< RectGetFilterCoverage (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< 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...
 
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, 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< 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
 
- 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< SizeGetColorSourceSize () 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< 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 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 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)>
 
- Static Public Member Functions inherited from impeller::FilterContents
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 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 std::shared_ptr< FilterContentsMakeRuntimeEffect (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< ContentsMakeAnonymous (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 ( )
overridedefault

Member Function Documentation

◆ GetFilterCoverage()

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

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 120 of file matrix_filter_contents.cc.

123  {
124  if (inputs.empty()) {
125  return std::nullopt;
126  }
127 
128  std::optional<Rect> coverage = inputs[0]->GetCoverage(entity);
129  if (!coverage.has_value()) {
130  return std::nullopt;
131  }
132 
133  Matrix input_transform = inputs[0]->GetTransform(entity);
134  if (rendering_mode_ ==
136  rendering_mode_ ==
138  Rect coverage_bounds = coverage->TransformBounds(input_transform.Invert());
139  Matrix transform = CalculateSubpassTransform(
140  input_transform, effect_transform, matrix_, rendering_mode_);
141  return coverage_bounds.TransformBounds(transform);
142  } else {
143  Matrix transform = input_transform * //
144  matrix_ * //
145  input_transform.Invert(); //
146  return coverage->TransformBounds(transform);
147  }
148 }
TRect< Scalar > Rect
Definition: rect.h:792
Matrix Invert() const
Definition: matrix.cc:97
constexpr TRect TransformBounds(const Matrix &transform) const
Creates a new bounding box that contains this transformed rectangle.
Definition: rect.h:476

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

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)
overridevirtual

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 }
virtual void SetRenderingMode(Entity::RenderingMode rendering_mode)
Marks this filter chain as applying in a subpass scenario.

References impeller::FilterContents::SetRenderingMode().

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

◆ SetSamplerDescriptor()

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

Definition at line 23 of file matrix_filter_contents.cc.

23  {
24  sampler_descriptor_ = desc;
25 }

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