Skia
2D Graphics Library
SkFlattenable Class Referenceabstract

SkFlattenable is the base class for objects that need to be flattened into a data stream for either transport or as part of the key to the font cache. More...

#include <SkFlattenable.h>

Inheritance diagram for SkFlattenable:

Classes

class  PrivateInitializer
 

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

 SkFlattenable ()
 
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< SkDataserialize (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< SkFlattenableDeserialize (Type, const void *data, size_t length, const SkDeserialProcs *procs=nullptr)
 

Friends

class SkGraphics
 

Detailed Description

SkFlattenable is the base class for objects that need to be flattened into a data stream for either transport or as part of the key to the font cache.

Member Typedef Documentation

◆ Factory

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

Member Enumeration Documentation

◆ Type

Enumerator
kSkColorFilter_Type 
kSkBlender_Type 
kSkDrawable_Type 
kSkDrawLooper_Type 
kSkImageFilter_Type 
kSkMaskFilter_Type 
kSkPathEffect_Type 
kSkShader_Type 

Constructor & Destructor Documentation

◆ SkFlattenable()

SkFlattenable::SkFlattenable ( )
inline

Member Function Documentation

◆ Deserialize()

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

◆ FactoryToName()

static const char* SkFlattenable::FactoryToName ( Factory  )
static

◆ flatten()

virtual void SkFlattenable::flatten ( SkWriteBuffer &  ) const
inlinevirtual

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 virtual

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 virtual

Implemented in SkDrawLooper, and SkDrawable.

◆ getTypeName()

virtual const char* SkFlattenable::getTypeName ( ) const
pure virtual

Returns the name of the object's class.

Implemented in SkDrawable.

◆ NameToFactory()

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

◆ 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   
)
static

◆ serialize() [1/2]

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

◆ serialize() [2/2]

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

◆ 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

◆ SkGraphics

friend class SkGraphics
friend

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