impeller::SolidColorContents Class Reference

#include <solid_color_contents.h>

Inheritance diagram for impeller::SolidColorContents:

Public Member Functions
	SolidColorContents ()
	~SolidColorContents () override
void	SetColor (Color color)
Color	GetColor () const
bool	IsSolidColor () const 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...
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...
bool	Render (const ContentContext &renderer, const Entity &entity, RenderPass &pass) const override
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. More...
bool	ApplyColorFilter (const ColorFilterProc &color_filter_proc) override
	If possible, applies a color filter to this contents inputs on the CPU. More...
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...
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 ClipCoverage	GetClipCoverage (const Entity &entity, const std::optional< Rect > &current_clip_coverage) const
	Given the current pass space bounding rectangle of the clip buffer, return the expected clip coverage after this draw call. This should only be implemented for contents that may write to the clip buffer. More...
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, const std::string &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 const FilterContents *	AsFilter () const
	Cast to a filter. Returns nullptr if this Contents is not a filter. More...

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)
Protected Types inherited from impeller::ColorSourceContents
using	BindFragmentCallback = std::function< bool(RenderPass &pass)>
using	PipelineBuilderMethod = std::shared_ptr< Pipeline< PipelineDescriptor > >(impeller::ContentContext::*)(ContentContextOptions) const
using	PipelineBuilderCallback = std::function< std::shared_ptr< Pipeline< PipelineDescriptor > >(ContentContextOptions)>
using	CreateGeometryCallback = std::function< GeometryResult(const ContentContext &renderer, const Entity &entity, RenderPass &pass, const Geometry *geom)>
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 14 of file solid_color_contents.h.

Constructor & Destructor Documentation

SolidColorContents()

impeller::SolidColorContents::SolidColorContents ( )

default

~SolidColorContents()

impeller::SolidColorContents::~SolidColorContents ( )

overridedefault

Member Function Documentation

ApplyColorFilter()

bool impeller::SolidColorContents::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 82 of file solid_color_contents.cc.

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

AsBackgroundColor()

std::optional< Color > impeller::SolidColorContents::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 73 of file solid_color_contents.cc.

                             {
  Rect target_rect = Rect::MakeSize(target_size);
  return GetGeometry()->CoversArea(entity.GetTransform(), target_rect)
             ? GetColor()
             : std::optional<Color>();
}

References impeller::Geometry::CoversArea(), GetColor(), impeller::ColorSourceContents::GetGeometry(), impeller::Entity::GetTransform(), and impeller::TRect< Scalar >::MakeSize().

GetColor()

Color impeller::SolidColorContents::GetColor

(

)

const

Definition at line 23 of file solid_color_contents.cc.

                                         {
  return color_.WithAlpha(color_.alpha * GetOpacityFactor());
}

References impeller::Color::alpha, impeller::ColorSourceContents::GetOpacityFactor(), and impeller::Color::WithAlpha().

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

GetCoverage()

std::optional< Rect > impeller::SolidColorContents::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 35 of file solid_color_contents.cc.

                                {
  if (GetColor().IsTransparent()) {
    return std::nullopt;
  }
 
  const Geometry* geometry = GetGeometry();
  if (geometry == nullptr) {
    return std::nullopt;
  }
  return geometry->GetCoverage(entity.GetTransform());
};

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

IsOpaque()

bool impeller::SolidColorContents::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 31 of file solid_color_contents.cc.

                                                               {
  return GetColor().IsOpaque() && !AppliesAlphaForStrokeCoverage(transform);
}

References impeller::ColorSourceContents::AppliesAlphaForStrokeCoverage(), GetColor(), impeller::Color::IsOpaque(), and transform.

Referenced by impeller::testing::TEST_P().

IsSolidColor()

bool impeller::SolidColorContents::IsSolidColor ( ) const

overridevirtual

Reimplemented from impeller::ColorSourceContents.

Definition at line 27 of file solid_color_contents.cc.

                                            {
  return true;
}

Render()

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

overridevirtual

Implements impeller::Contents.

Definition at line 48 of file solid_color_contents.cc.

                                                        {
  using VS = SolidFillPipeline::VertexShader;
  using FS = SolidFillPipeline::FragmentShader;
  auto& host_buffer = renderer.GetTransientsBuffer();
 
  VS::FrameInfo frame_info;
  FS::FragInfo frag_info;
  frag_info.color = GetColor().Premultiply() *
                    GetGeometry()->ComputeAlphaCoverage(entity.GetTransform());
 
  PipelineBuilderCallback pipeline_callback =
      [&renderer](ContentContextOptions options) {
        return renderer.GetSolidFillPipeline(options);
      };
  return ColorSourceContents::DrawGeometry<VS>(
      renderer, entity, pass, pipeline_callback, frame_info,
      [&frag_info, &host_buffer](RenderPass& pass) {
        FS::BindFragInfo(pass, host_buffer.EmplaceUniform(frag_info));
        pass.SetCommandLabel("Solid Fill");
        return true;
      });
}

References impeller::Geometry::ComputeAlphaCoverage(), GetColor(), impeller::ColorSourceContents::GetGeometry(), impeller::ContentContext::GetSolidFillPipeline(), impeller::Entity::GetTransform(), impeller::ContentContext::GetTransientsBuffer(), impeller::Color::Premultiply(), and impeller::RenderPass::SetCommandLabel().

SetColor()

void impeller::SolidColorContents::SetColor

(

Color

color

)

Definition at line 19 of file solid_color_contents.cc.

                                             {
  color_ = color;
}

References color.

Referenced by impeller::testing::TEST_P().

---

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

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