SkFlattenable Class Reference

#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
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 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	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.

Definition at line 28 of file SkFlattenable.h.

Member Typedef Documentation

Factory

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

Definition at line 41 of file SkFlattenable.h.

Member Enumeration Documentation

Type

enum SkFlattenable::Type

Enumerator
kSkColorFilter_Type
kSkBlender_Type
kSkDrawable_Type
kSkDrawLooper_Type
kSkImageFilter_Type
kSkMaskFilter_Type
kSkPathEffect_Type
kSkShader_Type

Definition at line 30 of file SkFlattenable.h.

              {
        kSkColorFilter_Type,
        kSkBlender_Type,
        kSkDrawable_Type,
        kSkDrawLooper_Type,  // no longer supported by Skia
        kSkImageFilter_Type,
        kSkMaskFilter_Type,
        kSkPathEffect_Type,
        kSkShader_Type,
    };

Constructor & Destructor Documentation

SkFlattenable()

SkFlattenable::SkFlattenable ( )

inline

Definition at line 43 of file SkFlattenable.h.

{}

Member Function Documentation

Deserialize()

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

static

Definition at line 151 of file SkFlattenable.cpp.

                                                                                           {
    SkReadBuffer buffer(data, size);
    if (procs) {
        buffer.setDeserialProcs(*procs);
    }
    return sk_sp<SkFlattenable>(buffer.readFlattenable(type));
}

FactoryToName()

const char * SkFlattenable::FactoryToName ( Factory  fact )

static

Definition at line 112 of file SkFlattenable.cpp.

                                                     {
    RegisterFlattenablesIfNeeded();
 
    const Entry* entries = gEntries;
    for (int i = gCount - 1; i >= 0; --i) {
        if (entries[i].fFactory == fact) {
            return entries[i].fName;
        }
    }
    return nullptr;
}

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 SkBlurMaskFilterImpl, SkImageFilter_Base, SkLocalMatrixImageFilter, SkBlendModeColorFilter, SkGaussianColorFilter, SkMatrixColorFilter, SkRuntimeImageFilter, SkDashImpl, SkEmbossMaskFilter, SkShaderMaskFilterImpl, SkTableMaskFilterImpl, SkTrimPE, SkGradientBaseShader, SkBlendShader, SkColorFilterShader, SkColorShader, SkColor4Shader, SkCoordClampShader, SkImageShader, SkLocalMatrixShader, SkCTMShader, SkPerlinNoiseShader, SkPictureShader, SkShaderBase, SkBlendModeBlender, SkPairPathEffect, SkRecordedDrawable, SkRuntimeBlender, SkColorSpaceXformColorFilter, SkComposeColorFilter, SkRuntimeColorFilter, SkTableColorFilter, SkWorkingFormatColorFilter, SkPath1DPathEffectImpl, Sk2DPathEffect, SkLine2DPathEffectImpl, SkPath2DPathEffectImpl, SkCornerPathEffectImpl, SkDiscretePathEffectImpl, SkConicalGradient, SkLinearGradient, SkRadialGradient, SkSweepGradient, SkEmptyShader, SkRuntimeShader, SkWorkingColorSpaceShader, IntDrawable, PaintDrawable, CompoundDrawable, and RootDrawable.

Definition at line 67 of file SkFlattenable.h.

{}

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, SkPath1DPathEffectImpl, SkLine2DPathEffectImpl, SkPath2DPathEffectImpl, SkCornerPathEffectImpl, SkDiscretePathEffectImpl, SkTransformShader, SkTriColorShader, FailureColorFilter, IntDrawable, PaintDrawable, CompoundDrawable, and RootDrawable.

getFlattenableType()

virtual Type SkFlattenable::getFlattenableType ( ) const

pure virtual

Implemented in SkDrawable, SkBlenderBase, SkImageFilter_Base, SkMaskFilterBase, SkPathEffectBase, SkColorFilterBase, and SkShaderBase.

getTypeName()

virtual const char * SkFlattenable::getTypeName ( ) const

pure virtual

Returns the name of the object's class.

Implemented in SkDrawable, SkPath1DPathEffectImpl, SkLine2DPathEffectImpl, SkPath2DPathEffectImpl, SkCornerPathEffectImpl, SkDiscretePathEffectImpl, SkTransformShader, SkTriColorShader, FailureColorFilter, IntDrawable, PaintDrawable, CompoundDrawable, and RootDrawable.

NameToFactory()

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

static

Definition at line 101 of file SkFlattenable.cpp.

                                                                   {
    RegisterFlattenablesIfNeeded();
 
    SkASSERT(std::is_sorted(gEntries, gEntries + gCount, EntryComparator()));
    auto pair = std::equal_range(gEntries, gEntries + gCount, name, EntryComparator());
    if (pair.first == pair.second) {
        return nullptr;
    }
    return pair.first->fFactory;
}

Register()

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

static

Definition at line 91 of file SkFlattenable.cpp.

                                                               {
    SkASSERT(name);
    SkASSERT(factory);
    SkASSERT(gCount < (int)std::size(gEntries));
 
    gEntries[gCount].fName = name;
    gEntries[gCount].fFactory = factory;
    gCount += 1;
}

serialize() [1/2]

sk_sp< SkData > SkFlattenable::serialize

(

const SkSerialProcs *

procs = nullptr

)

const

Definition at line 126 of file SkFlattenable.cpp.

                                                                       {
    SkSerialProcs p;
    if (procs) {
        p = *procs;
    }
    SkBinaryWriteBuffer writer(p);
 
    writer.writeFlattenable(this);
    size_t size = writer.bytesWritten();
    auto data = SkData::MakeUninitialized(size);
    writer.writeToMemory(data->writable_data());
    return data;
}

serialize() [2/2]

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

Definition at line 140 of file SkFlattenable.cpp.

                                                                  {
    SkSerialProcs p;
    if (procs) {
        p = *procs;
    }
    SkBinaryWriteBuffer writer(memory, memory_size, p);
    writer.writeFlattenable(this);
    return writer.usingInitialStorage() ? writer.bytesWritten() : 0u;
}

Friends And Related Symbol Documentation

SkGraphics

friend class SkGraphics

friend

Definition at line 91 of file SkFlattenable.h.

---

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

• third_party/skia/include/core/SkFlattenable.h
• third_party/skia/src/core/SkFlattenable.cpp
• third_party/skia/src/core/SkGlobalInitialization_core.cpp