Skia
2D Graphics Library
Classes | Public Types | Public Member Functions | Static Public Member Functions | Friends | List of all members
SkPathEffect Class Referenceabstract

SkPathEffect is the base class for objects in the SkPaint that affect the geometry of a drawing primitive before it is transformed by the canvas' matrix and drawn. More...

#include <SkPathEffect.h>

Inheritance diagram for SkPathEffect:
Inheritance graph
[legend]

Classes

struct  DashInfo
 

Public Types

enum  DashType { kNone_DashType , kDash_DashType }
 
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

DashType asADash (DashInfo *info) const
 
bool filterPath (SkPath *dst, const SkPath &src, SkStrokeRec *, const SkRect *cullR) const
 Given a src path (input) and a stroke-rec (input and output), apply this effect to the src path, returning the new path in dst, and return true. More...
 
bool filterPath (SkPath *dst, const SkPath &src, SkStrokeRec *, const SkRect *cullR, const SkMatrix &ctm) const
 Version of filterPath that can be called when the CTM is known. More...
 
bool needsCTM () const
 True if this path effect requires a valid CTM. 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< SkPathEffect > MakeSum (sk_sp< SkPathEffect > first, sk_sp< SkPathEffect > second)
 Returns a patheffect that apples each effect (first and second) to the original path, and returns a path with the sum of these. More...
 
static sk_sp< SkPathEffect > MakeCompose (sk_sp< SkPathEffect > outer, sk_sp< SkPathEffect > inner)
 Returns a patheffect that applies the inner effect to the path, and then applies the outer effect to the result of the inner's. More...
 
static SkFlattenable::Type GetFlattenableType ()
 
static sk_sp< SkPathEffect > 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 SkPathEffectBase
 

Detailed Description

SkPathEffect is the base class for objects in the SkPaint that affect the geometry of a drawing primitive before it is transformed by the canvas' matrix and drawn.

Dashing is implemented as a subclass of SkPathEffect.

Member Typedef Documentation

◆ Factory

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

Member Enumeration Documentation

◆ DashType

enum SkPathEffect::DashType
Enumerator
kNone_DashType 

ignores the info parameter

kDash_DashType 

fills in all of the info parameter

◆ 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

◆ asADash()

DashType SkPathEffect::asADash ( DashInfo *  info) const

◆ Deserialize() [1/2]

static sk_sp<SkPathEffect> SkPathEffect::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

◆ filterPath() [1/2]

bool SkPathEffect::filterPath ( SkPath *  dst,
const SkPath &  src,
SkStrokeRec *  ,
const SkRect *  cullR 
) const

Given a src path (input) and a stroke-rec (input and output), apply this effect to the src path, returning the new path in dst, and return true.

If this effect cannot be applied, return false and ignore dst and stroke-rec.

The stroke-rec specifies the initial request for stroking (if any). The effect can treat this as input only, or it can choose to change the rec as well. For example, the effect can decide to change the stroke's width or join, or the effect can change the rec from stroke to fill (or fill to stroke) in addition to returning a new (dst) path.

If this method returns true, the caller will apply (as needed) the resulting stroke-rec to dst and then draw.

◆ filterPath() [2/2]

bool SkPathEffect::filterPath ( SkPath *  dst,
const SkPath &  src,
SkStrokeRec *  ,
const SkRect *  cullR,
const SkMatrix &  ctm 
) const

Version of filterPath that can be called when the CTM is known.

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

static SkFlattenable::Type SkPathEffect::GetFlattenableType ( )
inlinestatic

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

◆ MakeCompose()

static sk_sp<SkPathEffect> SkPathEffect::MakeCompose ( sk_sp< SkPathEffect >  outer,
sk_sp< SkPathEffect >  inner 
)
static

Returns a patheffect that applies the inner effect to the path, and then applies the outer effect to the result of the inner's.

result = outer(inner(path))

◆ MakeSum()

static sk_sp<SkPathEffect> SkPathEffect::MakeSum ( sk_sp< SkPathEffect >  first,
sk_sp< SkPathEffect >  second 
)
static

Returns a patheffect that apples each effect (first and second) to the original path, and returns a path with the sum of these.

result = first(path) + second(path)

◆ NameToFactory()

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

◆ needsCTM()

bool SkPathEffect::needsCTM ( ) const

True if this path effect requires a valid CTM.

◆ 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

◆ SkPathEffectBase

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