flutter::DlImageSkia Class Reference

#include <dl_image_skia.h>

Inheritance diagram for flutter::DlImageSkia:

Public Member Functions
	DlImageSkia (sk_sp< SkImage > image)
	~DlImageSkia () override
Type	GetImageType () const override
	Returns the backend type of this image.
const DlImageSkia *	asSkiaImage () const override
	Safe downcast to DlImageSkia.
virtual sk_sp< SkImage >	skia_image () const
bool	isTextureBacked () const override
	Returns true if the image is backed by a GPU texture.
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
DlColorSpace	GetColorSpace () const override
	Gets the color space of the image.
Public Member Functions inherited from flutter::DlImage
virtual	~DlImage ()
virtual const impeller::DlImageImpeller *	asImpellerImage () const
	Safe downcast to DlImageImpeller.
int	width () const
int	height () const
DlIRect	GetBounds () const
virtual OwningContext	owning_context () 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< 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 }
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 13 of file dl_image_skia.h.

Constructor & Destructor Documentation

DlImageSkia()

flutter::DlImageSkia::DlImageSkia ( sk_sp< SkImage >  image )

explicit

Definition at line 25 of file dl_image_skia.cc.

: image_(std::move(image)) {}

~DlImageSkia()

flutter::DlImageSkia::~DlImageSkia ( )

overridedefault

Member Function Documentation

asSkiaImage()

const DlImageSkia * flutter::DlImageSkia::asSkiaImage ( ) const

inlineoverridevirtual

Safe downcast to DlImageSkia.

Returns

A pointer to DlImageSkia or null if not a Skia image.

Reimplemented from flutter::DlImage.

Definition at line 26 of file dl_image_skia.h.

{ return this; }

GetApproximateByteSize()

size_t flutter::DlImageSkia::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 62 of file dl_image_skia.cc.

                                                 {
  auto size = sizeof(*this);
  if (image_) {
    const auto& info = image_->imageInfo();
    const auto kMipmapOverhead = image_->hasMipmaps() ? 4.0 / 3.0 : 1.0;
    const size_t image_byte_size = info.computeMinByteSize() * kMipmapOverhead;
    size += image_byte_size;
  }
  return size;
}

References flutter::size.

GetColorSpace()

DlColorSpace flutter::DlImageSkia::GetColorSpace ( ) const

overridevirtual

Gets the color space of the image.

Returns

The color space.

Implements flutter::DlImage.

Definition at line 74 of file dl_image_skia.cc.

                                              {
  return DlColorSpace::kSRGB;
}

References flutter::kSRGB.

GetImageType()

Type flutter::DlImageSkia::GetImageType ( ) const

inlineoverridevirtual

Returns the backend type of this image.

Returns

The image type.

Implements flutter::DlImage.

Definition at line 24 of file dl_image_skia.h.

{ return Type::kSkia; }

References flutter::DlImage::kSkia.

GetSize()

DlISize flutter::DlImageSkia::GetSize ( ) const

overridevirtual

Returns

The dimensions of the pixel grid.

Implements flutter::DlImage.

Definition at line 57 of file dl_image_skia.cc.

                                   {
  return image_ ? ToDlISize(image_->dimensions()) : DlISize();
}

References flutter::ToDlISize().

isOpaque()

bool flutter::DlImageSkia::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 41 of file dl_image_skia.cc.

                                 {
  return image_ ? image_->isOpaque() : false;
}

isTextureBacked()

bool flutter::DlImageSkia::isTextureBacked ( ) const

overridevirtual

Returns true if the image is backed by a GPU texture.

Implements flutter::DlImage.

Definition at line 36 of file dl_image_skia.cc.

                                        {
  return image_ ? image_->isTextureBacked() : false;
}

isUIThreadSafe()

bool flutter::DlImageSkia::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 46 of file dl_image_skia.cc.

                                       {
  // Technically if the image is null then we are thread-safe, and possibly
  // if the image is constructed from a heap raster as well, but there
  // should never be a leak of an instance of this class into any data that
  // is shared with the UI thread, regardless of value.
  // All images intended to be shared with the UI thread should be constructed
  // via one of the DlImage subclasses designed for that purpose.
  return false;
}

Make() [1/2]

sk_sp< DlImage > flutter::DlImageSkia::Make ( const SkImage *  image )

static

Definition at line 11 of file dl_image_skia.cc.

                                                     {
  if (!image) {
    return nullptr;
  }
  return sk_make_sp<DlImageSkia>(sk_ref_sp(image));
}

References image.

Referenced by animatedImage_getCurrentFrame(), flutter::testing::BM_DrawImage(), flutter::testing::BM_DrawImageNine(), flutter::testing::BM_DrawImageRect(), flutter::testing::CreateAllRenderingOps(), flutter::Picture::DoRasterizeToImage(), flutter::testing::MakeTestImage(), flutter::testing::MakeTestImage(), flutter::testing::MockTexture::MakeTestTexture(), flutter::RasterCache::Rasterize(), flutter::testing::DlSurfaceInstanceSkiaBase::SnapshotToImage(), flutter::testing::TEST(), flutter::testing::TEST(), and flutter::testing::TEST().

Make() [2/2]

sk_sp< DlImage > flutter::DlImageSkia::Make ( sk_sp< SkImage >  image )

static

Definition at line 18 of file dl_image_skia.cc.

                                                     {
  if (!image) {
    return nullptr;
  }
  return sk_make_sp<DlImageSkia>(std::move(image));
}

References image.

skia_image()

sk_sp< SkImage > flutter::DlImageSkia::skia_image ( ) const

virtual

Reimplemented in flutter::DlDeferredImageGPUSkia, and flutter::DlImageGPU.

Definition at line 31 of file dl_image_skia.cc.

                                             {
  return image_;
};

Referenced by flutter::DlImage::Equals().

---

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

• display_list/image/dl_image_skia.h
• display_list/image/dl_image_skia.cc