impeller::Entity Class Reference

#include <entity.h>

Public Types
enum	RenderingMode {   RenderingMode::kDirect,   RenderingMode::kSubpass }
enum	TileMode {   TileMode::kClamp,   TileMode::kRepeat,   TileMode::kMirror,   TileMode::kDecal }
enum	ClipOperation {   ClipOperation::kDifference,   ClipOperation::kIntersect }

Public Member Functions
	Entity ()
	~Entity ()
	Entity (Entity &&)=default
const Matrix &	GetTransform () const
	Get the global transform matrix for this Entity. More...
void	SetTransform (const Matrix &transform)
	Set the global transform matrix for this Entity. More...
std::optional< Rect >	GetCoverage () const
Contents::ClipCoverage	GetClipCoverage (const std::optional< Rect > &current_clip_coverage) const
bool	ShouldRender (const std::optional< Rect > &clip_coverage) const
void	SetContents (std::shared_ptr< Contents > contents)
const std::shared_ptr< Contents > &	GetContents () const
void	SetClipDepth (uint32_t clip_depth)
void	IncrementStencilDepth (uint32_t increment)
uint32_t	GetClipDepth () const
void	SetBlendMode (BlendMode blend_mode)
BlendMode	GetBlendMode () const
bool	Render (const ContentContext &renderer, RenderPass &parent_pass) const
bool	CanInheritOpacity () const
bool	SetInheritedOpacity (Scalar alpha)
std::optional< Color >	AsBackgroundColor (ISize target_size) const
Scalar	DeriveTextScale () const
Capture &	GetCapture () const
void	SetCapture (Capture capture) const
Entity	Clone () const

Static Public Member Functions
static std::optional< Entity >	FromSnapshot (const std::optional< Snapshot > &snapshot, BlendMode blend_mode=BlendMode::kSourceOver, uint32_t clip_depth=0)
	Create an entity that can be used to render a given snapshot. More...
static bool	IsBlendModeDestructive (BlendMode blend_mode)
	Returns true if the blend mode is "destructive", meaning that even fully transparent source colors would result in the destination getting changed. More...

Static Public Attributes
static constexpr BlendMode	kLastPipelineBlendMode = BlendMode::kModulate
static constexpr BlendMode	kLastAdvancedBlendMode = BlendMode::kLuminosity

Detailed Description

Definition at line 21 of file entity.h.

Member Enumeration Documentation

ClipOperation

enum impeller::Entity::ClipOperation

strong

Enumerator
kDifference
kIntersect

Definition at line 59 of file entity.h.

                           {
    kDifference,
    kIntersect,
  };

RenderingMode

enum impeller::Entity::RenderingMode

strong

Enumerator
kDirect	In direct mode, the Entity's transform is used as the current local-to-screen transform matrix.
kSubpass	In subpass mode, the Entity passed through the filter is in screen space rather than local space, and so some filters (namely, MatrixFilterContents) need to interpret the given EffectTransform as the current transform matrix.

Definition at line 26 of file entity.h.

                           {
    /// In direct mode, the Entity's transform is used as the current
    /// local-to-screen transform matrix.
    kDirect,
    /// In subpass mode, the Entity passed through the filter is in screen space
    /// rather than local space, and so some filters (namely,
    /// MatrixFilterContents) need to interpret the given EffectTransform as the
    /// current transform matrix.
    kSubpass,
  };

TileMode

enum impeller::Entity::TileMode

strong

An enum to define how to repeat, fold, or omit colors outside of the typically defined range of the source of the colors (such as the bounds of an image or the defining geometry of a gradient).

Enumerator
kClamp	Replicate the edge color if the shader draws outside of its original bounds.
kRepeat	Repeat the shader's image horizontally and vertically (or both along and perpendicular to a gradient's geometry).
kMirror	Repeat the shader's image horizontally and vertically, seamlessly alternating mirrored images.
kDecal	Render the shader's image pixels only within its original bounds. If the shader draws outside of its original bounds, transparent black is drawn instead.

Definition at line 40 of file entity.h.

                      {
    /// Replicate the edge color if the shader draws outside of its original
    /// bounds.
    kClamp,
 
    /// Repeat the shader's image horizontally and vertically (or both along and
    /// perpendicular to a gradient's geometry).
    kRepeat,
 
    /// Repeat the shader's image horizontally and vertically, seamlessly
    /// alternating mirrored images.
    kMirror,
 
    /// Render the shader's image pixels only within its original bounds. If the
    /// shader draws outside of its original bounds, transparent black is drawn
    /// instead.
    kDecal,
  };

Constructor & Destructor Documentation

Entity() [1/2]

impeller::Entity::Entity ( )

default

Referenced by Clone().

~Entity()

impeller::Entity::~Entity ( )

default

Entity() [2/2]

impeller::Entity::Entity ( Entity &&  )

default

Member Function Documentation

AsBackgroundColor()

std::optional< Color > impeller::Entity::AsBackgroundColor

(

ISize

target_size

)

const

Definition at line 131 of file entity.cc.

                                                                    {
  return contents_->AsBackgroundColor(*this, target_size);
}

CanInheritOpacity()

bool impeller::Entity::CanInheritOpacity

(

)

const

Definition at line 109 of file entity.cc.

                                     {
  if (!contents_) {
    return false;
  }
  if (!((blend_mode_ == BlendMode::kSource && contents_->IsOpaque()) ||
        blend_mode_ == BlendMode::kSourceOver)) {
    return false;
  }
  return contents_->CanInheritOpacity(*this);
}

References impeller::kSource, and impeller::kSourceOver.

Referenced by impeller::OpacityPeepholePassDelegate::CanCollapseIntoParentPass(), and SetInheritedOpacity().

Clone()

Entity impeller::Entity::Clone

(

)

const

Definition at line 181 of file entity.cc.

                           {
  return Entity(*this);
}

References Entity().

Referenced by impeller::FilterContents::GetCoverage(), impeller::FilterContents::GetEntity(), impeller::FilterInput::GetLocalCoverage(), and impeller::testing::TEST_P().

DeriveTextScale()

Scalar impeller::Entity::DeriveTextScale

(

)

const

Definition at line 173 of file entity.cc.

                                     {
  return GetTransform().GetMaxBasisLengthXY();
}

References impeller::Matrix::GetMaxBasisLengthXY(), and GetTransform().

FromSnapshot()

std::optional< Entity > impeller::Entity::FromSnapshot ( const std::optional< Snapshot > &  snapshot, BlendMode  blend_mode = BlendMode::kSourceOver, uint32_t  clip_depth = 0  )

static

Create an entity that can be used to render a given snapshot.

Definition at line 21 of file entity.cc.

                         {
  if (!snapshot.has_value()) {
    return std::nullopt;
  }
 
  auto texture_rect = Rect::MakeSize(snapshot->texture->GetSize());
 
  auto contents = TextureContents::MakeRect(texture_rect);
  contents->SetTexture(snapshot->texture);
  contents->SetSamplerDescriptor(snapshot->sampler_descriptor);
  contents->SetSourceRect(texture_rect);
  contents->SetOpacity(snapshot->opacity);
 
  Entity entity;
  entity.SetBlendMode(blend_mode);
  entity.SetClipDepth(clip_depth);
  entity.SetTransform(snapshot->transform);
  entity.SetContents(contents);
  return entity;
}

References impeller::TextureContents::MakeRect(), impeller::TRect< Scalar >::MakeSize(), SetBlendMode(), SetClipDepth(), SetContents(), and SetTransform().

Referenced by impeller::AdvancedBlend(), and impeller::PipelineBlend().

GetBlendMode()

BlendMode impeller::Entity::GetBlendMode

(

)

const

Definition at line 105 of file entity.cc.

                                     {
  return blend_mode_;
}

Referenced by impeller::EntityPass::AddEntity(), impeller::AdvancedBlend(), impeller::OptionsFromPassAndEntity(), impeller::PipelineBlend(), impeller::SolidRRectBlurContents::Render(), and impeller::testing::TEST_P().

GetCapture()

Capture & impeller::Entity::GetCapture

(

)

const

Definition at line 177 of file entity.cc.

                                  {
  return capture_;
}

Referenced by impeller::SolidColorContents::Render(), and impeller::TextureContents::Render().

GetClipCoverage()

Contents::ClipCoverage impeller::Entity::GetClipCoverage

(

const std::optional< Rect > &

current_clip_coverage

)

const

Definition at line 65 of file entity.cc.

                                                          {
  if (!contents_) {
    return {};
  }
  return contents_->GetClipCoverage(*this, current_clip_coverage);
}

GetClipDepth()

uint32_t impeller::Entity::GetClipDepth

(

)

const

Definition at line 93 of file entity.cc.

                                    {
  return clip_depth_;
}

Referenced by impeller::AdvancedBlend(), impeller::PipelineBlend(), impeller::RuntimeEffectContents::Render(), impeller::TiledTextureContents::Render(), impeller::ClipContents::Render(), impeller::SolidRRectBlurContents::Render(), impeller::SolidColorContents::Render(), impeller::TextContents::Render(), impeller::TextureContents::Render(), impeller::VerticesColorContents::Render(), impeller::AtlasContents::Render(), impeller::ClipRestoreContents::Render(), impeller::VerticesUVContents::Render(), impeller::AtlasTextureContents::Render(), and impeller::AtlasColorContents::Render().

GetContents()

const std::shared_ptr< Contents > & impeller::Entity::GetContents

(

)

const

Definition at line 85 of file entity.cc.

                                                         {
  return contents_;
}

Referenced by impeller::EntityPass::AddEntity(), impeller::AdvancedBlend(), impeller::OpacityPeepholePassDelegate::CanCollapseIntoParentPass(), impeller::testing::GetCoverageOfFirstEntity(), impeller::ContentsFilterInput::GetSnapshot(), impeller::PipelineBlend(), and impeller::testing::TEST_P().

GetCoverage()

std::optional< Rect > impeller::Entity::GetCoverage

(

)

const

Definition at line 57 of file entity.cc.

                                            {
  if (!contents_) {
    return std::nullopt;
  }
 
  return contents_->GetCoverage(*this);
}

Referenced by impeller::testing::TEST_P().

GetTransform()

const Matrix & impeller::Entity::GetTransform

(

)

const

Get the global transform matrix for this Entity.

Definition at line 49 of file entity.cc.

                                         {
  return transform_;
}

Referenced by impeller::SolidColorContents::AsBackgroundColor(), impeller::Geometry::ComputePositionGeometry(), impeller::Geometry::ComputePositionUVGeometry(), impeller::ComputeUVGeometryForRect(), DeriveTextScale(), impeller::ClipContents::GetClipCoverage(), impeller::SolidRRectBlurContents::GetCoverage(), impeller::VerticesContents::GetCoverage(), impeller::SolidColorContents::GetCoverage(), impeller::TextContents::GetCoverage(), impeller::TextureContents::GetCoverage(), impeller::AtlasContents::GetCoverage(), impeller::ColorSourceContents::GetCoverage(), impeller::AtlasTextureContents::GetCoverage(), impeller::FilterContents::GetCoverage(), impeller::AtlasColorContents::GetCoverage(), impeller::FilterContents::GetEntity(), impeller::FilterContentsFilterInput::GetLocalTransform(), impeller::VerticesGeometry::GetPositionBuffer(), impeller::VerticesGeometry::GetPositionColorBuffer(), impeller::VerticesGeometry::GetPositionUVBuffer(), impeller::FilterContentsFilterInput::GetTransform(), impeller::FilterInput::GetTransform(), impeller::SceneContents::Render(), impeller::SolidRRectBlurContents::Render(), impeller::TextContents::Render(), impeller::TextureContents::Render(), impeller::AtlasContents::Render(), impeller::AtlasTextureContents::Render(), impeller::AtlasColorContents::Render(), impeller::TextureContents::RenderToSnapshot(), and impeller::testing::TEST_P().

IncrementStencilDepth()

void impeller::Entity::IncrementStencilDepth

(

uint32_t

increment

)

Definition at line 97 of file entity.cc.

                                                     {
  clip_depth_ += increment;
}

IsBlendModeDestructive()

bool impeller::Entity::IsBlendModeDestructive ( BlendMode  blend_mode )

static

Returns true if the blend mode is "destructive", meaning that even fully transparent source colors would result in the destination getting changed.

This is useful for determining if EntityPass textures can be shrinkwrapped to their Entities' coverage; they can be shrinkwrapped if all of the contained Entities have non-destructive blends.

Definition at line 142 of file entity.cc.

                                                        {
  switch (blend_mode) {
    case BlendMode::kClear:
    case BlendMode::kSource:
    case BlendMode::kSourceIn:
    case BlendMode::kDestinationIn:
    case BlendMode::kSourceOut:
    case BlendMode::kDestinationOut:
    case BlendMode::kDestinationATop:
    case BlendMode::kXor:
    case BlendMode::kModulate:
      return true;
    default:
      return false;
  }
}

References impeller::kClear, impeller::kDestinationATop, impeller::kDestinationIn, impeller::kDestinationOut, impeller::kModulate, impeller::kSource, impeller::kSourceIn, impeller::kSourceOut, and impeller::kXor.

Render()

bool impeller::Entity::Render	(	const ContentContext &	renderer,
		RenderPass &	parent_pass
	)		const

Definition at line 159 of file entity.cc.

                                                   {
  if (!contents_) {
    return true;
  }
 
  if (!contents_->GetCoverageHint().has_value()) {
    contents_->SetCoverageHint(
        Rect::MakeSize(parent_pass.GetRenderTargetSize()));
  }
 
  return contents_->Render(renderer, *this, parent_pass);
}

References impeller::RenderPass::GetRenderTargetSize(), and impeller::TRect< Scalar >::MakeSize().

Referenced by impeller::EntityPlayground::OpenPlaygroundHere(), impeller::PipelineBlend(), and impeller::testing::TEST_P().

SetBlendMode()

void impeller::Entity::SetBlendMode

(

BlendMode

blend_mode

)

Definition at line 101 of file entity.cc.

                                              {
  blend_mode_ = blend_mode;
}

Referenced by impeller::EntityPass::AddEntity(), impeller::Canvas::DrawAtlas(), impeller::Canvas::DrawCircle(), impeller::Canvas::DrawImageRect(), impeller::Canvas::DrawLine(), impeller::Canvas::DrawOval(), impeller::Canvas::DrawPaint(), impeller::Canvas::DrawPath(), impeller::Canvas::DrawPoints(), impeller::Canvas::DrawRect(), impeller::Canvas::DrawRRect(), impeller::Canvas::DrawTextFrame(), impeller::Canvas::DrawVertices(), FromSnapshot(), impeller::DlImageImpeller::MakeFromYUVTextures(), impeller::PipelineBlend(), and impeller::testing::TEST_P().

SetCapture()

void impeller::Entity::SetCapture

(

Capture

capture

)

const

Definition at line 185 of file entity.cc.

                                             {
  capture_ = std::move(capture);
}

SetClipDepth()

void impeller::Entity::SetClipDepth

(

uint32_t

clip_depth

)

Definition at line 89 of file entity.cc.

                                        {
  clip_depth_ = depth;
}

Referenced by impeller::Canvas::DrawAtlas(), impeller::Canvas::DrawCircle(), impeller::Canvas::DrawImageRect(), impeller::Canvas::DrawLine(), impeller::Canvas::DrawOval(), impeller::Canvas::DrawPaint(), impeller::Canvas::DrawPath(), impeller::Canvas::DrawPoints(), impeller::Canvas::DrawRect(), impeller::Canvas::DrawRRect(), impeller::Canvas::DrawTextFrame(), impeller::Canvas::DrawVertices(), and FromSnapshot().

SetContents()

void impeller::Entity::SetContents

(

std::shared_ptr< Contents >

contents

)

Definition at line 81 of file entity.cc.

                                                         {
  contents_ = std::move(contents);
}

Referenced by impeller::testing::CreatePassWithRectPath(), impeller::Canvas::DrawAtlas(), impeller::Canvas::DrawCircle(), impeller::Canvas::DrawImageRect(), impeller::Canvas::DrawLine(), impeller::Canvas::DrawOval(), impeller::Canvas::DrawPaint(), impeller::Canvas::DrawPath(), impeller::Canvas::DrawPoints(), impeller::Canvas::DrawRect(), impeller::Canvas::DrawRRect(), impeller::Canvas::DrawTextFrame(), impeller::Canvas::DrawVertices(), FromSnapshot(), impeller::PipelineBlend(), and impeller::testing::TEST_P().

SetInheritedOpacity()

bool impeller::Entity::SetInheritedOpacity

(

Scalar

alpha

)

Definition at line 120 of file entity.cc.

                                             {
  if (!CanInheritOpacity()) {
    return false;
  }
  if (blend_mode_ == BlendMode::kSource && contents_->IsOpaque()) {
    blend_mode_ = BlendMode::kSourceOver;
  }
  contents_->SetInheritedOpacity(alpha);
  return true;
}

References CanInheritOpacity(), impeller::kSource, and impeller::kSourceOver.

SetTransform()

void impeller::Entity::SetTransform

(

const Matrix &

transform

)

Set the global transform matrix for this Entity.

Definition at line 53 of file entity.cc.

                                                 {
  transform_ = transform;
}

Referenced by impeller::Canvas::DrawAtlas(), impeller::Canvas::DrawCircle(), impeller::Canvas::DrawImageRect(), impeller::Canvas::DrawLine(), impeller::Canvas::DrawOval(), impeller::Canvas::DrawPaint(), impeller::Canvas::DrawPath(), impeller::Canvas::DrawPoints(), impeller::Canvas::DrawRect(), impeller::Canvas::DrawRRect(), impeller::Canvas::DrawTextFrame(), impeller::Canvas::DrawVertices(), FromSnapshot(), impeller::FilterContents::GetCoverage(), impeller::EntityPass::GetElementsCoverage(), impeller::FilterContents::GetEntity(), impeller::FilterInput::GetLocalCoverage(), impeller::testing::TEST(), and impeller::testing::TEST_P().

ShouldRender()

bool impeller::Entity::ShouldRender

(

const std::optional< Rect > &

clip_coverage

)

const

Definition at line 73 of file entity.cc.

                                                                      {
#ifdef IMPELLER_CONTENT_CULLING
  return contents_->ShouldRender(*this, clip_coverage);
#else
  return true;
#endif  // IMPELLER_CONTENT_CULLING
}

Referenced by impeller::testing::TEST_P().

Member Data Documentation

kLastAdvancedBlendMode

constexpr BlendMode impeller::Entity::kLastAdvancedBlendMode = BlendMode::kLuminosity

staticconstexpr

Definition at line 24 of file entity.h.

Referenced by impeller::testing::GetBlendModeSelection(), impeller::ColorFilterContents::MakeBlend(), and impeller::BlendFilterContents::SetBlendMode().

kLastPipelineBlendMode

constexpr BlendMode impeller::Entity::kLastPipelineBlendMode = BlendMode::kModulate

staticconstexpr

Definition at line 23 of file entity.h.

Referenced by impeller::EntityPass::AddEntity(), impeller::EntityPass::AddSubpass(), impeller::ContentContextOptions::ApplyToPipelineDescriptor(), impeller::ColorFilterContents::MakeBlend(), impeller::BlendFilterContents::SetBlendMode(), and impeller::testing::TEST_P().

---

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

• impeller/entity/entity.h
• impeller/entity/entity.cc