impeller::FilterInput Class Reference

#include <filter_input.h>

Inheritance diagram for impeller::FilterInput:

Public Types
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 >

Public Member Functions
virtual	~FilterInput ()
virtual Variant	GetInput () const =0
virtual std::optional< Snapshot >	GetSnapshot (const std::string &label, const ContentContext &renderer, const Entity &entity, std::optional< Rect > coverage_limit=std::nullopt, int32_t mip_count=1) const =0
std::optional< Rect >	GetLocalCoverage (const Entity &entity) const
virtual std::optional< Rect >	GetCoverage (const Entity &entity) const =0
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.
virtual Matrix	GetTransform (const Entity &entity) const
	Get the transform of this FilterInput. This is equivalent to calling entity.GetTransform() * GetLocalTransform().
virtual void	PopulateGlyphAtlas (const std::shared_ptr< LazyGlyphAtlas > &lazy_glyph_atlas, Scalar scale)
virtual bool	IsTranslationOnly () const
virtual bool	IsLeaf () const
	Returns true unless this input is a FilterInput, which may take other inputs.
virtual void	SetLeafInputs (const FilterInput::Vector &inputs)
	Replaces the inputs of all leaf FilterContents with a new set of inputs.
virtual void	SetEffectTransform (const Matrix &matrix)
	Sets the effect transform of filter inputs.
virtual void	SetRenderingMode (Entity::RenderingMode rendering_mode)
	Turns on subpass mode for filter inputs.

Static Public Member Functions
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

FilterInput is a lazy/single eval Snapshot which may be shared across filter parameters and used to evaluate input coverage.

A FilterInput can be re-used for any filter inputs across an entity's filter graph without repeating subpasses unnecessarily.

Filters may decide to not evaluate inputs in situations where they won't contribute to the filter's output texture.

Definition at line 30 of file filter_input.h.

Member Typedef Documentation

Ref

using impeller::FilterInput::Ref = std::shared_ptr<FilterInput>

Definition at line 32 of file filter_input.h.

Variant

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

Definition at line 34 of file filter_input.h.

Vector

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

Definition at line 33 of file filter_input.h.

Constructor & Destructor Documentation

~FilterInput()

impeller::FilterInput::~FilterInput ( )

virtualdefault

Member Function Documentation

GetCoverage()

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

pure virtual

Implemented in impeller::ContentsFilterInput, impeller::FilterContentsFilterInput, impeller::PlaceholderFilterInput, and impeller::TextureFilterInput.

GetInput()

virtual Variant impeller::FilterInput::GetInput ( ) const

pure virtual

Implemented in impeller::ContentsFilterInput, impeller::FilterContentsFilterInput, impeller::PlaceholderFilterInput, and impeller::TextureFilterInput.

GetLocalCoverage()

std::optional< Rect > impeller::FilterInput::GetLocalCoverage

(

const Entity &

entity

)

const

Definition at line 63 of file filter_input.cc.

                                                                          {
  Entity local_entity = entity.Clone();
  local_entity.SetTransform(GetLocalTransform(entity));
  return GetCoverage(local_entity);
}

GetLocalTransform()

Matrix impeller::FilterInput::GetLocalTransform ( const Entity &  entity ) const

virtual

Get the local transform of this filter input. This transform is relative to the Entity transform space.

Reimplemented in impeller::FilterContentsFilterInput, and impeller::TextureFilterInput.

Definition at line 59 of file filter_input.cc.

                                                                {
  return Matrix();
}

GetSnapshot()

virtual std::optional< Snapshot > impeller::FilterInput::GetSnapshot ( const std::string &  label, const ContentContext &  renderer, const Entity &  entity, std::optional< Rect >  coverage_limit = std::nullopt, int32_t  mip_count = 1  ) const

pure virtual

Implemented in impeller::ContentsFilterInput, impeller::FilterContentsFilterInput, impeller::TextureFilterInput, and impeller::PlaceholderFilterInput.

GetSourceCoverage()

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

virtual

Reimplemented in impeller::FilterContentsFilterInput.

Definition at line 69 of file filter_input.cc.

                                    {
  return output_limit;
}

GetTransform()

Matrix impeller::FilterInput::GetTransform ( const Entity &  entity ) const

virtual

Get the transform of this FilterInput. This is equivalent to calling entity.GetTransform() * GetLocalTransform().

Reimplemented in impeller::FilterContentsFilterInput.

Definition at line 75 of file filter_input.cc.

                                                           {
  return entity.GetTransform() * GetLocalTransform(entity);
}

IsLeaf()

bool impeller::FilterInput::IsLeaf ( ) const

virtual

Returns true unless this input is a FilterInput, which may take other inputs.

Reimplemented in impeller::FilterContentsFilterInput.

Definition at line 89 of file filter_input.cc.

                               {
  return true;
}

IsTranslationOnly()

bool impeller::FilterInput::IsTranslationOnly ( ) const

virtual

See also

FilterContents::HasBasisTransforms

Reimplemented in impeller::FilterContentsFilterInput.

Definition at line 85 of file filter_input.cc.

                                          {
  return true;
}

Make() [1/3]

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

static

Definition at line 50 of file filter_input.cc.

                                                                       {
  FilterInput::Vector result;
  result.reserve(inputs.size());
  for (const auto& input : inputs) {
    result.push_back(Make(input));
  }
  return result;
}

Make() [2/3]

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

static

Definition at line 44 of file filter_input.cc.

                                                           {
  return std::shared_ptr<TextureFilterInput>(
      new TextureFilterInput(std::move(texture), local_transform));
}

Make() [3/3]

FilterInput::Ref impeller::FilterInput::Make ( Variant  input, bool  msaa_enabled = true  )

static

Definition at line 19 of file filter_input.cc.

                                                                 {
  if (auto filter = std::get_if<std::shared_ptr<FilterContents>>(&input)) {
    return std::static_pointer_cast<FilterInput>(
        std::shared_ptr<FilterContentsFilterInput>(
            new FilterContentsFilterInput(*filter)));
  }
 
  if (auto contents = std::get_if<std::shared_ptr<Contents>>(&input)) {
    return std::static_pointer_cast<FilterInput>(
        std::shared_ptr<ContentsFilterInput>(
            new ContentsFilterInput(*contents, msaa_enabled)));
  }
 
  if (auto texture = std::get_if<std::shared_ptr<Texture>>(&input)) {
    return Make(*texture, Matrix());
  }
 
  if (auto rect = std::get_if<Rect>(&input)) {
    return std::shared_ptr<PlaceholderFilterInput>(
        new PlaceholderFilterInput(*rect));
  }
 
  FML_UNREACHABLE();
}

PopulateGlyphAtlas()

void impeller::FilterInput::PopulateGlyphAtlas ( const std::shared_ptr< LazyGlyphAtlas > &  lazy_glyph_atlas, Scalar  scale  )

virtual

See also

Contents::PopulateGlyphAtlas

Reimplemented in impeller::ContentsFilterInput, impeller::FilterContentsFilterInput, and impeller::PlaceholderFilterInput.

Definition at line 79 of file filter_input.cc.

                  {}

SetEffectTransform()

void impeller::FilterInput::SetEffectTransform ( const Matrix &  matrix )

virtual

Sets the effect transform of filter inputs.

Reimplemented in impeller::FilterContentsFilterInput.

Definition at line 95 of file filter_input.cc.

{}

SetLeafInputs()

void impeller::FilterInput::SetLeafInputs ( const FilterInput::Vector &  inputs )

virtual

Replaces the inputs of all leaf FilterContents with a new set of inputs.

See also

FilterInput::IsLeaf

Reimplemented in impeller::FilterContentsFilterInput.

Definition at line 93 of file filter_input.cc.

{}

SetRenderingMode()

void impeller::FilterInput::SetRenderingMode ( Entity::RenderingMode  rendering_mode )

virtual

Turns on subpass mode for filter inputs.

Reimplemented in impeller::FilterContentsFilterInput.

Definition at line 97 of file filter_input.cc.

{}

---

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

• impeller/entity/contents/filters/inputs/filter_input.h
• impeller/entity/contents/filters/inputs/filter_input.cc