#include <contents_filter_input.h>

Inheritance diagram for impeller::ContentsFilterInput:

Public Member Functions
	~ContentsFilterInput () override

std::optional< Snapshot >	GetSnapshot (std::string_view label, const ContentContext &renderer, const Entity &entity, std::optional< Rect > coverage_limit, int32_t mip_count) const override

std::optional< Rect >	GetCoverage (const Entity &entity) const override

Public Member Functions inherited from impeller::FilterInput
virtual	~FilterInput ()

std::optional< Rect >	GetLocalCoverage (const Entity &entity) const

virtual std::optional< Rect >	GetSourceCoverage (const Matrix &effect_transform, const Rect &output_limit) const

virtual Matrix	GetLocalTransform (const Entity &entity) const
	Get the local transform of this filter input. This transform is relative to the `Entity` transform space. More...

virtual Matrix	GetTransform (const Entity &entity) const
	Get the transform of this `FilterInput`. This is equivalent to calling `entity.GetTransform() * GetLocalTransform()`. More...

virtual void	SetEffectTransform (const Matrix &matrix)
	Sets the effect transform of filter inputs. More...

virtual void	SetRenderingMode (Entity::RenderingMode rendering_mode)
	Turns on subpass mode for filter inputs. More...

Additional Inherited Members
Public Types inherited from impeller::FilterInput
using	Ref = std::shared_ptr< FilterInput >

using	Vector = std::vector< FilterInput::Ref >

using	Variant = std::variant< std::shared_ptr< FilterContents >, std::shared_ptr< Contents >, std::shared_ptr< Texture >, Rect >

Static Public Member Functions inherited from impeller::FilterInput
static FilterInput::Ref	Make (Variant input, bool msaa_enabled=true)

static FilterInput::Ref	Make (std::shared_ptr< Texture > input, Matrix local_transform)

static FilterInput::Vector	Make (std::initializer_list< Variant > inputs)

Detailed Description

Definition at line 12 of file contents_filter_input.h.

Constructor & Destructor Documentation

◆ ~ContentsFilterInput()

impeller::ContentsFilterInput::~ContentsFilterInput ( )

overridedefault

Member Function Documentation

◆ GetCoverage()

std::optional< Rect > impeller::ContentsFilterInput::GetCoverage ( const Entity & entity ) const

overridevirtual

Implements impeller::FilterInput.

Definition at line 40 of file contents_filter_input.cc.

                                 {
   return contents_->GetCoverage(entity);
 }

◆ GetSnapshot()

std::optional< Snapshot > impeller::ContentsFilterInput::GetSnapshot	(	std::string_view	label,
		const ContentContext &	renderer,
		const Entity &	entity,
		std::optional< Rect >	coverage_limit,
		int32_t	mip_count
	)		const

overridevirtual

Evaluates the filter input and returns a snapshot of the result.

This method renders the input (which could be another filter, contents, or a texture) into a Snapshot object, which contains the resulting texture and its transform relative to the current render target.

Implementations are typically lazy and may cache the result, ensuring that the input is only rendered once even if GetSnapshot is called multiple times.

Parameters

[in]	label	A debug label for the rendering operation and the resulting snapshot texture.
[in]	renderer	The content context providing rendering resources.
[in]	entity	The entity associated with this filter input, providing transform and other contextual information.
[in]	coverage_limit	An optional rectangle to limit the area of the input that needs to be rendered. This can be used as an optimization.
[in]	mip_count	The number of mip levels to generate for the snapshot texture. Defaults to 1 (no mips).

Returns: A Snapshot containing the rendered texture and its transform, or std::nullopt if the input cannot be rendered or results in an empty output.

Implements impeller::FilterInput.

Definition at line 18 of file contents_filter_input.cc.

                              {
   if (!coverage_limit.has_value() && entity.GetContents()) {
     coverage_limit = entity.GetContents()->GetCoverageHint();
   }
   if (!snapshot_.has_value()) {
     snapshot_ = contents_->RenderToSnapshot(renderer,        // renderer
                                             entity,          // entity
                                             coverage_limit,  // coverage_limit
                                             std::nullopt,  // sampler_descriptor
                                             msaa_enabled_,  // msaa_enabled
                                             /*mip_count=*/mip_count,  //
                                             label                     //
     );
   }
   return snapshot_;
 }

References impeller::Entity::GetContents().

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

impeller/entity/contents/filters/inputs/contents_filter_input.h
impeller/entity/contents/filters/inputs/contents_filter_input.cc