A base class for SolidRRectBlurContents and SolidRSuperellipseBlurContents. More...

#include <solid_rrect_like_blur_contents.h>

Inheritance diagram for impeller::SolidRRectLikeBlurContents:

Classes
struct	PassContext

Public Member Functions
	~SolidRRectLikeBlurContents () override

void	SetShape (Rect rect, Scalar corner_radius)

void	SetSigma (Sigma sigma)

void	SetColor (Color color)

Color	GetColor () const

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.

bool	Render (const ContentContext &renderer, const Entity &entity, RenderPass &pass) const override

bool	ApplyColorFilter (const ColorFilterProc &color_filter_proc) override
	If possible, applies a color filter to this contents inputs on the CPU.

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()`.

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.

virtual std::optional< Snapshot >	RenderToSnapshot (const ContentContext &renderer, const Entity &entity, const SnapshotOptions &options) 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)`.

std::optional< Size >	GetColorSourceSize () const
	Return the color source's intrinsic size, if available.

void	SetColorSourceSize (Size size)

virtual void	SetInheritedOpacity (Scalar opacity)
	Inherit the provided opacity.

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.

Protected Member Functions
	SolidRRectLikeBlurContents ()

virtual bool	SetPassInfo (RenderPass &pass, const ContentContext &renderer, PassContext &pass_context) const =0

Rect	GetRect () const

Scalar	GetCornerRadius () const

Sigma	GetSigma () const

Static Protected Member Functions
static Vector4	Concat (Vector2 &a, Vector2 &b)

Additional Inherited Members
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::Contents
static std::shared_ptr< Contents >	MakeAnonymous (RenderProc render_proc, CoverageProc coverage_proc)

Detailed Description

A base class for SolidRRectBlurContents and SolidRSuperellipseBlurContents.

Definition at line 20 of file solid_rrect_like_blur_contents.h.

Constructor & Destructor Documentation

◆ ~SolidRRectLikeBlurContents()

impeller::SolidRRectLikeBlurContents::~SolidRRectLikeBlurContents ( )

overridedefault

◆ SolidRRectLikeBlurContents()

impeller::SolidRRectLikeBlurContents::SolidRRectLikeBlurContents ( )

protecteddefault

Member Function Documentation

◆ ApplyColorFilter()

bool impeller::SolidRRectLikeBlurContents::ApplyColorFilter ( const ColorFilterProc & color_filter_proc )

overridevirtual

If possible, applies a color filter to this contents inputs on the CPU.

This method will either fully apply the color filter or perform no action. Partial/incorrect application of the color filter will never occur.

Parameters

[in] color_filter_proc A function that filters a given unpremultiplied color to produce a new unpremultiplied color.

Returns: True if the color filter was able to be fully applied to all all relevant inputs. Otherwise, this operation is a no-op and false is returned.

Reimplemented from impeller::Contents.

Definition at line 187 of file solid_rrect_like_blur_contents.cc.

                                              {
  color_ = color_filter_proc(color_);
  return true;
}

◆ Concat()

Vector4 impeller::SolidRRectLikeBlurContents::Concat	(	Vector2 &	a,
		Vector2 &	b
	)

staticprotected

Definition at line 193 of file solid_rrect_like_blur_contents.cc.

                                                                 {
  return {a.x, a.y, b.x, b.y};
}

References impeller::TPoint< T >::x, and impeller::TPoint< T >::y.

Referenced by impeller::SolidRRectBlurContents::SetPassInfo().

◆ GetColor()

Color impeller::SolidRRectLikeBlurContents::GetColor ( ) const

Definition at line 46 of file solid_rrect_like_blur_contents.cc.

                                                 {
  return color_;
}

Referenced by impeller::SolidRRectBlurContents::SetPassInfo().

◆ GetCornerRadius()

Scalar impeller::SolidRRectLikeBlurContents::GetCornerRadius ( ) const

inlineprotected

Definition at line 66 of file solid_rrect_like_blur_contents.h.

66{ return corner_radius_; }

◆ GetCoverage()

std::optional< Rect > impeller::SolidRRectLikeBlurContents::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 108 of file solid_rrect_like_blur_contents.cc.

                                {
  Scalar radius = PadForSigma(sigma_.sigma);
 
  return rect_.Expand(radius).TransformBounds(entity.GetTransform());
}

References impeller::TRect< T >::Expand(), impeller::Entity::GetTransform(), impeller::Sigma::sigma, and impeller::TRect< T >::TransformBounds().

◆ GetRect()

Rect impeller::SolidRRectLikeBlurContents::GetRect ( ) const

inlineprotected

Definition at line 65 of file solid_rrect_like_blur_contents.h.

65{ return rect_; }

◆ GetSigma()

Sigma impeller::SolidRRectLikeBlurContents::GetSigma ( ) const

inlineprotected

Definition at line 67 of file solid_rrect_like_blur_contents.h.

67{ return sigma_; }

◆ Render()

bool impeller::SolidRRectLikeBlurContents::Render	(	const ContentContext &	renderer,
		const Entity &	entity,
		RenderPass &	pass
	)		const

overridevirtual

Implements impeller::Contents.

Definition at line 115 of file solid_rrect_like_blur_contents.cc.

                                                                {
  using VS = RrectLikeBlurVertexShader;
 
  Matrix basis_invert = entity.GetTransform().Basis().Invert();
  Vector2 max_sigmas =
      Vector2((basis_invert * Vector2(500.f, 0.f)).GetLength(),
              (basis_invert * Vector2(0.f, 500.f)).GetLength());
  Scalar max_sigma = std::min(max_sigmas.x, max_sigmas.y);
  // Clamp the max kernel width/height to 1000 (@ 2x) to limit the extent
  // of the blur and to kEhCloseEnough to prevent NaN calculations
  // trying to evaluate a Gaussian distribution with a sigma of 0.
  auto blur_sigma = std::clamp(sigma_.sigma, kEhCloseEnough, max_sigma);
  // Increase quality by making the radius a bit bigger than the typical
  // sigma->radius conversion we use for slower blurs.
  Scalar blur_radius = PadForSigma(blur_sigma);
  Rect positive_rect = rect_.GetPositive();
  Scalar left = -blur_radius;
  Scalar top = -blur_radius;
  Scalar right = positive_rect.GetWidth() + blur_radius;
  Scalar bottom = positive_rect.GetHeight() + blur_radius;
 
  ContentContextOptions opts = OptionsFromPassAndEntity(pass, entity);
  opts.primitive_type = PrimitiveType::kTriangleStrip;
  Color color = color_;
  if (entity.GetBlendMode() == BlendMode::kClear) {
    opts.is_for_rrect_blur_clear = true;
    color = Color::White();
  }
 
  std::array<VS::PerVertexData, 4> vertices = {
      VS::PerVertexData{Point(left, top)},
      VS::PerVertexData{Point(right, top)},
      VS::PerVertexData{Point(left, bottom)},
      VS::PerVertexData{Point(right, bottom)},
  };
 
  PassContext pass_context = {
      .opts = opts,
  };
 
  Scalar radius = std::min(std::clamp(corner_radius_, kEhCloseEnough,
                                      positive_rect.GetWidth() * 0.5f),
                           std::clamp(corner_radius_, kEhCloseEnough,
                                      positive_rect.GetHeight() * 0.5f));
  if (!PopulateFragContext(pass_context, blur_sigma, positive_rect.GetCenter(),
                           Point(positive_rect.GetSize()), radius)) {
    return true;
  }
 
  if (!SetPassInfo(pass, renderer, pass_context)) {
    return true;
  }
 
  VS::FrameInfo frame_info;
  frame_info.mvp = Entity::GetShaderTransform(
      entity.GetShaderClipDepth(), pass,
      entity.GetTransform() *
          Matrix::MakeTranslation(positive_rect.GetOrigin()));
 
  auto& data_host_buffer = renderer.GetTransientsDataBuffer();
  pass.SetVertexBuffer(CreateVertexBuffer(vertices, data_host_buffer));
  VS::BindFrameInfo(pass, data_host_buffer.EmplaceUniform(frame_info));
 
  if (!pass.Draw().ok()) {
    return false;
  }
 
  return true;
}

References impeller::Matrix::Basis(), blur_radius, impeller::CreateVertexBuffer(), impeller::RenderPass::Draw(), impeller::Entity::GetBlendMode(), impeller::TRect< T >::GetCenter(), impeller::TRect< T >::GetHeight(), impeller::TRect< T >::GetOrigin(), impeller::TRect< T >::GetPositive(), impeller::Entity::GetShaderClipDepth(), impeller::Entity::GetShaderTransform(), impeller::TRect< T >::GetSize(), impeller::Entity::GetTransform(), impeller::ContentContext::GetTransientsDataBuffer(), impeller::TRect< T >::GetWidth(), impeller::Matrix::Invert(), impeller::ContentContextOptions::is_for_rrect_blur_clear, impeller::kClear, impeller::kEhCloseEnough, impeller::kTriangleStrip, impeller::Matrix::MakeTranslation(), fml::Status::ok(), impeller::OptionsFromPassAndEntity(), impeller::SolidRRectLikeBlurContents::PassContext::opts, impeller::ContentContextOptions::primitive_type, SetPassInfo(), impeller::RenderPass::SetVertexBuffer(), impeller::Sigma::sigma, impeller::Color::White(), impeller::TPoint< T >::x, and impeller::TPoint< T >::y.

◆ SetColor()

void impeller::SolidRRectLikeBlurContents::SetColor ( Color color )

Definition at line 42 of file solid_rrect_like_blur_contents.cc.

                                                     {
  color_ = color.Premultiply();
}

References impeller::Color::Premultiply().

◆ SetPassInfo()

virtual bool impeller::SolidRRectLikeBlurContents::SetPassInfo	(	RenderPass &	pass,
		const ContentContext &	renderer,
		PassContext &	pass_context
	)		const

protectedpure virtual

Implemented in impeller::SolidRRectBlurContents.

Referenced by Render().

◆ SetShape()

void impeller::SolidRRectLikeBlurContents::SetShape	(	Rect	rect,
		Scalar	corner_radius
	)

Definition at line 33 of file solid_rrect_like_blur_contents.cc.

                                                                         {
  rect_ = rect;
  corner_radius_ = corner_radius;
}

◆ SetSigma()

void impeller::SolidRRectLikeBlurContents::SetSigma ( Sigma sigma )

Definition at line 38 of file solid_rrect_like_blur_contents.cc.

                                                     {
  sigma_ = sigma;
}

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

impeller/entity/contents/solid_rrect_like_blur_contents.h
impeller/entity/contents/solid_rrect_like_blur_contents.cc

Classes

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~SolidRRectLikeBlurContents()

◆ SolidRRectLikeBlurContents()

Member Function Documentation

◆ ApplyColorFilter()

◆ Concat()

◆ GetColor()

◆ GetCornerRadius()

◆ GetCoverage()

◆ GetRect()

◆ GetSigma()

◆ Render()

◆ SetColor()

◆ SetPassInfo()

◆ SetShape()

◆ SetSigma()