Flutter Impeller
impeller::VerticesUVContents Class Referencefinal

#include <vertices_contents.h>

Inheritance diagram for impeller::VerticesUVContents:
impeller::Contents

Public Member Functions

 VerticesUVContents (const VerticesContents &parent)
 
 ~VerticesUVContents () override
 
std::optional< RectGetCoverage (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< SnapshotRenderToSnapshot (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< SizeGetColorSourceSize () 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< ColorAsBackgroundColor (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 FilterContentsAsFilter () 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< ContentsMakeAnonymous (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 91 of file vertices_contents.cc.

92  : parent_(parent) {}

◆ ~VerticesUVContents()

impeller::VerticesUVContents::~VerticesUVContents ( )
override

Definition at line 94 of file vertices_contents.cc.

94 {}

Member Function Documentation

◆ GetCoverage()

std::optional< Rect > impeller::VerticesUVContents::GetCoverage ( const Entity entity) const
overridevirtual

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 96 of file vertices_contents.cc.

97  {
98  return parent_.GetCoverage(entity);
99 }

References impeller::VerticesContents::GetCoverage().

◆ Render()

bool impeller::VerticesUVContents::Render ( const ContentContext renderer,
const Entity entity,
RenderPass pass 
) const
overridevirtual

Implements impeller::Contents.

Definition at line 105 of file vertices_contents.cc.

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

References impeller::RenderPass::Draw(), impeller::Entity::GetClipDepth(), impeller::ContentContext::GetContext(), impeller::Contents::GetCoverageHint(), impeller::VerticesContents::GetGeometry(), impeller::VerticesContents::GetSourceContents(), impeller::ContentContext::GetTexturePipeline(), impeller::ContentContext::GetTransientsBuffer(), impeller::OptionsFromPassAndEntity(), impeller::RenderPass::SetCommandLabel(), impeller::RenderPass::SetPipeline(), impeller::RenderPass::SetStencilReference(), and impeller::RenderPass::SetVertexBuffer().

◆ SetAlpha()

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

Definition at line 101 of file vertices_contents.cc.

101  {
102  alpha_ = alpha;
103 }

The documentation for this class was generated from the following files:
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::Contents::GetCoverageHint
const std::optional< Rect > & GetCoverageHint() const
Definition: contents.cc:164
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::GetSourceContents
const std::shared_ptr< Contents > & GetSourceContents() const
Definition: vertices_contents.cc:46
impeller::VerticesContents::GetGeometry
std::shared_ptr< VerticesGeometry > GetGeometry() const
Definition: vertices_contents.cc:34