SkShaderBase Class Reference

#include <SkShaderBase.h>

Inheritance diagram for SkShaderBase:

Classes
class	Context
struct	ContextRec
struct	GradientInfo

Public Types
enum class	ShaderType { M }
enum class	GradientType { kNone , M }
enum	Flags { kOpaqueAlpha_Flag = 1 << 0 }
Public Types inherited from SkFlattenable
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
	~SkShaderBase () override
sk_sp< SkShader >	makeInvertAlpha () const
sk_sp< SkShader >	makeWithCTM (const SkMatrix &) const
virtual bool	isConstant () const
virtual ShaderType	type () const =0
virtual GradientType	asGradient (GradientInfo *info=nullptr, SkMatrix *localMatrix=nullptr) const
Context *	makeContext (const ContextRec &, SkArenaAlloc *) const
bool	asLuminanceColor (SkColor4f *) const
bool	appendRootStages (const SkStageRec &rec, const SkMatrix &ctm) const
virtual bool	appendStages (const SkStageRec &, const SkShaders::MatrixRec &) const =0
virtual SkImage *	onIsAImage (SkMatrix *, SkTileMode[2]) const
virtual SkRuntimeEffect *	asRuntimeEffect () const
Type	getFlattenableType () const override
virtual sk_sp< SkShader >	makeAsALocalMatrixShader (SkMatrix *localMatrix) const
Public Member Functions inherited from SkShader
virtual bool	isOpaque () const
SkImage *	isAImage (SkMatrix *localMatrix, SkTileMode xy[2]) const
bool	isAImage () const
sk_sp< SkShader >	makeWithLocalMatrix (const SkMatrix &) const
sk_sp< SkShader >	makeWithColorFilter (sk_sp< SkColorFilter >) const
sk_sp< SkShader >	makeWithWorkingColorSpace (sk_sp< SkColorSpace >) const
Public Member Functions inherited from SkFlattenable
	SkFlattenable ()
virtual Factory	getFactory () const =0
virtual const char *	getTypeName () const =0
sk_sp< SkData >	serialize (const SkSerialProcs *=nullptr) const
size_t	serialize (void *memory, size_t memory_size, const SkSerialProcs *=nullptr) const
Public Member Functions inherited from SkRefCntBase
	SkRefCntBase ()
virtual	~SkRefCntBase ()
bool	unique () const
void	ref () const
void	unref () const

Static Public Member Functions
static Type	GetFlattenableType ()
static sk_sp< SkShaderBase >	Deserialize (const void *data, size_t size, const SkDeserialProcs *procs=nullptr)
static void	RegisterFlattenables ()
static SkMatrix	ConcatLocalMatrices (const SkMatrix &parentLM, const SkMatrix &childLM)
Static Public Member Functions inherited from SkFlattenable
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
	SkShaderBase ()
void	flatten (SkWriteBuffer &) const override
virtual bool	onAsLuminanceColor (SkColor4f *) const

Friends
class	SkShaders::MatrixRec

Detailed Description

Definition at line 186 of file SkShaderBase.h.

Member Enumeration Documentation

Flags

enum SkShaderBase::Flags

Enumerator
kOpaqueAlpha_Flag	set if all of the colors will be opaque

Definition at line 260 of file SkShaderBase.h.

               {
        //!< set if all of the colors will be opaque
        kOpaqueAlpha_Flag = 1 << 0,
    };

GradientType

enum class SkShaderBase::GradientType

strong

Enumerator
kNone
M

Definition at line 207 of file SkShaderBase.h.

                            {
        kNone,
#define M(type) k##type,
        SK_ALL_GRADIENTS(M)
#undef M
    };

ShaderType

enum class SkShaderBase::ShaderType

strong

Enumerator
M

Definition at line 199 of file SkShaderBase.h.

                          {
#define M(type) k##type,
        SK_ALL_SHADERS(M)
#undef M
    };

Constructor & Destructor Documentation

~SkShaderBase()

SkShaderBase::~SkShaderBase ( )

overridedefault

SkShaderBase()

SkShaderBase::SkShaderBase ( )

protecteddefault

Member Function Documentation

appendRootStages()

bool SkShaderBase::appendRootStages	(	const SkStageRec &	rec,
		const SkMatrix &	ctm
	)		const

If this returns false, then we draw nothing (do not fall back to shader context). This should only be called on a root-level effect. It assumes that the initial device coordinates have not yet been seeded.

Definition at line 132 of file SkShaderBase.cpp.

                                                                                    {
    return this->appendStages(rec, SkShaders::MatrixRec(ctm));
}

appendStages()

virtual bool SkShaderBase::appendStages ( const SkStageRec &  , const SkShaders::MatrixRec &    ) const

pure virtual

Adds stages to implement this shader. To ensure that the correct input coords are present in r,g MatrixRec::apply() must be called (unless the shader doesn't require it's input coords). The default impl creates shadercontext and calls that (not very efficient).

Implemented in SkGradientBaseShader, SkBlendShader, SkColorFilterShader, SkColorShader, SkColor4Shader, SkCoordClampShader, SkEmptyShader, SkImageShader, SkLocalMatrixShader, SkPictureShader, SkCTMShader, SkTransformShader, SkTriColorShader, SkWorkingColorSpaceShader, SkPerlinNoiseShader, and SkRuntimeShader.

asGradient()

virtual GradientType SkShaderBase::asGradient ( GradientInfo *  info = nullptr, SkMatrix *  localMatrix = nullptr  ) const

inlinevirtual

Reimplemented in SkConicalGradient, SkLinearGradient, SkSweepGradient, SkLocalMatrixShader, SkCTMShader, and SkRadialGradient.

Definition at line 255 of file SkShaderBase.h.

                                                                           {
        return GradientType::kNone;
    }

asLuminanceColor()

bool SkShaderBase::asLuminanceColor

(

SkColor4f *

colorPtr

)

const

If the shader can represent its "average" luminance in a single color, return true and if color is not NULL, return that color. If it cannot, return false and ignore the color parameter.

Note: if this returns true, the returned color will always be opaque, as only the RGB components are used to compute luminance.

Definition at line 82 of file SkShaderBase.cpp.

                                                             {
    SkColor4f storage;
    if (nullptr == colorPtr) {
        colorPtr = &storage;
    }
    if (this->onAsLuminanceColor(colorPtr)) {
        colorPtr->fA = 1.0f;  // we only return opaque
        return true;
    }
    return false;
}

asRuntimeEffect()

virtual SkRuntimeEffect * SkShaderBase::asRuntimeEffect ( ) const

inlinevirtual

Reimplemented in SkRuntimeShader.

Definition at line 366 of file SkShaderBase.h.

{ return nullptr; }

ConcatLocalMatrices()

static SkMatrix SkShaderBase::ConcatLocalMatrices ( const SkMatrix &  parentLM, const SkMatrix &  childLM  )

inlinestatic

Definition at line 384 of file SkShaderBase.h.

                                                                                           {
#if defined(SK_BUILD_FOR_ANDROID_FRAMEWORK)  // b/256873449
        return SkMatrix::Concat(childLM, parentLM);
#endif
        return SkMatrix::Concat(parentLM, childLM);
    }

Deserialize()

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

inlinestatic

Definition at line 371 of file SkShaderBase.h.

                                                                                     {
        return sk_sp<SkShaderBase>(static_cast<SkShaderBase*>(
                SkFlattenable::Deserialize(GetFlattenableType(), data, size, procs).release()));
    }

flatten()

void SkShaderBase::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.

Reimplemented in SkSweepGradient, and SkWorkingColorSpaceShader.

Definition at line 80 of file SkShaderBase.cpp.

{ this->INHERITED::flatten(buffer); }

GetFlattenableType()

static Type SkShaderBase::GetFlattenableType ( )

inlinestatic

Definition at line 368 of file SkShaderBase.h.

{ return kSkShader_Type; }

getFlattenableType()

Type SkShaderBase::getFlattenableType ( ) const

inlineoverridevirtual

Implements SkFlattenable.

Definition at line 369 of file SkShaderBase.h.

{ return GetFlattenableType(); }

isConstant()

virtual bool SkShaderBase::isConstant ( ) const

inlinevirtual

Returns true if the shader is guaranteed to produce only a single color. Subclasses can override this to allow loop-hoisting optimization.

Reimplemented in SkColorShader, SkColor4Shader, SkLocalMatrixShader, and SkCTMShader.

Definition at line 197 of file SkShaderBase.h.

{ return false; }

makeAsALocalMatrixShader()

sk_sp< SkShader > SkShaderBase::makeAsALocalMatrixShader ( SkMatrix *  localMatrix ) const

virtual

DEPRECATED. skbug.com/8941 If this shader can be represented by another shader + a localMatrix, return that shader and the localMatrix. If not, return nullptr and ignore the localMatrix parameter.

Reimplemented in SkLocalMatrixShader.

Definition at line 130 of file SkShaderBase.cpp.

{ return nullptr; }

makeContext()

SkShaderBase::Context * SkShaderBase::makeContext	(	const ContextRec &	rec,
		SkArenaAlloc *	alloc
	)		const

Make a context using the memory provided by the arena.

Returns

pointer to context or nullptr if can't be created

Definition at line 94 of file SkShaderBase.cpp.

                                                                                               {
#ifdef SK_ENABLE_LEGACY_SHADERCONTEXT
    // We always fall back to raster pipeline when perspective is present.
    auto totalMatrix = rec.fMatrixRec.totalMatrix();
    if (totalMatrix.hasPerspective() || !totalMatrix.invert(nullptr)) {
        return nullptr;
    }
 
    return this->onMakeContext(rec, alloc);
#else
    return nullptr;
#endif
}

makeInvertAlpha()

sk_sp< SkShader > SkShaderBase::makeInvertAlpha

(

)

const

Definition at line 141 of file SkShaderBase.cpp.

                                                    {
    return this->makeWithColorFilter(SkColorFilters::Blend(0xFFFFFFFF, SkBlendMode::kSrcOut));
}

makeWithCTM()

sk_sp< SkShader > SkShaderBase::makeWithCTM

(

const SkMatrix &

postM

)

const

Definition at line 136 of file SkShaderBase.cpp.

                                                                     {
    return sk_sp<SkShader>(new SkCTMShader(sk_ref_sp(this), postM));
}

onAsLuminanceColor()

virtual bool SkShaderBase::onAsLuminanceColor ( SkColor4f *  ) const

inlineprotectedvirtual

Reimplemented in SkGradientBaseShader, SkColorShader, and SkColor4Shader.

Definition at line 406 of file SkShaderBase.h.

                                                      {
        return false;
    }

onIsAImage()

virtual SkImage * SkShaderBase::onIsAImage ( SkMatrix *  , SkTileMode  [2]  ) const

inlinevirtual

Definition at line 362 of file SkShaderBase.h.

                                                                {
        return nullptr;
    }

RegisterFlattenables()

void SkShaderBase::RegisterFlattenables ( )

static

Definition at line 432 of file SkImageShader.cpp.

{ SK_REGISTER_FLATTENABLE(SkImageShader); }

type()

virtual ShaderType SkShaderBase::type ( ) const

pure virtual

Implemented in SkGradientBaseShader, SkBlendShader, SkColorFilterShader, SkColorShader, SkColor4Shader, SkCoordClampShader, SkEmptyShader, SkImageShader, SkLocalMatrixShader, SkCTMShader, SkPerlinNoiseShader, SkPictureShader, SkRuntimeShader, SkTransformShader, SkTriColorShader, and SkWorkingColorSpaceShader.

Friends And Related Symbol Documentation

SkShaders::MatrixRec

friend class SkShaders::MatrixRec

friend

Definition at line 410 of file SkShaderBase.h.

---

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

• third_party/skia/src/shaders/SkShaderBase.h
• third_party/skia/src/shaders/SkImageShader.cpp
• third_party/skia/src/shaders/SkShaderBase.cpp