| Flutter Impeller |

Public Member Functions | List of all members
impeller::SweepGradientContents Class Referencefinal

`#include <sweep_gradient_contents.h>`

Inheritance diagram for impeller::SweepGradientContents:

## Public Member Functions
| SweepGradientContents ()
| ~SweepGradientContents () override
bool | IsOpaque () const override
| Whether this Contents only emits opaque source colors from the fragment stage. This value does not account for any entity properties (e.g. the blend mode), clips/visibility culling, or inherited opacity. More...
bool | Render (const ContentContext &renderer, const Entity &entity, RenderPass &pass) const override
bool | ApplyColorFilter (const ColorFilterProc &color_filter_proc) override
| If possible, applies a color filter to this contents inputs on the CPU. More...
void | SetCenterAndAngles (Point center, Degrees start_angle, Degrees end_angle)
void | SetColors (std::vector< Color > colors)
void | SetStops (std::vector< Scalar > stops)
void | SetTileMode (Entity::TileMode tile_mode)
void | SetDither (bool dither)
const std::vector< Color > & | GetColors () const
const std::vector< Scalar > & | GetStops () const
Public Member Functions inherited from impeller::ColorSourceContents
| ColorSourceContents ()
| ~ColorSourceContents () override
void | SetGeometry (std::shared_ptr< Geometry > geometry)
| Set the geometry that this contents will use to render. More...
const std::shared_ptr< Geometry > & | GetGeometry () const
| Get the geometry that this contents will use to render. More...
void | SetEffectTransform (Matrix matrix)
| Set the effect transform for this color source. More...
const Matrix & | GetInverseEffectTransform () const
| Set the inverted effect transform for this color source. More...
void | SetOpacityFactor (Scalar opacity)
| Set the opacity factor for this color source. More...
Scalar | GetOpacityFactor () const
| Get the opacity factor for this color source. More...
virtual bool | IsSolidColor () const
std::optional< Rect > | GetCoverage (const Entity &entity) const override
| Get the screen space bounding rectangle that this contents affects. More...
bool | CanInheritOpacity (const Entity &entity) const override
| Whether or not this contents can accept the opacity peephole optimization. More...
void | SetInheritedOpacity (Scalar opacity) override
| Inherit the provided opacity. More...
Public Member Functions inherited from impeller::Contents
| Contents ()
virtual | ~Contents ()
virtual void | PopulateGlyphAtlas (const std::shared_ptr< LazyGlyphAtlas > &lazy_glyph_atlas, Scalar scale)
| Add any text data to the specified lazy atlas. The scale parameter must be used again later when drawing the text. More...
void | SetCoverageHint (std::optional< Rect > coverage_hint)
| Hint that specifies the coverage area of this Contents that will actually be used during rendering. This is for optimization purposes only and can not be relied on as a clip. May optionally affect the result of `GetCoverage()`. More...
const std::optional< Rect > & | GetCoverageHint () const
virtual StencilCoverage | GetStencilCoverage (const Entity &entity, const std::optional< Rect > &current_stencil_coverage) const
| Given the current screen space bounding rectangle of the stencil, return the expected stencil coverage after this draw call. This should only be implemented for contents that may write to the stencil buffer. More...
virtual std::optional< Snapshot > | RenderToSnapshot (const ContentContext &renderer, const Entity &entity, std::optional< Rect > coverage_limit=std::nullopt, const std::optional< SamplerDescriptor > &sampler_descriptor=std::nullopt, bool msaa_enabled=true, const std::string &label="Snapshot") const
| Render this contents to a snapshot, respecting the entity's transform, path, stencil depth, and blend mode. The result texture size is always the size of `GetCoverage(entity)`. More...
virtual bool | ShouldRender (const Entity &entity, const std::optional< Rect > &stencil_coverage) const
std::optional< Size > | GetColorSourceSize () const
| Return the color source's intrinsic size, if available. More...
void | SetColorSourceSize (Size size)
virtual std::optional< Color > | AsBackgroundColor (const Entity &entity, ISize target_size) const
| Returns a color if this Contents will flood the given `target_size` with a color. This output color is the "Source" color that will be used for the Entity's blend operation. More...
virtual const FilterContents * | AsFilter () const
| Cast to a filter. Returns `nullptr` if this Contents is not a filter. More...

## Additional Inherited Members
Public Types inherited from impeller::Contents
using | ColorFilterProc = std::function< Color(Color)>
using | RenderProc = std::function< bool(const ContentContext &renderer, const Entity &entity, RenderPass &pass)>
using | CoverageProc = std::function< std::optional< Rect >(const Entity &entity)>
Static Public Member Functions inherited from impeller::Contents
static std::shared_ptr< Contents > | MakeAnonymous (RenderProc render_proc, CoverageProc coverage_proc)

## Detailed Description

Definition at line 22 of file sweep_gradient_contents.h.

## Constructor & Destructor Documentation

## ◆ SweepGradientContents()

impeller::SweepGradientContents::SweepGradientContents | ( |  | ) |
| default

## ◆ ~SweepGradientContents()

impeller::SweepGradientContents::~SweepGradientContents | ( |  | ) |
| override default

## Member Function Documentation

## ◆ ApplyColorFilter()

bool impeller::SweepGradientContents::ApplyColorFilter | ( | const ColorFilterProc & | color_filter_proc | ) |
| override virtual

If possible, applies a color filter to this contents inputs on the CPU.

This method will either fully apply the color filter or perform no action. Partial/incorrect application of the color filter will never occur.

Parameters

  [in] | color_filter_proc | A function that filters a given unpremultiplied color to produce a new unpremultiplied color.

Returns
  True if the color filter was able to be fully applied to all all relevant inputs. Otherwise, this operation is a no-op and false is returned.

Reimplemented from impeller::Contents.

Definition at line 202 of file sweep_gradient_contents.cc.

203 {
204 for (Color& color : colors_) {
205 color = color_filter_proc(color);
206 }
207 decal_border_color_ = color_filter_proc(decal_border_color_);
208 return true;
209 }

## ◆ GetColors()

const std::vector< Color > & impeller::SweepGradientContents::GetColors | ( |  | ) | const

Definition at line 49 of file sweep_gradient_contents.cc.

49 {
50 return colors_;
51 }

## ◆ GetStops()

const std::vector< Scalar > & impeller::SweepGradientContents::GetStops | ( |  | ) | const

Definition at line 53 of file sweep_gradient_contents.cc.

53 {
54 return stops_;
55 }

## ◆ IsOpaque()

bool impeller::SweepGradientContents::IsOpaque | ( |  | ) | const
| override virtual

Whether this Contents only emits opaque source colors from the fragment stage. This value does not account for any entity properties (e.g. the blend mode), clips/visibility culling, or inherited opacity.

Reimplemented from impeller::Contents.

Definition at line 57 of file sweep_gradient_contents.cc.

57 {
58 if (GetOpacityFactor() < 1 || tile_mode_ == Entity::TileMode::kDecal) {
59 return false;
60 }
61 for (auto color : colors_) {
62 if (!color.IsOpaque()) {
63 return false;
64 }
65 }
66 return true;
67 }

References impeller::ColorSourceContents::GetOpacityFactor(), and impeller::Entity::kDecal.

## ◆ Render()

bool impeller::SweepGradientContents::Render | ( | const ContentContext & | renderer,
|  | const Entity & | entity,
|  | RenderPass & | pass
| ) |  | const
| override virtual

Implements impeller::Contents.

Definition at line 69 of file sweep_gradient_contents.cc.

71 {
72 if (renderer.GetDeviceCapabilities().SupportsSSBO()) {
73 return RenderSSBO(renderer, entity, pass);
74 }
75 return RenderTexture(renderer, entity, pass);
76 }

References impeller::ContentContext::GetDeviceCapabilities(), and impeller::Capabilities::SupportsSSBO().

## ◆ SetCenterAndAngles()

void impeller::SweepGradientContents::SetCenterAndAngles | ( | Point | center,
|  | Degrees | start_angle,
|  | Degrees | end_angle
| ) |  |

Definition at line 22 of file sweep_gradient_contents.cc.

24 {
25 center_ = center;
26 Scalar t0 = start_angle.degrees / 360;
27 Scalar t1 = end_angle.degrees / 360;
28 FML_DCHECK(t0 < t1);
29 bias_ = -t0;
30 scale_ = 1 / (t1 - t0);
31 }

References impeller::Degrees::degrees.

## ◆ SetColors()

void impeller::SweepGradientContents::SetColors | ( | std::vector< Color > | colors | ) |

Definition at line 33 of file sweep_gradient_contents.cc.

33 {
34 colors_ = std::move(colors);
35 }

## ◆ SetDither()

void impeller::SweepGradientContents::SetDither | ( | bool | dither | ) |

Definition at line 45 of file sweep_gradient_contents.cc.

45 {
46 dither_ = dither;
47 }

## ◆ SetStops()

void impeller::SweepGradientContents::SetStops | ( | std::vector< Scalar > | stops | ) |

Definition at line 37 of file sweep_gradient_contents.cc.

37 {
38 stops_ = std::move(stops);
39 }

## ◆ SetTileMode()

void impeller::SweepGradientContents::SetTileMode | ( | Entity::TileMode | tile_mode | ) |

Definition at line 41 of file sweep_gradient_contents.cc.

41 {
42 tile_mode_ = tile_mode;
43 }

The documentation for this class was generated from the following files:

- impeller/entity/contents/sweep_gradient_contents.h
- impeller/entity/contents/sweep_gradient_contents.cc

impeller::ColorSourceContents::GetOpacityFactor
Scalar GetOpacityFactor() const
Get the opacity factor for this color source.
Definition: color_source_contents.cc:29
impeller::Scalar
float Scalar
Definition: scalar.h:15
impeller::Entity::TileMode::kDecal
@ kDecal