Flutter Impeller
vertices_contents.cc
Go to the documentation of this file.
1 // Copyright 2013 The Flutter Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
4 
5 #include "vertices_contents.h"
6 
7 #include "fml/logging.h"
18 
19 namespace impeller {
20 
21 namespace {
22 static std::optional<SamplerAddressMode> TileModeToAddressMode(
23  Entity::TileMode tile_mode,
24  const Capabilities& capabilities) {
25  switch (tile_mode) {
28  break;
31  break;
34  break;
36  if (capabilities.SupportsDecalSamplerAddressMode()) {
38  }
39  return std::nullopt;
40  }
41 }
42 } // namespace
43 
44 //------------------------------------------------------
45 // VerticesSimpleBlendContents
46 
48 
50 
52  std::shared_ptr<VerticesGeometry> geometry) {
53  geometry_ = std::move(geometry);
54 }
55 
57  alpha_ = alpha;
58 }
59 
61  blend_mode_ = blend_mode;
62 }
63 
64 void VerticesSimpleBlendContents::SetTexture(std::shared_ptr<Texture> texture) {
65  texture_ = std::move(texture);
66 }
67 
69  const Entity& entity) const {
70  return geometry_->GetCoverage(entity.GetTransform());
71 }
72 
74  const SamplerDescriptor& descriptor) {
75  descriptor_ = descriptor;
76 }
77 
79  Entity::TileMode tile_mode_y) {
80  tile_mode_x_ = tile_mode_x;
81  tile_mode_y_ = tile_mode_y;
82 }
83 
85  inverse_matrix_ = transform.Invert();
86 }
87 
89  const LazyTexture& lazy_texture) {
90  lazy_texture_ = lazy_texture;
91 }
92 
94  lazy_texture_coverage_ = rect;
95 }
96 
98  const Entity& entity,
99  RenderPass& pass) const {
100  FML_DCHECK(texture_ || lazy_texture_ || blend_mode_ == BlendMode::kDst);
101  BlendMode blend_mode = blend_mode_;
102  if (!geometry_->HasVertexColors()) {
103  blend_mode = BlendMode::kSrc;
104  }
105 
106  std::shared_ptr<Texture> texture;
107  if (blend_mode != BlendMode::kDst) {
108  if (!texture_) {
109  texture = lazy_texture_(renderer);
110  } else {
111  texture = texture_;
112  }
113  } else {
114  texture = renderer.GetEmptyTexture();
115  }
116  if (!texture) {
117  VALIDATION_LOG << "Missing texture for VerticesSimpleBlendContents";
118  return false;
119  }
120 
121  auto dst_sampler_descriptor = descriptor_;
122  dst_sampler_descriptor.width_address_mode =
123  TileModeToAddressMode(tile_mode_x_, renderer.GetDeviceCapabilities())
125  dst_sampler_descriptor.height_address_mode =
126  TileModeToAddressMode(tile_mode_y_, renderer.GetDeviceCapabilities())
128 
129  raw_ptr<const Sampler> dst_sampler =
130  renderer.GetContext()->GetSamplerLibrary()->GetSampler(
131  dst_sampler_descriptor);
132 
133  GeometryResult geometry_result = geometry_->GetPositionUVColorBuffer(
134  lazy_texture_coverage_.has_value() ? lazy_texture_coverage_.value()
135  : Rect::MakeSize(texture->GetSize()),
136  inverse_matrix_, renderer, entity, pass);
137  if (geometry_result.vertex_buffer.vertex_count == 0) {
138  return true;
139  }
140  FML_DCHECK(geometry_result.mode == GeometryResult::Mode::kNormal);
141 
142  if (blend_mode <= Entity::kLastPipelineBlendMode) {
145 
146 #ifdef IMPELLER_DEBUG
147  pass.SetCommandLabel(SPrintF("DrawVertices Porterduff Blend (%s)",
148  BlendModeToString(blend_mode)));
149 #endif // IMPELLER_DEBUG
150  pass.SetVertexBuffer(std::move(geometry_result.vertex_buffer));
151 
152  auto options = OptionsFromPassAndEntity(pass, entity);
153  options.primitive_type = geometry_result.type;
154  auto inverted_blend_mode =
155  InvertPorterDuffBlend(blend_mode).value_or(BlendMode::kSrc);
156  pass.SetPipeline(
157  renderer.GetPorterDuffPipeline(inverted_blend_mode, options));
158 
159  FS::BindTextureSamplerDst(pass, texture, dst_sampler);
160 
161  VS::FrameInfo frame_info;
162  FS::FragInfo frag_info;
163 
164  frame_info.texture_sampler_y_coord_scale = texture->GetYCoordScale();
165  frame_info.mvp = geometry_result.transform;
166 
167  frag_info.input_alpha_output_alpha_tmx_tmy =
168  Vector4(1, alpha_, static_cast<int>(tile_mode_x_),
169  static_cast<int>(tile_mode_y_));
170  frag_info.use_strict_source_rect = 0.0;
171 
172  auto& host_buffer = renderer.GetTransientsBuffer();
173  FS::BindFragInfo(pass, host_buffer.EmplaceUniform(frag_info));
174  VS::BindFrameInfo(pass, host_buffer.EmplaceUniform(frame_info));
175 
176  return pass.Draw().ok();
177  }
178 
181 
182 #ifdef IMPELLER_DEBUG
183  pass.SetCommandLabel(SPrintF("DrawVertices Advanced Blend (%s)",
184  BlendModeToString(blend_mode)));
185 #endif // IMPELLER_DEBUG
186  pass.SetVertexBuffer(std::move(geometry_result.vertex_buffer));
187 
188  auto options = OptionsFromPassAndEntity(pass, entity);
189  options.primitive_type = geometry_result.type;
190  pass.SetPipeline(renderer.GetDrawVerticesUberPipeline(blend_mode, options));
191 
192  FS::BindTextureSampler(pass, texture, dst_sampler);
193 
194  VS::FrameInfo frame_info;
195  FS::FragInfo frag_info;
196 
197  frame_info.texture_sampler_y_coord_scale = texture->GetYCoordScale();
198  frame_info.mvp = geometry_result.transform;
199  frag_info.alpha = alpha_;
200  frag_info.blend_mode = static_cast<int>(blend_mode);
201 
202  // These values are ignored if the platform supports native decal mode.
203  frag_info.tmx = static_cast<int>(tile_mode_x_);
204  frag_info.tmy = static_cast<int>(tile_mode_y_);
205 
206  auto& host_buffer = renderer.GetTransientsBuffer();
207  FS::BindFragInfo(pass, host_buffer.EmplaceUniform(frag_info));
208  VS::BindFrameInfo(pass, host_buffer.EmplaceUniform(frame_info));
209 
210  return pass.Draw().ok();
211 }
212 
213 } // namespace impeller
HostBuffer & GetTransientsBuffer() const
Retrieve the currnent host buffer for transient storage.
PipelineRef GetPorterDuffPipeline(BlendMode mode, ContentContextOptions opts) const
std::shared_ptr< Texture > GetEmptyTexture() const
const Capabilities & GetDeviceCapabilities() const
std::shared_ptr< Context > GetContext() const
PipelineRef GetDrawVerticesUberPipeline(BlendMode blend_mode, ContentContextOptions opts) const
const Matrix & GetTransform() const
Get the global transform matrix for this Entity.
Definition: entity.cc:44
static constexpr BlendMode kLastPipelineBlendMode
Definition: entity.h:28
Render passes encode render commands directed as one specific render target into an underlying comman...
Definition: render_pass.h:30
virtual bool SetVertexBuffer(VertexBuffer buffer)
Specify the vertex and index buffer to use for this command.
Definition: render_pass.cc:127
virtual void SetPipeline(PipelineRef pipeline)
The pipeline to use for this command.
Definition: render_pass.cc:86
virtual fml::Status Draw()
Record the currently pending command.
Definition: render_pass.cc:208
virtual void SetCommandLabel(std::string_view label)
The debugging label to use for the command.
Definition: render_pass.cc:97
FragmentShader_ FragmentShader
Definition: pipeline.h:164
void SetSamplerDescriptor(const SamplerDescriptor &descriptor)
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.
void SetBlendMode(BlendMode blend_mode)
bool Render(const ContentContext &renderer, const Entity &entity, RenderPass &pass) const override
void SetTileMode(Entity::TileMode tile_mode_x, Entity::TileMode tile_mode_y)
void SetLazyTexture(const LazyTexture &lazy_texture)
std::function< std::shared_ptr< Texture >(const ContentContext &renderer)> LazyTexture
void SetTexture(std::shared_ptr< Texture > texture)
void SetGeometry(std::shared_ptr< VerticesGeometry > geometry)
A wrapper around a raw ptr that adds additional unopt mode only checks.
Definition: raw_ptr.h:15
float Scalar
Definition: scalar.h:19
@ kDecal
decal sampling mode is only supported on devices that pass the Capabilities.SupportsDecalSamplerAddre...
const char * BlendModeToString(BlendMode blend_mode)
Definition: color.cc:47
std::string SPrintF(const char *format,...)
Definition: strings.cc:12
LinePipeline::FragmentShader FS
static std::optional< SamplerAddressMode > TileModeToAddressMode(Entity::TileMode tile_mode, const Capabilities &capabilities)
std::optional< BlendMode > InvertPorterDuffBlend(BlendMode blend_mode)
BlendMode
Definition: color.h:58
LinePipeline::VertexShader VS
ContentContextOptions OptionsFromPassAndEntity(const RenderPass &pass, const Entity &entity)
Definition: contents.cc:34
PrimitiveType type
Definition: geometry.h:37
@ kNormal
The geometry has no overlapping triangles.
VertexBuffer vertex_buffer
Definition: geometry.h:38
A 4x4 matrix using column-major storage.
Definition: matrix.h:37
SamplerAddressMode width_address_mode
constexpr static TRect MakeSize(const TSize< U > &size)
Definition: rect.h:150
#define VALIDATION_LOG
Definition: validation.h:91