Skia
2D Graphics Library
SkColorFilter Class Referenceabstract

ColorFilters are optional objects in the drawing pipeline. More...

#include <SkColorFilter.h>

Inheritance diagram for SkColorFilter:

Public Types

enum  Flags { kAlphaUnchanged_Flag = 1 << 0 }
 
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 asColorMode (SkColor *color, SkBlendMode *mode) const
 
bool asAColorMode (SkColor *color, SkBlendMode *mode) const
 If the filter can be represented by a source color plus Mode, this returns true, and sets (if not NULL) the color and mode appropriately. More...
 
bool asAColorMatrix (float matrix[20]) const
 If the filter can be represented by a 5x4 matrix, this returns true, and sets the matrix appropriately. More...
 
bool appendStages (const SkStageRec &rec, bool shaderIsOpaque) const
 
skvm::Color program (skvm::Builder *, skvm::Color, SkColorSpace *dstCS, skvm::Uniforms *, SkArenaAlloc *) const
 
virtual uint32_t getFlags () const
 Returns the flags for this filter. More...
 
SkColor filterColor (SkColor) const
 
SkColor4f filterColor4f (const SkColor4f &srcColor, SkColorSpace *srcCS, SkColorSpace *dstCS) const
 Converts the src color (in src colorspace), into the dst colorspace, then applies this filter to it, returning the filtered color in the dst colorspace. More...
 
sk_sp< SkColorFiltermakeComposed (sk_sp< SkColorFilter > inner) const
 Construct a colorfilter whose effect is to first apply the inner filter and then apply this filter, applied to the output of the inner filter. More...
 
bool affectsTransparentBlack () 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< 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 void RegisterFlattenables ()
 
static SkFlattenable::Type GetFlattenableType ()
 
static sk_sp< SkColorFilterDeserialize (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< SkFlattenableDeserialize (Type, const void *data, size_t length, const SkDeserialProcs *procs=nullptr)
 

Protected Member Functions

 SkColorFilter ()
 
virtual bool onAsAColorMatrix (float[20]) const
 
virtual bool onAsAColorMode (SkColor *color, SkBlendMode *bmode) const
 

Detailed Description

ColorFilters are optional objects in the drawing pipeline.

When present in a paint, they are called with the "src" colors, and return new colors, which are then passed onto the next stage (either ImageFilter or Xfermode).

All subclasses are required to be reentrant-safe : it must be legal to share the same instance between several threads.

Member Typedef Documentation

◆ Factory

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

Member Enumeration Documentation

◆ Flags

Enumerator
kAlphaUnchanged_Flag 

If set the filter methods will not change the alpha channel of the colors.

◆ 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

◆ SkColorFilter()

SkColorFilter::SkColorFilter ( )
inlineprotected

Member Function Documentation

◆ affectsTransparentBlack()

bool SkColorFilter::affectsTransparentBlack ( ) const
inline

◆ appendStages()

bool SkColorFilter::appendStages ( const SkStageRec &  rec,
bool  shaderIsOpaque 
) const

◆ asAColorMatrix()

bool SkColorFilter::asAColorMatrix ( float  matrix[20]) const
inline

If the filter can be represented by a 5x4 matrix, this returns true, and sets the matrix appropriately.

If not, this returns false and ignores the parameter.

◆ asAColorMode()

bool SkColorFilter::asAColorMode ( SkColor color,
SkBlendMode mode 
) const
inline

If the filter can be represented by a source color plus Mode, this returns true, and sets (if not NULL) the color and mode appropriately.

If not, this returns false and ignores the parameters.

◆ asColorMode()

bool SkColorFilter::asColorMode ( SkColor color,
SkBlendMode mode 
) const
inline

◆ Deserialize() [1/2]

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

◆ Deserialize() [2/2]

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

◆ FactoryToName()

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

◆ filterColor()

SkColor SkColorFilter::filterColor ( SkColor  ) const

◆ filterColor4f()

SkColor4f SkColorFilter::filterColor4f ( const SkColor4f srcColor,
SkColorSpace srcCS,
SkColorSpace dstCS 
) const

Converts the src color (in src colorspace), into the dst colorspace, then applies this filter to it, returning the filtered color in the dst colorspace.

◆ 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, SkLumaColorFilter, SkDiscretePathEffect, Sk2DPathEffect, SkOverdrawColorFilter, 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.

◆ getFlags()

virtual uint32_t SkColorFilter::getFlags ( ) const
inlinevirtual

Returns the flags for this filter.

Override in subclasses to return custom flags.

◆ GetFlattenableType()

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

◆ getFlattenableType()

SkFlattenable::Type SkColorFilter::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.

◆ makeComposed()

sk_sp<SkColorFilter> SkColorFilter::makeComposed ( sk_sp< SkColorFilter inner) const

Construct a colorfilter whose effect is to first apply the inner filter and then apply this filter, applied to the output of the inner filter.

result = this(inner(...))

◆ NameToFactory()

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

◆ onAsAColorMatrix()

virtual bool SkColorFilter::onAsAColorMatrix ( float  [20]) const
protectedvirtual

◆ onAsAColorMode()

virtual bool SkColorFilter::onAsAColorMode ( SkColor color,
SkBlendMode bmode 
) const
protectedvirtual

◆ program()

skvm::Color SkColorFilter::program ( skvm::Builder *  ,
skvm::Color  ,
SkColorSpace dstCS,
skvm::Uniforms *  ,
SkArenaAlloc *   
) const

◆ 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 SkColorFilter::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: