Flutter Impeller
canvas.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 
6 
7 #include <memory>
8 #include <optional>
9 #include <unordered_map>
10 #include <utility>
11 
12 #include "display_list/effects/color_filters/dl_blend_color_filter.h"
13 #include "display_list/effects/color_filters/dl_matrix_color_filter.h"
14 #include "display_list/effects/dl_color_filter.h"
15 #include "display_list/effects/dl_color_source.h"
16 #include "display_list/effects/dl_image_filter.h"
17 #include "display_list/image/dl_image.h"
18 #include "flutter/fml/logging.h"
19 #include "flutter/fml/trace_event.h"
21 #include "impeller/core/formats.h"
54 
55 namespace impeller {
56 
57 namespace {
58 
59 bool IsPipelineBlendOrMatrixFilter(const flutter::DlColorFilter* filter) {
60  return filter->type() == flutter::DlColorFilterType::kMatrix ||
61  (filter->type() == flutter::DlColorFilterType::kBlend &&
62  filter->asBlend()->mode() <= Entity::kLastPipelineBlendMode);
63 }
64 
65 static bool UseColorSourceContents(
66  const std::shared_ptr<VerticesGeometry>& vertices,
67  const Paint& paint) {
68  // If there are no vertex color or texture coordinates. Or if there
69  // are vertex coordinates but its just a color.
70  if (vertices->HasVertexColors()) {
71  return false;
72  }
73  if (vertices->HasTextureCoordinates() && !paint.color_source) {
74  return true;
75  }
76  return !vertices->HasTextureCoordinates();
77 }
78 
79 static void SetClipScissor(std::optional<Rect> clip_coverage,
80  RenderPass& pass,
81  Point global_pass_position) {
82  // Set the scissor to the clip coverage area. We do this prior to rendering
83  // the clip itself and all its contents.
84  IRect32 scissor;
85  if (clip_coverage.has_value()) {
86  clip_coverage = clip_coverage->Shift(-global_pass_position);
87  scissor = IRect32::RoundOut(clip_coverage.value());
88  // The scissor rect must not exceed the size of the render target.
89  scissor =
90  scissor.Intersection(IRect32::MakeSize(pass.GetRenderTargetSize()))
91  .value_or(IRect32());
92  }
93  pass.SetScissor(scissor);
94 }
95 
96 static void ApplyFramebufferBlend(Entity& entity) {
97  auto src_contents = entity.GetContents();
98  auto contents = std::make_shared<FramebufferBlendContents>();
99  contents->SetChildContents(src_contents);
100  contents->SetBlendMode(entity.GetBlendMode());
101  entity.SetContents(std::move(contents));
102  entity.SetBlendMode(BlendMode::kSrc);
103 }
104 
105 /// @brief Create the subpass restore contents, appling any filters or opacity
106 /// from the provided paint object.
107 static std::shared_ptr<Contents> CreateContentsForSubpassTarget(
108  const Paint& paint,
109  const std::shared_ptr<Texture>& target,
110  const Matrix& effect_transform) {
111  auto contents = TextureContents::MakeRect(Rect::MakeSize(target->GetSize()));
112  contents->SetTexture(target);
113  contents->SetLabel("Subpass");
114  contents->SetSourceRect(Rect::MakeSize(target->GetSize()));
115  contents->SetOpacity(paint.color.alpha);
116  contents->SetDeferApplyingOpacity(true);
117 
118  return paint.WithFiltersForSubpassTarget(std::move(contents),
119  effect_transform);
120 }
121 
122 static const constexpr RenderTarget::AttachmentConfig kDefaultStencilConfig =
123  RenderTarget::AttachmentConfig{
124  .storage_mode = StorageMode::kDeviceTransient,
125  .load_action = LoadAction::kDontCare,
126  .store_action = StoreAction::kDontCare,
127  };
128 
129 static std::unique_ptr<EntityPassTarget> CreateRenderTarget(
130  ContentContext& renderer,
131  ISize size,
132  const Color& clear_color) {
133  const std::shared_ptr<Context>& context = renderer.GetContext();
134 
135  /// All of the load/store actions are managed by `InlinePassContext` when
136  /// `RenderPasses` are created, so we just set them to `kDontCare` here.
137  /// What's important is the `StorageMode` of the textures, which cannot be
138  /// changed for the lifetime of the textures.
139 
140  RenderTarget target;
141  if (context->GetCapabilities()->SupportsOffscreenMSAA()) {
142  target = renderer.GetRenderTargetCache()->CreateOffscreenMSAA(
143  /*context=*/*context,
144  /*size=*/size,
145  /*mip_count=*/1,
146  /*label=*/"EntityPass",
147  /*color_attachment_config=*/
148  RenderTarget::AttachmentConfigMSAA{
149  .storage_mode = StorageMode::kDeviceTransient,
150  .resolve_storage_mode = StorageMode::kDevicePrivate,
151  .load_action = LoadAction::kDontCare,
152  .store_action = StoreAction::kMultisampleResolve,
153  .clear_color = clear_color},
154  /*stencil_attachment_config=*/kDefaultStencilConfig);
155  } else {
156  target = renderer.GetRenderTargetCache()->CreateOffscreen(
157  *context, // context
158  size, // size
159  /*mip_count=*/1,
160  "EntityPass", // label
161  RenderTarget::AttachmentConfig{
162  .storage_mode = StorageMode::kDevicePrivate,
163  .load_action = LoadAction::kDontCare,
164  .store_action = StoreAction::kDontCare,
165  .clear_color = clear_color,
166  }, // color_attachment_config
167  kDefaultStencilConfig //
168  );
169  }
170 
171  return std::make_unique<EntityPassTarget>(
172  target, //
173  renderer.GetDeviceCapabilities().SupportsReadFromResolve(), //
174  renderer.GetDeviceCapabilities().SupportsImplicitResolvingMSAA() //
175  );
176 }
177 
178 } // namespace
179 
180 std::shared_ptr<SolidRRectLikeBlurContents>
181 Canvas::RRectBlurShape::BuildBlurContent() {
182  return std::make_shared<SolidRRectBlurContents>();
183 }
184 
185 Geometry& Canvas::RRectBlurShape::BuildGeometry(Rect rect, Scalar radius) {
186  return geom_.emplace(rect, Size{radius, radius});
187 }
188 
189 std::shared_ptr<SolidRRectLikeBlurContents>
190 Canvas::RSuperellipseBlurShape::BuildBlurContent() {
191  return std::make_shared<SolidRSuperellipseBlurContents>();
192 }
193 
194 Geometry& Canvas::RSuperellipseBlurShape::BuildGeometry(Rect rect,
195  Scalar radius) {
196  return geom_.emplace(rect, radius);
197 }
198 
200  const RenderTarget& render_target,
201  bool is_onscreen,
202  bool requires_readback)
203  : renderer_(renderer),
204  render_target_(render_target),
205  is_onscreen_(is_onscreen),
206  requires_readback_(requires_readback),
207  clip_coverage_stack_(EntityPassClipStack(
208  Rect::MakeSize(render_target.GetRenderTargetSize()))) {
209  Initialize(std::nullopt);
210  SetupRenderPass();
211 }
212 
214  const RenderTarget& render_target,
215  bool is_onscreen,
216  bool requires_readback,
217  Rect cull_rect)
218  : renderer_(renderer),
219  render_target_(render_target),
220  is_onscreen_(is_onscreen),
221  requires_readback_(requires_readback),
222  clip_coverage_stack_(EntityPassClipStack(
223  Rect::MakeSize(render_target.GetRenderTargetSize()))) {
224  Initialize(cull_rect);
225  SetupRenderPass();
226 }
227 
229  const RenderTarget& render_target,
230  bool is_onscreen,
231  bool requires_readback,
232  IRect32 cull_rect)
233  : renderer_(renderer),
234  render_target_(render_target),
235  is_onscreen_(is_onscreen),
236  requires_readback_(requires_readback),
237  clip_coverage_stack_(EntityPassClipStack(
238  Rect::MakeSize(render_target.GetRenderTargetSize()))) {
239  Initialize(Rect::MakeLTRB(cull_rect.GetLeft(), cull_rect.GetTop(),
240  cull_rect.GetRight(), cull_rect.GetBottom()));
241  SetupRenderPass();
242 }
243 
244 void Canvas::Initialize(std::optional<Rect> cull_rect) {
245  initial_cull_rect_ = cull_rect;
246  transform_stack_.emplace_back(CanvasStackEntry{
248  });
249  FML_DCHECK(GetSaveCount() == 1u);
250 }
251 
252 void Canvas::Reset() {
253  current_depth_ = 0u;
254  transform_stack_ = {};
255 }
256 
258  transform_stack_.back().transform = GetCurrentTransform() * transform;
259 }
260 
262  transform_stack_.back().transform = transform * GetCurrentTransform();
263 }
264 
266  transform_stack_.back().transform = {};
267 }
268 
270  Concat(transform);
271 }
272 
274  return transform_stack_.back().transform;
275 }
276 
277 void Canvas::Translate(const Vector3& offset) {
279 }
280 
281 void Canvas::Scale(const Vector2& scale) {
282  Concat(Matrix::MakeScale(scale));
283 }
284 
285 void Canvas::Scale(const Vector3& scale) {
286  Concat(Matrix::MakeScale(scale));
287 }
288 
289 void Canvas::Skew(Scalar sx, Scalar sy) {
290  Concat(Matrix::MakeSkew(sx, sy));
291 }
292 
293 void Canvas::Rotate(Radians radians) {
294  Concat(Matrix::MakeRotationZ(radians));
295 }
296 
297 Point Canvas::GetGlobalPassPosition() const {
298  if (save_layer_state_.empty()) {
299  return Point(0, 0);
300  }
301  return save_layer_state_.back().coverage.GetOrigin();
302 }
303 
304 // clip depth of the previous save or 0.
305 size_t Canvas::GetClipHeightFloor() const {
306  if (transform_stack_.size() > 1) {
307  return transform_stack_[transform_stack_.size() - 2].clip_height;
308  }
309  return 0;
310 }
311 
312 size_t Canvas::GetSaveCount() const {
313  return transform_stack_.size();
314 }
315 
316 bool Canvas::IsSkipping() const {
317  return transform_stack_.back().skipping;
318 }
319 
320 void Canvas::RestoreToCount(size_t count) {
321  while (GetSaveCount() > count) {
322  if (!Restore()) {
323  return;
324  }
325  }
326 }
327 
328 void Canvas::DrawPath(const flutter::DlPath& path, const Paint& paint) {
329  Entity entity;
331  entity.SetBlendMode(paint.blend_mode);
332 
333  if (paint.style == Paint::Style::kFill) {
334  FillPathGeometry geom(path);
335  AddRenderEntityWithFiltersToCurrentPass(entity, &geom, paint);
336  } else {
337  StrokePathGeometry geom(path, paint.stroke);
338  AddRenderEntityWithFiltersToCurrentPass(entity, &geom, paint);
339  }
340 }
341 
342 void Canvas::DrawPaint(const Paint& paint) {
343  Entity entity;
345  entity.SetBlendMode(paint.blend_mode);
346 
347  CoverGeometry geom;
348  AddRenderEntityWithFiltersToCurrentPass(entity, &geom, paint);
349 }
350 
351 // Optimization: if the texture has a color filter that is a simple
352 // porter-duff blend or matrix filter, then instead of performing a save layer
353 // we should swap out the shader for the porter duff blend shader and avoid a
354 // saveLayer. This optimization is important for Flame.
355 bool Canvas::AttemptColorFilterOptimization(
356  const std::shared_ptr<Texture>& image,
357  Rect source,
358  Rect dest,
359  const Paint& paint,
360  const SamplerDescriptor& sampler,
361  SourceRectConstraint src_rect_constraint) {
362  if (!paint.color_filter || //
363  paint.image_filter != nullptr || //
364  paint.invert_colors || //
365  paint.mask_blur_descriptor.has_value() || //
366  !IsPipelineBlendOrMatrixFilter(paint.color_filter)) {
367  return false;
368  }
369 
370  if (paint.color_filter->type() == flutter::DlColorFilterType::kBlend) {
371  const flutter::DlBlendColorFilter* blend_filter =
372  paint.color_filter->asBlend();
373  DrawImageRectAtlasGeometry geometry = DrawImageRectAtlasGeometry(
374  /*texture=*/image,
375  /*source=*/source,
376  /*destination=*/dest,
377  /*color=*/skia_conversions::ToColor(blend_filter->color()),
378  /*blend_mode=*/blend_filter->mode(),
379  /*desc=*/sampler,
380  /*use_strict_src_rect=*/src_rect_constraint ==
382 
383  auto atlas_contents = std::make_shared<AtlasContents>();
384  atlas_contents->SetGeometry(&geometry);
385  atlas_contents->SetAlpha(paint.color.alpha);
386 
387  Entity entity;
388  entity.SetTransform(GetCurrentTransform());
389  entity.SetBlendMode(paint.blend_mode);
390  entity.SetContents(atlas_contents);
391 
392  AddRenderEntityToCurrentPass(entity);
393  } else {
394  // src_rect_constraint is only supported in the porter-duff mode
395  // for now.
396  if (src_rect_constraint == SourceRectConstraint::kStrict) {
397  return false;
398  }
399 
400  const flutter::DlMatrixColorFilter* matrix_filter =
401  paint.color_filter->asMatrix();
402 
403  DrawImageRectAtlasGeometry geometry = DrawImageRectAtlasGeometry(
404  /*texture=*/image,
405  /*source=*/source,
406  /*destination=*/dest,
407  /*color=*/Color::Khaki(), // ignored
408  /*blend_mode=*/BlendMode::kSrcOver, // ignored
409  /*desc=*/sampler,
410  /*use_strict_src_rect=*/src_rect_constraint ==
412 
413  auto atlas_contents = std::make_shared<ColorFilterAtlasContents>();
414  atlas_contents->SetGeometry(&geometry);
415  atlas_contents->SetAlpha(paint.color.alpha);
416  impeller::ColorMatrix color_matrix;
417  matrix_filter->get_matrix(color_matrix.array);
418  atlas_contents->SetMatrix(color_matrix);
419 
420  Entity entity;
421  entity.SetTransform(GetCurrentTransform());
422  entity.SetBlendMode(paint.blend_mode);
423  entity.SetContents(atlas_contents);
424 
425  AddRenderEntityToCurrentPass(entity);
426  }
427  return true;
428 }
429 
430 bool Canvas::AttemptDrawAntialiasedCircle(const Point& center,
431  Scalar radius,
432  const Paint& paint) {
433  if (paint.HasColorFilter() || paint.image_filter || paint.invert_colors ||
434  paint.color_source || paint.mask_blur_descriptor.has_value()) {
435  return false;
436  }
437 
438  Entity entity;
439  entity.SetTransform(GetCurrentTransform());
440  entity.SetBlendMode(paint.blend_mode);
441 
442  const bool is_stroked = paint.style == Paint::Style::kStroke;
443  std::unique_ptr<CircleGeometry> geom;
444  if (is_stroked) {
445  geom = std::make_unique<CircleGeometry>(center, radius, paint.stroke.width);
446  } else {
447  geom = std::make_unique<CircleGeometry>(center, radius);
448  }
449 
450  auto contents =
451  CircleContents::Make(std::move(geom), paint.color, is_stroked);
452 
453  entity.SetContents(std::move(contents));
454  AddRenderEntityToCurrentPass(entity);
455 
456  return true;
457 }
458 
459 bool Canvas::AttemptDrawBlurredRRect(const Rect& rect,
460  Size corner_radii,
461  const Paint& paint) {
462  RRectBlurShape rrect_shape;
463  return AttemptDrawBlurredRRectLike(rect, corner_radii, paint, rrect_shape);
464 }
465 
466 bool Canvas::AttemptDrawBlurredRSuperellipse(const Rect& rect,
467  Size corner_radii,
468  const Paint& paint) {
469  RSuperellipseBlurShape rsuperellipse_shape;
470  return AttemptDrawBlurredRRectLike(rect, corner_radii, paint,
471  rsuperellipse_shape);
472 }
473 
474 bool Canvas::AttemptDrawBlurredRRectLike(const Rect& rect,
475  Size corner_radii,
476  const Paint& paint,
477  RRectLikeBlurShape& shape) {
478  if (paint.style != Paint::Style::kFill) {
479  return false;
480  }
481 
482  if (paint.color_source) {
483  return false;
484  }
485 
486  if (!paint.mask_blur_descriptor.has_value()) {
487  return false;
488  }
489 
490  // A blur sigma that is not positive enough should not result in a blur.
491  if (paint.mask_blur_descriptor->sigma.sigma <= kEhCloseEnough) {
492  return false;
493  }
494 
495  // The current rrect blur math doesn't work on ovals.
496  if (fabsf(corner_radii.width - corner_radii.height) > kEhCloseEnough) {
497  return false;
498  }
499  Scalar corner_radius = corner_radii.width;
500 
501  // For symmetrically mask blurred solid RRects, absorb the mask blur and use
502  // a faster SDF approximation.
503  Color rrect_color = paint.color;
504  if (paint.invert_colors) {
505  rrect_color = rrect_color.ApplyColorMatrix(kColorInversion);
506  }
507  if (paint.color_filter) {
508  rrect_color = GetCPUColorFilterProc(paint.color_filter)(rrect_color);
509  }
510 
511  Paint rrect_paint = {.mask_blur_descriptor = paint.mask_blur_descriptor};
512 
513  // In some cases, we need to render the mask blur to a separate layer.
514  //
515  // 1. If the blur style is normal, we'll be drawing using one draw call and
516  // no clips. And so we can just wrap the RRect contents with the
517  // ImageFilter, which will get applied to the result as per usual.
518  //
519  // 2. If the blur style is solid, we combine the non-blurred RRect with the
520  // blurred RRect via two separate draw calls, and so we need to defer any
521  // fancy blending, translucency, or image filtering until after these two
522  // draws have been combined in a separate layer.
523  //
524  // 3. If the blur style is outer or inner, we apply the blur style via a
525  // clip. The ImageFilter needs to be applied to the mask blurred result.
526  // And so if there's an ImageFilter, we need to defer applying it until
527  // after the clipped RRect blur has been drawn to a separate texture.
528  // However, since there's only one draw call that produces color, we
529  // don't need to worry about the blend mode or translucency (unlike with
530  // BlurStyle::kSolid).
531  //
532  if ((paint.mask_blur_descriptor->style !=
534  paint.image_filter) ||
535  (paint.mask_blur_descriptor->style == FilterContents::BlurStyle::kSolid &&
536  (!rrect_color.IsOpaque() || paint.blend_mode != BlendMode::kSrcOver))) {
537  Rect render_bounds = rect;
538  if (paint.mask_blur_descriptor->style !=
540  render_bounds =
541  render_bounds.Expand(paint.mask_blur_descriptor->sigma.sigma * 4.0);
542  }
543  // Defer the alpha, blend mode, and image filter to a separate layer.
544  SaveLayer(
545  Paint{
546  .color = Color::White().WithAlpha(rrect_color.alpha),
547  .image_filter = paint.image_filter,
548  .blend_mode = paint.blend_mode,
549  },
550  render_bounds, nullptr, ContentBoundsPromise::kContainsContents, 1u);
551  rrect_paint.color = rrect_color.WithAlpha(1);
552  } else {
553  rrect_paint.color = rrect_color;
554  rrect_paint.blend_mode = paint.blend_mode;
555  rrect_paint.image_filter = paint.image_filter;
556  Save(1u);
557  }
558 
559  auto draw_blurred_rrect = [this, &rect, corner_radius, &rrect_paint,
560  &shape]() {
561  auto contents = shape.BuildBlurContent();
562 
563  contents->SetColor(rrect_paint.color);
564  contents->SetSigma(rrect_paint.mask_blur_descriptor->sigma);
565  contents->SetShape(rect, corner_radius);
566 
567  Entity blurred_rrect_entity;
568  blurred_rrect_entity.SetTransform(GetCurrentTransform());
569  blurred_rrect_entity.SetBlendMode(rrect_paint.blend_mode);
570 
571  rrect_paint.mask_blur_descriptor = std::nullopt;
572  blurred_rrect_entity.SetContents(
573  rrect_paint.WithFilters(std::move(contents)));
574  AddRenderEntityToCurrentPass(blurred_rrect_entity);
575  };
576 
577  switch (rrect_paint.mask_blur_descriptor->style) {
579  draw_blurred_rrect();
580  break;
581  }
583  // First, draw the blurred RRect.
584  draw_blurred_rrect();
585  // Then, draw the non-blurred RRect on top.
586  Entity entity;
587  entity.SetTransform(GetCurrentTransform());
588  entity.SetBlendMode(rrect_paint.blend_mode);
589 
590  Geometry& geom = shape.BuildGeometry(rect, corner_radius);
591  AddRenderEntityWithFiltersToCurrentPass(entity, &geom, rrect_paint,
592  /*reuse_depth=*/true);
593  break;
594  }
596  Geometry& geom = shape.BuildGeometry(rect, corner_radius);
598  draw_blurred_rrect();
599  break;
600  }
602  Geometry& geom = shape.BuildGeometry(rect, corner_radius);
604  draw_blurred_rrect();
605  break;
606  }
607  }
608 
609  Restore();
610 
611  return true;
612 }
613 
614 void Canvas::DrawLine(const Point& p0,
615  const Point& p1,
616  const Paint& paint,
617  bool reuse_depth) {
618  Entity entity;
620  entity.SetBlendMode(paint.blend_mode);
621 
622  auto geometry = std::make_unique<LineGeometry>(p0, p1, paint.stroke);
623 
624  if (renderer_.GetContext()->GetFlags().antialiased_lines &&
625  !paint.color_filter && !paint.invert_colors && !paint.image_filter &&
626  !paint.mask_blur_descriptor.has_value() && !paint.color_source) {
627  auto contents = LineContents::Make(std::move(geometry), paint.color);
628  entity.SetContents(std::move(contents));
629  AddRenderEntityToCurrentPass(entity, reuse_depth);
630  } else {
631  AddRenderEntityWithFiltersToCurrentPass(entity, geometry.get(), paint,
632  /*reuse_depth=*/reuse_depth);
633  }
634 }
635 
637  const Point& p1,
638  Scalar on_length,
639  Scalar off_length,
640  const Paint& paint) {
641  // Reasons to defer to regular DrawLine:
642  // - performance for degenerate and "regular line" cases
643  // - length is non-positive - DrawLine will draw appropriate "dot"
644  // - off_length is non-positive - no gaps, DrawLine will draw it solid
645  // - on_length is negative - invalid dashing
646  //
647  // Note that a 0 length "on" dash will draw "dot"s every "off" distance
648  // apart so we proceed with the dashing process in that case.
649  Scalar length = p0.GetDistance(p1);
650  if (length > 0.0f && on_length >= 0.0f && off_length > 0.0f) {
651  Entity entity;
653  entity.SetBlendMode(paint.blend_mode);
654 
655  StrokeDashedLineGeometry geom(p0, p1, on_length, off_length, paint.stroke);
656  AddRenderEntityWithFiltersToCurrentPass(entity, &geom, paint);
657  } else {
658  DrawLine(p0, p1, paint);
659  }
660 }
661 
662 void Canvas::DrawRect(const Rect& rect, const Paint& paint) {
663  if (AttemptDrawBlurredRRect(rect, {}, paint)) {
664  return;
665  }
666 
667  Entity entity;
669  entity.SetBlendMode(paint.blend_mode);
670 
671  if (paint.style == Paint::Style::kStroke) {
672  StrokeRectGeometry geom(rect, paint.stroke);
673  AddRenderEntityWithFiltersToCurrentPass(entity, &geom, paint);
674  } else {
675  FillRectGeometry geom(rect);
676  AddRenderEntityWithFiltersToCurrentPass(entity, &geom, paint);
677  }
678 }
679 
680 void Canvas::DrawOval(const Rect& rect, const Paint& paint) {
681  // TODO(jonahwilliams): This additional condition avoids an assert in the
682  // stroke circle geometry generator. I need to verify the condition that this
683  // assert prevents.
684  if (rect.IsSquare() && (paint.style == Paint::Style::kFill ||
685  (paint.style == Paint::Style::kStroke &&
686  paint.stroke.width < rect.GetWidth()))) {
687  // Circles have slightly less overhead and can do stroking
688  DrawCircle(rect.GetCenter(), rect.GetWidth() * 0.5f, paint);
689  return;
690  }
691 
692  if (AttemptDrawBlurredRRect(rect, rect.GetSize() * 0.5f, paint)) {
693  return;
694  }
695 
696  Entity entity;
698  entity.SetBlendMode(paint.blend_mode);
699 
700  if (paint.style == Paint::Style::kStroke) {
701  StrokeEllipseGeometry geom(rect, paint.stroke);
702  AddRenderEntityWithFiltersToCurrentPass(entity, &geom, paint);
703  } else {
704  EllipseGeometry geom(rect);
705  AddRenderEntityWithFiltersToCurrentPass(entity, &geom, paint);
706  }
707 }
708 
709 void Canvas::DrawArc(const Arc& arc, const Paint& paint) {
710  Entity entity;
712  entity.SetBlendMode(paint.blend_mode);
713 
714  if (paint.style == Paint::Style::kFill) {
715  ArcGeometry geom(arc);
716  AddRenderEntityWithFiltersToCurrentPass(entity, &geom, paint);
717  return;
718  }
719 
720  const Rect& oval_bounds = arc.GetOvalBounds();
721  if (paint.stroke.width > oval_bounds.GetSize().MaxDimension()) {
722  // This is a special case for rendering arcs whose stroke width is so large
723  // you are effectively drawing a sector of a circle.
724  // https://github.com/flutter/flutter/issues/158567
725  Arc expanded_arc(oval_bounds.Expand(Size(paint.stroke.width * 0.5f)),
726  arc.GetStart(), arc.GetSweep(), true);
727 
728  ArcGeometry geom(expanded_arc);
729  AddRenderEntityWithFiltersToCurrentPass(entity, &geom, paint);
730  return;
731  }
732 
733  // IncludeCenter incurs lots of extra work for stroking an arc, including:
734  // - It introduces segments to/from the center point (not too hard).
735  // - It introduces joins on those segments (a bit more complicated).
736  // - Even if the sweep is >=360 degrees, we still draw the segment to
737  // the center and it basically looks like a pie cut into the complete
738  // boundary circle, as if the slice were cut, but not extracted
739  // (hard to express as a continuous kTriangleStrip).
740  if (!arc.IncludeCenter()) {
741  if (arc.IsFullCircle()) {
742  return DrawOval(oval_bounds, paint);
743  }
744 
745  // Our fast stroking code only works for circular bounds as it assumes
746  // that the inner and outer radii can be scaled along each angular step
747  // of the arc - which is not true for elliptical arcs where the inner
748  // and outer samples are perpendicular to the traveling direction of the
749  // elliptical curve which may not line up with the center of the bounds.
750  if (oval_bounds.IsSquare()) {
751  ArcGeometry geom(arc, paint.stroke);
752  AddRenderEntityWithFiltersToCurrentPass(entity, &geom, paint);
753  return;
754  }
755  }
756 
757  ArcStrokeGeometry geom(arc, paint.stroke);
758  AddRenderEntityWithFiltersToCurrentPass(entity, &geom, paint);
759 }
760 
761 void Canvas::DrawRoundRect(const RoundRect& round_rect, const Paint& paint) {
762  auto& rect = round_rect.GetBounds();
763  auto& radii = round_rect.GetRadii();
764  if (radii.AreAllCornersSame()) {
765  if (AttemptDrawBlurredRRect(rect, radii.top_left, paint)) {
766  return;
767  }
768 
769  if (paint.style == Paint::Style::kFill) {
770  Entity entity;
772  entity.SetBlendMode(paint.blend_mode);
773 
774  RoundRectGeometry geom(rect, radii.top_left);
775  AddRenderEntityWithFiltersToCurrentPass(entity, &geom, paint);
776  return;
777  }
778  }
779 
780  Entity entity;
782  entity.SetBlendMode(paint.blend_mode);
783 
784  if (paint.style == Paint::Style::kFill) {
785  FillRoundRectGeometry geom(round_rect);
786  AddRenderEntityWithFiltersToCurrentPass(entity, &geom, paint);
787  } else {
788  StrokeRoundRectGeometry geom(round_rect, paint.stroke);
789  AddRenderEntityWithFiltersToCurrentPass(entity, &geom, paint);
790  }
791 }
792 
794  const RoundRect& inner,
795  const Paint& paint) {
796  Entity entity;
798  entity.SetBlendMode(paint.blend_mode);
799 
800  if (paint.style == Paint::Style::kFill) {
801  FillDiffRoundRectGeometry geom(outer, inner);
802  AddRenderEntityWithFiltersToCurrentPass(entity, &geom, paint);
803  } else {
804  StrokeDiffRoundRectGeometry geom(outer, inner, paint.stroke);
805  AddRenderEntityWithFiltersToCurrentPass(entity, &geom, paint);
806  }
807 }
808 
809 void Canvas::DrawRoundSuperellipse(const RoundSuperellipse& round_superellipse,
810  const Paint& paint) {
811  auto& rect = round_superellipse.GetBounds();
812  auto& radii = round_superellipse.GetRadii();
813  if (radii.AreAllCornersSame() &&
814  AttemptDrawBlurredRSuperellipse(rect, radii.top_left, paint)) {
815  return;
816  }
817 
818  Entity entity;
820  entity.SetBlendMode(paint.blend_mode);
821 
822  if (paint.style == Paint::Style::kFill) {
823  RoundSuperellipseGeometry geom(rect, radii);
824  AddRenderEntityWithFiltersToCurrentPass(entity, &geom, paint);
825  } else {
826  StrokeRoundSuperellipseGeometry geom(round_superellipse, paint.stroke);
827  AddRenderEntityWithFiltersToCurrentPass(entity, &geom, paint);
828  }
829 }
830 
831 void Canvas::DrawCircle(const Point& center,
832  Scalar radius,
833  const Paint& paint) {
834  Size half_size(radius, radius);
835  if (AttemptDrawBlurredRRect(
836  Rect::MakeOriginSize(center - half_size, half_size * 2),
837  {radius, radius}, paint)) {
838  return;
839  }
840 
841  if (AttemptDrawAntialiasedCircle(center, radius, paint)) {
842  return;
843  }
844 
845  Entity entity;
847  entity.SetBlendMode(paint.blend_mode);
848 
849  if (paint.style == Paint::Style::kStroke) {
850  CircleGeometry geom(center, radius, paint.stroke.width);
851  AddRenderEntityWithFiltersToCurrentPass(entity, &geom, paint);
852  } else {
853  CircleGeometry geom(center, radius);
854  AddRenderEntityWithFiltersToCurrentPass(entity, &geom, paint);
855  }
856 }
857 
858 void Canvas::ClipGeometry(const Geometry& geometry,
859  Entity::ClipOperation clip_op,
860  bool is_aa) {
861  if (IsSkipping()) {
862  return;
863  }
864 
865  // Ideally the clip depth would be greater than the current rendering
866  // depth because any rendering calls that follow this clip operation will
867  // pre-increment the depth and then be rendering above our clip depth,
868  // but that case will be caught by the CHECK in AddRenderEntity above.
869  // In practice we sometimes have a clip set with no rendering after it
870  // and in such cases the current depth will equal the clip depth.
871  // Eventually the DisplayList should optimize these out, but it is hard
872  // to know if a clip will actually be used in advance of storing it in
873  // the DisplayList buffer.
874  // See https://github.com/flutter/flutter/issues/147021
875  FML_DCHECK(current_depth_ <= transform_stack_.back().clip_depth)
876  << current_depth_ << " <=? " << transform_stack_.back().clip_depth;
877  uint32_t clip_depth = transform_stack_.back().clip_depth;
878 
879  const Matrix clip_transform =
880  Matrix::MakeTranslation(Vector3(-GetGlobalPassPosition())) *
882 
883  std::optional<Rect> clip_coverage = geometry.GetCoverage(clip_transform);
884  if (!clip_coverage.has_value()) {
885  return;
886  }
887 
888  ClipContents clip_contents(
889  clip_coverage.value(),
890  /*is_axis_aligned_rect=*/geometry.IsAxisAlignedRect() &&
891  GetCurrentTransform().IsTranslationScaleOnly());
892  clip_contents.SetClipOperation(clip_op);
893 
894  EntityPassClipStack::ClipStateResult clip_state_result =
895  clip_coverage_stack_.RecordClip(
896  clip_contents, //
897  /*transform=*/clip_transform, //
898  /*global_pass_position=*/GetGlobalPassPosition(), //
899  /*clip_depth=*/clip_depth, //
900  /*clip_height_floor=*/GetClipHeightFloor(), //
901  /*is_aa=*/is_aa);
902 
903  if (clip_state_result.clip_did_change) {
904  // We only need to update the pass scissor if the clip state has changed.
905  SetClipScissor(
906  clip_coverage_stack_.CurrentClipCoverage(),
907  *render_passes_.back().GetInlinePassContext()->GetRenderPass(),
908  GetGlobalPassPosition());
909  }
910 
911  ++transform_stack_.back().clip_height;
912  ++transform_stack_.back().num_clips;
913 
914  if (!clip_state_result.should_render) {
915  return;
916  }
917 
918  // Note: this is a bit of a hack. Its not possible to construct a geometry
919  // result without begninning the render pass. We should refactor the geometry
920  // objects so that they only need a reference to the render pass size and/or
921  // orthographic transform.
922  Entity entity;
923  entity.SetTransform(clip_transform);
924  entity.SetClipDepth(clip_depth);
925 
926  GeometryResult geometry_result = geometry.GetPositionBuffer(
927  renderer_, //
928  entity, //
929  *render_passes_.back().GetInlinePassContext()->GetRenderPass() //
930  );
931  clip_contents.SetGeometry(geometry_result);
932  clip_coverage_stack_.GetLastReplayResult().clip_contents.SetGeometry(
933  geometry_result);
934 
935  clip_contents.Render(
936  renderer_, *render_passes_.back().GetInlinePassContext()->GetRenderPass(),
937  clip_depth);
938 }
939 
941  uint32_t count,
942  Scalar radius,
943  const Paint& paint,
944  PointStyle point_style) {
945  if (radius <= 0) {
946  return;
947  }
948 
949  Entity entity;
951  entity.SetBlendMode(paint.blend_mode);
952 
953  PointFieldGeometry geom(points, count, radius,
954  /*round=*/point_style == PointStyle::kRound);
955  AddRenderEntityWithFiltersToCurrentPass(entity, &geom, paint);
956 }
957 
958 void Canvas::DrawImage(const std::shared_ptr<Texture>& image,
959  Point offset,
960  const Paint& paint,
961  const SamplerDescriptor& sampler) {
962  if (!image) {
963  return;
964  }
965 
966  const Rect source = Rect::MakeSize(image->GetSize());
967  const Rect dest = source.Shift(offset);
968 
969  DrawImageRect(image, source, dest, paint, sampler);
970 }
971 
972 void Canvas::DrawImageRect(const std::shared_ptr<Texture>& image,
973  Rect source,
974  Rect dest,
975  const Paint& paint,
976  const SamplerDescriptor& sampler,
977  SourceRectConstraint src_rect_constraint) {
978  if (!image || source.IsEmpty() || dest.IsEmpty()) {
979  return;
980  }
981 
982  ISize size = image->GetSize();
983  if (size.IsEmpty()) {
984  return;
985  }
986 
987  std::optional<Rect> clipped_source =
988  source.Intersection(Rect::MakeSize(size));
989  if (!clipped_source) {
990  return;
991  }
992 
993  if (AttemptColorFilterOptimization(image, source, dest, paint, sampler,
994  src_rect_constraint)) {
995  return;
996  }
997 
998  if (*clipped_source != source) {
999  Scalar sx = dest.GetWidth() / source.GetWidth();
1000  Scalar sy = dest.GetHeight() / source.GetHeight();
1001  Scalar tx = dest.GetLeft() - source.GetLeft() * sx;
1002  Scalar ty = dest.GetTop() - source.GetTop() * sy;
1003  Matrix src_to_dest = Matrix::MakeTranslateScale({sx, sy, 1}, {tx, ty, 0});
1004  dest = clipped_source->TransformBounds(src_to_dest);
1005  }
1006 
1007  auto texture_contents = TextureContents::MakeRect(dest);
1008  texture_contents->SetTexture(image);
1009  texture_contents->SetSourceRect(*clipped_source);
1010  texture_contents->SetStrictSourceRect(src_rect_constraint ==
1012  texture_contents->SetSamplerDescriptor(sampler);
1013  texture_contents->SetOpacity(paint.color.alpha);
1014  texture_contents->SetDeferApplyingOpacity(paint.HasColorFilter());
1015 
1016  Entity entity;
1017  entity.SetBlendMode(paint.blend_mode);
1019 
1020  if (!paint.mask_blur_descriptor.has_value()) {
1021  entity.SetContents(paint.WithFilters(std::move(texture_contents)));
1022  AddRenderEntityToCurrentPass(entity);
1023  return;
1024  }
1025 
1026  FillRectGeometry out_rect(Rect{});
1027 
1028  entity.SetContents(paint.WithFilters(
1029  paint.mask_blur_descriptor->CreateMaskBlur(texture_contents, &out_rect)));
1030  AddRenderEntityToCurrentPass(entity);
1031 }
1032 
1033 size_t Canvas::GetClipHeight() const {
1034  return transform_stack_.back().clip_height;
1035 }
1036 
1037 void Canvas::DrawVertices(const std::shared_ptr<VerticesGeometry>& vertices,
1038  BlendMode blend_mode,
1039  const Paint& paint) {
1040  // Override the blend mode with kDestination in order to match the behavior
1041  // of Skia's SK_LEGACY_IGNORE_DRAW_VERTICES_BLEND_WITH_NO_SHADER flag, which
1042  // is enabled when the Flutter engine builds Skia.
1043  if (!paint.color_source) {
1044  blend_mode = BlendMode::kDst;
1045  }
1046 
1047  Entity entity;
1049  entity.SetBlendMode(paint.blend_mode);
1050 
1051  // If there are no vertex colors.
1052  if (UseColorSourceContents(vertices, paint)) {
1053  AddRenderEntityWithFiltersToCurrentPass(entity, vertices.get(), paint);
1054  return;
1055  }
1056 
1057  // If the blend mode is destination don't bother to bind or create a texture.
1058  if (blend_mode == BlendMode::kDst) {
1059  auto contents = std::make_shared<VerticesSimpleBlendContents>();
1060  contents->SetBlendMode(blend_mode);
1061  contents->SetAlpha(paint.color.alpha);
1062  contents->SetGeometry(vertices);
1063  entity.SetContents(paint.WithFilters(std::move(contents)));
1064  AddRenderEntityToCurrentPass(entity);
1065  return;
1066  }
1067 
1068  // If there is a texture, use this directly. Otherwise render the color
1069  // source to a texture.
1070  if (paint.color_source &&
1071  paint.color_source->type() == flutter::DlColorSourceType::kImage) {
1072  const flutter::DlImageColorSource* image_color_source =
1073  paint.color_source->asImage();
1074  FML_DCHECK(image_color_source &&
1075  image_color_source->image()->impeller_texture());
1076  auto texture = image_color_source->image()->impeller_texture();
1077  auto x_tile_mode = static_cast<Entity::TileMode>(
1078  image_color_source->horizontal_tile_mode());
1079  auto y_tile_mode =
1080  static_cast<Entity::TileMode>(image_color_source->vertical_tile_mode());
1081  auto sampler_descriptor =
1082  skia_conversions::ToSamplerDescriptor(image_color_source->sampling());
1083  auto effect_transform = image_color_source->matrix();
1084 
1085  auto contents = std::make_shared<VerticesSimpleBlendContents>();
1086  contents->SetBlendMode(blend_mode);
1087  contents->SetAlpha(paint.color.alpha);
1088  contents->SetGeometry(vertices);
1089  contents->SetEffectTransform(effect_transform);
1090  contents->SetTexture(texture);
1091  contents->SetTileMode(x_tile_mode, y_tile_mode);
1092  contents->SetSamplerDescriptor(sampler_descriptor);
1093 
1094  entity.SetContents(paint.WithFilters(std::move(contents)));
1095  AddRenderEntityToCurrentPass(entity);
1096  return;
1097  }
1098 
1099  auto src_paint = paint;
1100  src_paint.color = paint.color.WithAlpha(1.0);
1101 
1102  std::shared_ptr<ColorSourceContents> src_contents =
1103  src_paint.CreateContents();
1104  src_contents->SetGeometry(vertices.get());
1105 
1106  // If the color source has an intrinsic size, then we use that to
1107  // create the src contents as a simplification. Otherwise we use
1108  // the extent of the texture coordinates to determine how large
1109  // the src contents should be. If neither has a value we fall back
1110  // to using the geometry coverage data.
1111  Rect src_coverage;
1112  auto size = src_contents->GetColorSourceSize();
1113  if (size.has_value()) {
1114  src_coverage = Rect::MakeXYWH(0, 0, size->width, size->height);
1115  } else {
1116  auto cvg = vertices->GetCoverage(Matrix{});
1117  FML_CHECK(cvg.has_value());
1118  auto texture_coverage = vertices->GetTextureCoordinateCoverage();
1119  if (texture_coverage.has_value()) {
1120  src_coverage =
1121  Rect::MakeOriginSize(texture_coverage->GetOrigin(),
1122  texture_coverage->GetSize().Max({1, 1}));
1123  } else {
1124  // NOLINTNEXTLINE(bugprone-unchecked-optional-access)
1125  src_coverage = cvg.value();
1126  }
1127  }
1128  src_contents = src_paint.CreateContents();
1129 
1130  clip_geometry_.push_back(Geometry::MakeRect(Rect::Round(src_coverage)));
1131  src_contents->SetGeometry(clip_geometry_.back().get());
1132 
1133  auto contents = std::make_shared<VerticesSimpleBlendContents>();
1134  contents->SetBlendMode(blend_mode);
1135  contents->SetAlpha(paint.color.alpha);
1136  contents->SetGeometry(vertices);
1137  contents->SetLazyTextureCoverage(src_coverage);
1138  contents->SetLazyTexture(
1139  [src_contents, src_coverage](const ContentContext& renderer) {
1140  // Applying the src coverage as the coverage limit prevents the 1px
1141  // coverage pad from adding a border that is picked up by developer
1142  // specified UVs.
1143  auto snapshot = src_contents->RenderToSnapshot(
1144  renderer, {}, {.coverage_limit = Rect::Round(src_coverage)});
1145  return snapshot.has_value() ? snapshot->texture : nullptr;
1146  });
1147  entity.SetContents(paint.WithFilters(std::move(contents)));
1148  AddRenderEntityToCurrentPass(entity);
1149 }
1150 
1151 void Canvas::DrawAtlas(const std::shared_ptr<AtlasContents>& atlas_contents,
1152  const Paint& paint) {
1153  atlas_contents->SetAlpha(paint.color.alpha);
1154 
1155  Entity entity;
1157  entity.SetBlendMode(paint.blend_mode);
1158  entity.SetContents(paint.WithFilters(atlas_contents));
1159 
1160  AddRenderEntityToCurrentPass(entity);
1161 }
1162 
1163 /// Compositor Functionality
1164 /////////////////////////////////////////
1165 
1166 void Canvas::SetupRenderPass() {
1167  renderer_.GetRenderTargetCache()->Start();
1168  ColorAttachment color0 = render_target_.GetColorAttachment(0);
1169 
1170  auto& stencil_attachment = render_target_.GetStencilAttachment();
1171  auto& depth_attachment = render_target_.GetDepthAttachment();
1172  if (!stencil_attachment.has_value() || !depth_attachment.has_value()) {
1173  // Setup a new root stencil with an optimal configuration if one wasn't
1174  // provided by the caller.
1175  render_target_.SetupDepthStencilAttachments(
1176  *renderer_.GetContext(),
1177  *renderer_.GetContext()->GetResourceAllocator(),
1178  color0.texture->GetSize(),
1179  renderer_.GetContext()->GetCapabilities()->SupportsOffscreenMSAA() &&
1180  color0.texture->GetTextureDescriptor().sample_count >
1182  "ImpellerOnscreen", kDefaultStencilConfig);
1183  }
1184 
1185  // Set up the clear color of the root pass.
1187  render_target_.SetColorAttachment(color0, 0);
1188 
1189  // If requires_readback is true, then there is a backdrop filter or emulated
1190  // advanced blend in the first save layer. This requires a readback, which
1191  // isn't supported by onscreen textures. To support this, we immediately begin
1192  // a second save layer with the same dimensions as the onscreen. When
1193  // rendering is completed, we must blit this saveLayer to the onscreen.
1194  if (requires_readback_) {
1195  auto entity_pass_target =
1196  CreateRenderTarget(renderer_, //
1197  color0.texture->GetSize(), //
1198  /*clear_color=*/Color::BlackTransparent());
1199  render_passes_.push_back(
1200  LazyRenderingConfig(renderer_, std::move(entity_pass_target)));
1201  } else {
1202  auto entity_pass_target = std::make_unique<EntityPassTarget>(
1203  render_target_, //
1206  );
1207  render_passes_.push_back(
1208  LazyRenderingConfig(renderer_, std::move(entity_pass_target)));
1209  }
1210 }
1211 
1212 void Canvas::SkipUntilMatchingRestore(size_t total_content_depth) {
1213  auto entry = CanvasStackEntry{};
1214  entry.skipping = true;
1215  entry.clip_depth = current_depth_ + total_content_depth;
1216  transform_stack_.push_back(entry);
1217 }
1218 
1219 void Canvas::Save(uint32_t total_content_depth) {
1220  if (IsSkipping()) {
1221  return SkipUntilMatchingRestore(total_content_depth);
1222  }
1223 
1224  auto entry = CanvasStackEntry{};
1225  entry.transform = transform_stack_.back().transform;
1226  entry.clip_depth = current_depth_ + total_content_depth;
1227  entry.distributed_opacity = transform_stack_.back().distributed_opacity;
1228  FML_DCHECK(entry.clip_depth <= transform_stack_.back().clip_depth)
1229  << entry.clip_depth << " <=? " << transform_stack_.back().clip_depth
1230  << " after allocating " << total_content_depth;
1231  entry.clip_height = transform_stack_.back().clip_height;
1232  entry.rendering_mode = Entity::RenderingMode::kDirect;
1233  transform_stack_.push_back(entry);
1234 }
1235 
1236 std::optional<Rect> Canvas::GetLocalCoverageLimit() const {
1237  if (!clip_coverage_stack_.HasCoverage()) {
1238  // The current clip is empty. This means the pass texture won't be
1239  // visible, so skip it.
1240  return std::nullopt;
1241  }
1242 
1243  std::optional<Rect> maybe_current_clip_coverage =
1244  clip_coverage_stack_.CurrentClipCoverage();
1245  if (!maybe_current_clip_coverage.has_value()) {
1246  return std::nullopt;
1247  }
1248 
1249  Rect current_clip_coverage = maybe_current_clip_coverage.value();
1250 
1251  FML_CHECK(!render_passes_.empty());
1252  const LazyRenderingConfig& back_render_pass = render_passes_.back();
1253  std::shared_ptr<Texture> back_texture =
1254  back_render_pass.GetInlinePassContext()->GetTexture();
1255  FML_CHECK(back_texture) << "Context is valid:"
1256  << back_render_pass.GetInlinePassContext()->IsValid();
1257 
1258  // The maximum coverage of the subpass. Subpasses textures should never
1259  // extend outside the parent pass texture or the current clip coverage.
1260  std::optional<Rect> maybe_coverage_limit =
1261  Rect::MakeOriginSize(GetGlobalPassPosition(),
1262  Size(back_texture->GetSize()))
1263  .Intersection(current_clip_coverage);
1264 
1265  if (!maybe_coverage_limit.has_value() || maybe_coverage_limit->IsEmpty()) {
1266  return std::nullopt;
1267  }
1268 
1269  return maybe_coverage_limit->Intersection(
1270  Rect::MakeSize(render_target_.GetRenderTargetSize()));
1271 }
1272 
1273 void Canvas::SaveLayer(const Paint& paint,
1274  std::optional<Rect> bounds,
1275  const flutter::DlImageFilter* backdrop_filter,
1276  ContentBoundsPromise bounds_promise,
1277  uint32_t total_content_depth,
1278  bool can_distribute_opacity,
1279  std::optional<int64_t> backdrop_id) {
1280  TRACE_EVENT0("flutter", "Canvas::saveLayer");
1281  if (IsSkipping()) {
1282  return SkipUntilMatchingRestore(total_content_depth);
1283  }
1284 
1285  auto maybe_coverage_limit = GetLocalCoverageLimit();
1286  if (!maybe_coverage_limit.has_value()) {
1287  return SkipUntilMatchingRestore(total_content_depth);
1288  }
1289  auto coverage_limit = maybe_coverage_limit.value();
1290 
1291  if (can_distribute_opacity && !backdrop_filter &&
1293  bounds_promise != ContentBoundsPromise::kMayClipContents) {
1294  Save(total_content_depth);
1295  transform_stack_.back().distributed_opacity *= paint.color.alpha;
1296  return;
1297  }
1298 
1299  std::shared_ptr<FilterContents> filter_contents = paint.WithImageFilter(
1300  Rect(), transform_stack_.back().transform,
1302 
1303  std::optional<Rect> maybe_subpass_coverage = ComputeSaveLayerCoverage(
1304  bounds.value_or(Rect::MakeMaximum()),
1305  transform_stack_.back().transform, //
1306  coverage_limit, //
1307  filter_contents, //
1308  /*flood_output_coverage=*/
1310  /*flood_input_coverage=*/!!backdrop_filter ||
1311  (paint.color_filter &&
1312  paint.color_filter->modifies_transparent_black()) //
1313  );
1314 
1315  if (!maybe_subpass_coverage.has_value()) {
1316  return SkipUntilMatchingRestore(total_content_depth);
1317  }
1318 
1319  auto subpass_coverage = maybe_subpass_coverage.value();
1320 
1321  // When an image filter is present, clamp to avoid flicking due to nearest
1322  // sampled image. For other cases, round out to ensure than any geometry is
1323  // not cut off.
1324  //
1325  // See also this bug: https://github.com/flutter/flutter/issues/144213
1326  //
1327  // TODO(jonahwilliams): this could still round out for filters that use decal
1328  // sampling mode.
1330  bool did_round_out = false;
1331  Point coverage_origin_adjustment = Point{0, 0};
1332  if (paint.image_filter) {
1333  subpass_size = ISize(subpass_coverage.GetSize());
1334  } else {
1335  did_round_out = true;
1336  subpass_size =
1337  static_cast<ISize>(IRect::RoundOut(subpass_coverage).GetSize());
1338  // If rounding out, adjust the coverage to account for the subpixel shift.
1339  coverage_origin_adjustment =
1340  Point(subpass_coverage.GetLeftTop().x -
1341  std::floor(subpass_coverage.GetLeftTop().x),
1342  subpass_coverage.GetLeftTop().y -
1343  std::floor(subpass_coverage.GetLeftTop().y));
1344  }
1345  if (subpass_size.IsEmpty()) {
1346  return SkipUntilMatchingRestore(total_content_depth);
1347  }
1348 
1349  // When there are scaling filters present, these contents may exceed the
1350  // maximum texture size. Perform a clamp here, which may cause rendering
1351  // artifacts.
1352  subpass_size = subpass_size.Min(renderer_.GetContext()
1353  ->GetCapabilities()
1354  ->GetMaximumRenderPassAttachmentSize());
1355 
1356  // Backdrop filter state, ignored if there is no BDF.
1357  std::shared_ptr<FilterContents> backdrop_filter_contents;
1358  Point local_position = Point(0, 0);
1359  if (backdrop_filter) {
1360  local_position = subpass_coverage.GetOrigin() - GetGlobalPassPosition();
1361  Canvas::BackdropFilterProc backdrop_filter_proc =
1362  [backdrop_filter = backdrop_filter](
1363  const FilterInput::Ref& input, const Matrix& effect_transform,
1364  Entity::RenderingMode rendering_mode) {
1365  auto filter = WrapInput(backdrop_filter, input);
1366  filter->SetEffectTransform(effect_transform);
1367  filter->SetRenderingMode(rendering_mode);
1368  return filter;
1369  };
1370 
1371  std::shared_ptr<Texture> input_texture;
1372 
1373  // If the backdrop ID is not nullopt and there is more than one usage
1374  // of it in the current scene, cache the backdrop texture and remove it from
1375  // the current entity pass flip.
1376  bool will_cache_backdrop_texture = false;
1377  BackdropData* backdrop_data = nullptr;
1378  // If we've reached this point, there is at least one backdrop filter. But
1379  // potentially more if there is a backdrop id. We may conditionally set this
1380  // to a higher value in the if block below.
1381  size_t backdrop_count = 1;
1382  if (backdrop_id.has_value()) {
1383  std::unordered_map<int64_t, BackdropData>::iterator backdrop_data_it =
1384  backdrop_data_.find(backdrop_id.value());
1385  if (backdrop_data_it != backdrop_data_.end()) {
1386  backdrop_data = &backdrop_data_it->second;
1387  will_cache_backdrop_texture =
1388  backdrop_data_it->second.backdrop_count > 1;
1389  backdrop_count = backdrop_data_it->second.backdrop_count;
1390  }
1391  }
1392 
1393  if (!will_cache_backdrop_texture || !backdrop_data->texture_slot) {
1394  backdrop_count_ -= backdrop_count;
1395 
1396  // The onscreen texture can be flipped to if:
1397  // 1. The device supports framebuffer fetch
1398  // 2. There are no more backdrop filters
1399  // 3. The current render pass is for the onscreen pass.
1400  const bool should_use_onscreen =
1402  backdrop_count_ == 0 && render_passes_.size() == 1u;
1403  input_texture = FlipBackdrop(
1404  GetGlobalPassPosition(), //
1405  /*should_remove_texture=*/will_cache_backdrop_texture, //
1406  /*should_use_onscreen=*/should_use_onscreen //
1407  );
1408  if (!input_texture) {
1409  // Validation failures are logged in FlipBackdrop.
1410  return;
1411  }
1412 
1413  if (will_cache_backdrop_texture) {
1414  backdrop_data->texture_slot = input_texture;
1415  }
1416  } else {
1417  input_texture = backdrop_data->texture_slot;
1418  }
1419 
1420  backdrop_filter_contents = backdrop_filter_proc(
1421  FilterInput::Make(std::move(input_texture)),
1422  transform_stack_.back().transform.Basis(),
1423  // When the subpass has a translation that means the math with
1424  // the snapshot has to be different.
1425  transform_stack_.back().transform.HasTranslation()
1428 
1429  if (will_cache_backdrop_texture) {
1430  FML_DCHECK(backdrop_data);
1431  // If all filters on the shared backdrop layer are equal, process the
1432  // layer once.
1433  if (backdrop_data->all_filters_equal &&
1434  !backdrop_data->shared_filter_snapshot.has_value()) {
1435  // TODO(157110): compute minimum input hint.
1436  backdrop_data->shared_filter_snapshot =
1437  backdrop_filter_contents->RenderToSnapshot(renderer_, {}, {});
1438  }
1439 
1440  std::optional<Snapshot> maybe_snapshot =
1441  backdrop_data->shared_filter_snapshot;
1442  if (maybe_snapshot.has_value()) {
1443  const Snapshot& snapshot = maybe_snapshot.value();
1444  std::shared_ptr<TextureContents> contents = TextureContents::MakeRect(
1445  subpass_coverage.Shift(-GetGlobalPassPosition()));
1446  auto scaled =
1447  subpass_coverage.TransformBounds(snapshot.transform.Invert());
1448  contents->SetTexture(snapshot.texture);
1449  contents->SetSourceRect(scaled);
1450  contents->SetSamplerDescriptor(snapshot.sampler_descriptor);
1451 
1452  // This backdrop entity sets a depth value as it is written to the newly
1453  // flipped backdrop and not into a new saveLayer.
1454  Entity backdrop_entity;
1455  backdrop_entity.SetContents(std::move(contents));
1456  backdrop_entity.SetClipDepth(++current_depth_);
1457  backdrop_entity.SetBlendMode(paint.blend_mode);
1458 
1459  backdrop_entity.Render(renderer_, GetCurrentRenderPass());
1460  Save(0);
1461  return;
1462  }
1463  }
1464  }
1465 
1466  // When applying a save layer, absorb any pending distributed opacity.
1467  Paint paint_copy = paint;
1468  paint_copy.color.alpha *= transform_stack_.back().distributed_opacity;
1469  transform_stack_.back().distributed_opacity = 1.0;
1470 
1471  render_passes_.push_back(
1472  LazyRenderingConfig(renderer_, //
1473  CreateRenderTarget(renderer_, //
1474  subpass_size, //
1476  )));
1477  save_layer_state_.push_back(SaveLayerState{
1478  paint_copy, subpass_coverage.Shift(-coverage_origin_adjustment)});
1479 
1480  CanvasStackEntry entry;
1481  entry.transform = transform_stack_.back().transform;
1482  entry.clip_depth = current_depth_ + total_content_depth;
1483  FML_DCHECK(entry.clip_depth <= transform_stack_.back().clip_depth)
1484  << entry.clip_depth << " <=? " << transform_stack_.back().clip_depth
1485  << " after allocating " << total_content_depth;
1486  entry.clip_height = transform_stack_.back().clip_height;
1488  entry.did_round_out = did_round_out;
1489  transform_stack_.emplace_back(entry);
1490 
1491  // Start non-collapsed subpasses with a fresh clip coverage stack limited by
1492  // the subpass coverage. This is important because image filters applied to
1493  // save layers may transform the subpass texture after it's rendered,
1494  // causing parent clip coverage to get misaligned with the actual area that
1495  // the subpass will affect in the parent pass.
1496  clip_coverage_stack_.PushSubpass(subpass_coverage, GetClipHeight());
1497 
1498  if (!backdrop_filter_contents) {
1499  return;
1500  }
1501 
1502  // Render the backdrop entity.
1503  Entity backdrop_entity;
1504  backdrop_entity.SetContents(std::move(backdrop_filter_contents));
1505  backdrop_entity.SetTransform(
1506  Matrix::MakeTranslation(Vector3(-local_position)));
1507  backdrop_entity.SetClipDepth(std::numeric_limits<uint32_t>::max());
1508  backdrop_entity.Render(renderer_, GetCurrentRenderPass());
1509 }
1510 
1512  FML_DCHECK(transform_stack_.size() > 0);
1513  if (transform_stack_.size() == 1) {
1514  return false;
1515  }
1516 
1517  // This check is important to make sure we didn't exceed the depth
1518  // that the clips were rendered at while rendering any of the
1519  // rendering ops. It is OK for the current depth to equal the
1520  // outgoing clip depth because that means the clipping would have
1521  // been successful up through the last rendering op, but it cannot
1522  // be greater.
1523  // Also, we bump the current rendering depth to the outgoing clip
1524  // depth so that future rendering operations are not clipped by
1525  // any of the pixels set by the expiring clips. It is OK for the
1526  // estimates used to determine the clip depth in save/saveLayer
1527  // to be overly conservative, but we need to jump the depth to
1528  // the clip depth so that the next rendering op will get a
1529  // larger depth (it will pre-increment the current_depth_ value).
1530  FML_DCHECK(current_depth_ <= transform_stack_.back().clip_depth)
1531  << current_depth_ << " <=? " << transform_stack_.back().clip_depth;
1532  current_depth_ = transform_stack_.back().clip_depth;
1533 
1534  if (IsSkipping()) {
1535  transform_stack_.pop_back();
1536  return true;
1537  }
1538 
1539  if (transform_stack_.back().rendering_mode ==
1541  transform_stack_.back().rendering_mode ==
1543  auto lazy_render_pass = std::move(render_passes_.back());
1544  render_passes_.pop_back();
1545  // Force the render pass to be constructed if it never was.
1546  lazy_render_pass.GetInlinePassContext()->GetRenderPass();
1547 
1548  SaveLayerState save_layer_state = save_layer_state_.back();
1549  save_layer_state_.pop_back();
1550  auto global_pass_position = GetGlobalPassPosition();
1551 
1552  std::shared_ptr<Contents> contents = CreateContentsForSubpassTarget(
1553  save_layer_state.paint, //
1554  lazy_render_pass.GetInlinePassContext()->GetTexture(), //
1555  Matrix::MakeTranslation(Vector3{-global_pass_position}) * //
1556  transform_stack_.back().transform //
1557  );
1558 
1559  lazy_render_pass.GetInlinePassContext()->EndPass();
1560 
1561  // Round the subpass texture position for pixel alignment with the parent
1562  // pass render target. By default, we draw subpass textures with nearest
1563  // sampling, so aligning here is important for avoiding visual nearest
1564  // sampling errors caused by limited floating point precision when
1565  // straddling a half pixel boundary.
1566  Point subpass_texture_position;
1567  if (transform_stack_.back().did_round_out) {
1568  // Subpass coverage was rounded out, origin potentially moved "down" by
1569  // as much as a pixel.
1570  subpass_texture_position =
1571  (save_layer_state.coverage.GetOrigin() - global_pass_position)
1572  .Floor();
1573  } else {
1574  // Subpass coverage was truncated. Pick the closest phyiscal pixel.
1575  subpass_texture_position =
1576  (save_layer_state.coverage.GetOrigin() - global_pass_position)
1577  .Round();
1578  }
1579 
1580  Entity element_entity;
1581  element_entity.SetClipDepth(++current_depth_);
1582  element_entity.SetContents(std::move(contents));
1583  element_entity.SetBlendMode(save_layer_state.paint.blend_mode);
1584  element_entity.SetTransform(
1585  Matrix::MakeTranslation(Vector3(subpass_texture_position)));
1586 
1587  if (element_entity.GetBlendMode() > Entity::kLastPipelineBlendMode) {
1588  if (renderer_.GetDeviceCapabilities().SupportsFramebufferFetch()) {
1589  ApplyFramebufferBlend(element_entity);
1590  } else {
1591  // End the active pass and flush the buffer before rendering "advanced"
1592  // blends. Advanced blends work by binding the current render target
1593  // texture as an input ("destination"), blending with a second texture
1594  // input ("source"), writing the result to an intermediate texture, and
1595  // finally copying the data from the intermediate texture back to the
1596  // render target texture. And so all of the commands that have written
1597  // to the render target texture so far need to execute before it's bound
1598  // for blending (otherwise the blend pass will end up executing before
1599  // all the previous commands in the active pass).
1600  auto input_texture = FlipBackdrop(GetGlobalPassPosition());
1601  if (!input_texture) {
1602  return false;
1603  }
1604 
1605  FilterInput::Vector inputs = {
1606  FilterInput::Make(input_texture,
1607  element_entity.GetTransform().Invert()),
1608  FilterInput::Make(element_entity.GetContents())};
1609  auto contents = ColorFilterContents::MakeBlend(
1610  element_entity.GetBlendMode(), inputs);
1611  contents->SetCoverageHint(element_entity.GetCoverage());
1612  element_entity.SetContents(std::move(contents));
1613  element_entity.SetBlendMode(BlendMode::kSrc);
1614  }
1615  }
1616 
1617  element_entity.Render(
1618  renderer_, //
1619  *render_passes_.back().GetInlinePassContext()->GetRenderPass() //
1620  );
1621  clip_coverage_stack_.PopSubpass();
1622  transform_stack_.pop_back();
1623 
1624  // We don't need to restore clips if a saveLayer was performed, as the clip
1625  // state is per render target, and no more rendering operations will be
1626  // performed as the render target workloaded is completed in the restore.
1627  return true;
1628  }
1629 
1630  size_t num_clips = transform_stack_.back().num_clips;
1631  transform_stack_.pop_back();
1632 
1633  if (num_clips > 0) {
1634  EntityPassClipStack::ClipStateResult clip_state_result =
1635  clip_coverage_stack_.RecordRestore(GetGlobalPassPosition(),
1636  GetClipHeight());
1637 
1638  // Clip restores are never required with depth based clipping.
1639  FML_DCHECK(!clip_state_result.should_render);
1640  if (clip_state_result.clip_did_change) {
1641  // We only need to update the pass scissor if the clip state has changed.
1642  SetClipScissor(
1643  clip_coverage_stack_.CurrentClipCoverage(), //
1644  *render_passes_.back().GetInlinePassContext()->GetRenderPass(), //
1645  GetGlobalPassPosition() //
1646  );
1647  }
1648  }
1649 
1650  return true;
1651 }
1652 
1653 bool Canvas::AttemptBlurredTextOptimization(
1654  const std::shared_ptr<TextFrame>& text_frame,
1655  const std::shared_ptr<TextContents>& text_contents,
1656  Entity& entity,
1657  const Paint& paint) {
1658  if (!paint.mask_blur_descriptor.has_value() || //
1659  paint.image_filter != nullptr || //
1660  paint.color_filter != nullptr || //
1661  paint.invert_colors) {
1662  return false;
1663  }
1664 
1665  // TODO(bdero): This mask blur application is a hack. It will always wind up
1666  // doing a gaussian blur that affects the color source itself
1667  // instead of just the mask. The color filter text support
1668  // needs to be reworked in order to interact correctly with
1669  // mask filters.
1670  // https://github.com/flutter/flutter/issues/133297
1671  std::shared_ptr<FilterContents> filter =
1672  paint.mask_blur_descriptor->CreateMaskBlur(
1673  FilterInput::Make(text_contents),
1674  /*is_solid_color=*/true, GetCurrentTransform());
1675 
1676  std::optional<Glyph> maybe_glyph = text_frame->AsSingleGlyph();
1677  int64_t identifier = maybe_glyph.has_value()
1678  ? maybe_glyph.value().index
1679  : reinterpret_cast<int64_t>(text_frame.get());
1680  TextShadowCache::TextShadowCacheKey cache_key(
1681  /*p_max_basis=*/entity.GetTransform().GetMaxBasisLengthXY(),
1682  /*p_identifier=*/identifier,
1683  /*p_is_single_glyph=*/maybe_glyph.has_value(),
1684  /*p_font=*/text_frame->GetFont(),
1685  /*p_sigma=*/paint.mask_blur_descriptor->sigma,
1686  /*p_color=*/paint.color);
1687 
1688  std::optional<Entity> result = renderer_.GetTextShadowCache().Lookup(
1689  renderer_, entity, filter, cache_key);
1690  if (result.has_value()) {
1691  AddRenderEntityToCurrentPass(result.value(), /*reuse_depth=*/false);
1692  return true;
1693  } else {
1694  return false;
1695  }
1696 }
1697 
1698 // If the text point size * max basis XY is larger than this value,
1699 // render the text as paths (if available) for faster and higher
1700 // fidelity rendering. This is a somewhat arbitrary cutoff
1701 static constexpr Scalar kMaxTextScale = 250;
1702 
1703 void Canvas::DrawTextFrame(const std::shared_ptr<TextFrame>& text_frame,
1704  Point position,
1705  const Paint& paint) {
1707  if (max_scale * text_frame->GetFont().GetMetrics().point_size >
1708  kMaxTextScale) {
1709  fml::StatusOr<flutter::DlPath> path = text_frame->GetPath();
1710  if (path.ok()) {
1711  Save(1);
1712  Concat(Matrix::MakeTranslation(position));
1713  DrawPath(path.value(), paint);
1714  Restore();
1715  return;
1716  }
1717  }
1718 
1719  Entity entity;
1720  entity.SetClipDepth(GetClipHeight());
1721  entity.SetBlendMode(paint.blend_mode);
1722 
1723  auto text_contents = std::make_shared<TextContents>();
1724  text_contents->SetTextFrame(text_frame);
1725  text_contents->SetForceTextColor(paint.mask_blur_descriptor.has_value());
1726  text_contents->SetScale(max_scale);
1727  text_contents->SetColor(paint.color);
1728  text_contents->SetOffset(position);
1729  text_contents->SetTextProperties(paint.color,
1730  paint.style == Paint::Style::kStroke
1731  ? std::optional(paint.stroke)
1732  : std::nullopt);
1733 
1735  Matrix::MakeTranslation(position));
1736 
1737  if (AttemptBlurredTextOptimization(text_frame, text_contents, entity,
1738  paint)) {
1739  return;
1740  }
1741 
1742  entity.SetContents(paint.WithFilters(std::move(text_contents)));
1743  AddRenderEntityToCurrentPass(entity, false);
1744 }
1745 
1746 void Canvas::AddRenderEntityWithFiltersToCurrentPass(Entity& entity,
1747  const Geometry* geometry,
1748  const Paint& paint,
1749  bool reuse_depth) {
1750  std::shared_ptr<ColorSourceContents> contents = paint.CreateContents();
1751  if (!paint.color_filter && !paint.invert_colors && !paint.image_filter &&
1752  !paint.mask_blur_descriptor.has_value()) {
1753  contents->SetGeometry(geometry);
1754  entity.SetContents(std::move(contents));
1755  AddRenderEntityToCurrentPass(entity, reuse_depth);
1756  return;
1757  }
1758 
1759  // Attempt to apply the color filter on the CPU first.
1760  // Note: This is not just an optimization; some color sources rely on
1761  // CPU-applied color filters to behave properly.
1762  bool needs_color_filter = paint.color_filter || paint.invert_colors;
1763  if (needs_color_filter &&
1764  contents->ApplyColorFilter([&](Color color) -> Color {
1765  if (paint.color_filter) {
1766  color = GetCPUColorFilterProc(paint.color_filter)(color);
1767  }
1768  if (paint.invert_colors) {
1769  color = color.ApplyColorMatrix(kColorInversion);
1770  }
1771  return color;
1772  })) {
1773  needs_color_filter = false;
1774  }
1775 
1776  bool can_apply_mask_filter = geometry->CanApplyMaskFilter();
1777  contents->SetGeometry(geometry);
1778 
1779  if (can_apply_mask_filter && paint.mask_blur_descriptor.has_value()) {
1780  // If there's a mask blur and we need to apply the color filter on the GPU,
1781  // we need to be careful to only apply the color filter to the source
1782  // colors. CreateMaskBlur is able to handle this case.
1783  FillRectGeometry out_rect(Rect{});
1784  auto filter_contents = paint.mask_blur_descriptor->CreateMaskBlur(
1785  contents, needs_color_filter ? paint.color_filter : nullptr,
1786  needs_color_filter ? paint.invert_colors : false, &out_rect);
1787  entity.SetContents(std::move(filter_contents));
1788  AddRenderEntityToCurrentPass(entity, reuse_depth);
1789  return;
1790  }
1791 
1792  std::shared_ptr<Contents> contents_copy = std::move(contents);
1793 
1794  // Image input types will directly set their color filter,
1795  // if any. See `TiledTextureContents.SetColorFilter`.
1796  if (needs_color_filter &&
1797  (!paint.color_source ||
1798  paint.color_source->type() != flutter::DlColorSourceType::kImage)) {
1799  if (paint.color_filter) {
1800  contents_copy = WrapWithGPUColorFilter(
1801  paint.color_filter, FilterInput::Make(std::move(contents_copy)),
1803  }
1804  if (paint.invert_colors) {
1805  contents_copy =
1806  WrapWithInvertColors(FilterInput::Make(std::move(contents_copy)),
1808  }
1809  }
1810 
1811  if (paint.image_filter) {
1812  std::shared_ptr<FilterContents> filter = WrapInput(
1813  paint.image_filter, FilterInput::Make(std::move(contents_copy)));
1814  filter->SetRenderingMode(Entity::RenderingMode::kDirect);
1815  entity.SetContents(filter);
1816  AddRenderEntityToCurrentPass(entity, reuse_depth);
1817  return;
1818  }
1819 
1820  entity.SetContents(std::move(contents_copy));
1821  AddRenderEntityToCurrentPass(entity, reuse_depth);
1822 }
1823 
1824 void Canvas::AddRenderEntityToCurrentPass(Entity& entity, bool reuse_depth) {
1825  if (IsSkipping()) {
1826  return;
1827  }
1828 
1829  entity.SetTransform(
1830  Matrix::MakeTranslation(Vector3(-GetGlobalPassPosition())) *
1831  entity.GetTransform());
1832  entity.SetInheritedOpacity(transform_stack_.back().distributed_opacity);
1833  if (entity.GetBlendMode() == BlendMode::kSrcOver &&
1834  entity.GetContents()->IsOpaque(entity.GetTransform())) {
1835  entity.SetBlendMode(BlendMode::kSrc);
1836  }
1837 
1838  // If the entity covers the current render target and is a solid color, then
1839  // conditionally update the backdrop color to its solid color value blended
1840  // with the current backdrop.
1841  if (render_passes_.back().IsApplyingClearColor()) {
1842  std::optional<Color> maybe_color = entity.AsBackgroundColor(
1843  render_passes_.back().GetInlinePassContext()->GetTexture()->GetSize());
1844  if (maybe_color.has_value()) {
1845  Color color = maybe_color.value();
1846  RenderTarget& render_target = render_passes_.back()
1847  .GetInlinePassContext()
1848  ->GetPassTarget()
1849  .GetRenderTarget();
1850  ColorAttachment attachment = render_target.GetColorAttachment(0);
1851  // Attachment.clear color needs to be premultiplied at all times, but the
1852  // Color::Blend function requires unpremultiplied colors.
1853  attachment.clear_color = attachment.clear_color.Unpremultiply()
1854  .Blend(color, entity.GetBlendMode())
1855  .Premultiply();
1856  render_target.SetColorAttachment(attachment, 0u);
1857  return;
1858  }
1859  }
1860  if (!reuse_depth) {
1861  ++current_depth_;
1862  }
1863 
1864  // We can render at a depth up to and including the depth of the currently
1865  // active clips and we will still be clipped out, but we cannot render at
1866  // a depth that is greater than the current clips or we will not be clipped.
1867  FML_DCHECK(current_depth_ <= transform_stack_.back().clip_depth)
1868  << current_depth_ << " <=? " << transform_stack_.back().clip_depth;
1869  entity.SetClipDepth(current_depth_);
1870 
1871  if (entity.GetBlendMode() > Entity::kLastPipelineBlendMode) {
1872  if (renderer_.GetDeviceCapabilities().SupportsFramebufferFetch()) {
1873  ApplyFramebufferBlend(entity);
1874  } else {
1875  // End the active pass and flush the buffer before rendering "advanced"
1876  // blends. Advanced blends work by binding the current render target
1877  // texture as an input ("destination"), blending with a second texture
1878  // input ("source"), writing the result to an intermediate texture, and
1879  // finally copying the data from the intermediate texture back to the
1880  // render target texture. And so all of the commands that have written
1881  // to the render target texture so far need to execute before it's bound
1882  // for blending (otherwise the blend pass will end up executing before
1883  // all the previous commands in the active pass).
1884  auto input_texture = FlipBackdrop(GetGlobalPassPosition(), //
1885  /*should_remove_texture=*/false,
1886  /*should_use_onscreen=*/false,
1887  /*post_depth_increment=*/true);
1888  if (!input_texture) {
1889  return;
1890  }
1891 
1892  // The coverage hint tells the rendered Contents which portion of the
1893  // rendered output will actually be used, and so we set this to the
1894  // current clip coverage (which is the max clip bounds). The contents may
1895  // optionally use this hint to avoid unnecessary rendering work.
1896  auto element_coverage_hint = entity.GetContents()->GetCoverageHint();
1897  entity.GetContents()->SetCoverageHint(Rect::Intersection(
1898  element_coverage_hint, clip_coverage_stack_.CurrentClipCoverage()));
1899 
1900  FilterInput::Vector inputs = {
1901  FilterInput::Make(input_texture, entity.GetTransform().Invert()),
1902  FilterInput::Make(entity.GetContents())};
1903  auto contents =
1904  ColorFilterContents::MakeBlend(entity.GetBlendMode(), inputs);
1905  entity.SetContents(std::move(contents));
1906  entity.SetBlendMode(BlendMode::kSrc);
1907  }
1908  }
1909 
1910  const std::shared_ptr<RenderPass>& result =
1911  render_passes_.back().GetInlinePassContext()->GetRenderPass();
1912  if (!result) {
1913  // Failure to produce a render pass should be explained by specific errors
1914  // in `InlinePassContext::GetRenderPass()`, so avoid log spam and don't
1915  // append a validation log here.
1916  return;
1917  }
1918 
1919  entity.Render(renderer_, *result);
1920 }
1921 
1922 RenderPass& Canvas::GetCurrentRenderPass() const {
1923  return *render_passes_.back().GetInlinePassContext()->GetRenderPass();
1924 }
1925 
1926 void Canvas::SetBackdropData(
1927  std::unordered_map<int64_t, BackdropData> backdrop_data,
1928  size_t backdrop_count) {
1929  backdrop_data_ = std::move(backdrop_data);
1930  backdrop_count_ = backdrop_count;
1931 }
1932 
1933 std::shared_ptr<Texture> Canvas::FlipBackdrop(Point global_pass_position,
1934  bool should_remove_texture,
1935  bool should_use_onscreen,
1936  bool post_depth_increment) {
1937  LazyRenderingConfig rendering_config = std::move(render_passes_.back());
1938  render_passes_.pop_back();
1939 
1940  // If the very first thing we render in this EntityPass is a subpass that
1941  // happens to have a backdrop filter or advanced blend, than that backdrop
1942  // filter/blend will sample from an uninitialized texture.
1943  //
1944  // By calling `pass_context.GetRenderPass` here, we force the texture to pass
1945  // through at least one RenderPass with the correct clear configuration before
1946  // any sampling occurs.
1947  //
1948  // In cases where there are no contents, we
1949  // could instead check the clear color and initialize a 1x2 CPU texture
1950  // instead of ending the pass.
1951  rendering_config.GetInlinePassContext()->GetRenderPass();
1952  if (!rendering_config.GetInlinePassContext()->EndPass()) {
1954  << "Failed to end the current render pass in order to read from "
1955  "the backdrop texture and apply an advanced blend or backdrop "
1956  "filter.";
1957  // Note: adding this render pass ensures there are no later crashes from
1958  // unbalanced save layers. Ideally, this method would return false and the
1959  // renderer could handle that by terminating dispatch.
1960  render_passes_.emplace_back(std::move(rendering_config));
1961  return nullptr;
1962  }
1963 
1964  const std::shared_ptr<Texture>& input_texture =
1965  rendering_config.GetInlinePassContext()->GetTexture();
1966 
1967  if (!input_texture) {
1968  VALIDATION_LOG << "Failed to fetch the color texture in order to "
1969  "apply an advanced blend or backdrop filter.";
1970 
1971  // Note: see above.
1972  render_passes_.emplace_back(std::move(rendering_config));
1973  return nullptr;
1974  }
1975 
1976  if (should_use_onscreen) {
1977  ColorAttachment color0 = render_target_.GetColorAttachment(0);
1978  // When MSAA is being used, we end up overriding the entire backdrop by
1979  // drawing the previous pass texture, and so we don't have to clear it and
1980  // can use kDontCare.
1981  color0.load_action = color0.resolve_texture != nullptr
1982  ? LoadAction::kDontCare
1983  : LoadAction::kLoad;
1984  render_target_.SetColorAttachment(color0, 0);
1985 
1986  auto entity_pass_target = std::make_unique<EntityPassTarget>(
1987  render_target_, //
1988  renderer_.GetDeviceCapabilities().SupportsReadFromResolve(), //
1989  renderer_.GetDeviceCapabilities().SupportsImplicitResolvingMSAA() //
1990  );
1991  render_passes_.push_back(
1992  LazyRenderingConfig(renderer_, std::move(entity_pass_target)));
1993  requires_readback_ = false;
1994  } else {
1995  render_passes_.emplace_back(std::move(rendering_config));
1996  // If the current texture is being cached for a BDF we need to ensure we
1997  // don't recycle it during recording; remove it from the entity pass target.
1998  if (should_remove_texture) {
1999  render_passes_.back().GetEntityPassTarget()->RemoveSecondary();
2000  }
2001  }
2002  RenderPass& current_render_pass =
2003  *render_passes_.back().GetInlinePassContext()->GetRenderPass();
2004 
2005  // Eagerly restore the BDF contents.
2006 
2007  // If the pass context returns a backdrop texture, we need to draw it to the
2008  // current pass. We do this because it's faster and takes significantly less
2009  // memory than storing/loading large MSAA textures. Also, it's not possible
2010  // to blit the non-MSAA resolve texture of the previous pass to MSAA
2011  // textures (let alone a transient one).
2012  Rect size_rect = Rect::MakeSize(input_texture->GetSize());
2013  auto msaa_backdrop_contents = TextureContents::MakeRect(size_rect);
2014  msaa_backdrop_contents->SetStencilEnabled(false);
2015  msaa_backdrop_contents->SetLabel("MSAA backdrop");
2016  msaa_backdrop_contents->SetSourceRect(size_rect);
2017  msaa_backdrop_contents->SetTexture(input_texture);
2018 
2019  Entity msaa_backdrop_entity;
2020  msaa_backdrop_entity.SetContents(std::move(msaa_backdrop_contents));
2021  msaa_backdrop_entity.SetBlendMode(BlendMode::kSrc);
2022  msaa_backdrop_entity.SetClipDepth(std::numeric_limits<uint32_t>::max());
2023  if (!msaa_backdrop_entity.Render(renderer_, current_render_pass)) {
2024  VALIDATION_LOG << "Failed to render MSAA backdrop entity.";
2025  return nullptr;
2026  }
2027 
2028  // Restore any clips that were recorded before the backdrop filter was
2029  // applied.
2030  auto& replay_entities = clip_coverage_stack_.GetReplayEntities();
2031  uint64_t current_depth =
2032  post_depth_increment ? current_depth_ - 1 : current_depth_;
2033  for (const auto& replay : replay_entities) {
2034  if (replay.clip_depth <= current_depth) {
2035  continue;
2036  }
2037 
2038  SetClipScissor(replay.clip_coverage, current_render_pass,
2039  global_pass_position);
2040  if (!replay.clip_contents.Render(renderer_, current_render_pass,
2041  replay.clip_depth)) {
2042  VALIDATION_LOG << "Failed to render entity for clip restore.";
2043  }
2044  }
2045 
2046  return input_texture;
2047 }
2048 
2049 bool Canvas::SupportsBlitToOnscreen() const {
2050  return renderer_.GetContext()
2051  ->GetCapabilities()
2052  ->SupportsTextureToTextureBlits() &&
2053  renderer_.GetContext()->GetBackendType() ==
2054  Context::BackendType::kMetal;
2055 }
2056 
2057 bool Canvas::BlitToOnscreen(bool is_onscreen) {
2058  auto command_buffer = renderer_.GetContext()->CreateCommandBuffer();
2059  command_buffer->SetLabel("EntityPass Root Command Buffer");
2060  auto offscreen_target = render_passes_.back()
2061  .GetInlinePassContext()
2062  ->GetPassTarget()
2063  .GetRenderTarget();
2064  if (SupportsBlitToOnscreen()) {
2065  auto blit_pass = command_buffer->CreateBlitPass();
2066  blit_pass->AddCopy(offscreen_target.GetRenderTargetTexture(),
2067  render_target_.GetRenderTargetTexture());
2068  if (!blit_pass->EncodeCommands()) {
2069  VALIDATION_LOG << "Failed to encode root pass blit command.";
2070  return false;
2071  }
2072  } else {
2073  auto render_pass = command_buffer->CreateRenderPass(render_target_);
2074  render_pass->SetLabel("EntityPass Root Render Pass");
2075 
2076  {
2077  auto size_rect = Rect::MakeSize(offscreen_target.GetRenderTargetSize());
2078  auto contents = TextureContents::MakeRect(size_rect);
2079  contents->SetTexture(offscreen_target.GetRenderTargetTexture());
2080  contents->SetSourceRect(size_rect);
2081  contents->SetLabel("Root pass blit");
2082 
2083  Entity entity;
2084  entity.SetContents(contents);
2085  entity.SetBlendMode(BlendMode::kSrc);
2086 
2087  if (!entity.Render(renderer_, *render_pass)) {
2088  VALIDATION_LOG << "Failed to render EntityPass root blit.";
2089  return false;
2090  }
2091  }
2092 
2093  if (!render_pass->EncodeCommands()) {
2094  VALIDATION_LOG << "Failed to encode root pass command buffer.";
2095  return false;
2096  }
2097  }
2098 
2099  if (is_onscreen) {
2100  return renderer_.GetContext()->SubmitOnscreen(std::move(command_buffer));
2101  } else {
2102  return renderer_.GetContext()->EnqueueCommandBuffer(
2103  std::move(command_buffer));
2104  }
2105 }
2106 
2107 bool Canvas::EnsureFinalMipmapGeneration() const {
2108  if (!render_target_.GetRenderTargetTexture()->NeedsMipmapGeneration()) {
2109  return true;
2110  }
2111  std::shared_ptr<CommandBuffer> cmd_buffer =
2112  renderer_.GetContext()->CreateCommandBuffer();
2113  if (!cmd_buffer) {
2114  return false;
2115  }
2116  std::shared_ptr<BlitPass> blit_pass = cmd_buffer->CreateBlitPass();
2117  if (!blit_pass) {
2118  return false;
2119  }
2120  blit_pass->GenerateMipmap(render_target_.GetRenderTargetTexture());
2121  blit_pass->EncodeCommands();
2122  return renderer_.GetContext()->EnqueueCommandBuffer(std::move(cmd_buffer));
2123 }
2124 
2125 void Canvas::EndReplay() {
2126  FML_DCHECK(render_passes_.size() == 1u);
2127  render_passes_.back().GetInlinePassContext()->GetRenderPass();
2128  render_passes_.back().GetInlinePassContext()->EndPass(
2129  /*is_onscreen=*/!requires_readback_ && is_onscreen_);
2130  backdrop_data_.clear();
2131 
2132  // If requires_readback_ was true, then we rendered to an offscreen texture
2133  // instead of to the onscreen provided in the render target. Now we need to
2134  // draw or blit the offscreen back to the onscreen.
2135  if (requires_readback_) {
2136  BlitToOnscreen(/*is_onscreen_=*/is_onscreen_);
2137  }
2138  if (!EnsureFinalMipmapGeneration()) {
2139  VALIDATION_LOG << "Failed to generate onscreen mipmaps.";
2140  }
2141  if (!renderer_.GetContext()->FlushCommandBuffers()) {
2142  // Not much we can do.
2143  VALIDATION_LOG << "Failed to submit command buffers";
2144  }
2145  render_passes_.clear();
2146  renderer_.GetRenderTargetCache()->End();
2147  clip_geometry_.clear();
2148 
2149  Reset();
2150  Initialize(initial_cull_rect_);
2151 }
2152 
2153 LazyRenderingConfig::LazyRenderingConfig(
2154  ContentContext& renderer,
2155  std::unique_ptr<EntityPassTarget> p_entity_pass_target)
2156  : entity_pass_target_(std::move(p_entity_pass_target)) {
2157  inline_pass_context_ =
2158  std::make_unique<InlinePassContext>(renderer, *entity_pass_target_);
2159 }
2160 
2162  return !inline_pass_context_->IsActive();
2163 }
2164 
2166  return entity_pass_target_.get();
2167 }
2168 
2170  return inline_pass_context_.get();
2171 }
2172 
2173 } // namespace impeller
A Geometry that produces fillable vertices representing the stroked outline of an |Arc| object using ...
void ClipGeometry(const Geometry &geometry, Entity::ClipOperation clip_op, bool is_aa=true)
Definition: canvas.cc:858
static constexpr uint32_t kMaxDepth
Definition: canvas.h:120
Canvas(ContentContext &renderer, const RenderTarget &render_target, bool is_onscreen, bool requires_readback)
Definition: canvas.cc:199
void DrawRoundSuperellipse(const RoundSuperellipse &rse, const Paint &paint)
Definition: canvas.cc:809
std::optional< Rect > GetLocalCoverageLimit() const
Return the culling bounds of the current render target, or nullopt if there is no coverage.
Definition: canvas.cc:1236
void SaveLayer(const Paint &paint, std::optional< Rect > bounds=std::nullopt, const flutter::DlImageFilter *backdrop_filter=nullptr, ContentBoundsPromise bounds_promise=ContentBoundsPromise::kUnknown, uint32_t total_content_depth=kMaxDepth, bool can_distribute_opacity=false, std::optional< int64_t > backdrop_id=std::nullopt)
Definition: canvas.cc:1273
const Matrix & GetCurrentTransform() const
Definition: canvas.cc:273
void DrawVertices(const std::shared_ptr< VerticesGeometry > &vertices, BlendMode blend_mode, const Paint &paint)
Definition: canvas.cc:1037
void DrawOval(const Rect &rect, const Paint &paint)
Definition: canvas.cc:680
void DrawImageRect(const std::shared_ptr< Texture > &image, Rect source, Rect dest, const Paint &paint, const SamplerDescriptor &sampler={}, SourceRectConstraint src_rect_constraint=SourceRectConstraint::kFast)
Definition: canvas.cc:972
void RestoreToCount(size_t count)
Definition: canvas.cc:320
bool Restore()
Definition: canvas.cc:1511
size_t GetSaveCount() const
Definition: canvas.cc:312
void Concat(const Matrix &transform)
Definition: canvas.cc:257
void Transform(const Matrix &transform)
Definition: canvas.cc:269
void DrawDashedLine(const Point &p0, const Point &p1, Scalar on_length, Scalar off_length, const Paint &paint)
Definition: canvas.cc:636
void DrawDiffRoundRect(const RoundRect &outer, const RoundRect &inner, const Paint &paint)
Definition: canvas.cc:793
void DrawPath(const flutter::DlPath &path, const Paint &paint)
Definition: canvas.cc:328
std::function< std::shared_ptr< FilterContents >(FilterInput::Ref, const Matrix &effect_transform, Entity::RenderingMode rendering_mode)> BackdropFilterProc
Definition: canvas.h:125
void PreConcat(const Matrix &transform)
Definition: canvas.cc:261
void Rotate(Radians radians)
Definition: canvas.cc:293
void DrawPoints(const Point points[], uint32_t count, Scalar radius, const Paint &paint, PointStyle point_style)
Definition: canvas.cc:940
void ResetTransform()
Definition: canvas.cc:265
void DrawTextFrame(const std::shared_ptr< TextFrame > &text_frame, Point position, const Paint &paint)
Definition: canvas.cc:1703
void DrawImage(const std::shared_ptr< Texture > &image, Point offset, const Paint &paint, const SamplerDescriptor &sampler={})
Definition: canvas.cc:958
void DrawPaint(const Paint &paint)
Definition: canvas.cc:342
void DrawRoundRect(const RoundRect &rect, const Paint &paint)
Definition: canvas.cc:761
void Skew(Scalar sx, Scalar sy)
Definition: canvas.cc:289
void Scale(const Vector2 &scale)
Definition: canvas.cc:281
void Save(uint32_t total_content_depth=kMaxDepth)
Definition: canvas.cc:1219
void DrawRect(const Rect &rect, const Paint &paint)
Definition: canvas.cc:662
void DrawAtlas(const std::shared_ptr< AtlasContents > &atlas_contents, const Paint &paint)
Definition: canvas.cc:1151
void DrawLine(const Point &p0, const Point &p1, const Paint &paint, bool reuse_depth=false)
Definition: canvas.cc:614
void Translate(const Vector3 &offset)
Definition: canvas.cc:277
void DrawCircle(const Point &center, Scalar radius, const Paint &paint)
Definition: canvas.cc:831
void DrawArc(const Arc &arc, const Paint &paint)
Definition: canvas.cc:709
virtual bool SupportsImplicitResolvingMSAA() const =0
Whether the context backend supports multisampled rendering to the on-screen surface without requirin...
virtual bool SupportsFramebufferFetch() const =0
Whether the context backend is able to support pipelines with shaders that read from the framebuffer ...
virtual bool SupportsReadFromResolve() const =0
Whether the context backend supports binding the current RenderPass attachments. This is supported if...
static std::unique_ptr< CircleContents > Make(std::unique_ptr< CircleGeometry > geometry, Color color, bool stroked)
void SetGeometry(GeometryResult geometry)
Set the pre-tessellated clip geometry.
void SetClipOperation(Entity::ClipOperation clip_op)
bool Render(const ContentContext &renderer, RenderPass &pass, uint32_t clip_depth) const
static std::shared_ptr< ColorFilterContents > MakeBlend(BlendMode blend_mode, FilterInput::Vector inputs, std::optional< Color > foreground_color=std::nullopt)
the [inputs] are expected to be in the order of dst, src.
const Capabilities & GetDeviceCapabilities() const
const std::shared_ptr< RenderTargetAllocator > & GetRenderTargetCache() const
TextShadowCache & GetTextShadowCache() const
std::shared_ptr< Context > GetContext() const
A geometry that implements "drawPaint" like behavior by covering the entire render pass area.
A Geometry class that can directly generate vertices (with or without texture coordinates) for filled...
void SetTransform(const Matrix &transform)
Set the global transform matrix for this Entity.
Definition: entity.cc:62
std::optional< Rect > GetCoverage() const
Definition: entity.cc:66
const std::shared_ptr< Contents > & GetContents() const
Definition: entity.cc:78
void SetClipDepth(uint32_t clip_depth)
Definition: entity.cc:82
BlendMode GetBlendMode() const
Definition: entity.cc:102
void SetContents(std::shared_ptr< Contents > contents)
Definition: entity.cc:74
void SetBlendMode(BlendMode blend_mode)
Definition: entity.cc:98
bool Render(const ContentContext &renderer, RenderPass &parent_pass) const
Definition: entity.cc:145
const Matrix & GetTransform() const
Get the global transform matrix for this Entity.
Definition: entity.cc:46
static constexpr BlendMode kLastPipelineBlendMode
Definition: entity.h:28
static bool IsBlendModeDestructive(BlendMode blend_mode)
Returns true if the blend mode is "destructive", meaning that even fully transparent source colors wo...
Definition: entity.cc:128
A class that tracks all clips that have been recorded in the current entity pass stencil.
std::optional< Rect > CurrentClipCoverage() const
void PushSubpass(std::optional< Rect > subpass_coverage, size_t clip_height)
ClipStateResult RecordClip(const ClipContents &clip_contents, Matrix transform, Point global_pass_position, uint32_t clip_depth, size_t clip_height_floor, bool is_aa)
ClipStateResult RecordRestore(Point global_pass_position, size_t restore_height)
A Geometry that produces fillable vertices for the gap between a pair of |RoundRect| objects using th...
A Geometry that produces fillable vertices from a |DlPath| object using the |FillPathSourceGeometry| ...
A Geometry class that produces fillable vertices from any |RoundRect| object regardless of radii unif...
@ kNormal
Blurred inside and outside.
@ kOuter
Nothing inside, blurred outside.
@ kInner
Blurred inside, nothing outside.
@ kSolid
Solid inside, blurred outside.
std::shared_ptr< FilterInput > Ref
Definition: filter_input.h:32
static FilterInput::Ref Make(Variant input, bool msaa_enabled=true)
Definition: filter_input.cc:19
std::vector< FilterInput::Ref > Vector
Definition: filter_input.h:33
static std::unique_ptr< Geometry > MakeRect(const Rect &rect)
Definition: geometry.cc:83
virtual GeometryResult GetPositionBuffer(const ContentContext &renderer, const Entity &entity, RenderPass &pass) const =0
virtual bool CanApplyMaskFilter() const
Definition: geometry.cc:144
virtual std::optional< Rect > GetCoverage(const Matrix &transform) const =0
virtual bool IsAxisAlignedRect() const
Definition: geometry.cc:140
bool EndPass(bool is_onscreen=false)
std::shared_ptr< Texture > GetTexture()
const std::shared_ptr< RenderPass > & GetRenderPass()
bool IsApplyingClearColor() const
Whether or not the clear color texture can still be updated.
Definition: canvas.cc:2161
EntityPassTarget * GetEntityPassTarget() const
Definition: canvas.cc:2165
InlinePassContext * GetInlinePassContext() const
Definition: canvas.cc:2169
static std::unique_ptr< LineContents > Make(std::unique_ptr< LineGeometry > geometry, Color color)
A geometry class specialized for Canvas::DrawPoints.
ColorAttachment GetColorAttachment(size_t index) const
Get the color attachment at [index].
RenderTarget & SetColorAttachment(const ColorAttachment &attachment, size_t index)
ISize GetRenderTargetSize() const
const std::optional< DepthAttachment > & GetDepthAttachment() const
const std::optional< StencilAttachment > & GetStencilAttachment() const
void SetupDepthStencilAttachments(const Context &context, Allocator &allocator, ISize size, bool msaa, std::string_view label="Offscreen", RenderTarget::AttachmentConfig stencil_attachment_config=RenderTarget::kDefaultStencilAttachmentConfig, const std::shared_ptr< Texture > &depth_stencil_texture=nullptr)
A Geometry class that generates fillable vertices (with or without texture coordinates) directly from...
A Geometry class that generates fillable vertices (with or without texture coordinates) directly from...
A Geometry that produces fillable vertices representing the stroked outline of a |DlPath| object usin...
A Geometry that produces fillable vertices representing the stroked outline of a pair of nested |Roun...
A Geometry class that produces fillable vertices representing the stroked outline of an ellipse with ...
A Geometry that produces fillable vertices representing the stroked outline of a |DlPath| object usin...
A Geometry class that produces fillable vertices representing the stroked outline of any |Roundrect| ...
A Geometry class that produces fillable vertices representing the stroked outline of any |RoundSupere...
std::optional< Entity > Lookup(const ContentContext &renderer, const Entity &entity, const std::shared_ptr< FilterContents > &contents, const TextShadowCacheKey &)
Lookup the entity in the cache with the given filter/text contents, returning the new entity to rende...
static std::shared_ptr< TextureContents > MakeRect(Rect destination)
ISize subpass_size
The output size of the down-sampling pass.
impeller::SamplerDescriptor ToSamplerDescriptor(const flutter::DlImageSampling options)
Color ToColor(const flutter::DlColor &color)
static constexpr Scalar kMaxTextScale
Definition: canvas.cc:1701
std::shared_ptr< ColorFilterContents > WrapWithGPUColorFilter(const flutter::DlColorFilter *filter, const std::shared_ptr< FilterInput > &input, ColorFilterContents::AbsorbOpacity absorb_opacity)
Definition: color_filter.cc:24
TRect< int32_t > IRect32
Definition: rect.h:789
float Scalar
Definition: scalar.h:19
SourceRectConstraint
Controls the behavior of the source rectangle given to DrawImageRect.
Definition: canvas.h:74
@ kStrict
Sample only within the source rectangle. May be slower.
std::shared_ptr< FilterContents > WrapInput(const flutter::DlImageFilter *filter, const FilterInput::Ref &input)
Generate a new FilterContents using this filter's configuration.
Definition: image_filter.cc:18
constexpr float kEhCloseEnough
Definition: constants.h:57
std::shared_ptr< ColorFilterContents > WrapWithInvertColors(const std::shared_ptr< FilterInput > &input, ColorFilterContents::AbsorbOpacity absorb_opacity)
Definition: color_filter.cc:16
TRect< Scalar > Rect
Definition: rect.h:788
PointStyle
Definition: canvas.h:65
@ kRound
Points are drawn as squares.
TPoint< Scalar > Point
Definition: point.h:327
ColorFilterProc GetCPUColorFilterProc(const flutter::DlColorFilter *filter)
Definition: color_filter.cc:66
flutter::DlPath DlPath
Definition: dl_dispatcher.h:29
BlendMode
Definition: color.h:58
ContentBoundsPromise
Definition: canvas.h:84
@ kMayClipContents
The caller claims the bounds are a subset of an estimate of the reasonably tight bounds but likely cl...
@ kContainsContents
The caller claims the bounds are a reasonably tight estimate of the coverage of the contents and shou...
TSize< Scalar > Size
Definition: size.h:159
static constexpr const ColorMatrix kColorInversion
A color matrix which inverts colors.
Definition: color_filter.h:16
std::optional< Rect > ComputeSaveLayerCoverage(const Rect &content_coverage, const Matrix &effect_transform, const Rect &coverage_limit, const std::shared_ptr< FilterContents > &image_filter, bool flood_output_coverage, bool flood_input_coverage)
Compute the coverage of a subpass in the global coordinate space.
ISize64 ISize
Definition: size.h:162
Definition: comparable.h:95
constexpr bool IncludeCenter() const
Definition: arc.h:110
constexpr bool IsFullCircle() const
Definition: arc.h:114
const Rect & GetOvalBounds() const
Return the bounds of the oval in which this arc is inscribed.
Definition: arc.h:94
constexpr Degrees GetSweep() const
Definition: arc.h:108
constexpr Degrees GetStart() const
Definition: arc.h:106
LoadAction load_action
Definition: formats.h:663
std::shared_ptr< Texture > texture
Definition: formats.h:661
std::shared_ptr< Texture > texture_slot
Definition: canvas.h:43
size_t backdrop_count
Definition: canvas.h:41
std::optional< Snapshot > shared_filter_snapshot
Definition: canvas.h:46
Definition: canvas.h:50
size_t clip_height
Definition: canvas.h:53
bool did_round_out
Definition: canvas.h:62
Entity::RenderingMode rendering_mode
Definition: canvas.h:57
Matrix transform
Definition: canvas.h:51
uint32_t clip_depth
Definition: canvas.h:52
static constexpr Color BlackTransparent()
Definition: color.h:270
static constexpr Color Khaki()
Definition: color.h:518
Scalar alpha
Definition: color.h:143
static constexpr Color White()
Definition: color.h:264
constexpr Color WithAlpha(Scalar new_alpha) const
Definition: color.h:278
Scalar array[20]
Definition: color.h:118
A 4x4 matrix using column-major storage.
Definition: matrix.h:37
static constexpr Matrix MakeTranslation(const Vector3 &t)
Definition: matrix.h:95
Matrix Invert() const
Definition: matrix.cc:99
static constexpr Matrix MakeSkew(Scalar sx, Scalar sy)
Definition: matrix.h:127
static constexpr Matrix MakeTranslateScale(const Vector3 &s, const Vector3 &t)
Definition: matrix.h:113
static Matrix MakeRotationZ(Radians r)
Definition: matrix.h:223
static constexpr Matrix MakeScale(const Vector3 &s)
Definition: matrix.h:104
Scalar GetMaxBasisLengthXY() const
Return the maximum scale applied specifically to either the X axis or Y axis unit vectors (the bases)...
Definition: matrix.h:328
std::shared_ptr< Contents > WithFilters(std::shared_ptr< Contents > input) const
Wrap this paint's configured filters to the given contents.
Definition: paint.cc:278
const flutter::DlColorFilter * color_filter
Definition: paint.h:77
const flutter::DlColorSource * color_source
Definition: paint.h:76
const flutter::DlImageFilter * image_filter
Definition: paint.h:78
Style style
Definition: paint.h:81
bool invert_colors
Definition: paint.h:83
static bool CanApplyOpacityPeephole(const Paint &paint)
Whether or not a save layer with the provided paint can perform the opacity peephole optimization.
Definition: paint.h:40
std::optional< MaskBlurDescriptor > mask_blur_descriptor
Definition: paint.h:85
Color color
Definition: paint.h:75
BlendMode blend_mode
Definition: paint.h:82
std::shared_ptr< FilterContents > WithImageFilter(const FilterInput::Variant &input, const Matrix &effect_transform, Entity::RenderingMode rendering_mode) const
Definition: paint.cc:312
StrokeParameters stroke
Definition: paint.h:80
std::shared_ptr< ColorSourceContents > CreateContents() const
Definition: paint.cc:62
bool HasColorFilter() const
Whether this paint has a color filter that can apply opacity.
Definition: paint.cc:469
constexpr const RoundingRadii & GetRadii() const
Definition: round_rect.h:55
constexpr const Rect & GetBounds() const
Definition: round_rect.h:53
constexpr const RoundingRadii & GetRadii() const
constexpr const Rect & GetBounds() const
Represents a texture and its intended draw transform/sampler configuration.
Definition: snapshot.h:24
Matrix transform
The transform that should be applied to this texture for rendering.
Definition: snapshot.h:27
std::shared_ptr< Texture > texture
Definition: snapshot.h:25
SamplerDescriptor sampler_descriptor
Definition: snapshot.h:29
constexpr Type GetDistance(const TPoint &p) const
Definition: point.h:200
constexpr TRect< T > Expand(T left, T top, T right, T bottom) const
Returns a rectangle with expanded edges. Negative expansion results in shrinking.
Definition: rect.h:618
constexpr auto GetBottom() const
Definition: rect.h:357
constexpr TRect TransformBounds(const Matrix &transform) const
Creates a new bounding box that contains this transformed rectangle.
Definition: rect.h:472
constexpr auto GetTop() const
Definition: rect.h:353
constexpr Type GetHeight() const
Returns the height of the rectangle, equivalent to |GetSize().height|.
Definition: rect.h:347
constexpr TPoint< Type > GetOrigin() const
Returns the upper left corner of the rectangle as specified by the left/top or x/y values when it was...
Definition: rect.h:320
constexpr std::optional< TRect > Intersection(const TRect &o) const
Definition: rect.h:528
constexpr bool IsEmpty() const
Returns true if either of the width or height are 0, negative, or NaN.
Definition: rect.h:297
constexpr static TRect MakeOriginSize(const TPoint< Type > &origin, const TSize< Type > &size)
Definition: rect.h:144
constexpr auto GetLeft() const
Definition: rect.h:351
constexpr TSize< Type > GetSize() const
Returns the size of the rectangle which may be negative in either width or height and may have been c...
Definition: rect.h:327
Round(const TRect< U > &r)
Definition: rect.h:695
RoundOut(const TRect< U > &r)
Definition: rect.h:679
constexpr auto GetRight() const
Definition: rect.h:355
constexpr bool IsSquare() const
Returns true if width and height are equal and neither is NaN.
Definition: rect.h:304
constexpr static TRect MakeXYWH(Type x, Type y, Type width, Type height)
Definition: rect.h:136
constexpr TRect< T > Shift(T dx, T dy) const
Returns a new rectangle translated by the given offset.
Definition: rect.h:602
constexpr static TRect MakeSize(const TSize< U > &size)
Definition: rect.h:150
constexpr Type GetWidth() const
Returns the width of the rectangle, equivalent to |GetSize().width|.
Definition: rect.h:341
constexpr Point GetCenter() const
Get the center point as a |Point|.
Definition: rect.h:382
constexpr static TRect MakeLTRB(Type left, Type top, Type right, Type bottom)
Definition: rect.h:129
constexpr static TRect MakeMaximum()
Definition: rect.h:188
constexpr bool IsEmpty() const
Returns true if either of the width or height are 0, negative, or NaN.
Definition: size.h:123
std::vector< Point > points
#define VALIDATION_LOG
Definition: validation.h:91