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

DEPRECATED: No longer supported by Skia. More...

#include <SkLayerDrawLooper.h>

Inheritance diagram for SkLayerDrawLooper:
Inheritance graph
[legend]

Classes

class  Builder
 
struct  LayerInfo
 Info for how to apply the layer's paint and offset. More...
 

Public Types

enum  Bits {
  kStyle_Bit = 1 << 0 , kPathEffect_Bit = 1 << 2 , kMaskFilter_Bit = 1 << 3 , kShader_Bit = 1 << 4 ,
  kColorFilter_Bit = 1 << 5 , kXfermode_Bit = 1 << 6 , kEntirePaint_Bits = -1
}
 Bits specifies which aspects of the layer's paint should replace the corresponding aspects on the draw's paint. More...
 
typedef int32_t BitFlags
 
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

 ~SkLayerDrawLooper () override
 
SkDrawLooper::Context * makeContext (SkArenaAlloc *) const override
 Called right before something is being drawn. More...
 
bool asABlurShadow (BlurShadowRec *rec) const override
 If this looper can be interpreted as having two layers, such that. More...
 
bool canComputeFastBounds (const SkPaint &paint) const
 The fast bounds functions are used to enable the paint to be culled early in the drawing pipeline. More...
 
void computeFastBounds (const SkPaint &paint, const SkRect &src, SkRect *dst) const
 
SkFlattenable::Type getFlattenableType () const override
 
void apply (SkCanvas *canvas, const SkPaint &paint, std::function< void(SkCanvas *, const SkPaint &)>)
 
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...
 
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 SkFlattenable::Type GetFlattenableType ()
 
static sk_sp< SkDrawLooper > Deserialize (const void *data, size_t size, const SkDeserialProcs *procs=nullptr)
 
static sk_sp< SkFlattenable > Deserialize (Type, const void *data, size_t length, const SkDeserialProcs *procs=nullptr)
 
static Factory NameToFactory (const char name[])
 
static const char * FactoryToName (Factory)
 
static void Register (const char name[], Factory)
 

Protected Member Functions

 SkLayerDrawLooper ()
 
void flatten (SkWriteBuffer &) const override
 Override this if your subclass needs to record data that it will need to recreate itself from its CreateProc (returned by getFactory()). More...
 

Detailed Description

DEPRECATED: No longer supported by Skia.

Member Typedef Documentation

◆ BitFlags

typedef int32_t SkLayerDrawLooper::BitFlags

◆ Factory

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

Member Enumeration Documentation

◆ Bits

enum SkLayerDrawLooper::Bits

Bits specifies which aspects of the layer's paint should replace the corresponding aspects on the draw's paint.

kEntirePaint_Bits means use the layer's paint completely. 0 means ignore the layer's paint... except for fColorMode, which is always applied.

Enumerator
kStyle_Bit 

use this layer's Style/stroke settings

kPathEffect_Bit 

use this layer's patheffect

kMaskFilter_Bit 

use this layer's maskfilter

kShader_Bit 

use this layer's shader

kColorFilter_Bit 

use this layer's colorfilter

kXfermode_Bit 

use this layer's xfermode

kEntirePaint_Bits 

Use the layer's paint entirely, with these exceptions:

  • We never override the draw's paint's text_encoding, since that is used to interpret the text/len parameters in draw[Pos]Text.
  • Color is always computed using the LayerInfo's fColorMode.

◆ Type

enum SkFlattenable::Type
inherited
Enumerator
kSkColorFilter_Type 
kSkBlender_Type 
kSkDrawable_Type 
kSkDrawLooper_Type 
kSkImageFilter_Type 
kSkMaskFilter_Type 
kSkPathEffect_Type 
kSkShader_Type 

Constructor & Destructor Documentation

◆ ~SkLayerDrawLooper()

SkLayerDrawLooper::~SkLayerDrawLooper ( )
override

◆ SkLayerDrawLooper()

SkLayerDrawLooper::SkLayerDrawLooper ( )
protected

Member Function Documentation

◆ apply()

void SkDrawLooper::apply ( SkCanvas *  canvas,
const SkPaint &  paint,
std::function< void(SkCanvas *, const SkPaint &)>   
)
inherited

◆ asABlurShadow()

bool SkLayerDrawLooper::asABlurShadow ( BlurShadowRec *  ) const
overridevirtual

If this looper can be interpreted as having two layers, such that.

  1. The first layer (bottom most) just has a blur and translate
  2. The second layer has no modifications to either paint or canvas
  3. No other layers. then return true, and if not null, fill out the BlurShadowRec).

If any of the above are not met, return false and ignore the BlurShadowRec parameter.

Reimplemented from SkDrawLooper.

◆ canComputeFastBounds()

bool SkDrawLooper::canComputeFastBounds ( const SkPaint &  paint) const
inherited

The fast bounds functions are used to enable the paint to be culled early in the drawing pipeline.

If a subclass can support this feature it must return true for the canComputeFastBounds() function. If that function returns false then computeFastBounds behavior is undefined otherwise it is expected to have the following behavior. Given the parent paint and the parent's bounding rect the subclass must fill in and return the storage rect, where the storage rect is with the union of the src rect and the looper's bounding rect.

◆ computeFastBounds()

void SkDrawLooper::computeFastBounds ( const SkPaint &  paint,
const SkRect &  src,
SkRect *  dst 
) const
inherited

◆ Deserialize() [1/2]

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

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

void SkLayerDrawLooper::flatten ( SkWriteBuffer &  ) const
overrideprotectedvirtual

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 from SkFlattenable.

◆ 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 SkDrawLooper::GetFlattenableType ( )
inlinestaticinherited

◆ getFlattenableType()

SkFlattenable::Type SkDrawLooper::getFlattenableType ( ) const
inlineoverridevirtualinherited

Implements SkFlattenable.

◆ getTypeName()

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

Returns the name of the object's class.

Implemented in SkDrawable.

◆ makeContext()

SkDrawLooper::Context* SkLayerDrawLooper::makeContext ( SkArenaAlloc *  ) const
overridevirtual

Called right before something is being drawn.

Returns a Context whose next() method should be called until it returns false.

Implements SkDrawLooper.

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

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