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

#include <SkPathEffect.h>

Inheritance diagram for SkPathEffect:
Inheritance graph
[legend]

Classes

struct  DashInfo
 
class  PointData
 

Public Types

enum  DashType { kNone_DashType, kDash_DashType }
 If the PathEffect can be represented as a dash pattern, asADash will return kDash_DashType and None otherwise. More...
 
enum  Type {
  kSkColorFilter_Type, kSkDrawable_Type, kSkDrawLooper_Type, kSkImageFilter_Type,
  kSkMaskFilter_Type, kSkPathEffect_Type, kSkPixelRef_Type, kSkUnused_Type4,
  kSkShaderBase_Type, kSkUnused_Type, kSkUnused_Type2, kSkUnused_Type3
}
 
typedef sk_sp< SkFlattenable >(* Factory) (SkReadBuffer &)
 

Public Member Functions

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...
 
void computeFastBounds (SkRect *dst, const SkRect &src) const
 Compute a conservative bounds for its effect, given the src bounds. More...
 
bool asPoints (PointData *results, const SkPath &src, const SkStrokeRec &, const SkMatrix &, const SkRect *cullR) const
 Does applying this path effect to 'src' yield a set of points? If so, optionally return the points in 'results'. More...
 
DashType asADash (DashInfo *info) const
 
SkFlattenable::Type getFlattenableType () const override
 
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...
 
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 void RegisterFlattenables ()
 
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)
 

Protected Member Functions

 SkPathEffect ()
 
virtual bool onFilterPath (SkPath *, const SkPath &, SkStrokeRec *, const SkRect *) const =0
 
virtual SkRect onComputeFastBounds (const SkRect &src) const
 
virtual bool onAsPoints (PointData *, const SkPath &, const SkStrokeRec &, const SkMatrix &, const SkRect *) const
 
virtual DashType onAsADash (DashInfo *) const
 

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

If the PathEffect can be represented as a dash pattern, asADash will return kDash_DashType and None otherwise.

If a non NULL info is passed in, the various DashInfo will be filled in if the PathEffect can be a dash pattern. If passed in info has an fCount equal or greater to that of the effect, it will memcpy the values of the dash intervals into the info. Thus the general approach will be call asADash once with default info to get DashType and fCount. If effect can be represented as a dash pattern, allocate space for the intervals in info, then call asADash again with the same info and the intervals will get copied in.

Enumerator
kNone_DashType 

ignores the info parameter

kDash_DashType 

fills in all of the info parameter

◆ Type

enum SkFlattenable::Type
inherited
Enumerator
kSkColorFilter_Type 
kSkDrawable_Type 
kSkDrawLooper_Type 
kSkImageFilter_Type 
kSkMaskFilter_Type 
kSkPathEffect_Type 
kSkPixelRef_Type 
kSkUnused_Type4 
kSkShaderBase_Type 
kSkUnused_Type 
kSkUnused_Type2 
kSkUnused_Type3 

Constructor & Destructor Documentation

◆ SkPathEffect()

SkPathEffect::SkPathEffect ( )
inlineprotected

Member Function Documentation

◆ asADash()

DashType SkPathEffect::asADash ( DashInfo *  info) const

◆ asPoints()

bool SkPathEffect::asPoints ( PointData *  results,
const SkPath &  src,
const SkStrokeRec &  ,
const SkMatrix &  ,
const SkRect *  cullR 
) const

Does applying this path effect to 'src' yield a set of points? If so, optionally return the points in 'results'.

◆ computeFastBounds()

void SkPathEffect::computeFastBounds ( SkRect *  dst,
const SkRect &  src 
) const

Compute a conservative bounds for its effect, given the src bounds.

The baseline implementation just assigns src to dst.

◆ Deserialize() [1/2]

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

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

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.

◆ 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 SkPath2DPathEffect, SkLayerDrawLooper, SkLine2DPathEffect, SkPath1DPathEffect, SkDiscretePathEffect, Sk2DPathEffect, and SkCornerPathEffect.

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

SkFlattenable::Type SkPathEffect::getFlattenableType ( ) const
inlineoverridevirtual

Implements SkFlattenable.

◆ 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

◆ onAsADash()

virtual DashType SkPathEffect::onAsADash ( DashInfo *  ) const
inlineprotectedvirtual

◆ onAsPoints()

virtual bool SkPathEffect::onAsPoints ( PointData *  ,
const SkPath &  ,
const SkStrokeRec &  ,
const SkMatrix &  ,
const SkRect *   
) const
inlineprotectedvirtual

◆ onComputeFastBounds()

virtual SkRect SkPathEffect::onComputeFastBounds ( const SkRect &  src) const
inlineprotectedvirtual

◆ onFilterPath()

virtual bool SkPathEffect::onFilterPath ( SkPath *  ,
const SkPath &  ,
SkStrokeRec *  ,
const SkRect *   
) const
protectedpure virtual

Implemented in SkLine2DPathEffect, SkDiscretePathEffect, SkCornerPathEffect, Sk1DPathEffect, SkPath1DPathEffect, and Sk2DPathEffect.

◆ 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

◆ RegisterFlattenables()

static void SkPathEffect::RegisterFlattenables ( )
static

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

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