#include <SkPerlinNoiseShaderImpl.h>

Inheritance diagram for SkPerlinNoiseShader:

Classes
struct	PaintingData

struct	StitchData

Public Member Functions
	SkPerlinNoiseShader (SkPerlinNoiseShaderType type, SkScalar baseFrequencyX, SkScalar baseFrequencyY, int numOctaves, SkScalar seed, const SkISize *tileSize)

ShaderType	type () const override

SkPerlinNoiseShaderType	noiseType () const

int	numOctaves () const

bool	stitchTiles () const

SkISize	tileSize () const

std::unique_ptr< PaintingData >	getPaintingData () const

bool	appendStages (const SkStageRec &rec, const SkShaders::MatrixRec &mRec) const override

Public Member Functions inherited from SkShaderBase
	~SkShaderBase () override

sk_sp< SkShader >	makeInvertAlpha () const

sk_sp< SkShader >	makeWithCTM (const SkMatrix &) const

virtual bool	isConstant () const

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 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 Attributes
static const int	kMaxOctaves = 255

Protected Member Functions
void	flatten (SkWriteBuffer &) const override

Protected Member Functions inherited from SkShaderBase
	SkShaderBase ()

void	flatten (SkWriteBuffer &) const override

virtual bool	onAsLuminanceColor (SkColor4f *) const

Friends
void	SkRegisterPerlinNoiseShaderFlattenable ()

Additional Inherited Members
Public Types inherited from SkShaderBase
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 &)

Static Public Member Functions inherited from SkShaderBase
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)

Detailed Description

SkPerlinNoiseShader creates an image using the Perlin turbulence function.

It can produce tileable noise if asked to stitch tiles and provided a tile size. In order to fill a large area with repeating noise, set the stitchTiles flag to true, and render exactly a single tile of noise. Without this flag, the result will contain visible seams between tiles.

The algorithm used is described here : http://www.w3.org/TR/SVG/filters.html#feTurbulenceElement

Definition at line 34 of file SkPerlinNoiseShaderImpl.h.

Constructor & Destructor Documentation

◆ SkPerlinNoiseShader()

SkPerlinNoiseShader::SkPerlinNoiseShader	(	SkPerlinNoiseShaderType	type,
		SkScalar	baseFrequencyX,
		SkScalar	baseFrequencyY,
		int	numOctaves,
		SkScalar	seed,
		const SkISize *	tileSize
	)

Definition at line 26 of file SkPerlinNoiseShaderImpl.cpp.

        : fType(type)
        , fBaseFrequencyX(baseFrequencyX)
        , fBaseFrequencyY(baseFrequencyY)
        , fNumOctaves(numOctaves > kMaxOctaves ? kMaxOctaves
                                               : numOctaves)  // [0,255] octaves allowed
        , fSeed(seed)
        , fTileSize(nullptr == tileSize ? SkISize::Make(0, 0) : *tileSize)
        , fStitchTiles(!fTileSize.isEmpty()) {
    SkASSERT(numOctaves >= 0 && numOctaves <= kMaxOctaves);
    SkASSERT(fBaseFrequencyX >= 0);
    SkASSERT(fBaseFrequencyY >= 0);
 
    // If kBlockSize changes then it must be changed in the SkSL noise_function
    // implementation and the graphite backend
    static_assert(SkPerlinNoiseShader::kBlockSize == 256);
}

Member Function Documentation

◆ appendStages()

bool SkPerlinNoiseShader::appendStages	(	const SkStageRec &	,
		const SkShaders::MatrixRec &
	)		const

overridevirtual

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

Implements SkShaderBase.

Definition at line 83 of file SkPerlinNoiseShaderImpl.cpp.

                                                                             {
    std::optional<SkShaders::MatrixRec> newMRec = mRec.apply(rec);
    if (!newMRec.has_value()) {
        return false;
    }
 
    fInitPaintingDataOnce([&] {
        const_cast<SkPerlinNoiseShader*>(this)->fPaintingData = this->getPaintingData();
    });
 
    auto* ctx = rec.fAlloc->make<SkRasterPipeline_PerlinNoiseCtx>();
    ctx->noiseType = fType;
    ctx->baseFrequencyX = fPaintingData->fBaseFrequency.fX;
    ctx->baseFrequencyY = fPaintingData->fBaseFrequency.fY;
    ctx->stitchDataInX = fPaintingData->fStitchDataInit.fWidth;
    ctx->stitchDataInY = fPaintingData->fStitchDataInit.fHeight;
    ctx->stitching = fStitchTiles;
    ctx->numOctaves = fNumOctaves;
    ctx->latticeSelector = fPaintingData->fLatticeSelector;
    ctx->noiseData = &fPaintingData->fNoise[0][0][0];
 
    rec.fPipeline->append(SkRasterPipelineOp::perlin_noise, ctx);
    return true;
}

◆ flatten()

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

Definition at line 73 of file SkPerlinNoiseShaderImpl.cpp.

                                                             {
    buffer.writeInt((int)fType);
    buffer.writeScalar(fBaseFrequencyX);
    buffer.writeScalar(fBaseFrequencyY);
    buffer.writeInt(fNumOctaves);
    buffer.writeScalar(fSeed);
    buffer.writeInt(fTileSize.fWidth);
    buffer.writeInt(fTileSize.fHeight);
}

◆ getPaintingData()

std::unique_ptr< PaintingData > SkPerlinNoiseShader::getPaintingData ( ) const

inline

Definition at line 254 of file SkPerlinNoiseShaderImpl.h.

                                                        {
        return std::make_unique<PaintingData>(fTileSize, fSeed, fBaseFrequencyX, fBaseFrequencyY);
    }

◆ noiseType()

SkPerlinNoiseShaderType SkPerlinNoiseShader::noiseType ( ) const

inline

Definition at line 249 of file SkPerlinNoiseShaderImpl.h.

249{ return fType; }

◆ numOctaves()

int SkPerlinNoiseShader::numOctaves ( ) const

inline

Definition at line 250 of file SkPerlinNoiseShaderImpl.h.

250{ return fNumOctaves; }

◆ stitchTiles()

bool SkPerlinNoiseShader::stitchTiles ( ) const

inline

Definition at line 251 of file SkPerlinNoiseShaderImpl.h.

251{ return fStitchTiles; }

◆ tileSize()

SkISize SkPerlinNoiseShader::tileSize ( ) const

inline

Definition at line 252 of file SkPerlinNoiseShaderImpl.h.

252{ return fTileSize; }

◆ type()

ShaderType SkPerlinNoiseShader::type ( ) const

inlineoverridevirtual

Implements SkShaderBase.

Definition at line 247 of file SkPerlinNoiseShaderImpl.h.

247{ return ShaderType::kPerlinNoise; }

Friends And Related Symbol Documentation

◆ SkRegisterPerlinNoiseShaderFlattenable

void SkRegisterPerlinNoiseShaderFlattenable ( )

friend

Definition at line 128 of file SkPerlinNoiseShaderImpl.cpp.

                                              {
    SK_REGISTER_FLATTENABLE(SkPerlinNoiseShader);
    // Previous name
    SkFlattenable::Register("SkPerlinNoiseShaderImpl", SkPerlinNoiseShader::CreateProc);
}

Member Data Documentation

◆ kMaxOctaves

const int SkPerlinNoiseShader::kMaxOctaves = 255

static

Definition at line 238 of file SkPerlinNoiseShaderImpl.h.

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

third_party/skia/src/shaders/SkPerlinNoiseShaderImpl.h
third_party/skia/src/shaders/SkPerlinNoiseShaderImpl.cpp

Classes

Public Member Functions

Static Public Attributes

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SkPerlinNoiseShader()

Member Function Documentation

◆ appendStages()

◆ flatten()

◆ getPaintingData()

◆ noiseType()

◆ numOctaves()

◆ stitchTiles()

◆ tileSize()

◆ type()

Friends And Related Symbol Documentation

◆ SkRegisterPerlinNoiseShaderFlattenable

Member Data Documentation

◆ kMaxOctaves