| Flutter Impeller |

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

`#include <vertices_contents.h>`

Inheritance diagram for impeller::VerticesUVContents:

## Public Member Functions
| VerticesUVContents (const VerticesContents &parent)
| ~VerticesUVContents () 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, 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 86 of file vertices_contents.h.

## Constructor & Destructor Documentation

## ◆ VerticesUVContents()

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

Definition at line 89 of file vertices_contents.cc.

90 : parent_(parent) {}

## ◆ ~VerticesUVContents()

impeller::VerticesUVContents::~VerticesUVContents | ( |  | ) |
| override

Definition at line 92 of file vertices_contents.cc.

92 {}

## Member Function Documentation

## ◆ GetCoverage()

std::optional< Rect > impeller::VerticesUVContents::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 94 of file vertices_contents.cc.

95 {
96 return parent_.GetCoverage(entity);
97 }

References impeller::VerticesContents::GetCoverage().

## ◆ Render()

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

Implements impeller::Contents.

Definition at line 103 of file vertices_contents.cc.

105 {
106 using VS = TexturePipeline::VertexShader;
107 using FS = TexturePipeline::FragmentShader;
108
109 auto src_contents = parent_.GetSourceContents();
110
111 auto snapshot =
112 src_contents->RenderToSnapshot(renderer, // renderer
113 entity, // entity
114 GetCoverageHint(), // coverage_limit
115 std::nullopt, // sampler_descriptor
116 true, // msaa_enabled
117 "VerticesUVContents Snapshot"); // label
118 if (!snapshot.has_value()) {
119 return false;
120 }
121
122 Command cmd;
123 DEBUG_COMMAND_INFO(cmd, "VerticesUV");
124 auto& host_buffer = pass.GetTransientsBuffer();
125 auto geometry = parent_.GetGeometry();
126
127 auto coverage = src_contents->GetCoverage(Entity{});
128 if (!coverage.has_value()) {
129 return false;
130 }
131 auto geometry_result = geometry->GetPositionUVBuffer(
132 coverage.value(), Matrix(), renderer, entity, pass);
133 auto opts = OptionsFromPassAndEntity(pass, entity);
134 opts.primitive_type = geometry_result.type;
135 cmd.pipeline = renderer.GetTexturePipeline(opts);
136 cmd.stencil_reference = entity.GetClipDepth();
137 cmd.BindVertices(std::move(geometry_result.vertex_buffer));
138
139 VS::FrameInfo frame_info;
140 frame_info.mvp = geometry_result.transform;
141 frame_info.texture_sampler_y_coord_scale =
142 snapshot->texture->GetYCoordScale();
143 frame_info.alpha = alpha_ * snapshot->opacity;
144 VS::BindFrameInfo(cmd, host_buffer.EmplaceUniform(frame_info));
145
146 FS::BindTextureSampler(cmd, snapshot->texture,
147 renderer.GetContext()->GetSamplerLibrary()->GetSampler(
148 snapshot->sampler_descriptor));
149
150 return pass.AddCommand(std::move(cmd));
151 }

References impeller::RenderPass::AddCommand(), impeller::Command::BindVertices(), DEBUG_COMMAND_INFO, impeller::Entity::GetClipDepth(), impeller::ContentContext::GetContext(), impeller::Contents::GetCoverageHint(), impeller::VerticesContents::GetGeometry(), impeller::VerticesContents::GetSourceContents(), impeller::ContentContext::GetTexturePipeline(), impeller::RenderPass::GetTransientsBuffer(), impeller::OptionsFromPassAndEntity(), impeller::Command::pipeline, and impeller::Command::stencil_reference.

## ◆ SetAlpha()

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

Definition at line 99 of file vertices_contents.cc.

99 {
100 alpha_ = alpha;
101 }

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

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

DEBUG_COMMAND_INFO
#define DEBUG_COMMAND_INFO(obj, arg)
Definition: command.h:28
impeller::RenderPipelineT::FragmentShader
FragmentShader_ FragmentShader
Definition: pipeline.h:93
impeller::OptionsFromPassAndEntity
ContentContextOptions OptionsFromPassAndEntity(const RenderPass &pass, const Entity &entity)
Definition: contents.cc:28
impeller::Contents::GetCoverageHint
const std::optional< Rect > & GetCoverageHint() const
Definition: contents.cc:152
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:20
impeller::RenderPipelineT::VertexShader
VertexShader_ VertexShader
Definition: pipeline.h:92
impeller::VerticesContents::GetSourceContents
const std::shared_ptr< Contents > & GetSourceContents() const
Definition: vertices_contents.cc:44
impeller::VerticesContents::GetGeometry
std::shared_ptr< VerticesGeometry > GetGeometry() const
Definition: vertices_contents.cc:32