SkShader Class Reference

Shaders specify the source color(s) for what is being drawn. More...

#include <SkShader.h>

Inheritance diagram for SkShader:

Public Types
enum	Type {   kSkColorFilter_Type , kSkBlender_Type , kSkDrawable_Type , kSkDrawLooper_Type ,   kSkImageFilter_Type , kSkMaskFilter_Type , kSkPathEffect_Type , kSkShader_Type }
typedef sk_sp< SkFlattenable >(*	Factory) (SkReadBuffer &)

Public Member Functions
virtual bool	isOpaque () const
	Returns true if the shader is guaranteed to produce only opaque colors, subject to the SkPaint using the shader to apply an opaque alpha value. More...
SkImage *	isAImage (SkMatrix *localMatrix, SkTileMode xy[2]) const
	Iff this shader is backed by a single SkImage, return its ptr (the caller must ref this if they want to keep it longer than the lifetime of the shader). More...
bool	isAImage () const
sk_sp< SkShader >	makeWithLocalMatrix (const SkMatrix &) const
	Return a shader that will apply the specified localMatrix to this shader. More...
sk_sp< SkShader >	makeWithColorFilter (sk_sp< SkColorFilter >) const
	Create a new shader that produces the same colors as invoking this shader and then applying the colorfilter. More...
sk_sp< SkShader >	makeWithWorkingColorSpace (sk_sp< SkColorSpace >) const
	Return a shader that will compute this shader in a specific color space. More...
virtual Factory	getFactory () const =0
	Implement this to return a factory function pointer that can be called to recreate your class given a buffer (previously written to by your override of flatten(). More...
virtual const char *	getTypeName () const =0
	Returns the name of the object's class. More...
virtual void	flatten (SkWriteBuffer &) const
	Override this if your subclass needs to record data that it will need to recreate itself from its CreateProc (returned by getFactory()). More...
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
bool	unique () const
	May return true if the caller is the only owner. More...
void	ref () const
	Increment the reference count. More...
void	unref () const
	Decrement the reference count. More...

Static Public Member Functions
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)

Friends
class	SkShaderBase

Detailed Description

Shaders specify the source color(s) for what is being drawn.

If a paint has no shader, then the paint's color is used. If the paint has a shader, then the shader's color(s) are use instead, but they are modulated by the paint's alpha. This makes it easy to create a shader once (e.g. bitmap tiling or gradient) and then change its transparency w/o having to modify the original shader... only the paint's alpha needs to be modified.

Member Typedef Documentation

Factory

typedef sk_sp<SkFlattenable>(* SkFlattenable::Factory) (SkReadBuffer &)

inherited

Member Enumeration Documentation

Type

enum SkFlattenable::Type

inherited

Enumerator
kSkColorFilter_Type
kSkBlender_Type
kSkDrawable_Type
kSkDrawLooper_Type
kSkImageFilter_Type
kSkMaskFilter_Type
kSkPathEffect_Type
kSkShader_Type

Member Function Documentation

Deserialize()

static sk_sp<SkFlattenable> SkFlattenable::Deserialize ( Type  , const void *  data, size_t  length, const SkDeserialProcs *  procs = nullptr  )

staticinherited

FactoryToName()

static const char* SkFlattenable::FactoryToName ( Factory  )

staticinherited

flatten()

virtual void SkFlattenable::flatten ( SkWriteBuffer &  ) const

inlinevirtualinherited

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 in SkLayerDrawLooper.

getFactory()

virtual Factory SkFlattenable::getFactory ( ) const

pure virtualinherited

Implement this to return a factory function pointer that can be called to recreate your class given a buffer (previously written to by your override of flatten().

Implemented in SkDrawable.

getFlattenableType()

virtual Type SkFlattenable::getFlattenableType ( ) const

pure virtualinherited

Implemented in SkDrawLooper, and SkDrawable.

getTypeName()

virtual const char* SkFlattenable::getTypeName ( ) const

pure virtualinherited

Returns the name of the object's class.

Implemented in SkDrawable.

isAImage() [1/2]

bool SkShader::isAImage ( ) const

inline

isAImage() [2/2]

SkImage* SkShader::isAImage	(	SkMatrix *	localMatrix,
		SkTileMode	xy[2]
	)		const

Iff this shader is backed by a single SkImage, return its ptr (the caller must ref this if they want to keep it longer than the lifetime of the shader).

If not, return nullptr.

isOpaque()

virtual bool SkShader::isOpaque ( ) const

inlinevirtual

Returns true if the shader is guaranteed to produce only opaque colors, subject to the SkPaint using the shader to apply an opaque alpha value.

Subclasses should override this to allow some optimizations.

makeWithColorFilter()

sk_sp<SkShader> SkShader::makeWithColorFilter

(

sk_sp< SkColorFilter >

)

const

Create a new shader that produces the same colors as invoking this shader and then applying the colorfilter.

makeWithLocalMatrix()

sk_sp<SkShader> SkShader::makeWithLocalMatrix

(

const SkMatrix &

)

const

Return a shader that will apply the specified localMatrix to this shader.

The specified matrix will be applied before any matrix associated with this shader.

makeWithWorkingColorSpace()

sk_sp<SkShader> SkShader::makeWithWorkingColorSpace

(

sk_sp< SkColorSpace >

)

const

Return a shader that will compute this shader in a specific color space.

By default, all shaders operate in the destination (surface) color space. The results of a shader are still always converted to the destination - this API has no impact on simple shaders or images. Primarily, it impacts shaders that perform mathematical operations, like Blend shaders, or runtime shaders.

NameToFactory()

static Factory SkFlattenable::NameToFactory ( const char  name[] )

staticinherited

ref()

void SkRefCntBase::ref ( ) const

inlineinherited

Increment the reference count.

Must be balanced by a call to unref().

Register()

static void SkFlattenable::Register ( const char  name[], Factory    )

staticinherited

serialize() [1/2]

sk_sp<SkData> SkFlattenable::serialize ( const SkSerialProcs *  = nullptr ) const

inherited

serialize() [2/2]

size_t SkFlattenable::serialize ( void *  memory, size_t  memory_size, const SkSerialProcs *  = nullptr  ) const

inherited

unique()

bool SkRefCntBase::unique ( ) const

inlineinherited

May return true if the caller is the only owner.

Ensures that all previous owner's actions are complete.

unref()

void SkRefCntBase::unref ( ) const

inlineinherited

Decrement the reference count.

If the reference count is 1 before the decrement, then delete the object. Note that if this is the case, then the object needs to have been allocated via new, and not on the stack.

Friends And Related Function Documentation

SkShaderBase

friend class SkShaderBase

friend

---

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

• /CHECKOUT/include/core/SkShader.h