consolidate runtime effect builder logic to base class

1) move make functions to base class and make base class constructor public
2) prepare for Android APIs: allow base class copy constructor like SkRuntimeShaderBuilder subclass had before refactor

Bug: b/365765693

Change-Id: I5eb1d8a6cdb1a1482897d23dfad983f9bb47cd0f
Reviewed-on: https://skia-review.googlesource.com/c/skia/+/897376
Reviewed-by: Brian Osman <brianosman@google.com>
Commit-Queue: Jorge Betancourt <jmbetancourt@google.com>

Author: jbeta51

include/effects/SkImageFilters.h

@@ -28,7 +28,7 @@
 class SkBlender;
 class SkColorFilter;
 class SkMatrix;
-class SkRuntimeShaderBuilder;
+class SkRuntimeEffectBuilder;
 enum class SkBlendMode;
 struct SkIPoint;
 struct SkISize;
@@ -382,7 +382,7 @@ class SK_API SkImageFilters {
 
     /**
      *  Create a filter that fills the output with the per-pixel evaluation of the SkShader produced
-     *  by the SkRuntimeShaderBuilder. The shader is defined in the image filter's local coordinate
+     *  by the SkRuntimeEffectBuilder. The shader is defined in the image filter's local coordinate
      *  system, so it will automatically be affected by SkCanvas' transform.
      *
      *  This variant assumes that the runtime shader samples 'childShaderName' with the same input
@@ -399,7 +399,7 @@ class SK_API SkImageFilters {
      *  @param input           The image filter that will be provided as input to the runtime
      *                         shader. If null the implicit source image is used instead
      */
-    static sk_sp<SkImageFilter> RuntimeShader(const SkRuntimeShaderBuilder& builder,
+    static sk_sp<SkImageFilter> RuntimeShader(const SkRuntimeEffectBuilder& builder,
                                               std::string_view childShaderName,
                                               sk_sp<SkImageFilter> input) {
         return RuntimeShader(builder, /*sampleRadius=*/0.f, childShaderName, std::move(input));
@@ -416,14 +416,14 @@ class SK_API SkImageFilters {
      *
      * This requires a GPU backend or SkSL to be compiled in.
     */
-    static sk_sp<SkImageFilter> RuntimeShader(const SkRuntimeShaderBuilder& builder,
+    static sk_sp<SkImageFilter> RuntimeShader(const SkRuntimeEffectBuilder& builder,
                                               SkScalar sampleRadius,
                                               std::string_view childShaderName,
                                               sk_sp<SkImageFilter> input);
 
     /**
      *  Create a filter that fills the output with the per-pixel evaluation of the SkShader produced
-     *  by the SkRuntimeShaderBuilder. The shader is defined in the image filter's local coordinate
+     *  by the SkRuntimeEffectBuilder. The shader is defined in the image filter's local coordinate
      *  system, so it will automatically be affected by SkCanvas' transform.
      *
      *  This requires a GPU backend or SkSL to be compiled in.
@@ -438,7 +438,7 @@ class SK_API SkImageFilters {
      *                          shader. If any are null, the implicit source image is used instead.
      *  @param inputCount       How many entries are present in 'childShaderNames' and 'inputs'.
      */
-    static sk_sp<SkImageFilter> RuntimeShader(const SkRuntimeShaderBuilder& builder,
+    static sk_sp<SkImageFilter> RuntimeShader(const SkRuntimeEffectBuilder& builder,
                                               std::string_view childShaderNames[],
                                               const sk_sp<SkImageFilter> inputs[],
                                               int inputCount) {
@@ -455,7 +455,7 @@ class SK_API SkImageFilters {
      *
      *  This requires a GPU backend or SkSL to be compiled in.
      */
-    static sk_sp<SkImageFilter> RuntimeShader(const SkRuntimeShaderBuilder& builder,
+    static sk_sp<SkImageFilter> RuntimeShader(const SkRuntimeEffectBuilder& builder,
                                               SkScalar maxSampleRadius,
                                               std::string_view childShaderNames[],
                                               const sk_sp<SkImageFilter> inputs[],

include/effects/SkRuntimeEffect.h

@@ -328,9 +328,45 @@ class SK_API SkRuntimeEffect : public SkRefCnt {
     uint32_t fFlags;  // Flags
 };
 
-/** Base class for SkRuntimeShaderBuilder, defined below. */
+/**
+ * SkRuntimeEffectBuilder is a utility to simplify creating SkShader, SkColorFilter, and SkBlender
+ * objects from SkRuntimeEffects.
+ *
+ * NOTE: Like SkRuntimeEffect, this API is experimental and subject to change!
+ *
+ * Given an SkRuntimeEffect, the SkRuntimeEffectBuilder manages creating an input data block and
+ * provides named access to the 'uniform' variables in that block, as well as named access
+ * to a list of child shader slots. Usage:
+ *
+ *   sk_sp<SkRuntimeEffect> effect = ...;
+ *   SkRuntimeEffectBuilder builder(effect);
+ *   builder.uniform("some_uniform_float")  = 3.14f;
+ *   builder.uniform("some_uniform_matrix") = SkM44::Rotate(...);
+ *   builder.child("some_child_effect")     = mySkImage->makeShader(...);
+ *   ...
+ *   sk_sp<SkShader> shader = builder.makeShader(nullptr, false);
+ *
+ * Upon calling makeShader, makeColorFilter, or makeBlender, the builder will check the validity
+ * of the SkSL to see if the entry point is correct.
+ *
+ * Note that SkRuntimeEffectBuilder is built entirely on the public API of SkRuntimeEffect,
+ * so can be used as-is or serve as inspiration for other interfaces or binding techniques.
+ */
 class SkRuntimeEffectBuilder {
 public:
+    explicit SkRuntimeEffectBuilder(sk_sp<SkRuntimeEffect> effect)
+            : fEffect(std::move(effect))
+            , fUniforms(SkData::MakeZeroInitialized(fEffect->uniformSize()))
+            , fChildren(fEffect->children().size()) {}
+    explicit SkRuntimeEffectBuilder(sk_sp<SkRuntimeEffect> effect, sk_sp<SkData> uniforms)
+            : fEffect(std::move(effect))
+            , fUniforms(std::move(uniforms))
+            , fChildren(fEffect->children().size()) {}
+
+    // This is currently required by Android Framework but may go away if that dependency
+    // can be removed.
+    SkRuntimeEffectBuilder(const SkRuntimeEffectBuilder&) = default;
+
     struct BuilderUniform {
         // Copy 'val' to this variable. No type conversion is performed - 'val' must be same
         // size as expected by the effect. Information about the variable can be queried by
@@ -419,19 +455,17 @@ class SkRuntimeEffectBuilder {
     sk_sp<const SkData> uniforms() const { return fUniforms; }
     SkSpan<const SkRuntimeEffect::ChildPtr> children() const { return fChildren; }
 
+    // Build methods, at this point checks are made to ensure the SkSL entry point `main` is correct
+    sk_sp<SkShader> makeShader(const SkMatrix* localMatrix = nullptr) const;
+    sk_sp<SkColorFilter> makeColorFilter() const;
+    sk_sp<SkBlender> makeBlender() const;
+
+    ~SkRuntimeEffectBuilder() = default;
+
 protected:
     SkRuntimeEffectBuilder() = delete;
-    explicit SkRuntimeEffectBuilder(sk_sp<SkRuntimeEffect> effect)
-            : fEffect(std::move(effect))
-            , fUniforms(SkData::MakeZeroInitialized(fEffect->uniformSize()))
-            , fChildren(fEffect->children().size()) {}
-    explicit SkRuntimeEffectBuilder(sk_sp<SkRuntimeEffect> effect, sk_sp<SkData> uniforms)
-            : fEffect(std::move(effect))
-            , fUniforms(std::move(uniforms))
-            , fChildren(fEffect->children().size()) {}
 
     SkRuntimeEffectBuilder(SkRuntimeEffectBuilder&&) = default;
-    SkRuntimeEffectBuilder(const SkRuntimeEffectBuilder&) = default;
 
     SkRuntimeEffectBuilder& operator=(SkRuntimeEffectBuilder&&) = delete;
     SkRuntimeEffectBuilder& operator=(const SkRuntimeEffectBuilder&) = delete;
@@ -447,71 +481,15 @@ class SkRuntimeEffectBuilder {
     sk_sp<SkRuntimeEffect>                 fEffect;
     sk_sp<SkData>                          fUniforms;
     std::vector<SkRuntimeEffect::ChildPtr> fChildren;
-};
-
-/**
- * SkRuntimeShaderBuilder is a utility to simplify creating SkShader objects from SkRuntimeEffects.
- *
- * NOTE: Like SkRuntimeEffect, this API is experimental and subject to change!
- *
- * Given an SkRuntimeEffect, the SkRuntimeShaderBuilder manages creating an input data block and
- * provides named access to the 'uniform' variables in that block, as well as named access
- * to a list of child shader slots. Usage:
- *
- *   sk_sp<SkRuntimeEffect> effect = ...;
- *   SkRuntimeShaderBuilder builder(effect);
- *   builder.uniform("some_uniform_float")  = 3.14f;
- *   builder.uniform("some_uniform_matrix") = SkM44::Rotate(...);
- *   builder.child("some_child_effect")     = mySkImage->makeShader(...);
- *   ...
- *   sk_sp<SkShader> shader = builder.makeShader(nullptr, false);
- *
- * Note that SkRuntimeShaderBuilder is built entirely on the public API of SkRuntimeEffect,
- * so can be used as-is or serve as inspiration for other interfaces or binding techniques.
- */
-class SK_API SkRuntimeShaderBuilder : public SkRuntimeEffectBuilder {
-public:
-    explicit SkRuntimeShaderBuilder(sk_sp<SkRuntimeEffect>);
-    // This is currently required by Android Framework but may go away if that dependency
-    // can be removed.
-    SkRuntimeShaderBuilder(const SkRuntimeShaderBuilder&) = default;
-    ~SkRuntimeShaderBuilder();
-
-    sk_sp<SkShader> makeShader(const SkMatrix* localMatrix = nullptr) const;
-
-private:
-    explicit SkRuntimeShaderBuilder(sk_sp<SkRuntimeEffect> effect, sk_sp<SkData> uniforms)
-            : SkRuntimeEffectBuilder(std::move(effect), std::move(uniforms)) {}
 
     friend class SkRuntimeImageFilter;
 };
 
 /**
- * SkRuntimeColorFilterBuilder makes it easy to setup and assign uniforms to runtime color filters.
- */
-class SK_API SkRuntimeColorFilterBuilder : public SkRuntimeEffectBuilder {
-public:
-    explicit SkRuntimeColorFilterBuilder(sk_sp<SkRuntimeEffect>);
-    ~SkRuntimeColorFilterBuilder();
-
-    SkRuntimeColorFilterBuilder(const SkRuntimeColorFilterBuilder&) = delete;
-    SkRuntimeColorFilterBuilder& operator=(const SkRuntimeColorFilterBuilder&) = delete;
-
-    sk_sp<SkColorFilter> makeColorFilter() const;
-};
-
-/**
- * SkRuntimeBlendBuilder is a utility to simplify creation and uniform setup of runtime blenders.
+ * DEPRECATED: Subclass logic has been moved to base class SkRuntimeEffectBuilder.
  */
-class SK_API SkRuntimeBlendBuilder : public SkRuntimeEffectBuilder {
-public:
-    explicit SkRuntimeBlendBuilder(sk_sp<SkRuntimeEffect>);
-    ~SkRuntimeBlendBuilder();
-
-    SkRuntimeBlendBuilder(const SkRuntimeBlendBuilder&) = delete;
-    SkRuntimeBlendBuilder& operator=(const SkRuntimeBlendBuilder&) = delete;
-
-    sk_sp<SkBlender> makeBlender() const;
-};
+using SkRuntimeShaderBuilder = SkRuntimeEffectBuilder;
+using SkRuntimeColorFilterBuilder = SkRuntimeEffectBuilder;
+using SkRuntimeBlendBuilder = SkRuntimeEffectBuilder;
 
 #endif  // SkRuntimeEffect_DEFINED

relnotes/skslbuilders.md

@@ -0,0 +1,3 @@
+A noop change to our SkSL runtime effect builder APIs. Moved make functions from subclasses
+SkRuntimeShaderBuilder, SkRuntimeColorFilterBuilder, and SkRuntimeBlendBuilder to the base class
+SkRuntimeEffectBuilder.

src/core/SkBlurEngine.h

@@ -20,7 +20,7 @@
 
 class SkDevice;
 class SkRuntimeEffect;
-class SkRuntimeShaderBuilder;
+class SkRuntimeEffectBuilder;
 class SkSpecialImage;
 struct SkImageInfo;
 struct SkIRect;
@@ -148,7 +148,7 @@ class SkShaderBlurAlgorithm : public SkBlurEngine::Algorithm {
     // Create a new surface, which can be approx-fit and have undefined contents.
     virtual sk_sp<SkDevice> makeDevice(const SkImageInfo&) const = 0;
 
-    sk_sp<SkSpecialImage> renderBlur(SkRuntimeShaderBuilder* blurEffectBuilder,
+    sk_sp<SkSpecialImage> renderBlur(SkRuntimeEffectBuilder* blurEffectBuilder,
                                      SkFilterMode filter,
                                      SkISize radii,
                                      sk_sp<SkSpecialImage> input,

src/core/SkRuntimeEffect.cpp

@@ -965,29 +965,14 @@ void SkRuntimeEffect::RegisterFlattenables() {
     SkFlattenable::Register("SkRTShader", SkRuntimeShader::CreateProc);
 }
 
-SkRuntimeShaderBuilder::SkRuntimeShaderBuilder(sk_sp<SkRuntimeEffect> effect)
-        : SkRuntimeEffectBuilder(std::move(effect)) {}
-
-SkRuntimeShaderBuilder::~SkRuntimeShaderBuilder() = default;
-
-sk_sp<SkShader> SkRuntimeShaderBuilder::makeShader(const SkMatrix* localMatrix) const {
+sk_sp<SkShader> SkRuntimeEffectBuilder::makeShader(const SkMatrix* localMatrix) const {
     return this->effect()->makeShader(this->uniforms(), this->children(), localMatrix);
 }
 
-SkRuntimeBlendBuilder::SkRuntimeBlendBuilder(sk_sp<SkRuntimeEffect> effect)
-        : SkRuntimeEffectBuilder(std::move(effect)) {}
-
-SkRuntimeBlendBuilder::~SkRuntimeBlendBuilder() = default;
-
-sk_sp<SkBlender> SkRuntimeBlendBuilder::makeBlender() const {
+sk_sp<SkBlender> SkRuntimeEffectBuilder::makeBlender() const {
     return this->effect()->makeBlender(this->uniforms(), this->children());
 }
 
-SkRuntimeColorFilterBuilder::SkRuntimeColorFilterBuilder(sk_sp<SkRuntimeEffect> effect)
-        : SkRuntimeEffectBuilder(std::move(effect)) {}
-
-SkRuntimeColorFilterBuilder::~SkRuntimeColorFilterBuilder() = default;
-
-sk_sp<SkColorFilter> SkRuntimeColorFilterBuilder::makeColorFilter() const {
+sk_sp<SkColorFilter> SkRuntimeEffectBuilder::makeColorFilter() const {
     return this->effect()->makeColorFilter(this->uniforms(), this->children());
 }