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

#include <SkColorMatrixFilter.h>

Inheritance diagram for SkColorMatrixFilter:
Inheritance graph
[legend]

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

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 isAlphaUnchanged () const
 
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< 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. More...
 
sk_sp< SkColorFilter > makeWithWorkingColorSpace (sk_sp< SkColorSpace >) const
 Return a colorfilter that will compute this filter in a specific color space. 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< SkColorFilter > MakeLightingFilter (SkColor mul, SkColor add)
 
static sk_sp< SkColorFilter > 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)
 

Member Typedef Documentation

◆ Factory

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

Member Enumeration Documentation

◆ 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

◆ asAColorMatrix()

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

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
inherited

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.

◆ Deserialize() [1/2]

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

◆ 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

◆ filterColor()

SkColor SkColorFilter::filterColor ( SkColor  ) const
inherited

◆ filterColor4f()

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

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

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.

◆ isAlphaUnchanged()

bool SkColorFilter::isAlphaUnchanged ( ) const
inherited

◆ makeComposed()

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

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

◆ MakeLightingFilter()

static sk_sp<SkColorFilter> SkColorMatrixFilter::MakeLightingFilter ( SkColor  mul,
SkColor  add 
)
inlinestatic

◆ makeWithWorkingColorSpace()

sk_sp<SkColorFilter> SkColorFilter::makeWithWorkingColorSpace ( sk_sp< SkColorSpace >  ) const
inherited

Return a colorfilter that will compute this filter in a specific color space.

By default all filters operate in the destination (surface) color space. This allows filters like Blend and Matrix, or runtime color filters to perform their math in a known space.

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