Flutter Engine
The Flutter Engine
Public Member Functions | List of all members
impeller::ConicalGradientContents Class Referencefinal

#include <conical_gradient_contents.h>

Inheritance diagram for impeller::ConicalGradientContents:
impeller::ColorSourceContents impeller::Contents

Public Member Functions

 ConicalGradientContents ()
 
 ~ConicalGradientContents () override
 
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 SetCenterAndRadius (Point center, Scalar radius)
 
void SetColors (std::vector< Color > colors)
 
void SetStops (std::vector< Scalar > stops)
 
const std::vector< Color > & GetColors () const
 
const std::vector< Scalar > & GetStops () const
 
void SetTileMode (Entity::TileMode tile_mode)
 
void SetFocus (std::optional< Point > focus, Scalar radius)
 
- 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 MatrixGetInverseEffectTransform () 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< RectGetCoverage (const Entity &entity) const override
 Get the area of the render pass that will be affected when this contents is rendered. 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...
 
virtual bool Render (const ContentContext &renderer, const Entity &entity, RenderPass &pass) const =0
 
virtual std::optional< RectGetCoverage (const Entity &entity) const =0
 Get the area of the render pass that will be affected when this contents is rendered. 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 bool IsOpaque () const
 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...
 
virtual ClipCoverage GetClipCoverage (const Entity &entity, const std::optional< Rect > &current_clip_coverage) const
 Given the current pass space bounding rectangle of the clip buffer, return the expected clip coverage after this draw call. This should only be implemented for contents that may write to the clip buffer. More...
 
virtual std::optional< SnapshotRenderToSnapshot (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, int32_t mip_count=1, const std::string &label="Snapshot") const
 Render this contents to a snapshot, respecting the entity's transform, path, clip 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 > clip_coverage) const
 
std::optional< SizeGetColorSourceSize () const
 Return the color source's intrinsic size, if available. More...
 
void SetColorSourceSize (Size size)
 
virtual bool CanInheritOpacity (const Entity &entity) const
 Whether or not this contents can accept the opacity peephole optimization. More...
 
virtual void SetInheritedOpacity (Scalar opacity)
 Inherit the provided opacity. More...
 
virtual std::optional< ColorAsBackgroundColor (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 FilterContentsAsFilter () const
 Cast to a filter. Returns nullptr if this Contents is not a filter. More...
 
virtual bool ApplyColorFilter (const ColorFilterProc &color_filter_proc)
 If possible, applies a color filter to this contents inputs on the CPU. 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< ContentsMakeAnonymous (RenderProc render_proc, CoverageProc coverage_proc)
 
- Protected Types inherited from impeller::ColorSourceContents
using BindFragmentCallback = std::function< bool(RenderPass &pass)>
 
using PipelineBuilderMethod = std::shared_ptr< Pipeline< PipelineDescriptor > >(impeller::ContentContext::*)(ContentContextOptions) const
 
using PipelineBuilderCallback = std::function< std::shared_ptr< Pipeline< PipelineDescriptor > >(ContentContextOptions)>
 
using CreateGeometryCallback = std::function< GeometryResult(const ContentContext &renderer, const Entity &entity, RenderPass &pass, const Geometry &geom)>
 
- Protected Member Functions inherited from impeller::ColorSourceContents
template<typename VertexShaderT >
bool DrawGeometry (const ContentContext &renderer, const Entity &entity, RenderPass &pass, const PipelineBuilderCallback &pipeline_callback, typename VertexShaderT::FrameInfo frame_info, const BindFragmentCallback &bind_fragment_callback, bool force_stencil=false, const CreateGeometryCallback &create_geom_callback=DefaultCreateGeometryCallback) const
 
- Static Protected Member Functions inherited from impeller::ColorSourceContents
static GeometryResult DefaultCreateGeometryCallback (const ContentContext &renderer, const Entity &entity, RenderPass &pass, const Geometry &geom)
 

Detailed Description

Definition at line 17 of file conical_gradient_contents.h.

Constructor & Destructor Documentation

◆ ConicalGradientContents()

impeller::ConicalGradientContents::ConicalGradientContents ( )
default

◆ ~ConicalGradientContents()

impeller::ConicalGradientContents::~ConicalGradientContents ( )
overridedefault

Member Function Documentation

◆ ApplyColorFilter()

bool impeller::ConicalGradientContents::ApplyColorFilter ( const ColorFilterProc color_filter_proc)
overridevirtual

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_procA 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 168 of file conical_gradient_contents.cc.

169 {
170 for (Color& color : colors_) {
171 color = color_filter_proc(color);
172 }
173 decal_border_color_ = color_filter_proc(decal_border_color_);
174 return true;
175}
DlColor color
SK_API sk_sp< SkShader > Color(SkColor)

◆ GetColors()

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

Definition at line 38 of file conical_gradient_contents.cc.

38 {
39 return colors_;
40}

◆ GetStops()

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

Definition at line 42 of file conical_gradient_contents.cc.

42 {
43 return stops_;
44}

◆ Render()

bool impeller::ConicalGradientContents::Render ( const ContentContext renderer,
const Entity entity,
RenderPass pass 
) const
overridevirtual

Implements impeller::Contents.

Definition at line 52 of file conical_gradient_contents.cc.

54 {
55 if (renderer.GetDeviceCapabilities().SupportsSSBO()) {
56 return RenderSSBO(renderer, entity, pass);
57 }
58 return RenderTexture(renderer, entity, pass);
59}

◆ SetCenterAndRadius()

void impeller::ConicalGradientContents::SetCenterAndRadius ( Point  center,
Scalar  radius 
)

Definition at line 21 of file conical_gradient_contents.cc.

21 {
22 center_ = center;
23 radius_ = radius;
24}

◆ SetColors()

void impeller::ConicalGradientContents::SetColors ( std::vector< Color colors)

Definition at line 30 of file conical_gradient_contents.cc.

30 {
31 colors_ = std::move(colors);
32}
PODArray< SkColor > colors
Definition: SkRecords.h:276

◆ SetFocus()

void impeller::ConicalGradientContents::SetFocus ( std::optional< Point focus,
Scalar  radius 
)

Definition at line 46 of file conical_gradient_contents.cc.

47 {
48 focus_ = focus;
49 focus_radius_ = radius;
50}

◆ SetStops()

void impeller::ConicalGradientContents::SetStops ( std::vector< Scalar stops)

Definition at line 34 of file conical_gradient_contents.cc.

34 {
35 stops_ = std::move(stops);
36}

◆ SetTileMode()

void impeller::ConicalGradientContents::SetTileMode ( Entity::TileMode  tile_mode)

Definition at line 26 of file conical_gradient_contents.cc.

26 {
27 tile_mode_ = tile_mode;
28}

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