2019-08-30 14:59:47 +00:00
|
|
|
/*
|
|
|
|
|
* Copyright 2019 Google LLC
|
|
|
|
|
*
|
|
|
|
|
* Use of this source code is governed by a BSD-style license that can be
|
|
|
|
|
* found in the LICENSE file.
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
#ifndef SkParticleBinding_DEFINED
|
|
|
|
|
#define SkParticleBinding_DEFINED
|
|
|
|
|
|
|
|
|
|
#include "include/core/SkString.h"
|
|
|
|
|
#include "modules/particles/include/SkReflected.h"
|
|
|
|
|
#include "src/sksl/SkSLExternalValue.h"
|
|
|
|
|
|
|
|
|
|
#include <memory>
|
|
|
|
|
|
Particles: Sub-effect spawning and some slight refactoring
* Added a new binding type, SkEffectBinding. This stores another
entire effect params structure (so the JSON is just nested).
The name is a callable value that spawns a new instance of
that effect, inheriting the parameters of the spawning effect
or particle (depending on which kind of script made the call).
* Broke up the monolithic update function into some helpers,
got some code reuse with the script calling logic.
* Unlike particle capacity, there is no upper limit on child
effects (yet), so it's easy to trigger runaway memory and
CPU consumption. Be careful.
* Added death scripts to effects and particles, which are a
common place to want to spawn sub-effects. Like spawn,
these run on each loop, but for one-shots they play at the
end. Even with loops, this is helpful for timing sub-effects
(see fireworks2.json).
* Finally, added a much more comprehensive example effect,
raincloud.json. This includes a total of three effects, to
generate a cloud, raindrops, and splashes when those drops
hit "the ground".
Change-Id: I3d7b72bcbb684642cd9723518b67ab1c7d7a538a
Reviewed-on: https://skia-review.googlesource.com/c/skia/+/242479
Reviewed-by: Michael Ludwig <michaelludwig@google.com>
Commit-Queue: Brian Osman <brianosman@google.com>
2019-09-19 14:06:36 +00:00
|
|
|
class SkParticleEffect;
|
|
|
|
|
class SkParticleEffectParams;
|
2019-08-30 14:59:47 +00:00
|
|
|
class SkRandom;
|
|
|
|
|
|
|
|
|
|
namespace SkSL {
|
|
|
|
|
class Compiler;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
class SkParticleExternalValue : public SkSL::ExternalValue {
|
|
|
|
|
public:
|
|
|
|
|
SkParticleExternalValue(const char* name, SkSL::Compiler& compiler, const SkSL::Type& type)
|
|
|
|
|
: SkSL::ExternalValue(name, type)
|
|
|
|
|
, fCompiler(compiler)
|
Particles: Sub-effect spawning and some slight refactoring
* Added a new binding type, SkEffectBinding. This stores another
entire effect params structure (so the JSON is just nested).
The name is a callable value that spawns a new instance of
that effect, inheriting the parameters of the spawning effect
or particle (depending on which kind of script made the call).
* Broke up the monolithic update function into some helpers,
got some code reuse with the script calling logic.
* Unlike particle capacity, there is no upper limit on child
effects (yet), so it's easy to trigger runaway memory and
CPU consumption. Be careful.
* Added death scripts to effects and particles, which are a
common place to want to spawn sub-effects. Like spawn,
these run on each loop, but for one-shots they play at the
end. Even with loops, this is helpful for timing sub-effects
(see fireworks2.json).
* Finally, added a much more comprehensive example effect,
raincloud.json. This includes a total of three effects, to
generate a cloud, raindrops, and splashes when those drops
hit "the ground".
Change-Id: I3d7b72bcbb684642cd9723518b67ab1c7d7a538a
Reviewed-on: https://skia-review.googlesource.com/c/skia/+/242479
Reviewed-by: Michael Ludwig <michaelludwig@google.com>
Commit-Queue: Brian Osman <brianosman@google.com>
2019-09-19 14:06:36 +00:00
|
|
|
, fRandom(nullptr)
|
|
|
|
|
, fEffect(nullptr) {}
|
2019-08-30 14:59:47 +00:00
|
|
|
|
|
|
|
|
void setRandom(SkRandom* random) { fRandom = random; }
|
Particles: Sub-effect spawning and some slight refactoring
* Added a new binding type, SkEffectBinding. This stores another
entire effect params structure (so the JSON is just nested).
The name is a callable value that spawns a new instance of
that effect, inheriting the parameters of the spawning effect
or particle (depending on which kind of script made the call).
* Broke up the monolithic update function into some helpers,
got some code reuse with the script calling logic.
* Unlike particle capacity, there is no upper limit on child
effects (yet), so it's easy to trigger runaway memory and
CPU consumption. Be careful.
* Added death scripts to effects and particles, which are a
common place to want to spawn sub-effects. Like spawn,
these run on each loop, but for one-shots they play at the
end. Even with loops, this is helpful for timing sub-effects
(see fireworks2.json).
* Finally, added a much more comprehensive example effect,
raincloud.json. This includes a total of three effects, to
generate a cloud, raindrops, and splashes when those drops
hit "the ground".
Change-Id: I3d7b72bcbb684642cd9723518b67ab1c7d7a538a
Reviewed-on: https://skia-review.googlesource.com/c/skia/+/242479
Reviewed-by: Michael Ludwig <michaelludwig@google.com>
Commit-Queue: Brian Osman <brianosman@google.com>
2019-09-19 14:06:36 +00:00
|
|
|
void setEffect(SkParticleEffect* effect) { fEffect = effect; }
|
2019-08-30 14:59:47 +00:00
|
|
|
|
|
|
|
|
protected:
|
Particles: Sub-effect spawning and some slight refactoring
* Added a new binding type, SkEffectBinding. This stores another
entire effect params structure (so the JSON is just nested).
The name is a callable value that spawns a new instance of
that effect, inheriting the parameters of the spawning effect
or particle (depending on which kind of script made the call).
* Broke up the monolithic update function into some helpers,
got some code reuse with the script calling logic.
* Unlike particle capacity, there is no upper limit on child
effects (yet), so it's easy to trigger runaway memory and
CPU consumption. Be careful.
* Added death scripts to effects and particles, which are a
common place to want to spawn sub-effects. Like spawn,
these run on each loop, but for one-shots they play at the
end. Even with loops, this is helpful for timing sub-effects
(see fireworks2.json).
* Finally, added a much more comprehensive example effect,
raincloud.json. This includes a total of three effects, to
generate a cloud, raindrops, and splashes when those drops
hit "the ground".
Change-Id: I3d7b72bcbb684642cd9723518b67ab1c7d7a538a
Reviewed-on: https://skia-review.googlesource.com/c/skia/+/242479
Reviewed-by: Michael Ludwig <michaelludwig@google.com>
Commit-Queue: Brian Osman <brianosman@google.com>
2019-09-19 14:06:36 +00:00
|
|
|
SkSL::Compiler& fCompiler;
|
|
|
|
|
|
|
|
|
|
SkRandom* fRandom;
|
|
|
|
|
SkParticleEffect* fEffect;
|
2019-08-30 14:59:47 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
|
|
class SkParticleBinding : public SkReflected {
|
|
|
|
|
public:
|
|
|
|
|
SkParticleBinding(const char* name = "name") : fName(name) {}
|
|
|
|
|
|
|
|
|
|
REFLECTED_ABSTRACT(SkParticleBinding, SkReflected)
|
|
|
|
|
|
|
|
|
|
void visitFields(SkFieldVisitor* v) override;
|
|
|
|
|
virtual std::unique_ptr<SkParticleExternalValue> toValue(SkSL::Compiler&) = 0;
|
|
|
|
|
|
|
|
|
|
static void RegisterBindingTypes();
|
|
|
|
|
|
|
|
|
|
/*
|
|
|
|
|
* All SkParticleBinding objects expose a particular native object to an effect's SkSL code.
|
|
|
|
|
* In all cases, the 'name' is the symbol that will be used to access the object from the SkSL.
|
|
|
|
|
* Each binding is a callable object, so the SkSL name behaves like a function. The behavior of
|
|
|
|
|
* each kind of binding is described below.
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
// Binds an SkPath to an effect's SkSL. The path is specified using SVG syntax. It is called
|
|
|
|
|
// in the SkSL as 'name(t)'. 't' is a normalized distance along the path. This returns a float4
|
|
|
|
|
// value, containing the position in .xy, and the normal in .zw.
|
|
|
|
|
static sk_sp<SkParticleBinding> MakePathBinding(const char* name, const char* path);
|
|
|
|
|
|
Particles: Sub-effect spawning and some slight refactoring
* Added a new binding type, SkEffectBinding. This stores another
entire effect params structure (so the JSON is just nested).
The name is a callable value that spawns a new instance of
that effect, inheriting the parameters of the spawning effect
or particle (depending on which kind of script made the call).
* Broke up the monolithic update function into some helpers,
got some code reuse with the script calling logic.
* Unlike particle capacity, there is no upper limit on child
effects (yet), so it's easy to trigger runaway memory and
CPU consumption. Be careful.
* Added death scripts to effects and particles, which are a
common place to want to spawn sub-effects. Like spawn,
these run on each loop, but for one-shots they play at the
end. Even with loops, this is helpful for timing sub-effects
(see fireworks2.json).
* Finally, added a much more comprehensive example effect,
raincloud.json. This includes a total of three effects, to
generate a cloud, raindrops, and splashes when those drops
hit "the ground".
Change-Id: I3d7b72bcbb684642cd9723518b67ab1c7d7a538a
Reviewed-on: https://skia-review.googlesource.com/c/skia/+/242479
Reviewed-by: Michael Ludwig <michaelludwig@google.com>
Commit-Queue: Brian Osman <brianosman@google.com>
2019-09-19 14:06:36 +00:00
|
|
|
static sk_sp<SkParticleBinding> MakeEffectBinding(const char* name,
|
|
|
|
|
sk_sp<SkParticleEffectParams> effect);
|
|
|
|
|
|
2019-08-30 14:59:47 +00:00
|
|
|
protected:
|
|
|
|
|
SkString fName;
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
#endif // SkParticleBinding_DEFINED
|