flutter::DlDeferredImageGPUImpeller Class Reference

#include <display_list_deferred_image_gpu_impeller.h>

Inheritance diagram for flutter::DlDeferredImageGPUImpeller:

Public Member Functions
	~DlDeferredImageGPUImpeller () override
std::shared_ptr< impeller::Texture >	GetImpellerTexture (const std::shared_ptr< impeller::Context > &context) const override
flutter::DlColorSpace	GetColorSpace () const override
	Gets the color space of the image.
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	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.
DlISize	GetSize () const override
size_t	GetApproximateByteSize () const override
OwningContext	owning_context () const override
Public Member Functions inherited from impeller::DlImageImpeller
Type	GetImageType () const override
	Returns the backend type of this image.
const DlImageImpeller *	asImpellerImage () const override
	Safe downcast to DlImageImpeller.
bool	isTextureBacked () const override
	Returns true if the image is backed by a GPU texture.
virtual std::shared_ptr< Texture >	GetImpellerTexture (const std::shared_ptr< Context > &context) const =0
std::shared_ptr< Texture >	GetCachedTexture (const ContentContext &renderer) const
Public Member Functions inherited from flutter::DlImage
virtual	~DlImage ()
virtual const DlImageSkia *	asSkiaImage () const
	Safe downcast to DlImageSkia.
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< DlDeferredImageGPUImpeller >	Make (std::unique_ptr< LayerTree > layer_tree, fml::TaskRunnerAffineWeakPtr< SnapshotDelegate > snapshot_delegate, fml::RefPtr< fml::TaskRunner > raster_task_runner)
static sk_sp< DlDeferredImageGPUImpeller >	Make (sk_sp< DisplayList > display_list, const DlISize &size, SnapshotPixelFormat pixel_format, fml::TaskRunnerAffineWeakPtr< SnapshotDelegate > snapshot_delegate, fml::RefPtr< fml::TaskRunner > raster_task_runner)
Static Public Member Functions inherited from impeller::DlImageImpeller
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)

Additional Inherited Members
Public Types inherited from flutter::DlImage
enum class	OwningContext {   kRaster ,   kIO }
enum class	Type {   kSkia ,   kImpeller }
	The backend type of this image. More...
Protected Member Functions inherited from flutter::DlImage
	DlImage ()

Detailed Description

Definition at line 26 of file display_list_deferred_image_gpu_impeller.h.

Constructor & Destructor Documentation

~DlDeferredImageGPUImpeller()

flutter::DlDeferredImageGPUImpeller::~DlDeferredImageGPUImpeller ( )

overridedefault

Member Function Documentation

GetApproximateByteSize()

size_t flutter::DlDeferredImageGPUImpeller::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 93 of file display_list_deferred_image_gpu_impeller.cc.

                                                                {
  auto size = sizeof(DlDeferredImageGPUImpeller);
  if (wrapper_) {
    if (wrapper_->texture()) {
      size += wrapper_->texture()
                  ->GetTextureDescriptor()
                  .GetByteSizeOfBaseMipLevel();
    } else {
      size += wrapper_->size().Area() * 4;
    }
  }
  return size;
}

References flutter::size.

GetColorSpace()

flutter::DlColorSpace flutter::DlDeferredImageGPUImpeller::GetColorSpace ( ) const

overridevirtual

Gets the color space of the image.

Returns

The color space.

Implements flutter::DlImage.

Definition at line 59 of file display_list_deferred_image_gpu_impeller.cc.

                                                                    {
  if (!wrapper_) {
    return flutter::DlColorSpace::kSRGB;
  }
  std::shared_ptr<impeller::Texture> texture = wrapper_->texture();
  if (!texture) {
    return flutter::DlColorSpace::kSRGB;
  }
  switch (texture->GetTextureDescriptor().format) {
    case impeller::PixelFormat::kB10G10R10XR:
    case impeller::PixelFormat::kR16G16B16A16Float:
      return flutter::DlColorSpace::kExtendedSRGB;
    default:
      return flutter::DlColorSpace::kSRGB;
  }
}

References impeller::kB10G10R10XR, flutter::kExtendedSRGB, impeller::kR16G16B16A16Float, flutter::kSRGB, and texture.

GetImpellerTexture()

std::shared_ptr< impeller::Texture > flutter::DlDeferredImageGPUImpeller::GetImpellerTexture ( const std::shared_ptr< impeller::Context > &  context ) const

override

Definition at line 50 of file display_list_deferred_image_gpu_impeller.cc.

                                                         {
  if (!wrapper_) {
    return nullptr;
  }
  return wrapper_->texture();
}

GetSize()

DlISize flutter::DlDeferredImageGPUImpeller::GetSize ( ) const

overridevirtual

Returns

The dimensions of the pixel grid.

Implements flutter::DlImage.

Definition at line 88 of file display_list_deferred_image_gpu_impeller.cc.

                                                  {
  return wrapper_ ? wrapper_->size() : DlISize();
}

isOpaque()

bool flutter::DlDeferredImageGPUImpeller::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 77 of file display_list_deferred_image_gpu_impeller.cc.

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

isUIThreadSafe()

bool flutter::DlDeferredImageGPUImpeller::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 83 of file display_list_deferred_image_gpu_impeller.cc.

                                                      {
  return true;
}

Make() [1/2]

sk_sp< DlDeferredImageGPUImpeller > flutter::DlDeferredImageGPUImpeller::Make ( sk_sp< DisplayList >  display_list, const DlISize &  size, SnapshotPixelFormat  pixel_format, fml::TaskRunnerAffineWeakPtr< SnapshotDelegate >  snapshot_delegate, fml::RefPtr< fml::TaskRunner >  raster_task_runner  )

static

Definition at line 29 of file display_list_deferred_image_gpu_impeller.cc.

                                                 {
  return sk_sp<DlDeferredImageGPUImpeller>(new DlDeferredImageGPUImpeller(
      DlDeferredImageGPUImpeller::ImageWrapper::Make(
          std::move(display_list), size, pixel_format,
          std::move(snapshot_delegate), std::move(raster_task_runner))));
}

References flutter::size.

Make() [2/2]

sk_sp< DlDeferredImageGPUImpeller > flutter::DlDeferredImageGPUImpeller::Make ( std::unique_ptr< LayerTree >  layer_tree, fml::TaskRunnerAffineWeakPtr< SnapshotDelegate >  snapshot_delegate, fml::RefPtr< fml::TaskRunner >  raster_task_runner  )

static

Definition at line 19 of file display_list_deferred_image_gpu_impeller.cc.

                                                 {
  return sk_sp<DlDeferredImageGPUImpeller>(new DlDeferredImageGPUImpeller(
      DlDeferredImageGPUImpeller::ImageWrapper::Make(
          std::move(layer_tree), std::move(snapshot_delegate),
          std::move(raster_task_runner))));
}

Referenced by flutter::CreateDeferredImage(), flutter::CreateDeferredImage(), flutter::testing::TEST(), and flutter::testing::TEST().

owning_context()

OwningContext flutter::DlDeferredImageGPUImpeller::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 63 of file display_list_deferred_image_gpu_impeller.h.

                                                {
    return OwningContext::kRaster;
  }

References flutter::DlImage::kRaster.

---

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

• lib/ui/painting/display_list_deferred_image_gpu_impeller.h
• lib/ui/painting/display_list_deferred_image_gpu_impeller.cc