impeller::UberSDFContents Class Reference

#include <uber_sdf_contents.h>

Inheritance diagram for impeller::UberSDFContents:

Public Types
enum class	Type {   kCircle ,   kRect }
Public Types inherited from impeller::ColorSourceContents
using	BindFragmentCallback = std::function< bool(RenderPass &pass)>
using	PipelineBuilderCallback = std::function< PipelineRef(ContentContextOptions)>
using	CreateGeometryCallback = std::function< GeometryResult(const ContentContext &renderer, const Entity &entity, RenderPass &pass, const Geometry *geom)>
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
	UberSDFContents (Type type, Rect rect, Color color, Scalar stroke_width, Join stroke_join, bool stroked, const Geometry *geometry, Scalar aa_padding)
	~UberSDFContents () override
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...
Color	GetColor () const
bool	ApplyColorFilter (const ColorFilterProc &color_filter_proc) override
	If possible, applies a color filter to this contents inputs on the CPU. More...
const Geometry *	GetGeometry () const override
	Get the geometry that this contents will use to render. More...
Public Member Functions inherited from impeller::ColorSourceContents
	ColorSourceContents ()
	~ColorSourceContents () override
void	SetEffectTransform (Matrix matrix)
	Set the effect transform for this color source. More...
const Matrix &	GetInverseEffectTransform () const
	Set the inverted effect transform for this color source. More...
void	SetOpacityFactor (Scalar opacity)
	Set the opacity factor for this color source. More...
Scalar	GetOpacityFactor () const
	Get the opacity factor for this color source. More...
virtual bool	IsSolidColor () const
void	SetInheritedOpacity (Scalar opacity) override
	Inherit the provided opacity. 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...
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). More...
std::optional< Size >	GetColorSourceSize () const
	Return the color source's intrinsic size, if available. More...
void	SetColorSourceSize (Size size)
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...

Static Public Member Functions
static std::unique_ptr< UberSDFContents >	MakeRect (Color color, Scalar stroke_width, Join stroke_join, bool stroked, const FillRectGeometry *geometry)
static std::unique_ptr< UberSDFContents >	MakeCircle (Color color, bool stroked, const CircleGeometry *geometry)
Static Public Member Functions inherited from impeller::ColorSourceContents
template<typename VertexShaderT >
static bool	DrawGeometry (const Contents *contents, const Geometry *geometry, const ContentContext &renderer, const Entity &entity, RenderPass &pass, const PipelineBuilderCallback &pipeline_callback, typename VertexShaderT::FrameInfo frame_info, const BindFragmentCallback &bind_fragment_callback, bool force_stencil=false, const CreateGeometryCallback &create_geom_callback=DefaultCreateGeometryCallback)
Static Public Member Functions inherited from impeller::Contents
static std::shared_ptr< Contents >	MakeAnonymous (RenderProc render_proc, CoverageProc coverage_proc)

Additional Inherited Members
Protected Member Functions inherited from impeller::ColorSourceContents
bool	AppliesAlphaForStrokeCoverage (const Matrix &transform) const
	Whether the entity should be treated as non-opaque due to stroke geometry requiring alpha for coverage. More...
template<typename VertexShaderT >
bool	DrawGeometry (const ContentContext &renderer, const Entity &entity, RenderPass &pass, const PipelineBuilderCallback &pipeline_callback, typename VertexShaderT::FrameInfo frame_info, const BindFragmentCallback &bind_fragment_callback, bool force_stencil=false, const CreateGeometryCallback &create_geom_callback=DefaultCreateGeometryCallback) const
Static Protected Member Functions inherited from impeller::ColorSourceContents
static GeometryResult	DefaultCreateGeometryCallback (const ContentContext &renderer, const Entity &entity, RenderPass &pass, const Geometry *geom)

Detailed Description

Definition at line 20 of file uber_sdf_contents.h.

Member Enumeration Documentation

Type

enum impeller::UberSDFContents::Type

strong

Enumerator
kCircle
kRect

Definition at line 22 of file uber_sdf_contents.h.

                  {
    kCircle,
    kRect,
  };

Constructor & Destructor Documentation

UberSDFContents()

impeller::UberSDFContents::UberSDFContents	(	Type	type,
		Rect	rect,
		Color	color,
		Scalar	stroke_width,
		Join	stroke_join,
		bool	stroked,
		const Geometry *	geometry,
		Scalar	aa_padding
	)

Definition at line 51 of file uber_sdf_contents.cc.

    : type_(type),
      bounding_box_(bounding_box),
      color_(color),
      stroke_width_(stroke_width),
      stroke_join_(stroke_join),
      stroked_(stroked),
      geometry_(geometry),
      aa_padding_(aa_padding) {}

Referenced by MakeCircle().

~UberSDFContents()

impeller::UberSDFContents::~UberSDFContents ( )

overridedefault

Member Function Documentation

ApplyColorFilter()

bool impeller::UberSDFContents::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 134 of file uber_sdf_contents.cc.

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

GetColor()

Color impeller::UberSDFContents::GetColor

(

)

const

Definition at line 130 of file uber_sdf_contents.cc.

                                      {
  return color_;
}

GetCoverage()

std::optional< Rect > impeller::UberSDFContents::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.

Reimplemented from impeller::ColorSourceContents.

Definition at line 122 of file uber_sdf_contents.cc.

                                                                         {
  return GetGeometry()->GetCoverage(entity.GetTransform());
}

References impeller::Geometry::GetCoverage(), GetGeometry(), and impeller::Entity::GetTransform().

GetGeometry()

const Geometry * impeller::UberSDFContents::GetGeometry ( ) const

overridevirtual

Get the geometry that this contents will use to render.

Implements impeller::ColorSourceContents.

Definition at line 126 of file uber_sdf_contents.cc.

                                                   {
  return geometry_;
}

Referenced by GetCoverage(), and Render().

MakeCircle()

std::unique_ptr< UberSDFContents > impeller::UberSDFContents::MakeCircle ( Color  color, bool  stroked, const CircleGeometry *  geometry  )

static

Definition at line 37 of file uber_sdf_contents.cc.

                                    {
  Point center = geometry->GetCenter();
  Scalar radius = geometry->GetRadius();
  Rect bounding_box = Rect::MakeXYWH(center.x - radius, center.y - radius,
                                     radius * 2, radius * 2);
  Scalar aa_padding = geometry->GetAntialiasPadding();
  return std::unique_ptr<UberSDFContents>(new UberSDFContents(
      Type::kCircle, bounding_box, color, geometry->GetStrokeWidth(),
      Join::kMiter, stroked, geometry, aa_padding));
}

References impeller::CircleGeometry::GetAntialiasPadding(), impeller::CircleGeometry::GetCenter(), impeller::CircleGeometry::GetRadius(), impeller::CircleGeometry::GetStrokeWidth(), kCircle, impeller::kMiter, impeller::TRect< Scalar >::MakeXYWH(), UberSDFContents(), impeller::TPoint< T >::x, and impeller::TPoint< T >::y.

Referenced by impeller::Canvas::DrawCircle().

MakeRect()

std::unique_ptr< UberSDFContents > impeller::UberSDFContents::MakeRect ( Color  color, Scalar  stroke_width, Join  stroke_join, bool  stroked, const FillRectGeometry *  geometry  )

static

Definition at line 24 of file uber_sdf_contents.cc.

                                      {
  Rect bounding_box = geometry->GetRect();
  Scalar aa_padding = 1.0f;
  return std::make_unique<UberSDFContents>(Type::kRect, bounding_box, color,
                                           stroke_width, stroke_join, stroked,
                                           geometry, aa_padding);
}

References impeller::FillRectGeometry::GetRect(), and kRect.

Referenced by impeller::Canvas::DrawRect(), and impeller::testing::TEST().

Render()

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

overridevirtual

Implements impeller::Contents.

Definition at line 70 of file uber_sdf_contents.cc.

                                                     {
  auto& data_host_buffer = renderer.GetTransientsDataBuffer();
 
  VS::FrameInfo frame_info;
  FS::FragInfo frag_info;
  frag_info.color = color_.WithAlpha(color_.alpha * GetOpacityFactor());
  frag_info.center = bounding_box_.GetCenter();
  frag_info.size =
      Point(bounding_box_.GetWidth() / 2.0f, bounding_box_.GetHeight() / 2.0f);
  frag_info.stroke_width = stroke_width_;
  switch (stroke_join_) {
    case Join::kMiter:
      frag_info.stroke_join = 0.0f;
      break;
    case Join::kBevel:
      frag_info.stroke_join = 1.0f;
      break;
    case Join::kRound:
      frag_info.stroke_join = 2.0f;
      break;
  }
  frag_info.aa_pixels = aa_padding_;
  frag_info.stroked = stroked_ ? 1.0f : 0.0f;
  frag_info.type = type_ == Type::kCircle ? 0.0f : 1.0f;
 
  auto geometry_result =
      GetGeometry()->GetPositionBuffer(renderer, entity, pass);
 
  PipelineBuilderCallback pipeline_callback =
      [&renderer](ContentContextOptions options) {
        return renderer.GetUberSDFPipeline(options);
      };
 
  return ColorSourceContents::DrawGeometry<VS>(
      this, GetGeometry(), renderer, entity, pass, pipeline_callback,
      frame_info,
      /*bind_fragment_callback=*/
      [&frag_info, &data_host_buffer](RenderPass& pass) {
        FS::BindFragInfo(pass, data_host_buffer.EmplaceUniform(frag_info));
        pass.SetCommandLabel("UberSDF");
        return true;
      },
      /*force_stencil=*/false,
      /*create_geom_callback=*/
      [geometry_result = std::move(geometry_result)](
          const ContentContext& renderer, const Entity& entity,
          RenderPass& pass,
          const Geometry* geometry) { return geometry_result; });
}

References impeller::Color::alpha, impeller::TRect< T >::GetCenter(), GetGeometry(), impeller::TRect< T >::GetHeight(), impeller::ColorSourceContents::GetOpacityFactor(), impeller::Geometry::GetPositionBuffer(), impeller::ContentContext::GetTransientsDataBuffer(), impeller::ContentContext::GetUberSDFPipeline(), impeller::TRect< T >::GetWidth(), impeller::kBevel, kCircle, impeller::kMiter, impeller::kRound, impeller::RenderPass::SetCommandLabel(), and impeller::Color::WithAlpha().

---

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

• impeller/entity/contents/uber_sdf_contents.h
• impeller/entity/contents/uber_sdf_contents.cc