#include <sweep_gradient_contents.h>

Inheritance diagram for impeller::SweepGradientContents:

Public Member Functions
	SweepGradientContents ()

	~SweepGradientContents () override

bool	IsOpaque (const Matrix &transform) const override
	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...

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. More...

void	SetCenterAndAngles (Point center, Degrees start_angle, Degrees end_angle)

void	SetColors (std::vector< Color > colors)

void	SetStops (std::vector< Scalar > stops)

void	SetTileMode (Entity::TileMode tile_mode)

const std::vector< Color > &	GetColors () const

const std::vector< Scalar > &	GetStops () const

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

	~ColorSourceContents () override

void	SetGeometry (const Geometry *geometry)
	Set the geometry that this contents will use to render. More...

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

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

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...

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 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="Snapshot") 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...

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

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)

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 18 of file sweep_gradient_contents.h.

Constructor & Destructor Documentation

◆ SweepGradientContents()

impeller::SweepGradientContents::SweepGradientContents ( )

default

◆ ~SweepGradientContents()

impeller::SweepGradientContents::~SweepGradientContents ( )

overridedefault

Member Function Documentation

◆ ApplyColorFilter()

bool impeller::SweepGradientContents::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 226 of file sweep_gradient_contents.cc.

                                               {
   for (Color& color : colors_) {
     color = color_filter_proc(color);
   }
   decal_border_color_ = color_filter_proc(decal_border_color_);
   return true;
 }

◆ GetColors()

const std::vector< Color > & impeller::SweepGradientContents::GetColors ( ) const

Definition at line 44 of file sweep_gradient_contents.cc.

                                                                {
   return colors_;
 }

◆ GetStops()

const std::vector< Scalar > & impeller::SweepGradientContents::GetStops ( ) const

Definition at line 48 of file sweep_gradient_contents.cc.

                                                                {
   return stops_;
 }

◆ IsOpaque()

bool impeller::SweepGradientContents::IsOpaque ( const Matrix & transform ) const

overridevirtual

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.

Parameters

transform The current transform matrix of the entity that will render this contents.

Reimplemented from impeller::Contents.

Definition at line 52 of file sweep_gradient_contents.cc.

                                                                   {
   if (GetOpacityFactor() < 1 || tile_mode_ == Entity::TileMode::kDecal) {
     return false;
   }
   for (auto color : colors_) {
     if (!color.IsOpaque()) {
       return false;
     }
   }
   return !AppliesAlphaForStrokeCoverage(transform);
 }

References impeller::ColorSourceContents::AppliesAlphaForStrokeCoverage(), impeller::ColorSourceContents::GetOpacityFactor(), impeller::Entity::kDecal, and transform.

◆ Render()

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

overridevirtual

Implements impeller::Contents.

Definition at line 72 of file sweep_gradient_contents.cc.

                                                            {
   if (renderer.GetDeviceCapabilities().SupportsSSBO()) {
     return RenderSSBO(renderer, entity, pass);
   }
   if (colors_.size() <= kMaxUniformGradientStops &&
       stops_.size() <= kMaxUniformGradientStops) {
     return RenderUniform(renderer, entity, pass);
   }
   return RenderTexture(renderer, entity, pass);
 }

References impeller::ContentContext::GetDeviceCapabilities(), impeller::kMaxUniformGradientStops, and impeller::Capabilities::SupportsSSBO().

◆ SetCenterAndAngles()

void impeller::SweepGradientContents::SetCenterAndAngles	(	Point	center,
		Degrees	start_angle,
		Degrees	end_angle
	)

Definition at line 21 of file sweep_gradient_contents.cc.

                                                                   {
   center_ = center;
   Scalar t0 = start_angle.degrees / 360;
   Scalar t1 = end_angle.degrees / 360;
   FML_DCHECK(t0 < t1);
   bias_ = -t0;
   scale_ = 1 / (t1 - t0);
 }

References impeller::Degrees::degrees.

◆ SetColors()

void impeller::SweepGradientContents::SetColors ( std::vector< Color > colors )

Definition at line 32 of file sweep_gradient_contents.cc.

                                                              {
   colors_ = std::move(colors);
 }

◆ SetStops()

void impeller::SweepGradientContents::SetStops ( std::vector< Scalar > stops )

Definition at line 36 of file sweep_gradient_contents.cc.

                                                             {
   stops_ = std::move(stops);
 }

◆ SetTileMode()

void impeller::SweepGradientContents::SetTileMode ( Entity::TileMode tile_mode )

Definition at line 40 of file sweep_gradient_contents.cc.

                                                                 {
   tile_mode_ = tile_mode;
 }

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

impeller/entity/contents/sweep_gradient_contents.h
impeller/entity/contents/sweep_gradient_contents.cc

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SweepGradientContents()

◆ ~SweepGradientContents()

Member Function Documentation

◆ ApplyColorFilter()

◆ GetColors()

◆ GetStops()

◆ IsOpaque()

◆ Render()

◆ SetCenterAndAngles()

◆ SetColors()

◆ SetStops()

◆ SetTileMode()