flutter::DlImage Class Reference

Represents an image whose allocation is (usually) resident on device memory. More...

#include <dl_image.h>

Inheritance diagram for flutter::DlImage:

Public Types
enum class	OwningContext { kRaster , kIO }

Public Member Functions
virtual	~DlImage ()
virtual sk_sp< SkImage >	skia_image () const =0
	If this display list image is meant to be used by the Skia backend, an SkImage instance. Null otherwise.
virtual std::shared_ptr< impeller::Texture >	impeller_texture () const =0
	If this display list image is meant to be used by the Impeller backend, an Impeller texture instance. Null otherwise.
virtual bool	isOpaque () const =0
	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.
virtual bool	isTextureBacked () const =0
virtual bool	isUIThreadSafe () const =0
	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.
virtual SkISize	dimensions () const =0
virtual size_t	GetApproximateByteSize () const =0
int	width () const
int	height () const
SkIRect	bounds () 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
Public Member Functions inherited from SkRefCntBase
	SkRefCntBase ()
virtual	~SkRefCntBase ()
bool	unique () const
void	ref () const
void	unref () const

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

Protected Member Functions
	DlImage ()

Detailed Description

Represents an image whose allocation is (usually) resident on device memory.

Since it is usually impossible or expensive to transmute images for one rendering backend to another, these objects are backend specific.

Definition at line 30 of file dl_image.h.

Member Enumeration Documentation

OwningContext

enum class flutter::DlImage::OwningContext

strong

Enumerator
kRaster
kIO

Definition at line 33 of file dl_image.h.

{ kRaster, kIO };

Constructor & Destructor Documentation

~DlImage()

flutter::DlImage::~DlImage ( )

virtualdefault

DlImage()

flutter::DlImage::DlImage ( )

protecteddefault

Member Function Documentation

bounds()

SkIRect flutter::DlImage::bounds

(

)

const

Returns

The bounds of the pixel grid with 0, 0 as origin. A convenience method that calls |DlImagedimensions|.

Definition at line 31 of file dl_image.cc.

                              {
  return SkIRect::MakeSize(dimensions());
}

dimensions()

virtual SkISize flutter::DlImage::dimensions ( ) const

pure virtual

Returns

The dimensions of the pixel grid.

Implemented in flutter::DlImageSkia, impeller::DlImageImpeller, flutter::DlDeferredImageGPUImpeller, flutter::DlDeferredImageGPUSkia, and flutter::DlImageGPU.

Equals() [1/3]

bool flutter::DlImage::Equals ( const DlImage &  other ) const

inline

Definition at line 132 of file dl_image.h.

{ return Equals(&other); }

Equals() [2/3]

bool flutter::DlImage::Equals ( const DlImage *  other ) const

inline

Definition at line 121 of file dl_image.h.

                                          {
    if (!other) {
      return false;
    }
    if (this == other) {
      return true;
    }
    return skia_image() == other->skia_image() &&
           impeller_texture() == other->impeller_texture();
  }

Equals() [3/3]

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

inline

Definition at line 134 of file dl_image.h.

                                                       {
    return Equals(other.get());
  }

get_error()

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

virtual

Returns

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

Reimplemented in flutter::DlDeferredImageGPUSkia.

Definition at line 35 of file dl_image.cc.

                                                {
  return std::nullopt;
}

GetApproximateByteSize()

virtual size_t flutter::DlImage::GetApproximateByteSize ( ) const

pure virtual

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.

Implemented in flutter::DlImageSkia, impeller::DlImageImpeller, flutter::DlDeferredImageGPUImpeller, flutter::DlDeferredImageGPUSkia, and flutter::DlImageGPU.

height()

int flutter::DlImage::height

(

)

const

Returns

The height of the pixel grid. A convenience method that calls |DlImagedimensions|.

Definition at line 27 of file dl_image.cc.

                          {
  return dimensions().fHeight;
};

impeller_texture()

virtual std::shared_ptr< impeller::Texture > flutter::DlImage::impeller_texture ( ) const

pure virtual

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.

Implemented in flutter::DlImageSkia, impeller::DlImageImpeller, flutter::DlDeferredImageGPUImpeller, flutter::DlDeferredImageGPUSkia, and flutter::DlImageGPU.

isOpaque()

virtual bool flutter::DlImage::isOpaque ( ) const

pure virtual

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.

Implemented in flutter::DlImageSkia, impeller::DlImageImpeller, flutter::DlDeferredImageGPUImpeller, flutter::DlDeferredImageGPUSkia, and flutter::DlImageGPU.

isTextureBacked()

virtual bool flutter::DlImage::isTextureBacked ( ) const

pure virtual

Implemented in flutter::DlImageSkia, impeller::DlImageImpeller, flutter::DlDeferredImageGPUImpeller, flutter::DlDeferredImageGPUSkia, and flutter::DlImageGPU.

isUIThreadSafe()

virtual bool flutter::DlImage::isUIThreadSafe ( ) const

pure virtual

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.

Implemented in flutter::DlImageSkia, impeller::DlImageImpeller, flutter::DlDeferredImageGPUImpeller, flutter::DlDeferredImageGPUSkia, and flutter::DlImageGPU.

Make() [1/2]

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

static

Definition at line 11 of file dl_image.cc.

                                                 {
  return Make(sk_ref_sp(image));
}

Make() [2/2]

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

static

Definition at line 15 of file dl_image.cc.

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

owning_context()

virtual OwningContext flutter::DlImage::owning_context ( ) const

inlinevirtual

Returns

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

Reimplemented in impeller::DlImageImpeller, flutter::DlDeferredImageGPUImpeller, and flutter::DlDeferredImageGPUSkia.

Definition at line 114 of file dl_image.h.

{ return OwningContext::kIO; }

skia_image()

virtual sk_sp< SkImage > flutter::DlImage::skia_image ( ) const

pure virtual

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.

Implemented in flutter::DlImageSkia, impeller::DlImageImpeller, flutter::DlDeferredImageGPUImpeller, flutter::DlDeferredImageGPUSkia, and flutter::DlImageGPU.

width()

int flutter::DlImage::width

(

)

const

Returns

The width of the pixel grid. A convenience method that calls |DlImagedimensions|.

Definition at line 23 of file dl_image.cc.

                         {
  return dimensions().fWidth;
};

---

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

• display_list/image/dl_image.h
• display_list/image/dl_image.cc