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