SkSpecialImage Class Reference

#include <SkSpecialImage.h>

Inheritance diagram for SkSpecialImage:

Public Types
typedef void *	ReleaseContext
typedef void(*	RasterReleaseProc) (void *pixels, ReleaseContext)

Public Member Functions
const SkSurfaceProps &	props () const
int	width () const
int	height () const
SkISize	dimensions () const
const SkIRect &	subset () const
uint32_t	uniqueID () const
virtual SkISize	backingStoreDimensions () const =0
virtual size_t	getSize () const =0
bool	isExactFit () const
const SkColorInfo &	colorInfo () const
SkAlphaType	alphaType () const
SkColorType	colorType () const
SkColorSpace *	getColorSpace () const
void	draw (SkCanvas *canvas, SkScalar x, SkScalar y, const SkSamplingOptions &sampling, const SkPaint *paint, bool strict=true) const
void	draw (SkCanvas *canvas, SkScalar x, SkScalar y) const
sk_sp< SkSpecialImage >	makeSubset (const SkIRect &subset) const
sk_sp< SkSpecialImage >	makePixelOutset () const
virtual sk_sp< SkImage >	asImage () const =0
virtual sk_sp< SkShader >	asShader (SkTileMode, const SkSamplingOptions &, const SkMatrix &lm, bool strict=true) const
virtual bool	isGaneshBacked () const
virtual bool	isGraphiteBacked () const
virtual GrRecordingContext *	getContext () const
Public Member Functions inherited from SkRefCntBase
	SkRefCntBase ()
virtual	~SkRefCntBase ()
bool	unique () const
void	ref () const
void	unref () const

Protected Member Functions
	SkSpecialImage (const SkIRect &subset, uint32_t uniqueID, const SkColorInfo &, const SkSurfaceProps &)
virtual sk_sp< SkSpecialImage >	onMakeBackingStoreSubset (const SkIRect &subset) const =0

Detailed Description

This is a restricted form of SkImage solely intended for internal use. It differs from SkImage in that:

• it can only be backed by raster or gpu (no generators)
• it can be backed by a GrTextureProxy larger than its nominal bounds
• it can't be drawn tiled
• it can't be drawn with MIPMAPs It is similar to SkImage in that it abstracts how the pixels are stored/represented.

Note: the contents of the backing storage outside of the subset rect are undefined.

Definition at line 49 of file SkSpecialImage.h.

Member Typedef Documentation

RasterReleaseProc

typedef void(* SkSpecialImage::RasterReleaseProc) (void *pixels, ReleaseContext)

Definition at line 52 of file SkSpecialImage.h.

ReleaseContext

typedef void* SkSpecialImage::ReleaseContext

Definition at line 51 of file SkSpecialImage.h.

Constructor & Destructor Documentation

SkSpecialImage()

SkSpecialImage::SkSpecialImage ( const SkIRect &  subset, uint32_t  uniqueID, const SkColorInfo &  colorInfo, const SkSurfaceProps &  props  )

protected

Definition at line 29 of file SkSpecialImage.cpp.

    : fSubset(subset)
    , fUniqueID(kNeedNewImageUniqueID_SpecialImage == uniqueID ? SkNextID::ImageID() : uniqueID)
    , fColorInfo(colorInfo)
    , fProps(props) {
}

Member Function Documentation

alphaType()

SkAlphaType SkSpecialImage::alphaType ( ) const

inline

Definition at line 70 of file SkSpecialImage.h.

{ return fColorInfo.alphaType(); }

asImage()

virtual sk_sp< SkImage > SkSpecialImage::asImage ( ) const

pure virtual

Create an SkImage view of the contents of this special image, pointing to the same underlying memory.

TODO: If SkImages::MakeFiltered were to return an SkShader that accounted for the subset constraint and offset, then this could move to a private virtual for use in draw() and asShader().

Implemented in SkSpecialImage_Raster, SkSpecialImage_Gpu, and skgpu::graphite::SpecialImage.

asShader()

sk_sp< SkShader > SkSpecialImage::asShader ( SkTileMode  tileMode, const SkSamplingOptions &  sampling, const SkMatrix &  lm, bool  strict = true  ) const

virtual

Create an SkShader that samples the contents of this special image, applying tile mode for any sample that falls outside its internal subset.

'strict' defaults to true and applies shader-based tiling to the subset. If the subset is the same as the backing store dimensions, it is automatically degraded to non-strict (HW tiling and sampling). 'strict' can be set to false if it's known that the subset boundaries aren't visible AND the texel data in adjacent rows/cols is valid to be included by the given sampling options.

Reimplemented in SkSpecialImage_Raster.

Definition at line 52 of file SkSpecialImage.cpp.

                                                            {
    // The special image's logical (0,0) is at its subset's topLeft() so we need to account for
    // that in the local matrix used when sampling.
    SkMatrix subsetOrigin = SkMatrix::Translate(-this->subset().topLeft());
    subsetOrigin.postConcat(lm);
 
    if (strict) {
        // However, we don't need to modify the subset itself since that is defined with respect
        // to the base image, and the local matrix is applied before any tiling/clamping.
        const SkRect subset = SkRect::Make(this->subset());
 
        // asImage() w/o a subset makes no copy; create the SkImageShader directly to remember
        // the subset used to access the image.
        return SkImageShader::MakeSubset(
                this->asImage(), subset, tileMode, tileMode, sampling, &subsetOrigin);
    } else {
        // Ignore 'subset' other than its origin translation applied to the local matrix.
        return this->asImage()->makeShader(tileMode, tileMode, sampling, subsetOrigin);
    }
}

backingStoreDimensions()

virtual SkISize SkSpecialImage::backingStoreDimensions ( ) const

pure virtual

Implemented in SkSpecialImage_Raster, SkSpecialImage_Gpu, and skgpu::graphite::SpecialImage.

colorInfo()

const SkColorInfo & SkSpecialImage::colorInfo ( ) const

inline

Definition at line 69 of file SkSpecialImage.h.

{ return fColorInfo; }

colorType()

SkColorType SkSpecialImage::colorType ( ) const

inline

Definition at line 71 of file SkSpecialImage.h.

{ return fColorInfo.colorType(); }

dimensions()

SkISize SkSpecialImage::dimensions ( ) const

inline

Definition at line 58 of file SkSpecialImage.h.

{ return { this->width(), this->height() }; }

draw() [1/2]

void SkSpecialImage::draw ( SkCanvas *  canvas, SkScalar  x, SkScalar  y  ) const

inline

Definition at line 82 of file SkSpecialImage.h.

                                                              {
        this->draw(canvas, x, y, SkSamplingOptions(), nullptr);
    }

draw() [2/2]

void SkSpecialImage::draw	(	SkCanvas *	canvas,
		SkScalar	x,
		SkScalar	y,
		const SkSamplingOptions &	sampling,
		const SkPaint *	paint,
		bool	strict = true
	)		const

Draw this SpecialImage into the canvas, automatically taking into account the image's subset

Definition at line 39 of file SkSpecialImage.cpp.

                                                                   {
    SkRect dst = SkRect::MakeXYWH(x, y, this->subset().width(), this->subset().height());
 
    canvas->drawImageRect(this->asImage(), SkRect::Make(this->subset()), dst,
                          sampling, paint, strict ? SkCanvas::kStrict_SrcRectConstraint
                                                  : SkCanvas::kFast_SrcRectConstraint);
}

getColorSpace()

SkColorSpace * SkSpecialImage::getColorSpace ( ) const

inline

Definition at line 72 of file SkSpecialImage.h.

{ return fColorInfo.colorSpace(); }

getContext()

virtual GrRecordingContext * SkSpecialImage::getContext ( ) const

inlinevirtual

Return the GrRecordingContext if the SkSpecialImage is GrTexture-backed

Reimplemented in SkSpecialImage_Gpu.

Definition at line 138 of file SkSpecialImage.h.

{ return nullptr; }

getSize()

virtual size_t SkSpecialImage::getSize ( ) const

pure virtual

Implemented in SkSpecialImage_Raster, SkSpecialImage_Gpu, and skgpu::graphite::SpecialImage.

height()

int SkSpecialImage::height ( ) const

inline

Definition at line 57 of file SkSpecialImage.h.

{ return fSubset.height(); }

isExactFit()

bool SkSpecialImage::isExactFit ( ) const

inline

Definition at line 67 of file SkSpecialImage.h.

{ return fSubset == SkIRect::MakeSize(this->backingStoreDimensions()); }

isGaneshBacked()

virtual bool SkSpecialImage::isGaneshBacked ( ) const

inlinevirtual

If the SpecialImage is backed by a gpu texture, return true.

Reimplemented in SkSpecialImage_Gpu.

Definition at line 132 of file SkSpecialImage.h.

{ return false; }

isGraphiteBacked()

virtual bool SkSpecialImage::isGraphiteBacked ( ) const

inlinevirtual

Reimplemented in skgpu::graphite::SpecialImage.

Definition at line 133 of file SkSpecialImage.h.

{ return false; }

makePixelOutset()

sk_sp< SkSpecialImage > SkSpecialImage::makePixelOutset ( ) const

inline

Return a special image with a 1px larger subset in the backing store compared to this image. This should only be used when it's externally known that those outer pixels are valid.

Definition at line 100 of file SkSpecialImage.h.

                                                  {
        return this->onMakeBackingStoreSubset(this->subset().makeOutset(1, 1));
    }

makeSubset()

sk_sp< SkSpecialImage > SkSpecialImage::makeSubset ( const SkIRect &  subset ) const

inline

Extract a subset of this special image and return it as a special image. It may or may not point to the same backing memory. The input 'subset' is relative to the special image's content rect.

Definition at line 91 of file SkSpecialImage.h.

                                                                  {
        SkIRect absolute = subset.makeOffset(this->subset().topLeft());
        return this->onMakeBackingStoreSubset(absolute);
    }

onMakeBackingStoreSubset()

virtual sk_sp< SkSpecialImage > SkSpecialImage::onMakeBackingStoreSubset ( const SkIRect &  subset ) const

protectedpure virtual

Implemented in SkSpecialImage_Raster, SkSpecialImage_Gpu, and skgpu::graphite::SpecialImage.

props()

const SkSurfaceProps & SkSpecialImage::props ( ) const

inline

Definition at line 54 of file SkSpecialImage.h.

{ return fProps; }

subset()

const SkIRect & SkSpecialImage::subset ( ) const

inline

Definition at line 59 of file SkSpecialImage.h.

{ return fSubset; }

uniqueID()

uint32_t SkSpecialImage::uniqueID ( ) const

inline

Definition at line 61 of file SkSpecialImage.h.

{ return fUniqueID; }

width()

int SkSpecialImage::width ( ) const

inline

Definition at line 56 of file SkSpecialImage.h.

{ return fSubset.width(); }

---

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

• third_party/skia/src/core/SkSpecialImage.h
• third_party/skia/src/core/SkSpecialImage.cpp