A filter that applies a runtime effect shader. More...

#include <runtime_effect_filter_contents.h>

Inheritance diagram for impeller::RuntimeEffectFilterContents:

Public Member Functions
	RuntimeEffectFilterContents ()

	~RuntimeEffectFilterContents ()=default

void	SetRuntimeStage (std::shared_ptr< RuntimeStage > runtime_stage)

void	SetUniforms (std::shared_ptr< std::vector< uint8_t >> uniforms)

void	SetTextureInputs (std::vector< RuntimeEffectContents::TextureInput > texture_inputs)

Public Member Functions inherited from impeller::FilterContents
	FilterContents ()

	~FilterContents () override

void	SetInputs (FilterInput::Vector inputs)
	The input texture sources for this filter. Each input's emitted texture is expected to have premultiplied alpha colors. More...

void	SetEffectTransform (const Matrix &effect_transform)
	Sets the transform which gets appended to the effect of this filter. Note that this is in addition to the entity's transform. More...

std::optional< Entity >	GetEntity (const ContentContext &renderer, const Entity &entity, const std::optional< Rect > &coverage_hint) const
	Create an Entity that renders this filter's output. More...

bool	Render (const ContentContext &renderer, const Entity &entity, RenderPass &pass) const override

std::optional< Rect >	GetCoverage (const Entity &entity) const override
	Get the area of the render pass that will be affected when this contents is rendered. More...

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, int32_t mip_count=1, std::string_view label="Filter Snapshot") const override
	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...

std::optional< Rect >	GetSourceCoverage (const Matrix &effect_transform, const Rect &output_limit) const
	Determines the coverage of source pixels that will be needed to produce results for the specified \|output_limit\| under the specified \|effect_transform\|. This is essentially a reverse of the \|GetCoverage\| method computing a source coverage from an intended \|output_limit\| coverage. More...

virtual Matrix	GetLocalTransform (const Matrix &parent_transform) const

Matrix	GetTransform (const Matrix &parent_transform) const

virtual void	SetRenderingMode (Entity::RenderingMode rendering_mode)
	Marks this filter chain as applying in a subpass scenario. More...

Public Member Functions inherited from impeller::Contents
	Contents ()

virtual	~Contents ()

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 Matrix &transform) 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...

std::optional< Size >	GetColorSourceSize () const
	Return the color source's intrinsic size, if available. More...

void	SetColorSourceSize (Size size)

virtual void	SetInheritedOpacity (Scalar opacity)
	Inherit the provided opacity. More...

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 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::FilterContents
enum class	BlurStyle { kNormal , kSolid , kOuter , kInner }

enum class	MorphType { kDilate , kErode }

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::FilterContents
static std::shared_ptr< FilterContents >	MakeGaussianBlur (const FilterInput::Ref &input, Sigma sigma_x, Sigma sigma_y, Entity::TileMode tile_mode=Entity::TileMode::kDecal, BlurStyle mask_blur_style=BlurStyle::kNormal, const Geometry *mask_geometry=nullptr)

static std::shared_ptr< FilterContents >	MakeBorderMaskBlur (FilterInput::Ref input, Sigma sigma_x, Sigma sigma_y, BlurStyle blur_style=BlurStyle::kNormal)

static std::shared_ptr< FilterContents >	MakeDirectionalMorphology (FilterInput::Ref input, Radius radius, Vector2 direction, MorphType morph_type)

static std::shared_ptr< FilterContents >	MakeMorphology (FilterInput::Ref input, Radius radius_x, Radius radius_y, MorphType morph_type)

static std::shared_ptr< FilterContents >	MakeMatrixFilter (FilterInput::Ref input, const Matrix &matrix, const SamplerDescriptor &desc)

static std::shared_ptr< FilterContents >	MakeLocalMatrixFilter (FilterInput::Ref input, const Matrix &matrix)

static std::shared_ptr< FilterContents >	MakeYUVToRGBFilter (std::shared_ptr< Texture > y_texture, std::shared_ptr< Texture > uv_texture, YUVColorSpace yuv_color_space)

static std::shared_ptr< FilterContents >	MakeRuntimeEffect (FilterInput::Ref input, std::shared_ptr< RuntimeStage > runtime_stage, std::shared_ptr< std::vector< uint8_t >> uniforms, std::vector< RuntimeEffectContents::TextureInput > texture_inputs)

Static Public Member Functions inherited from impeller::Contents
static std::shared_ptr< Contents >	MakeAnonymous (RenderProc render_proc, CoverageProc coverage_proc)

Static Public Attributes inherited from impeller::FilterContents
static const int32_t	kBlurFilterRequiredMipCount

Detailed Description

A filter that applies a runtime effect shader.

Definition at line 13 of file runtime_effect_filter_contents.h.

Constructor & Destructor Documentation

◆ RuntimeEffectFilterContents()

impeller::RuntimeEffectFilterContents::RuntimeEffectFilterContents ( )

inline

Definition at line 15 of file runtime_effect_filter_contents.h.

15 {}

◆ ~RuntimeEffectFilterContents()

impeller::RuntimeEffectFilterContents::~RuntimeEffectFilterContents ( )

default

Member Function Documentation

◆ SetRuntimeStage()

void impeller::RuntimeEffectFilterContents::SetRuntimeStage ( std::shared_ptr< RuntimeStage > runtime_stage )

Definition at line 17 of file runtime_effect_filter_contents.cc.

                                                {
   runtime_stage_ = std::move(runtime_stage);
 }

◆ SetTextureInputs()

void impeller::RuntimeEffectFilterContents::SetTextureInputs ( std::vector< RuntimeEffectContents::TextureInput > texture_inputs )

Definition at line 27 of file runtime_effect_filter_contents.cc.

                                                                  {
   texture_inputs_ = std::move(texture_inputs);
 }

◆ SetUniforms()

void impeller::RuntimeEffectFilterContents::SetUniforms ( std::shared_ptr< std::vector< uint8_t >> uniforms )

Definition at line 22 of file runtime_effect_filter_contents.cc.

                                                 {
   uniforms_ = std::move(uniforms);
 }

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

impeller/entity/contents/filters/runtime_effect_filter_contents.h
impeller/entity/contents/filters/runtime_effect_filter_contents.cc

Public Member Functions

Additional Inherited Members