| Flutter Impeller |

Public Member Functions | Static 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 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 (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 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, 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...
virtual bool | ShouldRender (const Entity &entity, const std::optional< Rect > clip_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 (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 25 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 106 of file solid_color_contents.cc.

107 {
108 color_ = color_filter_proc(color_);
109 return true;
110 }

## ◆ 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 97 of file solid_color_contents.cc.

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

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

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

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

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

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

Referenced by Render().

## ◆ IsOpaque()

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

Reimplemented from impeller::Contents.

Definition at line 31 of file solid_color_contents.cc.

31 {
32 return GetColor().IsOpaque();
33 }

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

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

## ◆ IsSolidColor()

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

Reimplemented from impeller::ColorSourceContents.

Definition at line 27 of file solid_color_contents.cc.

27 {
28 return true;
29 }

## ◆ Make()

std::unique_ptr< SolidColorContents > impeller::SolidColorContents::Make | ( | Path | path,
|  | Color | color
| ) |  |
| static

Definition at line 89 of file solid_color_contents.cc.

90 {
91 auto contents = std::make_unique<SolidColorContents>();
92 contents->SetGeometry(Geometry::MakeFillPath(std::move(path)));
93 contents->SetColor(color);
94 return contents;
95 }

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

Implements impeller::Contents.

Definition at line 48 of file solid_color_contents.cc.

50 {
51 auto capture = entity.GetCapture().CreateChild("SolidColorContents");
52
53 using VS = SolidFillPipeline::VertexShader;
54
55 Command cmd;
56 DEBUG_COMMAND_INFO(cmd, "Solid Fill");
57 cmd.stencil_reference = entity.GetClipDepth();
58
59 auto geometry_result =
60 GetGeometry()->GetPositionBuffer(renderer, entity, pass);
61
62 auto options = OptionsFromPassAndEntity(pass, entity);
63 if (geometry_result.prevent_overdraw) {
64 options.stencil_compare = CompareFunction::kEqual;
65 options.stencil_operation = StencilOperation::kIncrementClamp;
66 }
67
68 options.primitive_type = geometry_result.type;
69 cmd.pipeline = renderer.GetSolidFillPipeline(options);
70 cmd.BindVertices(std::move(geometry_result.vertex_buffer));
71
72 VS::FrameInfo frame_info;
73 frame_info.mvp = capture.AddMatrix("Transform", geometry_result.transform);
74 frame_info.color = capture.AddColor("Color", GetColor()).Premultiply();
75 VS::BindFrameInfo(cmd, pass.GetTransientsBuffer().EmplaceUniform(frame_info));
76
77 if (!pass.AddCommand(std::move(cmd))) {
78 return false;
79 }
80
81 if (geometry_result.prevent_overdraw) {
82 auto restore = ClipRestoreContents();
83 restore.SetRestoreCoverage(GetCoverage(entity));
84 return restore.Render(renderer, entity, pass);
85 }
86 return true;
87 }

References impeller::RenderPass::AddCommand(), impeller::Command::BindVertices(), impeller::Capture::CreateChild(), DEBUG_COMMAND_INFO, impeller::HostBuffer::EmplaceUniform(), impeller::Entity::GetCapture(), impeller::Entity::GetClipDepth(), GetColor(), GetCoverage(), impeller::ColorSourceContents::GetGeometry(), impeller::ContentContext::GetSolidFillPipeline(), 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.

19 {
20 color_ = color;
21 }

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

impeller::SolidColorContents::GetColor
Color GetColor() const
Definition: solid_color_contents.cc:23
impeller::ColorSourceContents::GetOpacityFactor
Scalar GetOpacityFactor() const
Get the opacity factor for this color source.
Definition: color_source_contents.cc:29
DEBUG_COMMAND_INFO
#define DEBUG_COMMAND_INFO(obj, arg)
Definition: command.h:28
impeller::CompareFunction::kEqual
@ kEqual
Comparison test passes if new_value == current_value.
impeller::StencilOperation::kIncrementClamp
@ kIncrementClamp
Increment the current stencil value by 1. Clamp it to the maximum.
impeller::SolidColorContents::GetCoverage
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.
Definition: solid_color_contents.cc:35
impeller::Color::alpha
Scalar alpha
Definition: color.h:143
impeller::ColorSourceContents::GetGeometry
const std::shared_ptr< Geometry > & GetGeometry() const
Get the geometry that this contents will use to render.
Definition: color_source_contents.cc:21
impeller::OptionsFromPassAndEntity
ContentContextOptions OptionsFromPassAndEntity(const RenderPass &pass, const Entity &entity)
Definition: contents.cc:28
impeller::Color::WithAlpha
constexpr Color WithAlpha(Scalar new_alpha) const
Definition: color.h:270
impeller::Rect
TRect< Scalar > Rect
Definition: rect.h:488
impeller::Geometry::MakeFillPath
static std::shared_ptr< Geometry > MakeFillPath(Path path, std::optional< Rect > inner_rect=std::nullopt)
Definition: geometry.cc:150
impeller::TRect< Scalar >::MakeSize
constexpr static TRect MakeSize(const TSize< U > &size)
Definition: rect.h:44
std
Definition: comparable.h:95
impeller::Color::IsOpaque
constexpr bool IsOpaque() const
Definition: color.h:886
impeller::RenderPipelineT::VertexShader
VertexShader_ VertexShader
Definition: pipeline.h:92