#include <uber_sdf_contents.h>

Inheritance diagram for impeller::UberSDFContents:

Public Member Functions
	~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.

Color	GetColor () const

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

const Geometry *	GetGeometry () const override
	Get the geometry that this contents will use to render.

std::optional< Color >	AsBackgroundColor (const Entity &entity, ISize target_size) const override
	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.

Public Member Functions inherited from impeller::ColorSourceContents
	ColorSourceContents ()

	~ColorSourceContents () override

void	SetEffectTransform (Matrix matrix)
	Set the effect transform for this color source.

const Matrix &	GetInverseEffectTransform () const
	Set the inverted effect transform for this color source.

void	SetOpacityFactor (Scalar opacity)
	Set the opacity factor for this color source.

Scalar	GetOpacityFactor () const
	Get the opacity factor for this color source.

virtual bool	IsSolidColor () const

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

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)

Static Public Member Functions
static std::unique_ptr< UberSDFContents >	Make (const UberSDFParameters &params, std::unique_ptr< Geometry > 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
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)>

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.

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 19 of file uber_sdf_contents.h.

Constructor & Destructor Documentation

◆ ~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 132 of file uber_sdf_contents.cc.

                                              {
  params_.color = color_filter_proc(params_.color);
  return true;
}

References impeller::UberSDFParameters::color.

◆ AsBackgroundColor()

std::optional< Color > impeller::UberSDFContents::AsBackgroundColor	(	const Entity &	entity,
		ISize	target_size
	)		const

overridevirtual

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.

This is useful for absorbing full screen solid color draws into subpass clear colors.

Reimplemented from impeller::Contents.

Definition at line 138 of file uber_sdf_contents.cc.

                             {
  if (params_.type != UberSDFParameters::Type::kRect) {
    return std::nullopt;
  }
  const Geometry* geometry = GetGeometry();
  if (geometry == nullptr) {
    return std::nullopt;
  }
  IRect target_rect = IRect::MakeSize(target_size);
  return geometry->CoversArea(entity.GetTransform(), target_rect)
             ? GetColor()
             : std::optional<Color>();
}

References impeller::Geometry::CoversArea(), GetColor(), GetGeometry(), impeller::Entity::GetTransform(), impeller::UberSDFParameters::kRect, impeller::TRect< T >::MakeSize(), and impeller::UberSDFParameters::type.

◆ GetColor()

Color impeller::UberSDFContents::GetColor ( ) const

Definition at line 128 of file uber_sdf_contents.cc.

                                      {
  return params_.color;
}

References impeller::UberSDFParameters::color.

Referenced by AsBackgroundColor().

◆ 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 120 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 124 of file uber_sdf_contents.cc.

                                                   {
  return geometry_.get();
}

Referenced by AsBackgroundColor(), GetCoverage(), and Render().

◆ Make()

std::unique_ptr< UberSDFContents > impeller::UberSDFContents::Make	(	const UberSDFParameters &	params,
		std::unique_ptr< Geometry >	geometry
	)

static

Definition at line 51 of file uber_sdf_contents.cc.

                                      {
  return std::unique_ptr<UberSDFContents>(
      new UberSDFContents(params, std::move(geometry)));
}

References params.

Referenced by impeller::testing::TEST(), impeller::testing::TEST(), impeller::testing::TEST(), impeller::testing::TEST(), impeller::testing::TEST(), impeller::testing::TEST(), impeller::testing::TEST(), impeller::testing::TEST(), 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 64 of file uber_sdf_contents.cc.

                                                     {
  auto& data_host_buffer = renderer.GetTransientsDataBuffer();
 
  VS::FrameInfo frame_info;
  FS::FragInfo frag_info;
  frag_info.type = ToShaderType(params_.type);
  frag_info.color =
      params_.color.WithAlpha(params_.color.alpha * GetOpacityFactor());
  frag_info.center = params_.center;
  frag_info.size = params_.size;
  frag_info.radii =
      Vector4(params_.radii.bottom_right.width, params_.radii.top_right.width,
              params_.radii.bottom_left.width, params_.radii.top_left.width);
  frag_info.radii_right =
      Vector4(params_.radii.bottom_right.height, params_.radii.top_right.height,
              params_.radii.bottom_left.height, params_.radii.top_left.height);
  frag_info.stroked = params_.stroke ? 1.0f : 0.0f;
  frag_info.stroke_width = params_.stroke ? params_.stroke->width : 0.0f;
  frag_info.stroke_join =
      params_.stroke ? ToShaderStrokeJoin(params_.stroke->join) : 0.0f;
  frag_info.aa_pixels = UberSDFParameters::kAntialiasPixels;
  frag_info.superellipse_degree = params_.superellipse_degree;
  frag_info.superellipse_a = params_.superellipse_a;
  frag_info.corner_angle_span = params_.corner_angle_span;
  frag_info.corner_circle_center_top = params_.corner_circle_center_top;
  frag_info.corner_circle_center_right = params_.corner_circle_center_right;
  frag_info.superellipse_c = params_.superellipse_c;
  frag_info.superellipse_scale = params_.superellipse_scale;
 
  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; });
}

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

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~UberSDFContents()

Member Function Documentation

◆ ApplyColorFilter()

◆ AsBackgroundColor()

◆ GetColor()

◆ GetCoverage()

◆ GetGeometry()

◆ Make()

◆ Render()