SkMaskFilter Class Reference

SkMaskFilter is the base class for object that perform transformations on the mask before drawing it. More...

#include <SkMaskFilter.h>

Inheritance diagram for SkMaskFilter:

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
SkRect	approximateFilteredBounds (const SkRect &src) const
	Returns the approximate bounds that would result from filtering the src rect. 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 sk_sp< SkMaskFilter >	MakeBlur (SkBlurStyle style, SkScalar sigma, bool respectCTM=true)
	Create a blur maskfilter. More...
static sk_sp< SkMaskFilter >	Deserialize (const void *data, size_t size, const SkDeserialProcs *procs=nullptr)
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	SkFlattenable

Detailed Description

SkMaskFilter is the base class for object that perform transformations on the mask before drawing it.

An example subclass is Blur.

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

approximateFilteredBounds()

SkRect SkMaskFilter::approximateFilteredBounds

(

const SkRect &

src

)

const

Returns the approximate bounds that would result from filtering the src rect.

The actual result may be different, but it should be contained within the returned bounds.

Deserialize() [1/2]

static sk_sp<SkMaskFilter> SkMaskFilter::Deserialize ( const void *  data, size_t  size, const SkDeserialProcs *  procs = nullptr  )

static

Deserialize() [2/2]

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.

MakeBlur()

static sk_sp<SkMaskFilter> SkMaskFilter::MakeBlur ( SkBlurStyle  style, SkScalar  sigma, bool  respectCTM = true  )

static

Create a blur maskfilter.

Parameters

style	The SkBlurStyle to use
sigma	Standard deviation of the Gaussian blur to apply. Must be > 0.
respectCTM	if true the blur's sigma is modified by the CTM.

Returns

The new blur maskfilter

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

SkFlattenable

friend class SkFlattenable

friend

---

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

• /CHECKOUT/include/core/SkMaskFilter.h