#include <SkRuntimeShader.h>

Inheritance diagram for SkRuntimeShader:

Public Member Functions
	SkRuntimeShader (sk_sp< SkRuntimeEffect > effect, sk_sp< SkSL::DebugTracePriv > debugTrace, sk_sp< const SkData > uniforms, SkSpan< const SkRuntimeEffect::ChildPtr > children)

	SkRuntimeShader (sk_sp< SkRuntimeEffect > effect, sk_sp< SkSL::DebugTracePriv > debugTrace, UniformsCallback uniformsCallback, SkSpan< const SkRuntimeEffect::ChildPtr > children)

SkRuntimeEffect::TracedShader	makeTracedClone (const SkIPoint &coord)

bool	isOpaque () const override

ShaderType	type () const override

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

void	flatten (SkWriteBuffer &buffer) const override

SkRuntimeEffect *	asRuntimeEffect () const override

sk_sp< SkRuntimeEffect >	effect () const

SkSpan< const SkRuntimeEffect::ChildPtr >	children () const

sk_sp< const SkData >	uniformData (const SkColorSpace *dstCS) const

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

Type	getFlattenableType () const override

virtual sk_sp< SkShader >	makeAsALocalMatrixShader (SkMatrix *localMatrix) const

Public Member Functions inherited from SkShader
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

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)

Protected Member Functions inherited from SkShaderBase
	SkShaderBase ()

void	flatten (SkWriteBuffer &) const override

virtual bool	onAsLuminanceColor (SkColor4f *) const

Detailed Description

Definition at line 30 of file SkRuntimeShader.h.

Constructor & Destructor Documentation

◆ SkRuntimeShader() [1/2]

SkRuntimeShader::SkRuntimeShader	(	sk_sp< SkRuntimeEffect >	effect,
		sk_sp< SkSL::DebugTracePriv >	debugTrace,
		sk_sp< const SkData >	uniforms,
		SkSpan< const SkRuntimeEffect::ChildPtr >	children
	)

Definition at line 44 of file SkRuntimeShader.cpp.

        : fEffect(std::move(effect))
        , fDebugTrace(std::move(debugTrace))
        , fUniformData(std::move(uniforms))
        , fChildren(children.begin(), children.end()) {}

◆ SkRuntimeShader() [2/2]

SkRuntimeShader::SkRuntimeShader	(	sk_sp< SkRuntimeEffect >	effect,
		sk_sp< SkSL::DebugTracePriv >	debugTrace,
		UniformsCallback	uniformsCallback,
		SkSpan< const SkRuntimeEffect::ChildPtr >	children
	)

Definition at line 53 of file SkRuntimeShader.cpp.

        : fEffect(std::move(effect))
        , fDebugTrace(std::move(debugTrace))
        , fUniformsCallback(std::move(uniformsCallback))
        , fChildren(children.begin(), children.end()) {}

Member Function Documentation

◆ appendStages()

bool SkRuntimeShader::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 79 of file SkRuntimeShader.cpp.

                                                                                              {
    if (!SkRuntimeEffectPriv::CanDraw(SkCapabilities::RasterBackend().get(), fEffect.get())) {
        // SkRP has support for many parts of #version 300 already, but for now, we restrict its
        // usage in runtime effects to just #version 100.
        return false;
    }
    if (const SkSL::RP::Program* program = fEffect->getRPProgram(fDebugTrace.get())) {
        std::optional<SkShaders::MatrixRec> newMRec = mRec.apply(rec);
        if (!newMRec.has_value()) {
            return false;
        }
        SkSpan<const float> uniforms =
                SkRuntimeEffectPriv::UniformsAsSpan(fEffect->uniforms(),
                                                    this->uniformData(rec.fDstCS),
                                                    /*alwaysCopyIntoAlloc=*/fUniformData == nullptr,
                                                    rec.fDstCS,
                                                    rec.fAlloc);
        RuntimeEffectRPCallbacks callbacks(rec, *newMRec, fChildren, fEffect->fSampleUsages);
        bool success = program->appendStages(rec.fPipeline, rec.fAlloc, &callbacks, uniforms);
        return success;
    }
    return false;
}

◆ asRuntimeEffect()

SkRuntimeEffect * SkRuntimeShader::asRuntimeEffect ( ) const

inlineoverridevirtual

Reimplemented from SkShaderBase.

Definition at line 52 of file SkRuntimeShader.h.

52{ return fEffect.get(); }

◆ children()

SkSpan< const SkRuntimeEffect::ChildPtr > SkRuntimeShader::children ( ) const

inline

Definition at line 55 of file SkRuntimeShader.h.

55{ return fChildren; }

◆ effect()

sk_sp< SkRuntimeEffect > SkRuntimeShader::effect ( ) const

inline

Definition at line 54 of file SkRuntimeShader.h.

54{ return fEffect; }

◆ flatten()

void SkRuntimeShader::flatten ( SkWriteBuffer & ) const

overridevirtual

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 103 of file SkRuntimeShader.cpp.

                                                         {
    buffer.writeString(fEffect->source().c_str());
    buffer.writeDataAsByteArray(this->uniformData(nullptr).get());
    SkRuntimeEffectPriv::WriteChildEffects(buffer, fChildren);
}

◆ isOpaque()

bool SkRuntimeShader::isOpaque ( ) const

inlineoverridevirtual

Returns true if the shader is guaranteed to produce only opaque colors, subject to the SkPaint using the shader to apply an opaque alpha value. Subclasses should override this to allow some optimizations.

Reimplemented from SkShader.

Definition at line 44 of file SkRuntimeShader.h.

44{ return fEffect->alwaysOpaque(); }

◆ makeTracedClone()

SkRuntimeEffect::TracedShader SkRuntimeShader::makeTracedClone ( const SkIPoint & coord )

Definition at line 70 of file SkRuntimeShader.cpp.

                                                                                  {
    sk_sp<SkRuntimeEffect> unoptimized = fEffect->makeUnoptimizedClone();
    sk_sp<SkSL::DebugTracePriv> debugTrace = make_debug_trace(unoptimized.get(), coord);
    auto debugShader = sk_make_sp<SkRuntimeShader>(
            unoptimized, debugTrace, this->uniformData(nullptr), SkSpan(fChildren));
 
    return SkRuntimeEffect::TracedShader{std::move(debugShader), std::move(debugTrace)};
}

◆ type()

ShaderType SkRuntimeShader::type ( ) const

inlineoverridevirtual

Implements SkShaderBase.

Definition at line 46 of file SkRuntimeShader.h.

46{ return ShaderType::kRuntime; }

◆ uniformData()

sk_sp< const SkData > SkRuntimeShader::uniformData ( const SkColorSpace * dstCS ) const

Definition at line 109 of file SkRuntimeShader.cpp.

                                                                                {
    if (fUniformData) {
        return fUniformData;
    }
 
    // We want to invoke the uniforms-callback each time a paint occurs.
    SkASSERT(fUniformsCallback);
    sk_sp<const SkData> uniforms = fUniformsCallback({dstCS});
    SkASSERT(uniforms && uniforms->size() == fEffect->uniformSize());
    return uniforms;
}

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

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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SkRuntimeShader() [1/2]

◆ SkRuntimeShader() [2/2]

Member Function Documentation

◆ appendStages()

◆ asRuntimeEffect()

◆ children()

◆ effect()

◆ flatten()

◆ isOpaque()

◆ makeTracedClone()

◆ type()

◆ uniformData()