SkRuntimeEffect Class Reference

#include <SkRuntimeEffect.h>

Inheritance diagram for SkRuntimeEffect:

Classes
struct	Child
class	ChildPtr
class	Options
struct	Result
struct	TracedShader
struct	Uniform

Public Types
enum class	ChildType { kShader , kColorFilter , kBlender }

Public Member Functions
sk_sp< SkShader >	makeShader (sk_sp< const SkData > uniforms, sk_sp< SkShader > children[], size_t childCount, const SkMatrix *localMatrix=nullptr) const
sk_sp< SkShader >	makeShader (sk_sp< const SkData > uniforms, SkSpan< const ChildPtr > children, const SkMatrix *localMatrix=nullptr) const
sk_sp< SkColorFilter >	makeColorFilter (sk_sp< const SkData > uniforms) const
sk_sp< SkColorFilter >	makeColorFilter (sk_sp< const SkData > uniforms, sk_sp< SkColorFilter > children[], size_t childCount) const
sk_sp< SkColorFilter >	makeColorFilter (sk_sp< const SkData > uniforms, SkSpan< const ChildPtr > children) const
sk_sp< SkBlender >	makeBlender (sk_sp< const SkData > uniforms, SkSpan< const ChildPtr > children={}) const
const std::string &	source () const
size_t	uniformSize () const
SkSpan< const Uniform >	uniforms () const
SkSpan< const Child >	children () const
const Uniform *	findUniform (std::string_view name) const
const Child *	findChild (std::string_view name) const
bool	allowShader () const
bool	allowColorFilter () const
bool	allowBlender () const
	~SkRuntimeEffect () override
Public Member Functions inherited from SkRefCntBase
	SkRefCntBase ()
virtual	~SkRefCntBase ()
bool	unique () const
void	ref () const
void	unref () const

Static Public Member Functions
static Result	MakeForColorFilter (SkString sksl, const Options &)
static Result	MakeForColorFilter (SkString sksl)
static Result	MakeForShader (SkString sksl, const Options &)
static Result	MakeForShader (SkString sksl)
static Result	MakeForBlender (SkString sksl, const Options &)
static Result	MakeForBlender (SkString sksl)
static TracedShader	MakeTraced (sk_sp< SkShader > shader, const SkIPoint &traceCoord)
static void	RegisterFlattenables ()

Friends
class	GrSkSLFP
class	SkRuntimeShader
class	SkRuntimeBlender
class	SkRuntimeColorFilter
class	SkRuntimeEffectPriv

Detailed Description

Definition at line 59 of file SkRuntimeEffect.h.

Member Enumeration Documentation

ChildType

enum class SkRuntimeEffect::ChildType

strong

Enumerator
kShader
kColorFilter
kBlender

Definition at line 111 of file SkRuntimeEffect.h.

                         {
        kShader,
        kColorFilter,
        kBlender,
    };

Constructor & Destructor Documentation

~SkRuntimeEffect()

SkRuntimeEffect::~SkRuntimeEffect ( )

overridedefault

Member Function Documentation

allowBlender()

bool SkRuntimeEffect::allowBlender ( ) const

inline

Definition at line 265 of file SkRuntimeEffect.h.

{ return (fFlags & kAllowBlender_Flag);       }

allowColorFilter()

bool SkRuntimeEffect::allowColorFilter ( ) const

inline

Definition at line 264 of file SkRuntimeEffect.h.

{ return (fFlags & kAllowColorFilter_Flag);   }

allowShader()

bool SkRuntimeEffect::allowShader ( ) const

inline

Definition at line 263 of file SkRuntimeEffect.h.

{ return (fFlags & kAllowShader_Flag);        }

children()

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

inline

Definition at line 254 of file SkRuntimeEffect.h.

{ return SkSpan(fChildren); }

findChild()

const SkRuntimeEffect::Child * SkRuntimeEffect::findChild

(

std::string_view

name

)

const

Definition at line 791 of file SkRuntimeEffect.cpp.

                                                                                {
    auto iter = std::find_if(fChildren.begin(), fChildren.end(), [name](const Child& c) {
        return c.name == name;
    });
    return iter == fChildren.end() ? nullptr : &(*iter);
}

findUniform()

const SkRuntimeEffect::Uniform * SkRuntimeEffect::findUniform

(

std::string_view

name

)

const

Definition at line 784 of file SkRuntimeEffect.cpp.

                                                                                    {
    auto iter = std::find_if(fUniforms.begin(), fUniforms.end(), [name](const Uniform& u) {
        return u.name == name;
    });
    return iter == fUniforms.end() ? nullptr : &(*iter);
}

makeBlender()

sk_sp< SkBlender > SkRuntimeEffect::makeBlender	(	sk_sp< const SkData >	uniforms,
		SkSpan< const ChildPtr >	children = {}
	)		const

Definition at line 885 of file SkRuntimeEffect.cpp.

                                                                                     {
    if (!this->allowBlender()) {
        return nullptr;
    }
    if (!verify_child_effects(fChildren, children)) {
        return nullptr;
    }
    if (!uniforms) {
        uniforms = SkData::MakeEmpty();
    }
    if (uniforms->size() != this->uniformSize()) {
        return nullptr;
    }
    return sk_make_sp<SkRuntimeBlender>(sk_ref_sp(this), std::move(uniforms), children);
}

makeColorFilter() [1/3]

sk_sp< SkColorFilter > SkRuntimeEffect::makeColorFilter

(

sk_sp< const SkData >

uniforms

)

const

Definition at line 881 of file SkRuntimeEffect.cpp.

                                                                                        {
    return this->makeColorFilter(std::move(uniforms), /*children=*/{});
}

makeColorFilter() [2/3]

sk_sp< SkColorFilter > SkRuntimeEffect::makeColorFilter	(	sk_sp< const SkData >	uniforms,
		sk_sp< SkColorFilter >	children[],
		size_t	childCount
	)		const

Definition at line 854 of file SkRuntimeEffect.cpp.

                                                                               {
    STArray<4, ChildPtr> children(childCount);
    for (size_t i = 0; i < childCount; ++i) {
        children.emplace_back(childColorFilters[i]);
    }
    return this->makeColorFilter(std::move(uniforms), SkSpan(children));
}

makeColorFilter() [3/3]

sk_sp< SkColorFilter > SkRuntimeEffect::makeColorFilter	(	sk_sp< const SkData >	uniforms,
		SkSpan< const ChildPtr >	children
	)		const

Definition at line 864 of file SkRuntimeEffect.cpp.

                                                                                             {
    if (!this->allowColorFilter()) {
        return nullptr;
    }
    if (!verify_child_effects(fChildren, children)) {
        return nullptr;
    }
    if (!uniforms) {
        uniforms = SkData::MakeEmpty();
    }
    if (uniforms->size() != this->uniformSize()) {
        return nullptr;
    }
    return sk_make_sp<SkRuntimeColorFilter>(sk_ref_sp(this), std::move(uniforms), children);
}

MakeForBlender() [1/2]

static Result SkRuntimeEffect::MakeForBlender ( SkString  sksl )

inlinestatic

Definition at line 180 of file SkRuntimeEffect.h.

                                                {
        return MakeForBlender(std::move(sksl), Options{});
    }

MakeForBlender() [2/2]

SkRuntimeEffect::Result SkRuntimeEffect::MakeForBlender ( SkString  sksl, const Options &  options  )

static

Definition at line 672 of file SkRuntimeEffect.cpp.

                                                                                           {
    auto programKind = options.allowPrivateAccess ? SkSL::ProgramKind::kPrivateRuntimeBlender
                                                  : SkSL::ProgramKind::kRuntimeBlender;
    auto result = MakeFromSource(std::move(sksl), options, programKind);
    SkASSERT(!result.effect || result.effect->allowBlender());
    return result;
}

MakeForColorFilter() [1/2]

static Result SkRuntimeEffect::MakeForColorFilter ( SkString  sksl )

inlinestatic

Definition at line 166 of file SkRuntimeEffect.h.

                                                    {
        return MakeForColorFilter(std::move(sksl), Options{});
    }

MakeForColorFilter() [2/2]

SkRuntimeEffect::Result SkRuntimeEffect::MakeForColorFilter ( SkString  sksl, const Options &  options  )

static

Definition at line 656 of file SkRuntimeEffect.cpp.

                                                                                               {
    auto programKind = options.allowPrivateAccess ? SkSL::ProgramKind::kPrivateRuntimeColorFilter
                                                  : SkSL::ProgramKind::kRuntimeColorFilter;
    auto result = MakeFromSource(std::move(sksl), options, programKind);
    SkASSERT(!result.effect || result.effect->allowColorFilter());
    return result;
}

MakeForShader() [1/2]

static Result SkRuntimeEffect::MakeForShader ( SkString  sksl )

inlinestatic

Definition at line 173 of file SkRuntimeEffect.h.

                                               {
        return MakeForShader(std::move(sksl), Options{});
    }

MakeForShader() [2/2]

SkRuntimeEffect::Result SkRuntimeEffect::MakeForShader ( SkString  sksl, const Options &  options  )

static

Definition at line 664 of file SkRuntimeEffect.cpp.

                                                                                          {
    auto programKind = options.allowPrivateAccess ? SkSL::ProgramKind::kPrivateRuntimeShader
                                                  : SkSL::ProgramKind::kRuntimeShader;
    auto result = MakeFromSource(std::move(sksl), options, programKind);
    SkASSERT(!result.effect || result.effect->allowShader());
    return result;
}

makeShader() [1/2]

sk_sp< SkShader > SkRuntimeEffect::makeShader	(	sk_sp< const SkData >	uniforms,
		sk_sp< SkShader >	children[],
		size_t	childCount,
		const SkMatrix *	localMatrix = nullptr
	)		const

Definition at line 821 of file SkRuntimeEffect.cpp.

                                                                               {
    STArray<4, ChildPtr> children(childCount);
    for (size_t i = 0; i < childCount; ++i) {
        children.emplace_back(childShaders[i]);
    }
    return this->makeShader(std::move(uniforms), SkSpan(children), localMatrix);
}

makeShader() [2/2]

sk_sp< SkShader > SkRuntimeEffect::makeShader	(	sk_sp< const SkData >	uniforms,
		SkSpan< const ChildPtr >	children,
		const SkMatrix *	localMatrix = nullptr
	)		const

Definition at line 832 of file SkRuntimeEffect.cpp.

                                                                               {
    if (!this->allowShader()) {
        return nullptr;
    }
    if (!verify_child_effects(fChildren, children)) {
        return nullptr;
    }
    if (!uniforms) {
        uniforms = SkData::MakeEmpty();
    }
    if (uniforms->size() != this->uniformSize()) {
        return nullptr;
    }
    return SkLocalMatrixShader::MakeWrapped<SkRuntimeShader>(localMatrix,
                                                             sk_ref_sp(this),
                                                             /*debugTrace=*/nullptr,
                                                             std::move(uniforms),
                                                             children);
}

MakeTraced()

SkRuntimeEffect::TracedShader SkRuntimeEffect::MakeTraced ( sk_sp< SkShader >  shader, const SkIPoint &  traceCoord  )

static

Definition at line 904 of file SkRuntimeEffect.cpp.

                                                                                      {
    SkRuntimeEffect* effect = as_SB(shader)->asRuntimeEffect();
    if (!effect) {
        return TracedShader{nullptr, nullptr};
    }
    // An SkShader with an attached SkRuntimeEffect must be an SkRuntimeShader.
    SkRuntimeShader* rtShader = static_cast<SkRuntimeShader*>(shader.get());
    return rtShader->makeTracedClone(traceCoord);
}

RegisterFlattenables()

void SkRuntimeEffect::RegisterFlattenables ( )

static

Definition at line 953 of file SkRuntimeEffect.cpp.

                                           {
    SK_REGISTER_FLATTENABLE(SkRuntimeBlender);
    SK_REGISTER_FLATTENABLE(SkRuntimeColorFilter);
    SK_REGISTER_FLATTENABLE(SkRuntimeShader);
 
    // Previous name
    SkFlattenable::Register("SkRTShader", SkRuntimeShader::CreateProc);
}

source()

const std::string & SkRuntimeEffect::source

(

)

const

Definition at line 775 of file SkRuntimeEffect.cpp.

                                               {
    return *fBaseProgram->fSource;
}

uniforms()

SkSpan< const Uniform > SkRuntimeEffect::uniforms ( ) const

inline

Definition at line 253 of file SkRuntimeEffect.h.

{ return SkSpan(fUniforms); }

uniformSize()

size_t SkRuntimeEffect::uniformSize

(

)

const

Definition at line 779 of file SkRuntimeEffect.cpp.

                                          {
    return fUniforms.empty() ? 0
                             : SkAlign4(fUniforms.back().offset + fUniforms.back().sizeInBytes());
}

Friends And Related Function Documentation

GrSkSLFP

friend class GrSkSLFP

friend

Definition at line 310 of file SkRuntimeEffect.h.

SkRuntimeBlender

friend class SkRuntimeBlender

friend

Definition at line 312 of file SkRuntimeEffect.h.

SkRuntimeColorFilter

friend class SkRuntimeColorFilter

friend

Definition at line 313 of file SkRuntimeEffect.h.

SkRuntimeEffectPriv

friend class SkRuntimeEffectPriv

friend

Definition at line 315 of file SkRuntimeEffect.h.

SkRuntimeShader

friend class SkRuntimeShader

friend

Definition at line 311 of file SkRuntimeEffect.h.

---

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

• third_party/skia/include/effects/SkRuntimeEffect.h
• third_party/skia/src/core/SkRuntimeEffect.cpp