| Flutter Impeller |

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

`#include <vertices_contents.h>`

Inheritance diagram for impeller::VerticesColorContents:

## Public Member Functions
| VerticesColorContents (const VerticesContents &parent)
| ~VerticesColorContents () override
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
void | SetAlpha (Scalar alpha)
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 bool | IsOpaque () const
| 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...
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...
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 bool | CanInheritOpacity (const Entity &entity) const
| Whether or not this contents can accept the opacity peephole optimization. More...
virtual void | SetInheritedOpacity (Scalar opacity)
| Inherit the provided opacity. More...
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...
virtual const FilterContents * | AsFilter () const
| Cast to a filter. Returns `nullptr` if this Contents is not a filter. More...
virtual bool | ApplyColorFilter (const ColorFilterProc &color_filter_proc)
| If possible, applies a color filter to this contents inputs on the CPU. 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)

## Detailed Description

Definition at line 61 of file vertices_contents.h.

## Constructor & Destructor Documentation

## ◆ VerticesColorContents()

impeller::VerticesColorContents::VerticesColorContents | ( | const VerticesContents & | parent | ) |
| explicit

Definition at line 158 of file vertices_contents.cc.

159 : parent_(parent) {}

## ◆ ~VerticesColorContents()

impeller::VerticesColorContents::~VerticesColorContents | ( |  | ) |
| override

Definition at line 161 of file vertices_contents.cc.

161 {}

## Member Function Documentation

## ◆ GetCoverage()

std::optional< Rect > impeller::VerticesColorContents::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.

Implements impeller::Contents.

Definition at line 163 of file vertices_contents.cc.

164 {
165 return parent_.GetCoverage(entity);
166 }

References impeller::VerticesContents::GetCoverage().

## ◆ Render()

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

Implements impeller::Contents.

Definition at line 172 of file vertices_contents.cc.

174 {
175 using VS = GeometryColorPipeline::VertexShader;
176 using FS = GeometryColorPipeline::FragmentShader;
177
178 pass.SetCommandLabel("VerticesColors");
179 auto& host_buffer = renderer.GetTransientsBuffer();
180 const std::shared_ptr<VerticesGeometry>& geometry = parent_.GetGeometry();
181
182 auto geometry_result =
183 geometry->GetPositionColorBuffer(renderer, entity, pass);
184 auto opts = OptionsFromPassAndEntity(pass, entity);
185 opts.primitive_type = geometry_result.type;
186 pass.SetPipeline(renderer.GetGeometryColorPipeline(opts));
187 pass.SetStencilReference(entity.GetClipDepth());
188 pass.SetVertexBuffer(std::move(geometry_result.vertex_buffer));
189
190 VS::FrameInfo frame_info;
191 frame_info.mvp = geometry_result.transform;
192 VS::BindFrameInfo(pass, host_buffer.EmplaceUniform(frame_info));
193
194 FS::FragInfo frag_info;
195 frag_info.alpha = alpha_;
196 FS::BindFragInfo(pass, host_buffer.EmplaceUniform(frag_info));
197
198 return pass.Draw().ok();
199 }

References impeller::RenderPass::Draw(), impeller::Entity::GetClipDepth(), impeller::VerticesContents::GetGeometry(), impeller::ContentContext::GetGeometryColorPipeline(), impeller::ContentContext::GetTransientsBuffer(), impeller::OptionsFromPassAndEntity(), impeller::RenderPass::SetCommandLabel(), impeller::RenderPass::SetPipeline(), impeller::RenderPass::SetStencilReference(), and impeller::RenderPass::SetVertexBuffer().

## ◆ SetAlpha()

void impeller::VerticesColorContents::SetAlpha | ( | Scalar | alpha | ) |

Definition at line 168 of file vertices_contents.cc.

168 {
169 alpha_ = alpha;
170 }

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

- impeller/entity/contents/vertices_contents.h
- impeller/entity/contents/vertices_contents.cc

impeller::RenderPipelineT::FragmentShader
FragmentShader_ FragmentShader
Definition: pipeline.h:94
impeller::VS
SolidFillVertexShader VS
Definition: stroke_path_geometry.cc:15
impeller::OptionsFromPassAndEntity
ContentContextOptions OptionsFromPassAndEntity(const RenderPass &pass, const Entity &entity)
Definition: contents.cc:37
impeller::VerticesContents::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: vertices_contents.cc:22
impeller::RenderPipelineT::VertexShader
VertexShader_ VertexShader
Definition: pipeline.h:93
impeller::VerticesContents::GetGeometry
std::shared_ptr< VerticesGeometry > GetGeometry() const
Definition: vertices_contents.cc:34