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 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 screen space bounding rectangle that this contents affects. 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 (std::shared_ptr< Geometry > geometry)
	Set the geometry that this contents will use to render. More...
const std::shared_ptr< 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...
bool	CanInheritOpacity (const Entity &entity) const override
	Whether or not this contents can accept the opacity peephole optimization. More...
void	SetInheritedOpacity (Scalar opacity) override
	Inherit the provided opacity. More...
Public Member Functions inherited from impeller::Contents
	Contents ()
virtual	~Contents ()
virtual void	PopulateGlyphAtlas (const std::shared_ptr< LazyGlyphAtlas > &lazy_glyph_atlas, Scalar scale)
	Add any text data to the specified lazy atlas. The scale parameter must be used again later when drawing the text. More...
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 StencilCoverage	GetStencilCoverage (const Entity &entity, const std::optional< Rect > &current_stencil_coverage) const
	Given the current screen space bounding rectangle of the stencil, return the expected stencil coverage after this draw call. This should only be implemented for contents that may write to the stencil 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, const std::string &label="Snapshot") const
	Render this contents to a snapshot, respecting the entity's transform, path, stencil depth, and blend mode. The result texture size is always the size of GetCoverage(entity). More...
virtual bool	ShouldRender (const Entity &entity, const std::optional< Rect > &stencil_coverage) const
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...

Static Public Member Functions
static std::unique_ptr< SolidColorContents >	Make (const Path &path, Color color)
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::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)>

Detailed Description

Definition at line 24 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 106 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 97 of file solid_color_contents.cc.

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

References GetColor(), impeller::ColorSourceContents::GetGeometry(), impeller::Entity::GetTransformation(), 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 screen space bounding rectangle that this contents affects.

Reimplemented from impeller::ColorSourceContents.

Definition at line 35 of file solid_color_contents.cc.

                                {
  if (GetColor().IsTransparent()) {
    return std::nullopt;
  }
 
  auto geometry = GetGeometry();
  if (geometry == nullptr) {
    return std::nullopt;
  }
  return geometry->GetCoverage(entity.GetTransformation());
};

References GetColor(), impeller::ColorSourceContents::GetGeometry(), and impeller::Entity::GetTransformation().

Referenced by Render().

IsOpaque()

bool impeller::SolidColorContents::IsOpaque ( ) 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.

Reimplemented from impeller::Contents.

Definition at line 31 of file solid_color_contents.cc.

                                        {
  return GetColor().IsOpaque();
}

References GetColor(), and impeller::Color::IsOpaque().

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;
}

Make()

std::unique_ptr< SolidColorContents > impeller::SolidColorContents::Make ( const Path &  path, Color  color  )

static

Definition at line 89 of file solid_color_contents.cc.

                                                                          {
  auto contents = std::make_unique<SolidColorContents>();
  contents->SetGeometry(Geometry::MakeFillPath(path));
  contents->SetColor(color);
  return contents;
}

References impeller::Geometry::MakeFillPath().

Referenced by impeller::testing::CreatePassWithRectPath(), and impeller::testing::TEST_P().

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.

                                                        {
  auto capture = entity.GetCapture().CreateChild("SolidColorContents");
 
  using VS = SolidFillPipeline::VertexShader;
 
  Command cmd;
  DEBUG_COMMAND_INFO(cmd, "Solid Fill");
  cmd.stencil_reference = entity.GetStencilDepth();
 
  auto geometry_result =
      GetGeometry()->GetPositionBuffer(renderer, entity, pass);
 
  auto options = OptionsFromPassAndEntity(pass, entity);
  if (geometry_result.prevent_overdraw) {
    options.stencil_compare = CompareFunction::kEqual;
    options.stencil_operation = StencilOperation::kIncrementClamp;
  }
 
  options.primitive_type = geometry_result.type;
  cmd.pipeline = renderer.GetSolidFillPipeline(options);
  cmd.BindVertices(geometry_result.vertex_buffer);
 
  VS::FrameInfo frame_info;
  frame_info.mvp = capture.AddMatrix("Transform", geometry_result.transform);
  frame_info.color = capture.AddColor("Color", GetColor()).Premultiply();
  VS::BindFrameInfo(cmd, pass.GetTransientsBuffer().EmplaceUniform(frame_info));
 
  if (!pass.AddCommand(std::move(cmd))) {
    return false;
  }
 
  if (geometry_result.prevent_overdraw) {
    auto restore = ClipRestoreContents();
    restore.SetRestoreCoverage(GetCoverage(entity));
    return restore.Render(renderer, entity, pass);
  }
  return true;
}

References impeller::RenderPass::AddCommand(), impeller::Command::BindVertices(), impeller::Capture::CreateChild(), DEBUG_COMMAND_INFO, impeller::HostBuffer::EmplaceUniform(), impeller::Entity::GetCapture(), GetColor(), GetCoverage(), impeller::ColorSourceContents::GetGeometry(), impeller::ContentContext::GetSolidFillPipeline(), impeller::Entity::GetStencilDepth(), impeller::RenderPass::GetTransientsBuffer(), impeller::kEqual, impeller::kIncrementClamp, impeller::OptionsFromPassAndEntity(), impeller::Command::pipeline, and impeller::Command::stencil_reference.

SetColor()

void impeller::SolidColorContents::SetColor

(

Color

color

)

Definition at line 19 of file solid_color_contents.cc.

                                             {
  color_ = 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