| Flutter Impeller |

Public Member Functions | List of all members
impeller::SolidColorContents Class Referencefinal

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

## 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 | PipelineBuilderCallback = std::function< PipelineRef(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 | ( |  | ) |
| override default

## Member Function Documentation

## ◆ ApplyColorFilter()

bool impeller::SolidColorContents::ApplyColorFilter | ( | const ColorFilterProc & | color_filter_proc | ) |
| override virtual

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 81 of file solid_color_contents.cc.

82 {
83 color_ = color_filter_proc(color_);
84 return true;
85 }

## ◆ AsBackgroundColor()

std::optional< Color > impeller::SolidColorContents::AsBackgroundColor | ( | const Entity & | entity,
|  | ISize | target_size
| ) |  | const
| override virtual

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 72 of file solid_color_contents.cc.

74 {
75 Rect target_rect = Rect::MakeSize(target_size);
76 return GetGeometry()->CoversArea(entity.GetTransform(), target_rect)
77 ? GetColor()
78 : std::optional<Color>();
79 }
impeller::ColorSourceContents::GetGeometry
const Geometry * GetGeometry() const
Get the geometry that this contents will use to render.
Definition: color_source_contents.cc:20
impeller::Geometry::CoversArea
virtual bool CoversArea(const Matrix &transform, const Rect &rect) const
Determines if this geometry, transformed by the given transform, will completely cover all surface ar...
Definition: geometry.cc:113
impeller::SolidColorContents::GetColor
Color GetColor() const
Definition: solid_color_contents.cc:22
impeller::Rect
TRect< Scalar > Rect
Definition: rect.h:792
std
Definition: comparable.h:95
impeller::TRect< Scalar >::MakeSize
constexpr static TRect MakeSize(const TSize< U > &size)
Definition: rect.h:150

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 22 of file solid_color_contents.cc.

22 {
23 return color_.WithAlpha(color_.alpha * GetOpacityFactor());
24 }
impeller::ColorSourceContents::GetOpacityFactor
Scalar GetOpacityFactor() const
Get the opacity factor for this color source.
Definition: color_source_contents.cc:28
impeller::Color::alpha
Scalar alpha
Definition: color.h:142
impeller::Color::WithAlpha
constexpr Color WithAlpha(Scalar new_alpha) const
Definition: color.h:277

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
| override virtual

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 34 of file solid_color_contents.cc.

35 {
36 if (GetColor().IsTransparent()) {
37 return std::nullopt;
38 }
39
40 const Geometry* geometry = GetGeometry();
41 if (geometry == nullptr) {
42 return std::nullopt;
43 }
44 return geometry->GetCoverage(entity.GetTransform());
45 };

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

## ◆ IsOpaque()

bool impeller::SolidColorContents::IsOpaque | ( | const Matrix & | transform | ) | const
| override virtual

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 30 of file solid_color_contents.cc.

30 {
31 return GetColor().IsOpaque() && !AppliesAlphaForStrokeCoverage(transform);
32 }
impeller::ColorSourceContents::AppliesAlphaForStrokeCoverage
bool AppliesAlphaForStrokeCoverage(const Matrix &transform) const
Whether the entity should be treated as non-opaque due to stroke geometry requiring alpha for coverag...
Definition: color_source_contents.cc:53
transform
Matrix transform
Definition: gaussian_blur_filter_contents.cc:214
impeller::Color::IsOpaque
constexpr bool IsOpaque() const
Definition: color.h:893

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

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

## ◆ IsSolidColor()

bool impeller::SolidColorContents::IsSolidColor | ( |  | ) | const
| override virtual

Reimplemented from impeller::ColorSourceContents.

Definition at line 26 of file solid_color_contents.cc.

26 {
27 return true;
28 }

## ◆ Render()

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

Implements impeller::Contents.

Definition at line 47 of file solid_color_contents.cc.

49 {
50 using VS = SolidFillPipeline::VertexShader;
51 using FS = SolidFillPipeline::FragmentShader;
52 auto& host_buffer = renderer.GetTransientsBuffer();
53
54 VS::FrameInfo frame_info;
55 FS::FragInfo frag_info;
56 frag_info.color = GetColor().Premultiply() *
57 GetGeometry()->ComputeAlphaCoverage(entity.GetTransform());
58
59 PipelineBuilderCallback pipeline_callback =
60 [&renderer](ContentContextOptions options) {
61 return renderer.GetSolidFillPipeline(options);
62 };
63 return ColorSourceContents::DrawGeometry<VS>(
64 renderer, entity, pass, pipeline_callback, frame_info,
65 [&frag_info, &host_buffer](RenderPass& pass) {
66 FS::BindFragInfo(pass, host_buffer.EmplaceUniform(frag_info));
67 pass.SetCommandLabel("Solid Fill");
68 return true;
69 });
70 }
impeller::ColorSourceContents::PipelineBuilderCallback
std::function< PipelineRef(ContentContextOptions)> PipelineBuilderCallback
Definition: color_source_contents.h:105
impeller::Geometry::ComputeAlphaCoverage
virtual Scalar ComputeAlphaCoverage(const Matrix &transform) const
Definition: geometry.h:115
impeller::RenderPipelineHandle::VertexShader
VertexShader_ VertexShader
Definition: pipeline.h:113
impeller::RenderPipelineHandle::FragmentShader
FragmentShader_ FragmentShader
Definition: pipeline.h:114
impeller::VS
GlyphAtlasPipeline::VertexShader VS
Definition: text_contents.cc:25
impeller::FS
GlyphAtlasPipeline::FragmentShader FS
Definition: text_contents.cc:26
impeller::Color::Premultiply
constexpr Color Premultiply() const
Definition: color.h:211

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 18 of file solid_color_contents.cc.

18 {
19 color_ = color;
20 }

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