impeller::TiledTextureContents Class Reference

#include <tiled_texture_contents.h>

Inheritance diagram for impeller::TiledTextureContents:

Public Types
using	ColorFilterProc = std::function< std::shared_ptr< ColorFilterContents >(FilterInput::Ref)>
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)>

Public Member Functions
	TiledTextureContents ()
	~TiledTextureContents () override
bool	IsOpaque () const override
	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...
bool	Render (const ContentContext &renderer, const Entity &entity, RenderPass &pass) const override
void	SetTexture (std::shared_ptr< Texture > texture)
void	SetTileModes (Entity::TileMode x_tile_mode, Entity::TileMode y_tile_mode)
void	SetSamplerDescriptor (SamplerDescriptor desc)
void	SetColorFilter (ColorFilterProc color_filter)
	Set a color filter to apply directly to this tiled texture. 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, const std::string &label="Tiled Texture 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...
Public Member Functions inherited from impeller::ColorSourceContents
	ColorSourceContents ()
	~ColorSourceContents () override
void	SetGeometry (std::shared_ptr< Geometry > geometry)
	Set the geometry that this contents will use to render. More...
const std::shared_ptr< Geometry > &	GetGeometry () const
	Get the geometry that this contents will use to render. More...
void	SetEffectTransform (Matrix matrix)
	Set the effect transform for this color source. More...
const Matrix &	GetInverseEffectTransform () const
	Set the inverted effect transform for this color source. More...
void	SetOpacityFactor (Scalar opacity)
	Set the opacity factor for this color source. More...
Scalar	GetOpacityFactor () const
	Get the opacity factor for this color source. More...
virtual bool	IsSolidColor () const
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...
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 ClipCoverage	GetClipCoverage (const Entity &entity, const std::optional< Rect > &current_clip_coverage) const
	Given the current pass space bounding rectangle of the clip buffer, return the expected clip coverage after this draw call. This should only be implemented for contents that may write to the clip buffer. More...
virtual bool	ShouldRender (const Entity &entity, const std::optional< Rect > clip_coverage) const
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
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 22 of file tiled_texture_contents.h.

Member Typedef Documentation

ColorFilterProc

using impeller::TiledTextureContents::ColorFilterProc = std::function<std::shared_ptr<ColorFilterContents>(FilterInput::Ref)>

Definition at line 29 of file tiled_texture_contents.h.

Constructor & Destructor Documentation

TiledTextureContents()

impeller::TiledTextureContents::TiledTextureContents ( )

default

~TiledTextureContents()

impeller::TiledTextureContents::~TiledTextureContents ( )

overridedefault

Member Function Documentation

IsOpaque()

bool impeller::TiledTextureContents::IsOpaque ( ) const

overridevirtual

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.

Reimplemented from impeller::Contents.

Definition at line 101 of file tiled_texture_contents.cc.

                                          {
  if (GetOpacityFactor() < 1 || x_tile_mode_ == Entity::TileMode::kDecal ||
      y_tile_mode_ == Entity::TileMode::kDecal) {
    return false;
  }
  if (color_filter_) {
    return false;
  }
  return texture_->IsOpaque();
}

References impeller::ColorSourceContents::GetOpacityFactor(), and impeller::Entity::kDecal.

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

Render()

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

overridevirtual

Implements impeller::Contents.

Definition at line 112 of file tiled_texture_contents.cc.

                                                          {
  if (texture_ == nullptr) {
    return true;
  }
 
  using VS = TextureFillVertexShader;
  using FS = TiledTextureFillFragmentShader;
  using FSExternal = TiledTextureFillExternalFragmentShader;
 
  const auto texture_size = texture_->GetSize();
  if (texture_size.IsEmpty()) {
    return true;
  }
 
  bool is_external_texture =
      texture_->GetTextureDescriptor().type == TextureType::kTextureExternalOES;
 
  auto& host_buffer = pass.GetTransientsBuffer();
 
  auto geometry_result = GetGeometry()->GetPositionUVBuffer(
      Rect::MakeSize(texture_size), GetInverseEffectTransform(), renderer,
      entity, pass);
  bool uses_emulated_tile_mode =
      UsesEmulatedTileMode(renderer.GetDeviceCapabilities());
 
  VS::FrameInfo frame_info;
  frame_info.mvp = geometry_result.transform;
  frame_info.texture_sampler_y_coord_scale = texture_->GetYCoordScale();
  frame_info.alpha = GetOpacityFactor();
 
  Command cmd;
  if (uses_emulated_tile_mode) {
    DEBUG_COMMAND_INFO(cmd, "TiledTextureFill");
  } else {
    DEBUG_COMMAND_INFO(cmd, "TextureFill");
  }
 
  cmd.stencil_reference = entity.GetClipDepth();
 
  auto options = OptionsFromPassAndEntity(pass, entity);
  if (geometry_result.prevent_overdraw) {
    options.stencil_compare = CompareFunction::kEqual;
    options.stencil_operation = StencilOperation::kIncrementClamp;
  }
  options.primitive_type = geometry_result.type;
 
#ifdef IMPELLER_ENABLE_OPENGLES
  if (is_external_texture) {
    cmd.pipeline = renderer.GetTiledTextureExternalPipeline(options);
  } else {
    cmd.pipeline = uses_emulated_tile_mode
                       ? renderer.GetTiledTexturePipeline(options)
                       : renderer.GetTexturePipeline(options);
  }
#else
  cmd.pipeline = uses_emulated_tile_mode
                     ? renderer.GetTiledTexturePipeline(options)
                     : renderer.GetTexturePipeline(options);
#endif  // IMPELLER_ENABLE_OPENGLES
 
  cmd.BindVertices(std::move(geometry_result.vertex_buffer));
  VS::BindFrameInfo(cmd, host_buffer.EmplaceUniform(frame_info));
 
  if (is_external_texture) {
    FSExternal::FragInfo frag_info;
    frag_info.x_tile_mode = static_cast<Scalar>(x_tile_mode_);
    frag_info.y_tile_mode = static_cast<Scalar>(y_tile_mode_);
    FSExternal::BindFragInfo(cmd, host_buffer.EmplaceUniform(frag_info));
  } else if (uses_emulated_tile_mode) {
    FS::FragInfo frag_info;
    frag_info.x_tile_mode = static_cast<Scalar>(x_tile_mode_);
    frag_info.y_tile_mode = static_cast<Scalar>(y_tile_mode_);
    FS::BindFragInfo(cmd, host_buffer.EmplaceUniform(frag_info));
  }
 
  if (is_external_texture) {
    SamplerDescriptor sampler_desc;
    // OES_EGL_image_external states that only CLAMP_TO_EDGE is valid, so we
    // emulate all other tile modes here by remapping the texture coordinates.
    sampler_desc.width_address_mode = SamplerAddressMode::kClampToEdge;
    sampler_desc.height_address_mode = SamplerAddressMode::kClampToEdge;
 
    // Also, external textures cannot be bound to color filters, so ignore this
    // case for now.
    FML_DCHECK(!color_filter_)
        << "Color filters are not currently supported for external textures.";
 
    FSExternal::BindSAMPLEREXTERNALOESTextureSampler(
        cmd, texture_,
        renderer.GetContext()->GetSamplerLibrary()->GetSampler(sampler_desc));
  } else {
    if (color_filter_) {
      auto filtered_texture = CreateFilterTexture(renderer);
      if (!filtered_texture) {
        return false;
      }
      FS::BindTextureSampler(
          cmd, filtered_texture,
          renderer.GetContext()->GetSamplerLibrary()->GetSampler(
              CreateSamplerDescriptor(renderer.GetDeviceCapabilities())));
    } else {
      FS::BindTextureSampler(
          cmd, texture_,
          renderer.GetContext()->GetSamplerLibrary()->GetSampler(
              CreateSamplerDescriptor(renderer.GetDeviceCapabilities())));
    }
  }
 
  if (!pass.AddCommand(std::move(cmd))) {
    return false;
  }
 
  if (geometry_result.prevent_overdraw) {
    auto restore = ClipRestoreContents();
    restore.SetRestoreCoverage(GetCoverage(entity));
    return restore.Render(renderer, entity, pass);
  }
  return true;
}

References impeller::RenderPass::AddCommand(), impeller::Command::BindVertices(), DEBUG_COMMAND_INFO, impeller::Entity::GetClipDepth(), impeller::ContentContext::GetContext(), impeller::ColorSourceContents::GetCoverage(), impeller::ContentContext::GetDeviceCapabilities(), impeller::ColorSourceContents::GetGeometry(), impeller::ColorSourceContents::GetInverseEffectTransform(), impeller::ColorSourceContents::GetOpacityFactor(), impeller::ContentContext::GetTexturePipeline(), impeller::ContentContext::GetTiledTexturePipeline(), impeller::RenderPass::GetTransientsBuffer(), impeller::SamplerDescriptor::height_address_mode, impeller::kClampToEdge, impeller::kEqual, impeller::kIncrementClamp, impeller::kTextureExternalOES, impeller::TRect< Scalar >::MakeSize(), impeller::OptionsFromPassAndEntity(), impeller::Command::pipeline, impeller::Command::stencil_reference, and impeller::SamplerDescriptor::width_address_mode.

Referenced by impeller::SceneContents::Render(), and impeller::testing::TEST_P().

RenderToSnapshot()

std::optional< Snapshot > impeller::TiledTextureContents::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 = "Tiled Texture Snapshot"  ) const

overridevirtual

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).

Reimplemented from impeller::Contents.

Definition at line 234 of file tiled_texture_contents.cc.

                                  {
  if (GetInverseEffectTransform().IsIdentity() &&
      GetGeometry()->IsAxisAlignedRect()) {
    auto coverage = GetCoverage(entity);
    if (!coverage.has_value()) {
      return std::nullopt;
    }
    auto scale = Vector2(coverage->GetSize() / Size(texture_->GetSize()));
 
    return Snapshot{
        .texture = texture_,
        .transform = Matrix::MakeTranslation(coverage->GetOrigin()) *
                     Matrix::MakeScale(scale),
        .sampler_descriptor = sampler_descriptor.value_or(sampler_descriptor_),
        .opacity = GetOpacityFactor(),
    };
  }
 
  return Contents::RenderToSnapshot(
      renderer,                                          // renderer
      entity,                                            // entity
      std::nullopt,                                      // coverage_limit
      sampler_descriptor.value_or(sampler_descriptor_),  // sampler_descriptor
      true,                                              // msaa_enabled
      label);                                            // label
}

References impeller::ColorSourceContents::GetCoverage(), impeller::ColorSourceContents::GetGeometry(), impeller::ColorSourceContents::GetInverseEffectTransform(), impeller::ColorSourceContents::GetOpacityFactor(), impeller::Matrix::MakeScale(), impeller::Matrix::MakeTranslation(), impeller::Contents::RenderToSnapshot(), and impeller::Snapshot::texture.

SetColorFilter()

void impeller::TiledTextureContents::SetColorFilter

(

ColorFilterProc

color_filter

)

Set a color filter to apply directly to this tiled texture.

Parameters

color_filter

When applying a color filter to a tiled texture, we can reduce the size and number of the subpasses required and the shader workload by applying the filter to the untiled image and absorbing the opacity before tiling it into the final location.

This may not be a performance improvement if the image is tiled into a much smaller size that its original texture size.

Definition at line 57 of file tiled_texture_contents.cc.

                                                                      {
  color_filter_ = std::move(color_filter);
}

SetSamplerDescriptor()

void impeller::TiledTextureContents::SetSamplerDescriptor

(

SamplerDescriptor

desc

)

Definition at line 53 of file tiled_texture_contents.cc.

                                                                      {
  sampler_descriptor_ = std::move(desc);
}

SetTexture()

void impeller::TiledTextureContents::SetTexture

(

std::shared_ptr< Texture >

texture

)

Definition at line 43 of file tiled_texture_contents.cc.

                                                                    {
  texture_ = std::move(texture);
}

Referenced by impeller::SceneContents::Render(), and impeller::testing::TEST_P().

SetTileModes()

void impeller::TiledTextureContents::SetTileModes	(	Entity::TileMode	x_tile_mode,
		Entity::TileMode	y_tile_mode
	)

Definition at line 47 of file tiled_texture_contents.cc.

                                                                    {
  x_tile_mode_ = x_tile_mode;
  y_tile_mode_ = y_tile_mode;
}

---

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

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