Flutter Impeller
impeller::Paint Struct Reference

#include <paint.h>

Classes

struct  MaskBlurDescriptor
 

Public Types

enum  Style {
  Style::kFill,
  Style::kStroke
}
 
using ImageFilterProc = std::function< std::shared_ptr< FilterContents >(FilterInput::Ref, const Matrix &effect_transform, Entity::RenderingMode rendering_mode)>
 
using MaskFilterProc = std::function< std::shared_ptr< FilterContents >(FilterInput::Ref, bool is_solid_color, const Matrix &effect_transform)>
 
using ColorSourceProc = std::function< std::shared_ptr< ColorSourceContents >()>
 

Public Member Functions

std::shared_ptr< ColorFilterGetColorFilter () const
 
std::shared_ptr< ContentsWithFilters (std::shared_ptr< Contents > input) const
 Wrap this paint's configured filters to the given contents. More...
 
std::shared_ptr< ContentsWithFiltersForSubpassTarget (std::shared_ptr< Contents > input, const Matrix &effect_transform=Matrix()) const
 Wrap this paint's configured filters to the given contents of subpass target. More...
 
std::shared_ptr< ContentsCreateContentsForGeometry (const std::shared_ptr< Geometry > &geometry) const
 
bool HasColorFilter () const
 Whether this paint has a color filter that can apply opacity. More...
 
std::shared_ptr< ContentsWithMaskBlur (std::shared_ptr< Contents > input, bool is_solid_color) const
 
std::shared_ptr< FilterContentsWithImageFilter (const FilterInput::Variant &input, const Matrix &effect_transform, Entity::RenderingMode rendering_mode) const
 

Public Attributes

Color color = Color::Black()
 
ColorSource color_source
 
bool dither = false
 
Scalar stroke_width = 0.0
 
Cap stroke_cap = Cap::kButt
 
Join stroke_join = Join::kMiter
 
Scalar stroke_miter = 4.0
 
Style style = Style::kFill
 
BlendMode blend_mode = BlendMode::kSourceOver
 
bool invert_colors = false
 
std::shared_ptr< ImageFilterimage_filter
 
std::shared_ptr< ColorFiltercolor_filter
 
std::optional< MaskBlurDescriptormask_blur_descriptor
 

Detailed Description

Definition at line 23 of file paint.h.

Member Typedef Documentation

◆ ColorSourceProc

using impeller::Paint::ColorSourceProc = std::function<std::shared_ptr<ColorSourceContents>()>

Definition at line 32 of file paint.h.

◆ ImageFilterProc

using impeller::Paint::ImageFilterProc = std::function<std::shared_ptr<FilterContents>( FilterInput::Ref, const Matrix& effect_transform, Entity::RenderingMode rendering_mode)>

Definition at line 27 of file paint.h.

◆ MaskFilterProc

using impeller::Paint::MaskFilterProc = std::function<std::shared_ptr<FilterContents>( FilterInput::Ref, bool is_solid_color, const Matrix& effect_transform)>

Definition at line 31 of file paint.h.

Member Enumeration Documentation

◆ Style

Enumerator
kFill 
kStroke 

Definition at line 34 of file paint.h.

34  {
35  kFill,
36  kStroke,
37  };

Member Function Documentation

◆ CreateContentsForGeometry()

std::shared_ptr< Contents > impeller::Paint::CreateContentsForGeometry ( const std::shared_ptr< Geometry > &  geometry) const

Definition at line 30 of file paint.cc.

31  {
32  auto contents = color_source.GetContents(*this);
33 
34  // Attempt to apply the color filter on the CPU first.
35  // Note: This is not just an optimization; some color sources rely on
36  // CPU-applied color filters to behave properly.
38  bool needs_color_filter = !!color_filter;
39  if (color_filter &&
40  contents->ApplyColorFilter(color_filter->GetCPUColorFilterProc())) {
41  needs_color_filter = false;
42  }
43 
44  contents->SetGeometry(geometry);
45  if (mask_blur_descriptor.has_value()) {
46  // If there's a mask blur and we need to apply the color filter on the GPU,
47  // we need to be careful to only apply the color filter to the source
48  // colors. CreateMaskBlur is able to handle this case.
49  return mask_blur_descriptor->CreateMaskBlur(
50  contents, needs_color_filter ? color_filter : nullptr);
51  }
52 
53  return contents;
54 }

References color_filter, color_source, GetColorFilter(), impeller::ColorSource::GetContents(), and mask_blur_descriptor.

◆ GetColorFilter()

std::shared_ptr< ColorFilter > impeller::Paint::GetColorFilter ( ) const

Definition at line 213 of file paint.cc.

213  {
214  if (invert_colors && color_filter) {
216  return ColorFilter::MakeComposed(filter, color_filter);
217  }
218  if (invert_colors) {
220  }
221  if (color_filter) {
222  return color_filter;
223  }
224  return nullptr;
225 }

References color_filter, invert_colors, impeller::kColorInversion, impeller::ColorFilter::MakeComposed(), and impeller::ColorFilter::MakeMatrix().

Referenced by CreateContentsForGeometry().

◆ HasColorFilter()

bool impeller::Paint::HasColorFilter ( ) const

Whether this paint has a color filter that can apply opacity.

Definition at line 227 of file paint.cc.

227  {
228  return !!color_filter || invert_colors;
229 }

References color_filter, and invert_colors.

Referenced by impeller::Canvas::DrawImageRect(), and impeller::testing::TEST_P().

◆ WithFilters()

std::shared_ptr< Contents > impeller::Paint::WithFilters ( std::shared_ptr< Contents input) const

Wrap this paint's configured filters to the given contents.

Parameters
[in]inputThe contents to wrap with paint's filters.
Returns
The filter-wrapped contents. If there are no filters that need to be wrapped for the current paint configuration, the original contents is returned.

Definition at line 56 of file paint.cc.

57  {
58  input = WithColorFilter(input, ColorFilterContents::AbsorbOpacity::kYes);
59  auto image_filter =
61  if (image_filter) {
62  input = image_filter;
63  }
64  return input;
65 }

References image_filter, impeller::Entity::kDirect, impeller::ColorFilterContents::kYes, and WithImageFilter().

Referenced by impeller::Canvas::DrawAtlas(), impeller::Canvas::DrawImageRect(), impeller::Canvas::DrawTextFrame(), and impeller::Canvas::DrawVertices().

◆ WithFiltersForSubpassTarget()

std::shared_ptr< Contents > impeller::Paint::WithFiltersForSubpassTarget ( std::shared_ptr< Contents input,
const Matrix effect_transform = Matrix() 
) const

Wrap this paint's configured filters to the given contents of subpass target.

Parameters
[in]inputThe contents of subpass target to wrap with paint's filters.
Returns
The filter-wrapped contents. If there are no filters that need to be wrapped for the current paint configuration, the original contents is returned.

Definition at line 67 of file paint.cc.

69  {
70  auto image_filter =
71  WithImageFilter(input, effect_transform, Entity::RenderingMode::kSubpass);
72  if (image_filter) {
73  input = image_filter;
74  }
75  input = WithColorFilter(input, ColorFilterContents::AbsorbOpacity::kYes);
76  return input;
77 }

References image_filter, impeller::Entity::kSubpass, impeller::ColorFilterContents::kYes, and WithImageFilter().

Referenced by impeller::PaintPassDelegate::CreateContentsForSubpassTarget().

◆ WithImageFilter()

std::shared_ptr< FilterContents > impeller::Paint::WithImageFilter ( const FilterInput::Variant input,
const Matrix effect_transform,
Entity::RenderingMode  rendering_mode 
) const

Definition at line 88 of file paint.cc.

91  {
92  if (!image_filter) {
93  return nullptr;
94  }
95  auto filter = image_filter->WrapInput(FilterInput::Make(input));
96  filter->SetRenderingMode(rendering_mode);
97  filter->SetEffectTransform(effect_transform);
98  return filter;
99 }

References image_filter, and impeller::FilterInput::Make().

Referenced by WithFilters(), WithFiltersForSubpassTarget(), and impeller::PaintPassDelegate::WithImageFilter().

◆ WithMaskBlur()

std::shared_ptr< Contents > impeller::Paint::WithMaskBlur ( std::shared_ptr< Contents input,
bool  is_solid_color 
) const

Definition at line 79 of file paint.cc.

80  {
81  if (mask_blur_descriptor.has_value()) {
82  input = mask_blur_descriptor->CreateMaskBlur(FilterInput::Make(input),
83  is_solid_color);
84  }
85  return input;
86 }

References impeller::FilterInput::Make(), and mask_blur_descriptor.

Referenced by impeller::Canvas::DrawTextFrame().

Member Data Documentation

◆ blend_mode

◆ color

◆ color_filter

◆ color_source

◆ dither

◆ image_filter

◆ invert_colors

bool impeller::Paint::invert_colors = false

◆ mask_blur_descriptor

◆ stroke_cap

◆ stroke_join

Join impeller::Paint::stroke_join = Join::kMiter

Definition at line 61 of file paint.h.

Referenced by impeller::DlDispatcher::setStrokeJoin(), and impeller::testing::TEST_P().

◆ stroke_miter

Scalar impeller::Paint::stroke_miter = 4.0

Definition at line 62 of file paint.h.

Referenced by impeller::DlDispatcher::setStrokeMiter().

◆ stroke_width

◆ style


The documentation for this struct was generated from the following files:
impeller::ColorSource::GetContents
std::shared_ptr< ColorSourceContents > GetContents(const Paint &paint) const
Definition: color_source.cc:234
impeller::FilterInput::Make
static FilterInput::Ref Make(Variant input, bool msaa_enabled=true)
Definition: filter_input.cc:19
impeller::ColorFilter::MakeComposed
static std::shared_ptr< ColorFilter > MakeComposed(const std::shared_ptr< ColorFilter > &outer, const std::shared_ptr< ColorFilter > &inner)
Definition: color_filter.cc:40
impeller::Paint::color_source
ColorSource color_source
Definition: paint.h:56
impeller::PolygonMode::kFill
@ kFill
impeller::Paint::color_filter
std::shared_ptr< ColorFilter > color_filter
Definition: paint.h:68
impeller::kColorInversion
constexpr ColorMatrix kColorInversion
A color matrix which inverts colors.
Definition: paint.cc:20
impeller::Paint::GetColorFilter
std::shared_ptr< ColorFilter > GetColorFilter() const
Definition: paint.cc:213
impeller::Entity::RenderingMode::kDirect
@ kDirect
impeller::Entity::RenderingMode::kSubpass
@ kSubpass
impeller::ColorFilter::MakeMatrix
static std::shared_ptr< ColorFilter > MakeMatrix(ColorMatrix color_matrix)
Definition: color_filter.cc:28
impeller::Paint::WithImageFilter
std::shared_ptr< FilterContents > WithImageFilter(const FilterInput::Variant &input, const Matrix &effect_transform, Entity::RenderingMode rendering_mode) const
Definition: paint.cc:88
impeller::Paint::invert_colors
bool invert_colors
Definition: paint.h:65
impeller::ColorFilterContents::AbsorbOpacity::kYes
@ kYes
impeller::Paint::mask_blur_descriptor
std::optional< MaskBlurDescriptor > mask_blur_descriptor
Definition: paint.h:69
impeller::Paint::image_filter
std::shared_ptr< ImageFilter > image_filter
Definition: paint.h:67