SkPictureShader Class Reference

#include <SkPictureShader.h>

Inheritance diagram for SkPictureShader:

Classes
struct	CachedImageInfo

Public Member Functions
	SkPictureShader (sk_sp< SkPicture >, SkTileMode, SkTileMode, SkFilterMode, const SkRect *)
ShaderType	type () const override
sk_sp< SkPicture >	picture () const
SkRect	tile () const
SkTileMode	tileModeX () const
SkTileMode	tileModeY () const
SkFilterMode	filter () const
Public Member Functions inherited from SkShaderBase
	~SkShaderBase () override
sk_sp< SkShader >	makeInvertAlpha () const
sk_sp< SkShader >	makeWithCTM (const SkMatrix &) const
virtual bool	isConstant () const
virtual ShaderType	type () const =0
virtual GradientType	asGradient (GradientInfo *info=nullptr, SkMatrix *localMatrix=nullptr) const
Context *	makeContext (const ContextRec &, SkArenaAlloc *) const
bool	asLuminanceColor (SkColor4f *) const
bool	appendRootStages (const SkStageRec &rec, const SkMatrix &ctm) const
virtual bool	appendStages (const SkStageRec &, const SkShaders::MatrixRec &) const =0
virtual SkImage *	onIsAImage (SkMatrix *, SkTileMode[2]) const
virtual SkRuntimeEffect *	asRuntimeEffect () const
Type	getFlattenableType () const override
virtual sk_sp< SkShader >	makeAsALocalMatrixShader (SkMatrix *localMatrix) const
Public Member Functions inherited from SkShader
virtual bool	isOpaque () const
SkImage *	isAImage (SkMatrix *localMatrix, SkTileMode xy[2]) const
bool	isAImage () const
sk_sp< SkShader >	makeWithLocalMatrix (const SkMatrix &) const
sk_sp< SkShader >	makeWithColorFilter (sk_sp< SkColorFilter >) const
sk_sp< SkShader >	makeWithWorkingColorSpace (sk_sp< SkColorSpace >) const
Public Member Functions inherited from SkFlattenable
	SkFlattenable ()
virtual Factory	getFactory () const =0
virtual const char *	getTypeName () const =0
virtual void	flatten (SkWriteBuffer &) const
virtual Type	getFlattenableType () const =0
sk_sp< SkData >	serialize (const SkSerialProcs *=nullptr) const
size_t	serialize (void *memory, size_t memory_size, const SkSerialProcs *=nullptr) 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< SkShader >	Make (sk_sp< SkPicture >, SkTileMode, SkTileMode, SkFilterMode, const SkMatrix *, const SkRect *)
Static Public Member Functions inherited from SkShaderBase
static Type	GetFlattenableType ()
static sk_sp< SkShaderBase >	Deserialize (const void *data, size_t size, const SkDeserialProcs *procs=nullptr)
static void	RegisterFlattenables ()
static SkMatrix	ConcatLocalMatrices (const SkMatrix &parentLM, const SkMatrix &childLM)
Static Public Member Functions inherited from SkFlattenable
static Factory	NameToFactory (const char name[])
static const char *	FactoryToName (Factory)
static void	Register (const char name[], Factory)
static sk_sp< SkFlattenable >	Deserialize (Type, const void *data, size_t length, const SkDeserialProcs *procs=nullptr)

Protected Member Functions
	SkPictureShader (SkReadBuffer &)
void	flatten (SkWriteBuffer &) const override
bool	appendStages (const SkStageRec &, const SkShaders::MatrixRec &) const override
Protected Member Functions inherited from SkShaderBase
	SkShaderBase ()
void	flatten (SkWriteBuffer &) const override
virtual bool	onAsLuminanceColor (SkColor4f *) const

Additional Inherited Members
Public Types inherited from SkShaderBase
enum class	ShaderType { M }
enum class	GradientType { kNone , M }
enum	Flags { kOpaqueAlpha_Flag = 1 << 0 }
Public Types inherited from SkFlattenable
enum	Type {   kSkColorFilter_Type , kSkBlender_Type , kSkDrawable_Type , kSkDrawLooper_Type ,   kSkImageFilter_Type , kSkMaskFilter_Type , kSkPathEffect_Type , kSkShader_Type }
typedef sk_sp< SkFlattenable >(*	Factory) (SkReadBuffer &)

Detailed Description

Definition at line 40 of file SkPictureShader.h.

Constructor & Destructor Documentation

SkPictureShader() [1/2]

SkPictureShader::SkPictureShader	(	sk_sp< SkPicture >	picture,
		SkTileMode	tmx,
		SkTileMode	tmy,
		SkFilterMode	filter,
		const SkRect *	tile
	)

Definition at line 113 of file SkPictureShader.cpp.

        : fPicture(std::move(picture))
        , fTile(tile ? *tile : fPicture->cullRect())
        , fTmx(tmx)
        , fTmy(tmy)
        , fFilter(filter) {}

SkPictureShader() [2/2]

SkPictureShader::SkPictureShader ( SkReadBuffer &  )

protected

Member Function Documentation

appendStages()

bool SkPictureShader::appendStages ( const SkStageRec &  , const SkShaders::MatrixRec &    ) const

overrideprotectedvirtual

Adds stages to implement this shader. To ensure that the correct input coords are present in r,g MatrixRec::apply() must be called (unless the shader doesn't require it's input coords). The default impl creates shadercontext and calls that (not very efficient).

Implements SkShaderBase.

Definition at line 288 of file SkPictureShader.cpp.

                                                                                              {
    // Keep bitmapShader alive by using alloc instead of stack memory
    auto& bitmapShader = *rec.fAlloc->make<sk_sp<SkShader>>();
    // We don't check whether the total local matrix is valid here because we have to assume *some*
    // mapping to make an image. It could be wildly wrong if there is a runtime shader transforming
    // the coordinates in a manner we don't know about here. However, that is a fundamental problem
    // with the technique of converting a picture to an image to implement this shader.
    bitmapShader = this->rasterShader(mRec.totalMatrix(),
                                      rec.fDstColorType,
                                      rec.fDstCS,
                                      rec.fSurfaceProps);
    if (!bitmapShader) {
        return false;
    }
    return as_SB(bitmapShader)->appendStages(rec, mRec);
}

filter()

SkFilterMode SkPictureShader::filter ( ) const

inline

Definition at line 53 of file SkPictureShader.h.

{ return fFilter; }

flatten()

void SkPictureShader::flatten ( SkWriteBuffer &  ) const

overrideprotectedvirtual

Override this if your subclass needs to record data that it will need to recreate itself from its CreateProc (returned by getFactory()).

DEPRECATED public : will move to protected ... use serialize() instead

Reimplemented from SkFlattenable.

Definition at line 168 of file SkPictureShader.cpp.

                                                         {
    buffer.write32((unsigned)fTmx);
    buffer.write32((unsigned)fTmy);
    buffer.writeRect(fTile);
    buffer.write32((unsigned)fFilter);
    SkPicturePriv::Flatten(fPicture, buffer);
}

Make()

sk_sp< SkShader > SkPictureShader::Make ( sk_sp< SkPicture >  picture, SkTileMode  tmx, SkTileMode  tmy, SkFilterMode  filter, const SkMatrix *  lm, const SkRect *  tile  )

static

Definition at line 124 of file SkPictureShader.cpp.

                                                                                                   {
    if (!picture || picture->cullRect().isEmpty() || (tile && tile->isEmpty())) {
        return SkShaders::Empty();
    }
    return SkLocalMatrixShader::MakeWrapped<SkPictureShader>(lm,
                                                             std::move(picture),
                                                             tmx, tmy,
                                                             filter,
                                                             tile);
}

picture()

sk_sp< SkPicture > SkPictureShader::picture ( ) const

inline

Definition at line 49 of file SkPictureShader.h.

{ return fPicture; }

tile()

SkRect SkPictureShader::tile ( ) const

inline

Definition at line 50 of file SkPictureShader.h.

{ return fTile; }

tileModeX()

SkTileMode SkPictureShader::tileModeX ( ) const

inline

Definition at line 51 of file SkPictureShader.h.

{ return fTmx; }

tileModeY()

SkTileMode SkPictureShader::tileModeY ( ) const

inline

Definition at line 52 of file SkPictureShader.h.

{ return fTmy; }

type()

ShaderType SkPictureShader::type ( ) const

inlineoverridevirtual

Implements SkShaderBase.

Definition at line 47 of file SkPictureShader.h.

{ return ShaderType::kPicture; }

---

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

• third_party/skia/src/shaders/SkPictureShader.h
• third_party/skia/src/shaders/SkPictureShader.cpp