flutter::PixelDeferredImageGPUImpeller Class Reference

#include <pixel_deferred_image_gpu_impeller.h>

Inheritance diagram for flutter::PixelDeferredImageGPUImpeller:

Public Member Functions
	~PixelDeferredImageGPUImpeller () 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.
DlISize	GetSize () const override
size_t	GetApproximateByteSize () const override
std::optional< std::string >	get_error () const override
Public Member Functions inherited from flutter::DlImage
virtual	~DlImage ()
int	width () const
int	height () const
DlIRect	GetBounds () const
virtual OwningContext	owning_context () 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< PixelDeferredImageGPUImpeller >	Make (sk_sp< SkImage > image, fml::TaskRunnerAffineWeakPtr< SnapshotDelegate > snapshot_delegate, fml::RefPtr< fml::TaskRunner > raster_task_runner)
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

A deferred image that is created from pixels.

See also

DisplayListDeferredImageGPUImpeller for another example of a deferred image.

dart:ui decodeImageFromPixelsSync for the user of this class.

Definition at line 26 of file pixel_deferred_image_gpu_impeller.h.

Constructor & Destructor Documentation

~PixelDeferredImageGPUImpeller()

flutter::PixelDeferredImageGPUImpeller::~PixelDeferredImageGPUImpeller ( )

overridedefault

References texture.

Member Function Documentation

get_error()

std::optional< std::string > flutter::PixelDeferredImageGPUImpeller::get_error ( ) const

overridevirtual

Returns

An error, if any, that occurred when trying to create the image.

Reimplemented from flutter::DlImage.

Definition at line 70 of file pixel_deferred_image_gpu_impeller.cc.

                                                                      {
  return wrapper_ ? wrapper_->get_error() : std::nullopt;
}

GetApproximateByteSize()

size_t flutter::PixelDeferredImageGPUImpeller::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 56 of file pixel_deferred_image_gpu_impeller.cc.

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

References flutter::size.

GetSize()

DlISize flutter::PixelDeferredImageGPUImpeller::GetSize ( ) const

overridevirtual

Returns

The dimensions of the pixel grid.

Implements flutter::DlImage.

Definition at line 52 of file pixel_deferred_image_gpu_impeller.cc.

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

impeller_texture()

std::shared_ptr< impeller::Texture > flutter::PixelDeferredImageGPUImpeller::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 33 of file pixel_deferred_image_gpu_impeller.cc.

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

isOpaque()

bool flutter::PixelDeferredImageGPUImpeller::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 40 of file pixel_deferred_image_gpu_impeller.cc.

                                                   {
  return false;
}

isTextureBacked()

bool flutter::PixelDeferredImageGPUImpeller::isTextureBacked ( ) const

overridevirtual

Implements flutter::DlImage.

Definition at line 44 of file pixel_deferred_image_gpu_impeller.cc.

                                                          {
  return wrapper_ && wrapper_->isTextureBacked();
}

isUIThreadSafe()

bool flutter::PixelDeferredImageGPUImpeller::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 48 of file pixel_deferred_image_gpu_impeller.cc.

                                                         {
  return true;
}

Make()

sk_sp< PixelDeferredImageGPUImpeller > flutter::PixelDeferredImageGPUImpeller::Make ( sk_sp< SkImage >  image, fml::TaskRunnerAffineWeakPtr< SnapshotDelegate >  snapshot_delegate, fml::RefPtr< fml::TaskRunner >  raster_task_runner  )

static

Definition at line 12 of file pixel_deferred_image_gpu_impeller.cc.

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

References image.

skia_image()

sk_sp< SkImage > flutter::PixelDeferredImageGPUImpeller::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 28 of file pixel_deferred_image_gpu_impeller.cc.

                                                               {
  return nullptr;
}

---

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

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