@shopify/react-native-skia 2.6.2 → 2.6.3-next.1

package/cpp/skia/src/gpu/graphite/ResourceTypes.h

@@ -0,0 +1,360 @@
+/*
+ * Copyright 2021 Google LLC
+ *
+ * Use of this source code is governed by a BSD-style license that can be
+ * found in the LICENSE file.
+ */
+
+#ifndef skgpu_graphite_ResourceTypes_DEFINED
+#define skgpu_graphite_ResourceTypes_DEFINED
+
+#include "include/core/SkSamplingOptions.h"
+#include "include/core/SkSpan.h"
+#include "include/core/SkTileMode.h"
+#include "include/gpu/graphite/GraphiteTypes.h"
+#include "include/private/base/SkTo.h"
+#include "src/base/SkEnumBitMask.h"
+#include "src/base/SkMathPriv.h"
+
+namespace skgpu::graphite {
+
+class Buffer;
+
+// This declaration of the DepthStencilFlags' SkEnumBitMask ops is here bc, internally, we use
+// DepthStencilFlags as bit fields but, externally (i.e., from the GraphiteTypes view), we want
+// it to appear as just an enum class.
+SK_MAKE_BITMASK_OPS(DepthStencilFlags)
+// The same goes for SampleCount
+SK_MAKE_BITMASK_OPS(SampleCount)
+
+/**
+ * There are only a few possible valid sample counts (1, 2, 4, 8, 16). So we can key on those 5
+ * options instead of the actual sample value. The resulting key value only requires 3 bits of space
+ */
+static constexpr uint32_t SamplesToKey(SampleCount numSamples) {
+    switch (numSamples) {
+        case SampleCount::k1:
+            return 0;
+        case SampleCount::k2:
+            return 1;
+        case SampleCount::k4:
+            return 2;
+        case SampleCount::k8:
+            return 3;
+        case SampleCount::k16:
+            return 4;
+    }
+    SkUNREACHABLE;
+}
+static constexpr SampleCount KeyToSamples(uint32_t keyBits) {
+    SkASSERT(keyBits <= 4);
+    return static_cast<SampleCount>(1 << keyBits);
+}
+static constexpr int kNumSampleKeyBits = 3;
+
+/**
+ * The strategy that a renderpass and/or pipeline use to access the current dst pixel when blending.
+ */
+enum class DstReadStrategy : uint8_t {
+    kNoneRequired,
+    kTextureCopy,
+    kTextureSample,  // TODO(b/238756862): To be used once direct texture sampling is implemented
+    kReadFromInput,
+    kFramebufferFetch,
+
+    kLast = kFramebufferFetch
+};
+inline static constexpr int kDstReadStrategyCount = (int)(DstReadStrategy::kLast) + 1;
+
+/**
+ * This enum is used to specify the load operation to be used when a RenderPass begins execution.
+ */
+enum class LoadOp : uint8_t {
+    kLoad,
+    kClear,
+    kDiscard,
+
+    kLast = kDiscard
+};
+inline static constexpr int kLoadOpCount = (int)(LoadOp::kLast) + 1;
+
+/**
+ * This enum is used to specify the store operation to be used when a RenderPass ends execution.
+ */
+enum class StoreOp : uint8_t {
+    kStore,
+    kDiscard,
+
+    kLast = kDiscard
+};
+inline static constexpr int kStoreOpCount = (int)(StoreOp::kLast) + 1;
+
+/**
+ * What a GPU buffer will be used for
+ */
+enum class BufferType : int {
+    kVertex,
+    kIndex,
+    kXferCpuToGpu,
+    kXferGpuToCpu,
+    kUniform,
+    kStorage,
+    kQuery,
+
+    // GPU-only buffer types
+    kIndirect,
+    kVertexStorage,
+    kIndexStorage,
+
+    kLast = kIndexStorage,
+};
+static const int kBufferTypeCount = static_cast<int>(BufferType::kLast) + 1;
+
+/**
+ * Data layout requirements on host-shareable buffer contents.
+ */
+enum class Layout : uint8_t {
+    kInvalid = 0,
+    kStd140,
+    kStd140_F16,
+    kStd430,
+    kStd430_F16,
+    kMetal,
+};
+
+static constexpr const char* LayoutString(Layout layout) {
+    switch(layout) {
+        case Layout::kStd140:     return "std140";
+        case Layout::kStd140_F16: return "std140-f16";
+        case Layout::kStd430:     return "std430";
+        case Layout::kStd430_F16: return "std430-f16";
+        case Layout::kMetal:      return "metal";
+        case Layout::kInvalid:    return "invalid";
+    }
+    SkUNREACHABLE;
+}
+
+/**
+ * Indicates the intended access pattern over resource memory. This is used to select the most
+ * efficient memory type during resource creation based on the capabilities of the platform.
+ *
+ * This is only a hint and the actual memory type will be determined based on the resource type and
+ * backend capabilities.
+ */
+enum class AccessPattern : uint8_t {
+    // GPU-only memory does not need to support reads/writes from the CPU. GPU-private memory will
+    // be preferred if the backend supports an efficient private memory type.
+    kGpuOnly,
+
+    // The resource needs to be CPU visible, e.g. for read-back or as a copy/upload source.
+    kHostVisible,
+
+    // Use to debug GPU only buffers.
+    kGpuOnlyCopySrc,
+};
+
+/**
+ * Determines whether the contents of a GPU buffer sub-allocation gets cleared to 0 before being
+ * used in a GPU command submission.
+ */
+enum class ClearBuffer : bool {
+    kNo = false,
+    kYes = true,
+};
+
+/**
+ * Must the contents of the Resource be preserved af a render pass or can a more efficient
+ * representation be chosen when supported by hardware.
+ */
+enum class Discardable : bool {
+    kNo = false,
+    kYes = true
+};
+
+enum class Ownership : uint8_t {
+    kOwned,
+    kWrapped,
+};
+
+/** Uniquely identifies the type of resource that is cached with a GraphiteResourceKey. */
+using ResourceType = uint32_t;
+
+/**
+ * Can the resource be held by multiple users at the same time?
+ * For example, stencil buffers, pipelines, etc.
+ */
+enum class Shareable : uint8_t {
+    kNo,      // The resource is visible in the ResourceCache once all its usage refs are dropped
+    kScratch, // The resource is visible to other Recorders, but acts like kNo within a Recording
+    kYes,     // The resource is always visible in the ResourceCache
+};
+
+/*
+ * Struct that can be passed into bind buffer calls on the CommandBuffer. The ownership of the
+ * buffer and its usage in command submission must be tracked by the caller (e.g. as with
+ * buffers created by DrawBufferManager).
+ */
+struct BindBufferInfo {
+    const Buffer* fBuffer = nullptr;
+    uint32_t fOffset = 0;
+    uint32_t fSize = 0;
+
+    explicit operator bool() const { return SkToBool(fBuffer); }
+
+    bool operator==(const BindBufferInfo& o) const {
+        return fBuffer == o.fBuffer && (!fBuffer || (fOffset == o.fOffset && fSize == o.fSize));
+    }
+    bool operator!=(const BindBufferInfo& o) const { return !(*this == o); }
+};
+
+// How texture memory is arranged on the GPU, which can impact what operations are supported.
+enum class Tiling : uint8_t {
+    kOptimal,
+    kLinear
+};
+
+// Coarse ways in which a specific texture can be used, or the theoretic set of usages a texture
+// format supports.
+enum class TextureUsage : uint8_t {
+    kRender   = 0x01, // Can be used as a rendering attachment
+    kMSRTSS   = 0x02, // Can be rendered with MSAA-render-to-single-sampled functionality
+    kSample   = 0x04, // Can be sampled within a shader
+    kCopySrc  = 0x08, // Can be copied into another texture or buffer
+    kCopyDst  = 0x10, // Can be the copy target of another texture or buffer
+    kStorage  = 0x20, // Can be read and written to in a compute pipeline
+    kHostCopy = 0x40, // Can be written to directly from host memory
+};
+SK_MAKE_BITMASK_OPS(TextureUsage)
+
+struct ImmutableSamplerInfo {
+    // If the sampler requires YCbCr conversion, backends can place that information here.
+    // In order to fit within SamplerDesc's uint32 desc field, backends can only utilize up to
+    // kMaxNumConversionInfoBits bits.
+    uint32_t fNonFormatYcbcrConversionInfo = 0;
+    // fFormat represents known OR external format numerical representation.
+    uint64_t fFormat = 0;
+};
+
+/**
+ * Struct used to describe how a Texture/TextureProxy/TextureProxyView is sampled.
+ */
+struct SamplerDesc {
+    static_assert(kSkTileModeCount <= 4 && kSkFilterModeCount <= 2 && kSkMipmapModeCount <= 4);
+
+    constexpr SamplerDesc(const SkSamplingOptions& samplingOptions, SkTileMode tileMode)
+            : SamplerDesc(samplingOptions, {tileMode, tileMode}) {}
+
+    constexpr SamplerDesc(const SkSamplingOptions& samplingOptions,
+                          const std::pair<SkTileMode, SkTileMode> tileModes,
+                          const ImmutableSamplerInfo info = {})
+            : fDesc((static_cast<int>(tileModes.first)            << kTileModeXShift           ) |
+                    (static_cast<int>(tileModes.second)           << kTileModeYShift           ) |
+                    (static_cast<int>(samplingOptions.filter)     << kFilterModeShift          ) |
+                    (static_cast<int>(samplingOptions.mipmap)     << kMipmapModeShift          ) |
+                    (info.fNonFormatYcbcrConversionInfo           << kImmutableSamplerInfoShift) )
+            , fFormat(info.fFormat)
+            , fExternalFormatMostSignificantBits(info.fFormat >> 32) {
+
+        // Cubic sampling is handled in a shader, with the actual texture sampled by with NN,
+        // but that is what a cubic SkSamplingOptions is set to if you ignore 'cubic', which let's
+        // us simplify how we construct SamplerDec's from the options passed to high-level draws.
+        SkASSERT(!samplingOptions.useCubic || (samplingOptions.filter == SkFilterMode::kNearest &&
+                                               samplingOptions.mipmap == SkMipmapMode::kNone));
+
+        // TODO: Add aniso value when used.
+
+        // Assert that fYcbcrConversionInfo does not exceed kMaxNumConversionInfoBits such that
+        // the conversion information can fit within an uint32.
+        SkASSERT(info.fNonFormatYcbcrConversionInfo >> kMaxNumConversionInfoBits == 0);
+    }
+    constexpr SamplerDesc() = default;
+    constexpr SamplerDesc(const SamplerDesc&) = default;
+    constexpr SamplerDesc& operator=(const SamplerDesc&) = default;
+
+    constexpr SamplerDesc(uint32_t desc, uint32_t format, uint32_t extFormatMSB)
+            : fDesc(desc)
+            , fFormat(format)
+            , fExternalFormatMostSignificantBits(extFormatMSB) {}
+
+    bool operator==(const SamplerDesc& o) const {
+        return o.fDesc == fDesc && o.fFormat == fFormat &&
+               o.fExternalFormatMostSignificantBits == fExternalFormatMostSignificantBits;
+    }
+
+    bool operator!=(const SamplerDesc& o) const { return !(*this == o); }
+
+    SkTileMode tileModeX()          const {
+        return static_cast<SkTileMode>((fDesc >> kTileModeXShift) & 0b11);
+    }
+    SkTileMode tileModeY()          const {
+        return static_cast<SkTileMode>((fDesc >> kTileModeYShift) & 0b11);
+    }
+    SkFilterMode filterMode()       const {
+        return static_cast<SkFilterMode>((fDesc >> kFilterModeShift) & 0b01);
+    }
+    SkMipmapMode mipmap()           const {
+        return static_cast<SkMipmapMode>((fDesc >> kMipmapModeShift) & 0b11);
+    }
+    uint32_t   desc()               const { return fDesc;                                        }
+    uint32_t   format()             const { return fFormat;                                      }
+    uint32_t   externalFormatMSBs() const { return fExternalFormatMostSignificantBits;           }
+    bool       isImmutable()        const { return (fDesc >> kImmutableSamplerInfoShift) != 0;   }
+    bool       usesExternalFormat() const { return (fDesc >> kImmutableSamplerInfoShift) & 0b1;  }
+
+    // NOTE: returns the HW sampling options to use, so a bicubic SkSamplingOptions will become
+    // nearest-neighbor sampling in HW.
+    SkSamplingOptions samplingOptions() const {
+        // TODO: Add support for anisotropic filtering
+        SkFilterMode filter = static_cast<SkFilterMode>((fDesc >> kFilterModeShift) & 0b01);
+        SkMipmapMode mipmap = static_cast<SkMipmapMode>((fDesc >> kMipmapModeShift) & 0b11);
+        return SkSamplingOptions(filter, mipmap);
+    }
+
+    ImmutableSamplerInfo immutableSamplerInfo() const {
+        return {this->desc() >> kImmutableSamplerInfoShift,
+                ((uint64_t) this->externalFormatMSBs() << 32) | (uint64_t) this->format()};
+    }
+
+    SkSpan<const uint32_t> asSpan() const {
+        // Span length depends upon whether the sampler is immutable and if it uses a known format
+        return {&fDesc, 1u + this->isImmutable() + this->usesExternalFormat()};
+    }
+
+    // These are public such that backends can bitshift data in order to determine whatever
+    // sampler qualities they need from fDesc.
+    static constexpr int kNumTileModeBits   = SkNextLog2(int(SkTileMode::kLastTileMode)+1);
+    static constexpr int kNumFilterModeBits = SkNextLog2(int(SkFilterMode::kLast)+1);
+    static constexpr int kNumMipmapModeBits = SkNextLog2(int(SkMipmapMode::kLast)+1);
+    static constexpr int kMaxNumConversionInfoBits =
+            32 - kNumFilterModeBits - kNumMipmapModeBits - kNumTileModeBits;
+
+    static constexpr int kTileModeXShift            = 0;
+    static constexpr int kTileModeYShift            = kTileModeXShift  + kNumTileModeBits;
+    static constexpr int kFilterModeShift           = kTileModeYShift  + kNumTileModeBits;
+    static constexpr int kMipmapModeShift           = kFilterModeShift + kNumFilterModeBits;
+    static constexpr int kImmutableSamplerInfoShift = kMipmapModeShift + kNumMipmapModeBits;
+
+    // Only relevant when using immutable samplers. Otherwise, can be ignored. The number of uint32s
+    // required to represent all relevant sampler desc information depends upon whether we are using
+    // a known or external format.
+    static constexpr int kInt32sNeededKnownFormat = 2;
+    static constexpr int kInt32sNeededExternalFormat = 3;
+
+private:
+    // Note: The order of these member attributes matters to keep unique object representation
+    // such that SkGoodHash can be used to hash SamplerDesc objects.
+    uint32_t fDesc = 0;
+
+    // Data fields populated by backend Caps which store texture format information (needed for
+    // YCbCr sampling). Only relevant when using immutable samplers. Otherwise, can be ignored.
+    // Known formats only require a uint32, but external formats can be up to a uint64. We store
+    // this as two separate uint32s such that has_unique_object_representation can be true, allowing
+    // this structure to be easily hashed using SkGoodHash. So, external formats can be represented
+    // with (fExternalFormatMostSignificantBits << 32) | fFormat.
+    uint32_t fFormat = 0;
+    uint32_t fExternalFormatMostSignificantBits = 0;
+};
+
+}  // namespace skgpu::graphite
+
+#endif // skgpu_graphite_ResourceTypes_DEFINED

package/cpp/skia/src/gpu/graphite/TextureProxyView.h

@@ -0,0 +1,105 @@
+/*
+ * Copyright 2022 Google LLC
+ *
+ * Use of this source code is governed by a BSD-style license that can be
+ * found in the LICENSE file.
+ */
+
+#ifndef skgpu_graphite_TextureProxyView_DEFINED
+#define skgpu_graphite_TextureProxyView_DEFINED
+
+#include "include/core/SkRect.h"
+#include "include/core/SkRefCnt.h"
+#include "include/gpu/graphite/GraphiteTypes.h"
+#include "src/gpu/Swizzle.h"
+#include "src/gpu/graphite/TextureProxy.h"
+
+enum class SkBackingFit;
+
+namespace skgpu::graphite {
+
+class Recorder;
+
+class TextureProxyView {
+public:
+    TextureProxyView() = default;
+
+    TextureProxyView(sk_sp<TextureProxy> proxy, Swizzle swizzle)
+            : fProxy(std::move(proxy)), fSwizzle(swizzle) {}
+
+    TextureProxyView(sk_sp<TextureProxy> proxy, Swizzle swizzle, Origin origin)
+            : fProxy(std::move(proxy)), fSwizzle(swizzle), fOrigin(origin) {}
+
+    // This entry point is used when we don't care about the swizzle and assume TopLeft origin.
+    explicit TextureProxyView(sk_sp<TextureProxy> proxy)
+            : fProxy(std::move(proxy)) {}
+
+    TextureProxyView(TextureProxyView&& view) = default;
+    TextureProxyView(const TextureProxyView&) = default;
+
+    explicit operator bool() const { return SkToBool(fProxy.get()); }
+
+    TextureProxyView& operator=(const TextureProxyView&) = default;
+    TextureProxyView& operator=(TextureProxyView&& view) = default;
+
+    bool operator==(const TextureProxyView& view) const {
+        return fProxy == view.fProxy &&
+               fSwizzle == view.fSwizzle &&
+               fOrigin == view.fOrigin;
+    }
+    bool operator!=(const TextureProxyView& other) const { return !(*this == other); }
+
+    int width() const { return this->proxy()->dimensions().width(); }
+    int height() const { return this->proxy()->dimensions().height(); }
+    SkISize dimensions() const { return this->proxy()->dimensions(); }
+
+    skgpu::Mipmapped mipmapped() const {
+        if (const TextureProxy* proxy = this->proxy()) {
+            return proxy->mipmapped();
+        }
+        return skgpu::Mipmapped::kNo;
+    }
+
+    TextureProxy* proxy() const { return fProxy.get(); }
+    sk_sp<TextureProxy> refProxy() const { return fProxy; }
+
+    Swizzle swizzle() const { return fSwizzle; }
+    Origin origin() const { return fOrigin; }
+
+    void concatSwizzle(Swizzle swizzle) {
+        fSwizzle = skgpu::Swizzle::Concat(fSwizzle, swizzle);
+    }
+
+    // makeSwizzle returns a new view with 'swizzle' composed on to this view's existing swizzle
+    TextureProxyView makeSwizzle(Swizzle swizzle) const & {
+        return {fProxy, Swizzle::Concat(fSwizzle, swizzle), fOrigin};
+    }
+
+    TextureProxyView makeSwizzle(Swizzle swizzle) && {
+        return {std::move(fProxy), Swizzle::Concat(fSwizzle, swizzle), fOrigin};
+    }
+
+    // resetSwizzle returns a new view that uses 'swizzle' and disregards this view's prior swizzle.
+    TextureProxyView replaceSwizzle(Swizzle swizzle) const {
+        return {fProxy, swizzle, fOrigin};
+    }
+
+    void reset() {
+        *this = {};
+    }
+
+    // This does not reset the swizzle, so the View can still be used to access those
+    // properties associated with the detached proxy.
+    sk_sp<TextureProxy> detachProxy() {
+        return std::move(fProxy);
+    }
+
+private:
+    sk_sp<TextureProxy> fProxy;
+    Swizzle fSwizzle;
+    Origin fOrigin = Origin::kTopLeft;
+};
+
+} // namespace skgpu::graphite
+
+#endif // skgpu_graphite_TextureProxyView_DEFINED

package/package.json

@@ -9,7 +9,7 @@
     "setup-skia-web": "scripts/setup-canvaskit.js"
   },
   "title": "React Native Skia",
-  "version": "2.6.2",
+  "version": "2.6.3-next.1",
   "description": "High-performance React Native Graphics using Skia",
   "main": "lib/module/index.js",
   "react-native": "src/index.ts",
@@ -129,10 +129,10 @@
   },
   "dependencies": {
     "canvaskit-wasm": "0.41.0",
-    "react-native-skia-android": "147.1.0",
-    "react-native-skia-apple-ios": "147.1.0",
-    "react-native-skia-apple-macos": "147.1.0",
-    "react-native-skia-apple-tvos": "147.1.0",
+    "react-native-skia-graphite-android": "147.1.1",
+    "react-native-skia-graphite-apple-ios": "147.1.1",
+    "react-native-skia-graphite-apple-macos": "147.1.1",
+    "react-native-skia-graphite-headers": "147.1.1",
     "react-reconciler": "0.31.0"
   },
   "eslintIgnore": [
@@ -171,5 +171,6 @@
         }
       ]
     ]
-  }
+  },
+  "stableVersion": "0.0.0"
 }

package/scripts/install-libs.js

@@ -4,11 +4,10 @@
 const path = require("path");
 const fs = require("fs");
 
-const useGraphite =
-  process.env.SK_GRAPHITE === "1" ||
-  (process.env.SK_GRAPHITE || "").toLowerCase() === "true";
-const prefix = useGraphite ? "react-native-skia-graphite" : "react-native-skia";
+const useGraphite = true;
+const prefix = "react-native-skia-graphite";
 const libsDir = path.join(__dirname, "..", "libs");
+const packageRoot = path.join(__dirname, "..");
 
 function copySync(src, dest, options) {
   if (!src.includes("*")) {
@@ -131,3 +130,44 @@ fs.rmSync(androidDest, { recursive: true, force: true });
 copySync(androidSrcLibs, androidDest, { recursive: true });
 
 console.log("-- Copied Android libs to libs/android/");
+
+// --- Graphite: headers and marker file ---
+
+if (useGraphite) {
+  // Copy Dawn/WebGPU headers from the headers package
+  let headersPackage;
+  try {
+    headersPackage = path.dirname(
+      require.resolve("react-native-skia-graphite-headers/package.json")
+    );
+  } catch (e) {
+    console.error("ERROR: Could not find react-native-skia-graphite-headers");
+    console.error("Make sure you have run yarn install or npm install");
+    process.exit(1);
+  }
+
+  console.log("-- Skia Graphite headers package: " + headersPackage);
+
+  const headersSrcBase = path.join(headersPackage, "libs/skia/cpp");
+
+  // Copy Dawn/WebGPU headers
+  const dawnSrc = path.join(headersSrcBase, "dawn");
+  const dawnDest = path.join(packageRoot, "cpp/dawn");
+  fs.rmSync(dawnDest, { recursive: true, force: true });
+  fs.cpSync(dawnSrc, dawnDest, { recursive: true });
+  console.log("-- Copied Dawn/WebGPU headers to cpp/dawn/");
+
+  // Copy Graphite source headers
+  const graphiteSrc = path.join(headersSrcBase, "skia/src/gpu/graphite");
+  const graphiteDest = path.join(packageRoot, "cpp/skia/src/gpu/graphite");
+  fs.rmSync(graphiteDest, { recursive: true, force: true });
+  fs.mkdirSync(graphiteDest, { recursive: true });
+  fs.cpSync(graphiteSrc, graphiteDest, { recursive: true });
+  console.log("-- Copied Graphite source headers to cpp/skia/src/gpu/graphite/");
+
+  // Write .graphite marker file
+  const markerFile = path.join(libsDir, ".graphite");
+  const version = "m147a";
+  fs.writeFileSync(markerFile, version, "utf-8");
+  console.log("-- Wrote Graphite marker file: " + markerFile);
+}