#include <dl_image_impeller.h>

Inheritance diagram for impeller::DlImageImpeller:

Public Member Functions
	~DlImageImpeller () override

sk_sp< SkImage >	skia_image () const override
	If this display list image is meant to be used by the Skia backend, an SkImage instance. Null otherwise.

std::shared_ptr< impeller::Texture >	impeller_texture () const override
	If this display list image is meant to be used by the Impeller backend, an Impeller texture instance. Null otherwise.

bool	isOpaque () const override
	If the pixel format of this image ignores alpha, this returns true. This method might conservatively return false when it cannot guarnatee an opaque image, for example when the pixel format of the image supports alpha but the image is made up of entirely opaque pixels.

bool	isTextureBacked () const override

bool	isUIThreadSafe () const override
	If the underlying platform image held by this object has no threading requirements for the release of that image (or if arrangements have already been made to forward that image to the correct thread upon deletion), this method returns true.

flutter::DlISize	GetSize () const override

size_t	GetApproximateByteSize () const override

OwningContext	owning_context () const override

Public Member Functions inherited from flutter::DlImage
virtual	~DlImage ()

int	width () const

int	height () const

DlIRect	GetBounds () const

virtual std::optional< std::string >	get_error () const

bool	Equals (const DlImage *other) const

bool	Equals (const DlImage &other) const

bool	Equals (const sk_sp< const DlImage > &other) const

Static Public Member Functions
static sk_sp< DlImageImpeller >	Make (std::shared_ptr< Texture > texture, OwningContext owning_context=OwningContext::kIO)

static sk_sp< DlImageImpeller >	MakeFromYUVTextures (AiksContext *aiks_context, std::shared_ptr< Texture > y_texture, std::shared_ptr< Texture > uv_texture, YUVColorSpace yuv_color_space)

Static Public Member Functions inherited from flutter::DlImage
static sk_sp< DlImage >	Make (const SkImage *image)

static sk_sp< DlImage >	Make (sk_sp< SkImage > image)

Additional Inherited Members
Public Types inherited from flutter::DlImage
enum class	OwningContext { kRaster , kIO }

Protected Member Functions inherited from flutter::DlImage
	DlImage ()

Detailed Description

Definition at line 15 of file dl_image_impeller.h.

Constructor & Destructor Documentation

◆ ~DlImageImpeller()

impeller::DlImageImpeller::~DlImageImpeller ( )

overridedefault

Member Function Documentation

◆ GetApproximateByteSize()

size_t impeller::DlImageImpeller::GetApproximateByteSize ( ) const

overridevirtual

Returns: The approximate byte size of the allocation of this image. This takes into account details such as mip-mapping. The allocation is usually resident in device memory.

Implements flutter::DlImage.

Definition at line 122 of file dl_image_impeller.cc.

                                                     {
  auto size = sizeof(*this);
  if (texture_) {
    size += texture_->GetTextureDescriptor().GetByteSizeOfBaseMipLevel();
  }
  return size;
}

◆ GetSize()

flutter::DlISize impeller::DlImageImpeller::GetSize ( ) const

overridevirtual

Returns: The dimensions of the pixel grid.

Implements flutter::DlImage.

Definition at line 115 of file dl_image_impeller.cc.

                                              {
  // texture |GetSize()| returns a 64-bit size, but we need a 32-bit size,
  // so we need to convert to DlISize (the 32-bit variant) either way.
  return texture_ ? flutter::DlISize(texture_->GetSize()) : flutter::DlISize();
}

◆ impeller_texture()

std::shared_ptr< impeller::Texture > impeller::DlImageImpeller::impeller_texture ( ) const

overridevirtual

If this display list image is meant to be used by the Impeller backend, an Impeller texture instance. Null otherwise.

Returns: An Impeller texture instance or null.

Implements flutter::DlImage.

Definition at line 92 of file dl_image_impeller.cc.

                                                                       {
  return texture_;
}

◆ isOpaque()

bool impeller::DlImageImpeller::isOpaque ( ) const

overridevirtual

If the pixel format of this image ignores alpha, this returns true. This method might conservatively return false when it cannot guarnatee an opaque image, for example when the pixel format of the image supports alpha but the image is made up of entirely opaque pixels.

Returns: True if the pixel format of this image ignores alpha.

Implements flutter::DlImage.

Definition at line 97 of file dl_image_impeller.cc.

                                     {
  // Impeller doesn't currently implement opaque alpha types.
  return false;
}

◆ isTextureBacked()

bool impeller::DlImageImpeller::isTextureBacked ( ) const

overridevirtual

Implements flutter::DlImage.

Definition at line 103 of file dl_image_impeller.cc.

                                            {
  // Impeller textures are always ... textures :/
  return true;
}

◆ isUIThreadSafe()

bool impeller::DlImageImpeller::isUIThreadSafe ( ) const

overridevirtual

If the underlying platform image held by this object has no threading requirements for the release of that image (or if arrangements have already been made to forward that image to the correct thread upon deletion), this method returns true.

Returns: True if the underlying image is held in a thread-safe manner.

Implements flutter::DlImage.

Definition at line 109 of file dl_image_impeller.cc.

                                           {
  // Impeller textures are always thread-safe
  return true;
}

◆ Make()

sk_sp< DlImageImpeller > impeller::DlImageImpeller::Make	(	std::shared_ptr< Texture >	texture,
		OwningContext	owning_context = `OwningContext::kIO`
	)

static

Definition at line 23 of file dl_image_impeller.cc.

                                                                           {
  if (!texture) {
    return nullptr;
  }
  return sk_sp<DlImageImpeller>(
      new DlImageImpeller(std::move(texture), owning_context));
}

References owning_context(), and texture.

◆ MakeFromYUVTextures()

sk_sp< DlImageImpeller > impeller::DlImageImpeller::MakeFromYUVTextures	(	AiksContext *	aiks_context,
		std::shared_ptr< Texture >	y_texture,
		std::shared_ptr< Texture >	uv_texture,
		YUVColorSpace	yuv_color_space
	)

static

Definition at line 33 of file dl_image_impeller.cc.

                                   {
  if (!aiks_context || !y_texture || !uv_texture) {
    return nullptr;
  }
  auto yuv_to_rgb_filter_contents = FilterContents::MakeYUVToRGBFilter(
      std::move(y_texture), std::move(uv_texture), yuv_color_space);
  impeller::Entity entity;
  entity.SetBlendMode(impeller::BlendMode::kSrc);
 
  // Disable the render target cache so that this snapshot's texture will not
  // be reused later by other operations.
  const auto& renderer = aiks_context->GetContentContext();
  renderer.GetRenderTargetCache()->DisableCache();
  fml::ScopedCleanupClosure restore_cache(
      [&] { renderer.GetRenderTargetCache()->EnableCache(); });
 
  std::optional<Snapshot> snapshot =
      yuv_to_rgb_filter_contents->RenderToSnapshot(
          renderer, entity,
          {.coverage_limit = std::nullopt,
           .sampler_descriptor = std::nullopt,
           .msaa_enabled = true,
           .mip_count = 1,
           .label = "MakeYUVToRGBFilter Snapshot"});
  if (!snapshot.has_value()) {
    return nullptr;
  }
  return impeller::DlImageImpeller::Make(snapshot->texture);
}

References impeller::AiksContext::GetContentContext(), impeller::ContentContext::GetRenderTargetCache(), impeller::kSrc, Make(), impeller::FilterContents::MakeYUVToRGBFilter(), and impeller::Entity::SetBlendMode().

◆ owning_context()

OwningContext impeller::DlImageImpeller::owning_context ( ) const

inlineoverridevirtual

Returns: Specifies which context was used to create this image. The image must be collected on the same task runner as its context.

Reimplemented from flutter::DlImage.

Definition at line 57 of file dl_image_impeller.h.

57{ return owning_context_; }

Referenced by Make().

◆ skia_image()

sk_sp< SkImage > impeller::DlImageImpeller::skia_image ( ) const

overridevirtual

If this display list image is meant to be used by the Skia backend, an SkImage instance. Null otherwise.

Returns: A Skia image instance or null.

Implements flutter::DlImage.

Definition at line 87 of file dl_image_impeller.cc.

                                                 {
  return nullptr;
};

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

impeller/display_list/dl_image_impeller.h
impeller/display_list/dl_image_impeller.cc

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~DlImageImpeller()

Member Function Documentation

◆ GetApproximateByteSize()

◆ GetSize()

◆ impeller_texture()

◆ isOpaque()

◆ isTextureBacked()

◆ isUIThreadSafe()

◆ Make()

◆ MakeFromYUVTextures()

◆ owning_context()

◆ skia_image()