impeller::ClipContents Class Reference

#include <clip_contents.h>

Inheritance diagram for impeller::ClipContents:

Public Member Functions
	ClipContents ()
	~ClipContents ()
void	SetGeometry (std::unique_ptr< Geometry > geometry)
void	SetClipOperation (Entity::ClipOperation clip_op)
std::optional< Rect >	GetCoverage (const Entity &entity) const override
	Get the screen space bounding rectangle that this contents affects. More...
StencilCoverage	GetStencilCoverage (const Entity &entity, const std::optional< Rect > &current_stencil_coverage) const override
	Given the current screen space bounding rectangle of the stencil, return the expected stencil coverage after this draw call. This should only be implemented for contents that may write to the stencil buffer. More...
bool	ShouldRender (const Entity &entity, const std::optional< Rect > &stencil_coverage) const override
bool	Render (const ContentContext &renderer, const Entity &entity, RenderPass &pass) const override
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...
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 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, const std::string &label="Snapshot") const
	Render this contents to a snapshot, respecting the entity's transform, path, stencil depth, and blend mode. The result texture size is always the size of GetCoverage(entity). More...
std::optional< Size >	GetColorSourceSize () const
	Return the color source's intrinsic size, if available. More...
void	SetColorSourceSize (Size size)
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 const FilterContents *	AsFilter () 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< Contents >	MakeAnonymous (RenderProc render_proc, CoverageProc coverage_proc)

Detailed Description

Definition at line 18 of file clip_contents.h.

Constructor & Destructor Documentation

ClipContents()

impeller::ClipContents::ClipContents ( )

default

~ClipContents()

impeller::ClipContents::~ClipContents ( )

default

Member Function Documentation

CanInheritOpacity()

bool impeller::ClipContents::CanInheritOpacity ( const Entity &  entity ) const

overridevirtual

Whether or not this contents can accept the opacity peephole optimization.

By default all contents return false. Contents are responsible for determining whether or not their own geometries intersect in a way that makes accepting opacity impossible. It is always safe to return false, especially if computing overlap would be computationally expensive.

Reimplemented from impeller::Contents.

Definition at line 73 of file clip_contents.cc.

                                                               {
  return true;
}

GetCoverage()

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

overridevirtual

Get the screen space bounding rectangle that this contents affects.

Implements impeller::Contents.

Definition at line 33 of file clip_contents.cc.

                                                                      {
  return std::nullopt;
};

GetStencilCoverage()

Contents::StencilCoverage impeller::ClipContents::GetStencilCoverage ( const Entity &  entity, const std::optional< Rect > &  current_stencil_coverage  ) const

overridevirtual

Given the current screen space bounding rectangle of the stencil, return the expected stencil coverage after this draw call. This should only be implemented for contents that may write to the stencil buffer.

Reimplemented from impeller::Contents.

Definition at line 37 of file clip_contents.cc.

                                                             {
  if (!current_stencil_coverage.has_value()) {
    return {.type = StencilCoverage::Type::kAppend, .coverage = std::nullopt};
  }
  switch (clip_op_) {
    case Entity::ClipOperation::kDifference:
      // This can be optimized further by considering cases when the bounds of
      // the current stencil will shrink.
      return {.type = StencilCoverage::Type::kAppend,
              .coverage = current_stencil_coverage};
    case Entity::ClipOperation::kIntersect:
      if (!geometry_) {
        return {.type = StencilCoverage::Type::kAppend,
                .coverage = std::nullopt};
      }
      auto coverage = geometry_->GetCoverage(entity.GetTransformation());
      if (!coverage.has_value() || !current_stencil_coverage.has_value()) {
        return {.type = StencilCoverage::Type::kAppend,
                .coverage = std::nullopt};
      }
      return {
          .type = StencilCoverage::Type::kAppend,
          .coverage = current_stencil_coverage->Intersection(coverage.value()),
      };
  }
  FML_UNREACHABLE();
}

References impeller::Entity::GetTransformation(), impeller::Entity::kDifference, impeller::Entity::kIntersect, and impeller::Contents::StencilCoverage::type.

Render()

bool impeller::ClipContents::Render ( const ContentContext &  renderer, const Entity &  entity, RenderPass &  pass  ) const

overridevirtual

Implements impeller::Contents.

Definition at line 79 of file clip_contents.cc.

                                                  {
  using VS = ClipPipeline::VertexShader;
 
  VS::FrameInfo info;
 
  Command cmd;
 
  auto options = OptionsFromPass(pass);
  options.blend_mode = BlendMode::kDestination;
  cmd.stencil_reference = entity.GetStencilDepth();
  options.stencil_compare = CompareFunction::kEqual;
  options.stencil_operation = StencilOperation::kIncrementClamp;
 
  if (clip_op_ == Entity::ClipOperation::kDifference) {
    {
      DEBUG_COMMAND_INFO(cmd, "Difference Clip (Increment)");
 
      auto points = Rect(Size(pass.GetRenderTargetSize())).GetPoints();
      auto vertices =
          VertexBufferBuilder<VS::PerVertexData>{}
              .AddVertices({{points[0]}, {points[1]}, {points[2]}, {points[3]}})
              .CreateVertexBuffer(pass.GetTransientsBuffer());
      cmd.BindVertices(vertices);
 
      info.mvp = Matrix::MakeOrthographic(pass.GetRenderTargetSize());
      VS::BindFrameInfo(cmd, pass.GetTransientsBuffer().EmplaceUniform(info));
 
      options.primitive_type = PrimitiveType::kTriangleStrip;
      cmd.pipeline = renderer.GetClipPipeline(options);
      pass.AddCommand(Command(cmd));
    }
 
    {
      DEBUG_COMMAND_INFO(cmd, "Difference Clip (Punch)");
 
      cmd.stencil_reference = entity.GetStencilDepth() + 1;
      options.stencil_compare = CompareFunction::kEqual;
      options.stencil_operation = StencilOperation::kDecrementClamp;
    }
  } else {
    DEBUG_COMMAND_INFO(cmd, "Intersect Clip");
    options.stencil_compare = CompareFunction::kEqual;
    options.stencil_operation = StencilOperation::kIncrementClamp;
  }
 
  auto geometry_result = geometry_->GetPositionBuffer(renderer, entity, pass);
  options.primitive_type = geometry_result.type;
  cmd.pipeline = renderer.GetClipPipeline(options);
 
  auto allocator = renderer.GetContext()->GetResourceAllocator();
  cmd.BindVertices(geometry_result.vertex_buffer);
 
  info.mvp = geometry_result.transform;
  VS::BindFrameInfo(cmd, pass.GetTransientsBuffer().EmplaceUniform(info));
 
  pass.AddCommand(std::move(cmd));
  return true;
}

References impeller::RenderPass::AddCommand(), impeller::VertexBufferBuilder< VertexType_, IndexType_ >::AddVertices(), impeller::Command::BindVertices(), DEBUG_COMMAND_INFO, impeller::HostBuffer::EmplaceUniform(), impeller::ContentContext::GetClipPipeline(), impeller::ContentContext::GetContext(), impeller::TRect< T >::GetPoints(), impeller::RenderPass::GetRenderTargetSize(), impeller::Entity::GetStencilDepth(), impeller::RenderPass::GetTransientsBuffer(), impeller::kDecrementClamp, impeller::kDestination, impeller::Entity::kDifference, impeller::kEqual, impeller::kIncrementClamp, impeller::kTriangleStrip, impeller::Matrix::MakeOrthographic(), impeller::OptionsFromPass(), impeller::Command::pipeline, and impeller::Command::stencil_reference.

SetClipOperation()

void impeller::ClipContents::SetClipOperation

(

Entity::ClipOperation

clip_op

)

Definition at line 29 of file clip_contents.cc.

                                                               {
  clip_op_ = clip_op;
}

SetGeometry()

void impeller::ClipContents::SetGeometry

(

std::unique_ptr< Geometry >

geometry

)

Definition at line 25 of file clip_contents.cc.

                                                               {
  geometry_ = std::move(geometry);
}

SetInheritedOpacity()

void impeller::ClipContents::SetInheritedOpacity ( Scalar  opacity )

overridevirtual

Inherit the provided opacity.

   Use of this method is invalid if CanAcceptOpacity returns false.

Reimplemented from impeller::Contents.

Definition at line 77 of file clip_contents.cc.

{}

ShouldRender()

bool impeller::ClipContents::ShouldRender ( const Entity &  entity, const std::optional< Rect > &  stencil_coverage  ) const

overridevirtual

Reimplemented from impeller::Contents.

Definition at line 67 of file clip_contents.cc.

                                                     {
  return true;
}

---

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

• impeller/entity/contents/clip_contents.h
• impeller/entity/contents/clip_contents.cc