#include <SkImage_Raster.h>

Inheritance diagram for SkImage_Raster:

Public Member Functions
	SkImage_Raster (const SkImageInfo &, sk_sp< SkData >, size_t rb, uint32_t id=kNeedNewImageUniqueID)

	SkImage_Raster (const SkBitmap &bm, bool bitmapMayBeMutable=false)

	~SkImage_Raster () override

bool	isValid (GrRecordingContext *context) const override

bool	onReadPixels (GrDirectContext , const SkImageInfo &, void , size_t, int srcX, int srcY, CachingHint) const override

bool	onPeekPixels (SkPixmap *) const override

const SkBitmap *	onPeekBitmap () const override

bool	getROPixels (GrDirectContext , SkBitmap , CachingHint) const override

sk_sp< SkImage >	onMakeSubset (GrDirectContext *, const SkIRect &) const override

sk_sp< SkImage >	onMakeSubset (skgpu::graphite::Recorder *, const SkIRect &, RequiredProperties) const override

SkPixelRef *	getPixelRef () const

bool	onAsLegacyBitmap (GrDirectContext , SkBitmap ) const override

sk_sp< SkImage >	onMakeColorTypeAndColorSpace (SkColorType, sk_sp< SkColorSpace >, GrDirectContext *) const override

sk_sp< SkImage >	onReinterpretColorSpace (sk_sp< SkColorSpace >) const override

void	notifyAddedToRasterCache () const override

bool	onHasMipmaps () const override

bool	onIsProtected () const override

SkMipmap *	onPeekMips () const override

sk_sp< SkImage >	onMakeWithMipmaps (sk_sp< SkMipmap > mips) const override

SkImage_Base::Type	type () const override

SkBitmap	bitmap () const

Public Member Functions inherited from SkImage_Base
	~SkImage_Base () override

sk_sp< SkImage >	makeColorSpace (GrDirectContext *, sk_sp< SkColorSpace >) const override

sk_sp< SkImage >	makeColorSpace (skgpu::graphite::Recorder *, sk_sp< SkColorSpace >, RequiredProperties) const override

sk_sp< SkImage >	makeColorTypeAndColorSpace (GrDirectContext *dContext, SkColorType targetColorType, sk_sp< SkColorSpace > targetCS) const override

sk_sp< SkImage >	makeColorTypeAndColorSpace (skgpu::graphite::Recorder *, SkColorType, sk_sp< SkColorSpace >, RequiredProperties) const override

sk_sp< SkImage >	makeSubset (GrDirectContext *direct, const SkIRect &subset) const override

sk_sp< SkImage >	makeSubset (skgpu::graphite::Recorder *, const SkIRect &, RequiredProperties) const override

size_t	textureSize () const override

sk_sp< SkMipmap >	refMips () const

virtual void	onAsyncRescaleAndReadPixels (const SkImageInfo &, SkIRect srcRect, RescaleGamma, RescaleMode, ReadPixelsCallback, ReadPixelsContext) const

virtual void	onAsyncRescaleAndReadPixelsYUV420 (SkYUVColorSpace, bool readAlpha, sk_sp< SkColorSpace > dstColorSpace, SkIRect srcRect, SkISize dstSize, RescaleGamma, RescaleMode, ReadPixelsCallback, ReadPixelsContext) const

virtual GrImageContext *	context () const

virtual GrDirectContext *	directContext () const

virtual void	generatingSurfaceIsDeleted ()

virtual sk_sp< SkData >	onRefEncoded () const

bool	isLazyGenerated () const override

bool	isRasterBacked () const

bool	isGaneshBacked () const

bool	isGraphiteBacked () const

bool	isYUVA () const

bool	isTextureBacked () const override

Public Member Functions inherited from SkImage
const SkImageInfo &	imageInfo () const

int	width () const

int	height () const

SkISize	dimensions () const

SkIRect	bounds () const

uint32_t	uniqueID () const

SkAlphaType	alphaType () const

SkColorType	colorType () const

SkColorSpace *	colorSpace () const

sk_sp< SkColorSpace >	refColorSpace () const

bool	isAlphaOnly () const

bool	isOpaque () const

sk_sp< SkShader >	makeShader (SkTileMode tmx, SkTileMode tmy, const SkSamplingOptions &, const SkMatrix *localMatrix=nullptr) const

sk_sp< SkShader >	makeShader (SkTileMode tmx, SkTileMode tmy, const SkSamplingOptions &sampling, const SkMatrix &lm) const

sk_sp< SkShader >	makeShader (const SkSamplingOptions &sampling, const SkMatrix &lm) const

sk_sp< SkShader >	makeShader (const SkSamplingOptions &sampling, const SkMatrix *lm=nullptr) const

sk_sp< SkShader >	makeRawShader (SkTileMode tmx, SkTileMode tmy, const SkSamplingOptions &, const SkMatrix *localMatrix=nullptr) const

sk_sp< SkShader >	makeRawShader (SkTileMode tmx, SkTileMode tmy, const SkSamplingOptions &sampling, const SkMatrix &lm) const

sk_sp< SkShader >	makeRawShader (const SkSamplingOptions &sampling, const SkMatrix &lm) const

sk_sp< SkShader >	makeRawShader (const SkSamplingOptions &sampling, const SkMatrix *lm=nullptr) const

bool	peekPixels (SkPixmap *pixmap) const

bool	readPixels (GrDirectContext context, const SkImageInfo &dstInfo, void dstPixels, size_t dstRowBytes, int srcX, int srcY, CachingHint cachingHint=kAllow_CachingHint) const

bool	readPixels (GrDirectContext *context, const SkPixmap &dst, int srcX, int srcY, CachingHint cachingHint=kAllow_CachingHint) const

bool	readPixels (const SkImageInfo &dstInfo, void *dstPixels, size_t dstRowBytes, int srcX, int srcY, CachingHint cachingHint=kAllow_CachingHint) const

bool	readPixels (const SkPixmap &dst, int srcX, int srcY, CachingHint cachingHint=kAllow_CachingHint) const

void	asyncRescaleAndReadPixels (const SkImageInfo &info, const SkIRect &srcRect, RescaleGamma rescaleGamma, RescaleMode rescaleMode, ReadPixelsCallback callback, ReadPixelsContext context) const

void	asyncRescaleAndReadPixelsYUV420 (SkYUVColorSpace yuvColorSpace, sk_sp< SkColorSpace > dstColorSpace, const SkIRect &srcRect, const SkISize &dstSize, RescaleGamma rescaleGamma, RescaleMode rescaleMode, ReadPixelsCallback callback, ReadPixelsContext context) const

void	asyncRescaleAndReadPixelsYUVA420 (SkYUVColorSpace yuvColorSpace, sk_sp< SkColorSpace > dstColorSpace, const SkIRect &srcRect, const SkISize &dstSize, RescaleGamma rescaleGamma, RescaleMode rescaleMode, ReadPixelsCallback callback, ReadPixelsContext context) const

bool	scalePixels (const SkPixmap &dst, const SkSamplingOptions &, CachingHint cachingHint=kAllow_CachingHint) const

sk_sp< SkData >	refEncodedData () const

bool	hasMipmaps () const

bool	isProtected () const

sk_sp< SkImage >	withDefaultMipmaps () const

sk_sp< SkImage >	makeNonTextureImage (GrDirectContext *=nullptr) const

sk_sp< SkImage >	makeRasterImage (GrDirectContext *, CachingHint cachingHint=kDisallow_CachingHint) const

sk_sp< SkImage >	makeRasterImage (CachingHint cachingHint=kDisallow_CachingHint) const

bool	asLegacyBitmap (SkBitmap *bitmap, LegacyBitmapMode legacyBitmapMode=kRO_LegacyBitmapMode) const

sk_sp< SkImage >	reinterpretColorSpace (sk_sp< SkColorSpace > newColorSpace) const

Public Member Functions inherited from SkRefCntBase
	SkRefCntBase ()

virtual	~SkRefCntBase ()

bool	unique () const

void	ref () const

void	unref () const

Additional Inherited Members
Public Types inherited from SkImage_Base
enum class	Type { kRaster , kRasterPinnable , kLazy , kLazyPicture , kGanesh , kGaneshYUVA , kGraphite , kGraphiteYUVA }

Public Types inherited from SkImage
enum	CachingHint { kAllow_CachingHint , kDisallow_CachingHint }

enum class	RescaleGamma : bool { kSrc , kLinear }

enum class	RescaleMode { kNearest , kLinear , kRepeatedLinear , kRepeatedCubic }

enum	LegacyBitmapMode { kRO_LegacyBitmapMode }

using	ReadPixelsContext = void *

using	ReadPixelsCallback = void(ReadPixelsContext, std::unique_ptr< const AsyncReadResult >)

Protected Member Functions inherited from SkImage_Base
	SkImage_Base (const SkImageInfo &info, uint32_t uniqueID)

Detailed Description

Definition at line 36 of file SkImage_Raster.h.

Constructor & Destructor Documentation

◆ SkImage_Raster() [1/2]

SkImage_Raster::SkImage_Raster	(	const SkImageInfo &	info,
		sk_sp< SkData >	data,
		size_t	rb,
		uint32_t	id = `kNeedNewImageUniqueID`
	)

Definition at line 45 of file SkImage_Raster.cpp.

        : SkImage_Base(info, id) {
    void* addr = const_cast<void*>(data->data());
 
    fBitmap.installPixels(info, addr, rowBytes, release_data, data.release());
    fBitmap.setImmutable();
}

◆ SkImage_Raster() [2/2]

SkImage_Raster::SkImage_Raster	(	const SkBitmap &	bm,
		bool	bitmapMayBeMutable = `false`
	)

Definition at line 54 of file SkImage_Raster.cpp.

        : SkImage_Base(bm.info(),
                    is_not_subset(bm) ? bm.getGenerationID() : (uint32_t)kNeedNewImageUniqueID)
        , fBitmap(bm) {
    SkASSERT(bitmapMayBeMutable || fBitmap.isImmutable());
}

◆ ~SkImage_Raster()

SkImage_Raster::~SkImage_Raster ( )

override

Definition at line 61 of file SkImage_Raster.cpp.

61{}

Member Function Documentation

◆ bitmap()

SkBitmap SkImage_Raster::bitmap ( ) const

inline

Definition at line 99 of file SkImage_Raster.h.

99{ return fBitmap; }

◆ getPixelRef()

SkPixelRef * SkImage_Raster::getPixelRef ( ) const

inline

Definition at line 58 of file SkImage_Raster.h.

58{ return fBitmap.pixelRef(); }

SkBitmap::pixelRef

SkPixelRef * pixelRef() const

Definition SkBitmap.h:720

◆ getROPixels()

bool SkImage_Raster::getROPixels	(	GrDirectContext *	,
		SkBitmap *	dst,
		CachingHint
	)		const

overridevirtual

Implements SkImage_Base.

Definition at line 78 of file SkImage_Raster.cpp.

                                                                                   {
    *dst = fBitmap;
    return true;
}

◆ isValid()

bool SkImage_Raster::isValid ( GrRecordingContext * context ) const

inlineoverridevirtual

Returns true if SkImage can be drawn on either raster surface or GPU surface. If context is nullptr, tests if SkImage draws on raster surface; otherwise, tests if SkImage draws on GPU surface associated with context.

SkImage backed by GPU texture may become invalid if associated context is invalid. lazy image may be invalid and may not draw to raster surface or GPU surface or both.

Parameters

context GPU context

Returns: true if SkImage can be drawn

example: https://fiddle.skia.org/c/@Image_isValid

Implements SkImage.

Definition at line 44 of file SkImage_Raster.h.

44{ return true; }

◆ notifyAddedToRasterCache()

void SkImage_Raster::notifyAddedToRasterCache ( ) const

inlineoverridevirtual

Reimplemented from SkImage_Base.

Definition at line 67 of file SkImage_Raster.h.

                                                   {
        // We explicitly DON'T want to call INHERITED::notifyAddedToRasterCache. That ties the
        // lifetime of derived/cached resources to the image. In this case, we only want cached
        // data (eg mips) tied to the lifetime of the underlying pixelRef.
        SkASSERT(fBitmap.pixelRef());
        fBitmap.pixelRef()->notifyAddedToCache();
    }

◆ onAsLegacyBitmap()

bool SkImage_Raster::onAsLegacyBitmap	(	GrDirectContext *	,
		SkBitmap *	bitmap
	)		const

overridevirtual

Reimplemented from SkImage_Base.

Definition at line 194 of file SkImage_Raster.cpp.

                                                                              {
    // When we're a snapshot from a surface, our bitmap may not be marked immutable
    // even though logically always we are, but in that case we can't physically share our
    // pixelref since the caller might call setImmutable() themselves
    // (thus changing our state).
    if (fBitmap.isImmutable()) {
        SkIPoint origin = fBitmap.pixelRefOrigin();
        bitmap->setInfo(fBitmap.info(), fBitmap.rowBytes());
        bitmap->setPixelRef(sk_ref_sp(fBitmap.pixelRef()), origin.x(), origin.y());
        return true;
    }
    return this->SkImage_Base::onAsLegacyBitmap(nullptr, bitmap);
}

◆ onHasMipmaps()

bool SkImage_Raster::onHasMipmaps ( ) const

inlineoverridevirtual

Implements SkImage_Base.

Definition at line 75 of file SkImage_Raster.h.

75{ return SkToBool(fBitmap.fMips); }

SkToBool

static constexpr bool SkToBool(const T &x)

Definition SkTo.h:35

◆ onIsProtected()

bool SkImage_Raster::onIsProtected ( ) const

inlineoverridevirtual

Implements SkImage_Base.

Definition at line 76 of file SkImage_Raster.h.

76{ return false; }

◆ onMakeColorTypeAndColorSpace()

sk_sp< SkImage > SkImage_Raster::onMakeColorTypeAndColorSpace	(	SkColorType	targetCT,
		sk_sp< SkColorSpace >	targetCS,
		GrDirectContext *
	)		const

overridevirtual

Implements SkImage_Base.

Definition at line 210 of file SkImage_Raster.cpp.

                                                                                    {
    SkPixmap src;
    SkAssertResult(fBitmap.peekPixels(&src));
 
    SkBitmap dst;
    if (!dst.tryAllocPixels(fBitmap.info().makeColorType(targetCT).makeColorSpace(targetCS))) {
        return nullptr;
    }
 
    SkAssertResult(dst.writePixels(src));
    dst.setImmutable();
    return dst.asImage();
}

◆ onMakeSubset() [1/2]

sk_sp< SkImage > SkImage_Raster::onMakeSubset	(	GrDirectContext *	,
		const SkIRect &	subset
	)		const

overridevirtual

Implements SkImage_Base.

Definition at line 104 of file SkImage_Raster.cpp.

                                                                                         {
    SkBitmap copy = copy_bitmap_subset(fBitmap, subset);
    if (copy.isNull()) {
        return nullptr;
    } else {
        return copy.asImage();
    }
}

◆ onMakeSubset() [2/2]

sk_sp< SkImage > SkImage_Raster::onMakeSubset	(	skgpu::graphite::Recorder *	,
		const SkIRect &	subset,
		RequiredProperties	requiredProperties
	)		const

overridevirtual

Implements SkImage_Base.

Definition at line 135 of file SkImage_Raster.cpp.

                                                                                         {
    sk_sp<SkImage> img;
 
    if (requiredProperties.fMipmapped) {
        bool fullCopy = subset == SkIRect::MakeSize(fBitmap.dimensions());
 
        sk_sp<SkMipmap> mips = fullCopy ? copy_mipmaps(fBitmap, fBitmap.fMips.get()) : nullptr;
 
        // SkImage::withMipmaps will always make a copy for us so we can temporarily share
        // the pixel ref with fBitmap
        SkBitmap tmpSubset;
        if (!fBitmap.extractSubset(&tmpSubset, subset)) {
            return nullptr;
        }
 
        sk_sp<SkImage> tmp(new SkImage_Raster(tmpSubset, /* bitmapMayBeMutable= */ true));
 
        // withMipmaps will auto generate the mipmaps if a nullptr is passed in
        SkASSERT(!mips || mips->validForRootLevel(tmp->imageInfo()));
        img = tmp->withMipmaps(std::move(mips));
    } else {
        SkBitmap copy = copy_bitmap_subset(fBitmap, subset);
        if (!copy.isNull()) {
            img = copy.asImage();
        }
    }
 
    return img;
}

◆ onMakeWithMipmaps()

sk_sp< SkImage > SkImage_Raster::onMakeWithMipmaps ( sk_sp< SkMipmap > mips ) const

inlineoverridevirtual

Reimplemented from SkImage_Base.

Definition at line 80 of file SkImage_Raster.h.

                                                                          {
        // It's dangerous to have two SkBitmaps that share a SkPixelRef but have different SkMipmaps
        // since various caches key on SkPixelRef's generation ID. Also, SkPixelRefs that back
        // SkSurfaces are marked "temporarily immutable" and making an image that uses the same
        // SkPixelRef can interact badly with SkSurface/SkImage copy-on-write. So we just always
        // make a copy with a new ID.
        static auto constexpr kCopyMode = SkCopyPixelsMode::kAlways_SkCopyPixelsMode;
        sk_sp<SkImage> img = SkMakeImageFromRasterBitmap(fBitmap, kCopyMode);
        auto imgRaster = static_cast<SkImage_Raster*>(img.get());
        if (mips) {
            imgRaster->fBitmap.fMips = std::move(mips);
        } else {
            imgRaster->fBitmap.fMips.reset(SkMipmap::Build(fBitmap.pixmap(), nullptr));
        }
        return img;
    }

◆ onPeekBitmap()

const SkBitmap * SkImage_Raster::onPeekBitmap ( ) const

inlineoverridevirtual

Reimplemented from SkImage_Base.

Definition at line 50 of file SkImage_Raster.h.

50{ return &fBitmap; }

◆ onPeekMips()

SkMipmap * SkImage_Raster::onPeekMips ( ) const

inlineoverridevirtual

Reimplemented from SkImage_Base.

Definition at line 78 of file SkImage_Raster.h.

78{ return fBitmap.fMips.get(); }

◆ onPeekPixels()

bool SkImage_Raster::onPeekPixels ( SkPixmap * pm ) const

overridevirtual

Reimplemented from SkImage_Base.

Definition at line 74 of file SkImage_Raster.cpp.

                                                    {
    return fBitmap.peekPixels(pm);
}

◆ onReadPixels()

bool SkImage_Raster::onReadPixels	(	GrDirectContext *	,
		const SkImageInfo &	dstInfo,
		void *	dstPixels,
		size_t	dstRowBytes,
		int	srcX,
		int	srcY,
		CachingHint
	)		const

overridevirtual

Implements SkImage_Base.

Definition at line 63 of file SkImage_Raster.cpp.

                                                     {
    SkBitmap shallowCopy(fBitmap);
    return shallowCopy.readPixels(dstInfo, dstPixels, dstRowBytes, srcX, srcY);
}

◆ onReinterpretColorSpace()

sk_sp< SkImage > SkImage_Raster::onReinterpretColorSpace ( sk_sp< SkColorSpace > newCS ) const

overridevirtual

Implements SkImage_Base.

Definition at line 226 of file SkImage_Raster.cpp.

                                                                                      {
    // TODO: If our bitmap is immutable, then we could theoretically create another image sharing
    // our pixelRef. That doesn't work (without more invasive logic), because the image gets its
    // gen ID from the bitmap, which gets it from the pixelRef.
    SkPixmap pixmap = fBitmap.pixmap();
    pixmap.setColorSpace(std::move(newCS));
    return SkImages::RasterFromPixmapCopy(pixmap);
}

◆ type()

SkImage_Base::Type SkImage_Raster::type ( ) const

inlineoverridevirtual

Implements SkImage_Base.

Reimplemented in SkImage_RasterPinnable.

Definition at line 97 of file SkImage_Raster.h.

97{ return SkImage_Base::Type::kRaster; }

SkImage_Base::Type::kRaster

@ kRaster

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

third_party/skia/src/image/SkImage_Raster.h
third_party/skia/src/image/SkImage_Raster.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SkImage_Raster() [1/2]

◆ SkImage_Raster() [2/2]

◆ ~SkImage_Raster()

Member Function Documentation

◆ bitmap()

◆ getPixelRef()

◆ getROPixels()

◆ isValid()

◆ notifyAddedToRasterCache()

◆ onAsLegacyBitmap()

◆ onHasMipmaps()

◆ onIsProtected()

◆ onMakeColorTypeAndColorSpace()

◆ onMakeSubset() [1/2]

◆ onMakeSubset() [2/2]

◆ onMakeWithMipmaps()

◆ onPeekBitmap()

◆ onPeekMips()

◆ onPeekPixels()

◆ onReadPixels()

◆ onReinterpretColorSpace()

◆ type()