impeller::BorderMaskBlurFilterContents Class Reference

#include <border_mask_blur_filter_contents.h>

Inheritance diagram for impeller::BorderMaskBlurFilterContents:

Public Member Functions
	BorderMaskBlurFilterContents ()
	~BorderMaskBlurFilterContents () override
void	SetSigma (Sigma sigma_x, Sigma sigma_y)
void	SetBlurStyle (BlurStyle blur_style)
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...
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 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 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< 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 15 of file border_mask_blur_filter_contents.h.

Constructor & Destructor Documentation

BorderMaskBlurFilterContents()

impeller::BorderMaskBlurFilterContents::BorderMaskBlurFilterContents ( )

default

~BorderMaskBlurFilterContents()

impeller::BorderMaskBlurFilterContents::~BorderMaskBlurFilterContents ( )

overridedefault

Member Function Documentation

GetFilterCoverage()

std::optional< Rect > impeller::BorderMaskBlurFilterContents::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 145 of file border_mask_blur_filter_contents.cc.

                                          {
  if (inputs.empty()) {
    return std::nullopt;
  }
 
  auto coverage = inputs[0]->GetCoverage(entity);
  if (!coverage.has_value()) {
    return std::nullopt;
  }
  auto transform = inputs[0]->GetTransform(entity) * effect_transform;
  auto transformed_blur_vector =
      transform.TransformDirection(Vector2(Radius{sigma_x_}.radius, 0)).Abs() +
      transform.TransformDirection(Vector2(0, Radius{sigma_y_}.radius)).Abs();
  return coverage->Expand(transformed_blur_vector);
}

References impeller::TRect< T >::Expand(), and transform.

GetFilterSourceCoverage()

std::optional< Rect > impeller::BorderMaskBlurFilterContents::GetFilterSourceCoverage ( const Matrix &  effect_transform, const Rect &  output_limit  ) const

overridevirtual

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.

Implements impeller::FilterContents.

Definition at line 164 of file border_mask_blur_filter_contents.cc.

                                    {
  auto transformed_blur_vector =
      effect_transform.TransformDirection(Vector2(Radius{sigma_x_}.radius, 0))
          .Abs() +
      effect_transform.TransformDirection(Vector2(0, Radius{sigma_y_}.radius))
          .Abs();
  return output_limit.Expand(transformed_blur_vector);
}

References impeller::TRect< T >::Expand(), and impeller::Matrix::TransformDirection().

SetBlurStyle()

void impeller::BorderMaskBlurFilterContents::SetBlurStyle

(

BlurStyle

blur_style

)

Definition at line 24 of file border_mask_blur_filter_contents.cc.

                                                                    {
  blur_style_ = blur_style;
 
  switch (blur_style) {
    case FilterContents::BlurStyle::kNormal:
      src_color_factor_ = false;
      inner_blur_factor_ = true;
      outer_blur_factor_ = true;
      break;
    case FilterContents::BlurStyle::kSolid:
      src_color_factor_ = true;
      inner_blur_factor_ = false;
      outer_blur_factor_ = true;
      break;
    case FilterContents::BlurStyle::kOuter:
      src_color_factor_ = false;
      inner_blur_factor_ = false;
      outer_blur_factor_ = true;
      break;
    case FilterContents::BlurStyle::kInner:
      src_color_factor_ = false;
      inner_blur_factor_ = true;
      outer_blur_factor_ = false;
      break;
  }
}

References impeller::FilterContents::kInner, impeller::FilterContents::kNormal, impeller::FilterContents::kOuter, and impeller::FilterContents::kSolid.

SetSigma()

void impeller::BorderMaskBlurFilterContents::SetSigma	(	Sigma	sigma_x,
		Sigma	sigma_y
	)

Definition at line 19 of file border_mask_blur_filter_contents.cc.

                                                                        {
  sigma_x_ = sigma_x;
  sigma_y_ = sigma_y;
}

---

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

• impeller/entity/contents/filters/border_mask_blur_filter_contents.h
• impeller/entity/contents/filters/border_mask_blur_filter_contents.cc