@pompadour/react-native-skia 1.0.0

package/cpp/skia/include/gpu/graphite/Image.h

@@ -0,0 +1,352 @@
+/*
+ * Copyright 2023 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_Image_DEFINED
+#define skgpu_graphite_Image_DEFINED
+
+#include "include/core/SkColorSpace.h"
+#include "include/core/SkImage.h"
+#include "include/core/SkRefCnt.h"
+#include "include/core/SkSpan.h"
+#include "include/gpu/GpuTypes.h"
+
+class SkYUVAInfo;
+class SkYUVAPixmaps;
+struct SkIRect;
+
+namespace skgpu::graphite {
+    class BackendTexture;
+    class Recorder;
+    class TextureInfo;
+    class YUVABackendTextureInfo;
+    class YUVABackendTextures;
+    enum class Volatile : bool;
+}
+
+namespace SkImages {
+using TextureReleaseProc = void (*)(ReleaseContext);
+
+// Passed to both non-YUVA fulfill and imageRelease
+using GraphitePromiseImageContext = void*;
+// Passed to YUVA fulfill
+using GraphitePromiseTextureContext = void*;
+// Returned from fulfill and passed into textureRelease
+using GraphitePromiseTextureReleaseContext = void*;
+
+using GraphitePromiseImageFulfillProc =
+        std::tuple<skgpu::graphite::BackendTexture, GraphitePromiseTextureReleaseContext> (*)(
+                GraphitePromiseImageContext);
+using GraphitePromiseImageYUVAFulfillProc =
+        std::tuple<skgpu::graphite::BackendTexture, GraphitePromiseTextureReleaseContext> (*)(
+                GraphitePromiseTextureContext);
+using GraphitePromiseImageReleaseProc = void (*)(GraphitePromiseImageContext);
+using GraphitePromiseTextureReleaseProc = void (*)(GraphitePromiseTextureReleaseContext);
+
+/** Creates an SkImage from a GPU texture associated with the recorder. The client is still
+    responsible for managing the backend texture's lifetime.
+
+    SkImage is returned if the format of backendTexture is recognized and supported.
+    Recognized formats vary by GPU back-end.
+
+    @param recorder            The recorder
+    @param backendTexture      texture residing on GPU
+    @param colorSpace          This describes the color space of this image's contents, as
+                               seen after sampling. In general, if the format of the backend
+                               texture is SRGB, some linear colorSpace should be supplied
+                               (e.g., SkColorSpace::MakeSRGBLinear()). If the format of the
+                               backend texture is linear, then the colorSpace should include
+                               a description of the transfer function as
+                               well (e.g., SkColorSpace::MakeSRGB()).
+    @param origin              Whether the Texture logically treats the origin as TopLeft or
+                               BottomLeft
+    @return                    created SkImage, or nullptr
+*/
+SK_API sk_sp<SkImage> WrapTexture(skgpu::graphite::Recorder*,
+                                  const skgpu::graphite::BackendTexture&,
+                                  SkColorType colorType,
+                                  SkAlphaType alphaType,
+                                  sk_sp<SkColorSpace> colorSpace,
+                                  skgpu::Origin origin,
+                                  TextureReleaseProc = nullptr,
+                                  ReleaseContext = nullptr);
+
+SK_API sk_sp<SkImage> WrapTexture(skgpu::graphite::Recorder*,
+                                  const skgpu::graphite::BackendTexture&,
+                                  SkColorType colorType,
+                                  SkAlphaType alphaType,
+                                  sk_sp<SkColorSpace> colorSpace,
+                                  TextureReleaseProc = nullptr,
+                                  ReleaseContext = nullptr);
+
+#if !defined(SK_DISABLE_LEGACY_GRAPHITE_IMAGES)
+inline sk_sp<SkImage> AdoptTextureFrom(skgpu::graphite::Recorder* recorder,
+                                       const skgpu::graphite::BackendTexture& tex,
+                                       SkColorType colorType,
+                                       SkAlphaType alphaType,
+                                       sk_sp<SkColorSpace> colorSpace,
+                                       skgpu::Origin origin,
+                                       TextureReleaseProc trProc = nullptr,
+                                       ReleaseContext ctx = nullptr) {
+    return WrapTexture(recorder, tex, colorType, alphaType, colorSpace, origin, trProc, ctx);
+}
+
+inline sk_sp<SkImage> AdoptTextureFrom(skgpu::graphite::Recorder* recorder,
+                                       const skgpu::graphite::BackendTexture& tex,
+                                       SkColorType colorType,
+                                       SkAlphaType alphaType,
+                                       sk_sp<SkColorSpace> colorSpace,
+                                       TextureReleaseProc trProc = nullptr,
+                                       ReleaseContext ctx = nullptr) {
+    return WrapTexture(recorder, tex, colorType, alphaType, colorSpace, trProc, ctx);
+}
+#endif
+
+/** Create a new SkImage that is very similar to an SkImage created by WrapTexture. The difference
+    is that the caller need not have created the backend texture nor populated it with data when
+    creating the image. Instead of passing a BackendTexture to the factory the client supplies a
+    description of the texture consisting of dimensions, TextureInfo, SkColorInfo and Volatility.
+
+    In general, 'fulfill' must return a BackendTexture that matches the properties provided at
+    SkImage creation time. The BackendTexture must refer to a valid existing texture in the backend
+    API context/device, and already be populated with data. The texture cannot be deleted until
+    'textureRelease' is called. 'textureRelease' will be called with the textureReleaseContext
+    returned by 'fulfill'.
+
+    Wrt when and how often the fulfill, imageRelease, and textureRelease callbacks will be called:
+
+    For non-volatile promise images, 'fulfill' will be called at Context::insertRecording time.
+    Regardless of whether 'fulfill' succeeded or failed, 'imageRelease' will always be called only
+    once - when Skia will no longer try calling 'fulfill' to get a backend texture. If 'fulfill'
+    failed (i.e., it didn't return a valid backend texture) then 'textureRelease' will never be
+    called. If 'fulfill' was successful then 'textureRelease' will be called only once when the GPU
+    is done with the contents of the promise image. This will usually occur during a Context::submit
+    call but it could occur earlier due to error conditions. 'fulfill' can be called multiple times
+    if the promise image is used in multiple recordings. If 'fulfill' fails, the insertRecording
+    itself will fail. Subsequent insertRecording calls (with Recordings that use the promise image)
+    will keep calling 'fulfill' until it succeeds.
+
+    For volatile promise images, 'fulfill' will be called each time the Recording is inserted into a
+    Context. Regardless of whether 'fulfill' succeeded or failed, 'imageRelease' will always be
+    called only once just like the non-volatile case. If 'fulfill' fails at insertRecording-time,
+    'textureRelease' will never be called. If 'fulfill' was successful then a 'textureRelease'
+    matching that 'fulfill' will be called when the GPU is done with the contents of the promise
+    image. This will usually occur during a Context::submit call but it could occur earlier due to
+    error conditions.
+
+    @param recorder       the recorder that will capture the commands creating the image
+    @param dimensions     width & height of promised gpu texture
+    @param textureInfo    structural information for the promised gpu texture
+    @param colorInfo      color type, alpha type and colorSpace information for the image
+    @param origin         Whether the Texture logically treats the origin as TopLeft or BottomLeft
+    @param isVolatile     volatility of the promise image
+    @param fulfill        function called to get the actual backend texture,
+                          and the instance for the GraphitePromiseTextureReleaseProc
+    @param imageRelease   function called when any image-centric data can be deleted
+    @param textureRelease function called when the backend texture can be deleted
+    @param imageContext   state passed to fulfill and imageRelease
+    @return               created SkImage, or nullptr
+*/
+SK_API sk_sp<SkImage> PromiseTextureFrom(skgpu::graphite::Recorder*,
+                                         SkISize dimensions,
+                                         const skgpu::graphite::TextureInfo&,
+                                         const SkColorInfo&,
+                                         skgpu::Origin origin,
+                                         skgpu::graphite::Volatile,
+                                         GraphitePromiseImageFulfillProc,
+                                         GraphitePromiseImageReleaseProc,
+                                         GraphitePromiseTextureReleaseProc,
+                                         GraphitePromiseImageContext);
+
+SK_API sk_sp<SkImage> PromiseTextureFrom(skgpu::graphite::Recorder*,
+                                         SkISize dimensions,
+                                         const skgpu::graphite::TextureInfo&,
+                                         const SkColorInfo&,
+                                         skgpu::graphite::Volatile,
+                                         GraphitePromiseImageFulfillProc,
+                                         GraphitePromiseImageReleaseProc,
+                                         GraphitePromiseTextureReleaseProc,
+                                         GraphitePromiseImageContext);
+
+/** This is similar to 'PromiseTextureFrom' but it creates a GPU-backed SkImage from YUV[A] data.
+    The source data may be planar (i.e. spread across multiple textures). In the extreme Y, U, V,
+    and A are all in different planes and thus the image is specified by four textures.
+    'backendTextureInfo' describes the planar arrangement, texture formats, and conversion to RGB.
+    Separate 'fulfill' and 'textureRelease' calls are made for each texture. Each texture has its
+    own GraphitePromiseTextureContext. The GraphitePromiseImageReleaseProc will be made even on
+    failure. 'textureContexts' has one entry for each of the up to four textures, as indicated by
+    'backendTextureInfo'. Currently the mipmapped property of 'backendTextureInfo' is ignored.
+    However, in the near future it will be required that if it is kYes then the fulfillProc must
+    return a mip mapped texture for each plane in order to successfully draw the image.
+
+    @param recorder            the recorder that will capture the commands creating the image
+    @param backendTextureInfo  info about the promised yuva gpu texture(s)
+    @param imageColorSpace     range of colors; may be nullptr
+    @param isVolatile          volatility of the promise image
+    @param fulfill             function called to get the actual backend texture for
+                               a given GraphitePromiseTextureContext, and the instance
+                               for the GraphitePromiseTextureReleaseProc
+    @param imageRelease        function called when any image-centric data can be deleted
+    @param textureRelease      function called when the backend texture can be deleted
+    @param imageContext        state passed to imageRelease
+    @param textureContexts     states passed to fulfill and textureRelease
+    @return                    created SkImage, or nullptr
+*/
+SK_API sk_sp<SkImage> PromiseTextureFromYUVA(skgpu::graphite::Recorder*,
+                                             const skgpu::graphite::YUVABackendTextureInfo&,
+                                             sk_sp<SkColorSpace> imageColorSpace,
+                                             skgpu::graphite::Volatile,
+                                             GraphitePromiseImageYUVAFulfillProc,
+                                             GraphitePromiseImageReleaseProc,
+                                             GraphitePromiseTextureReleaseProc,
+                                             GraphitePromiseImageContext imageContext,
+                                             GraphitePromiseTextureContext textureContexts[]);
+
+
+/** Returns an SkImage backed by a Graphite texture, using the provided Recorder for creation and
+    uploads if necessary. The returned SkImage respects the required image properties' mipmap
+    setting for non-Graphite SkImages; i.e., if mipmapping is required, the backing Graphite texture
+    will have allocated mip map levels.
+
+    It is assumed that MIP maps are always supported by the GPU.
+
+    Returns original SkImage if the image is already Graphite-backed and the required mipmapping is
+    compatible with the backing Graphite texture. If the required mipmapping is not compatible,
+    nullptr will be returned.
+
+    Returns nullptr if no Recorder is provided, or if SkImage was created with another Recorder and
+    work on that Recorder has not been submitted.
+
+    @param Recorder            the Recorder to use for storing commands
+    @param RequiredProperties  properties the returned SkImage must possess (e.g. mipmaps)
+    @return                    created SkImage, or nullptr
+*/
+SK_API sk_sp<SkImage> TextureFromImage(skgpu::graphite::Recorder*,
+                                       const SkImage*,
+                                       SkImage::RequiredProperties = {});
+
+inline sk_sp<SkImage> TextureFromImage(skgpu::graphite::Recorder* r,
+                                       const sk_sp<const SkImage>& img,
+                                       SkImage::RequiredProperties props = {}) {
+    return TextureFromImage(r, img.get(), props);
+}
+
+/** Creates SkImage from SkYUVAPixmaps.
+
+    The image will remain planar with each plane converted to a texture using the passed Recorder.
+
+    SkYUVAPixmaps has a SkYUVAInfo which specifies the transformation from YUV to RGB. The
+    SkColorSpace of the resulting RGB values is specified by imgColorSpace. This will be the
+    SkColorSpace reported by the image and when drawn the RGB values will be converted from this
+    space into the destination space (if the destination is tagged).
+
+    This is only supported using the GPU backend and will fail if recorder is nullptr.
+
+    SkYUVAPixmaps does not need to remain valid after this returns.
+
+    @param Recorder                 The Recorder to use for storing commands
+    @param pixmaps                  The planes as pixmaps with supported SkYUVAInfo that
+                                    specifies conversion to RGB.
+    @param RequiredProperties       Properties the returned SkImage must possess (e.g. mipmaps)
+    @param limitToMaxTextureSize    Downscale image to GPU maximum texture size, if necessary
+    @param imgColorSpace            Range of colors of the resulting image; may be nullptr
+    @return                         Created SkImage, or nullptr
+*/
+SK_API sk_sp<SkImage> TextureFromYUVAPixmaps(skgpu::graphite::Recorder*,
+                                             const SkYUVAPixmaps& pixmaps,
+                                             SkImage::RequiredProperties = {},
+                                             bool limitToMaxTextureSize = false,
+                                             sk_sp<SkColorSpace> imgColorSpace = nullptr);
+
+/** Creates an SkImage from YUV[A] planar textures associated with the recorder.
+     @param recorder            The recorder.
+     @param yuvaBackendTextures A set of textures containing YUVA data and a description of the
+                                data and transformation to RGBA.
+     @param imageColorSpace     range of colors of the resulting image after conversion to RGB;
+                                may be nullptr
+     @param TextureReleaseProc  called when the backend textures can be released
+     @param ReleaseContext      state passed to TextureReleaseProc
+     @return                    created SkImage, or nullptr
+ */
+SK_API sk_sp<SkImage> TextureFromYUVATextures(
+        skgpu::graphite::Recorder* recorder,
+        const skgpu::graphite::YUVABackendTextures& yuvaBackendTextures,
+        sk_sp<SkColorSpace> imageColorSpace,
+        TextureReleaseProc = nullptr,
+        ReleaseContext = nullptr);
+
+/** Creates an SkImage from YUV[A] planar SkImages associated with the recorder.
+
+    The images should have kGraphite type, and the result will be nullptr if any are not. The
+    resulting SkImage will not take a ref on the given SkImages but will take a ref on the
+    underlying TextureProxies. The releaseProcs, if any, for those Textures will be the ones set
+    when the given SkImages were created.
+
+     @param recorder            The recorder.
+     @param yuvaInfo            Structure describing the YUVA format
+     @param images              A set of SkImages containing YUVA data
+     @param imageColorSpace     Range of colors of the resulting image after conversion to RGB;
+                                may be nullptr
+     @return                    created SkImage, or nullptr
+ */
+SK_API sk_sp<SkImage> TextureFromYUVAImages(
+        skgpu::graphite::Recorder* recorder,
+        const SkYUVAInfo& yuvaInfo,
+        SkSpan<const sk_sp<SkImage>> images,
+        sk_sp<SkColorSpace> imageColorSpace);
+
+/** Returns subset of this image as a texture-backed image.
+
+    Returns nullptr if any of the following are true:
+      - Subset is empty
+      - Subset is not contained inside the image's bounds
+      - Pixels in the source image could not be read or copied
+      - The source image is texture-backed and context does not match the source image's context.
+
+    @param recorder the non-null recorder in which to create the new image.
+    @param img     Source image
+    @param subset  bounds of returned SkImage
+    @param props   properties the returned SkImage must possess (e.g. mipmaps)
+    @return        the subsetted image, uploaded as a texture, or nullptr
+*/
+SK_API sk_sp<SkImage> SubsetTextureFrom(skgpu::graphite::Recorder* recorder,
+                                        const SkImage* img,
+                                        const SkIRect& subset,
+                                        SkImage::RequiredProperties props = {});
+
+/** Creates a filtered SkImage on the GPU. filter processes the src image, potentially changing
+    color, position, and size. subset is the bounds of src that are processed by filter. clipBounds
+    is the expected bounds of the filtered SkImage. outSubset is required storage for the actual
+    bounds of the filtered SkImage. offset is required storage for translation of returned SkImage.
+
+    Returns nullptr if SkImage could not be created. If nullptr is returned, outSubset and offset
+    are undefined.
+
+    Useful for animation of SkImageFilter that varies size from frame to frame. Returned SkImage is
+    created larger than required by filter so that GPU texture can be reused with different sized
+    effects. outSubset describes the valid bounds of GPU texture returned. offset translates the
+    returned SkImage to keep subsequent animation frames aligned with respect to each other.
+
+    @param recorder    the recorder in which the filtering operation is to be performed
+    @param filter      how SkImage is sampled when transformed
+    @param subset      bounds of SkImage processed by filter
+    @param clipBounds  expected bounds of filtered SkImage
+    @param outSubset   storage for returned SkImage bounds
+    @param offset      storage for returned SkImage translation
+    @return            filtered SkImage, or nullptr
+*/
+SK_API sk_sp<SkImage> MakeWithFilter(skgpu::graphite::Recorder* recorder,
+                                     sk_sp<SkImage> src,
+                                     const SkImageFilter* filter,
+                                     const SkIRect& subset,
+                                     const SkIRect& clipBounds,
+                                     SkIRect* outSubset,
+                                     SkIPoint* offset);
+
+} // namespace SkImages
+
+
+#endif // skgpu_graphite_Image_DEFINED

package/cpp/skia/include/gpu/graphite/ImageProvider.h

@@ -0,0 +1,68 @@
+/*
+ * 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_ImageProvider_DEFINED
+#define skgpu_graphite_ImageProvider_DEFINED
+
+#include "include/core/SkImage.h"
+#include "include/core/SkRefCnt.h"
+
+namespace skgpu::graphite {
+
+class Recorder;
+
+/*
+ * This class provides a centralized location for clients to perform any caching of images
+ * they desire. Whenever Graphite encounters an SkImage which is not Graphite-backed
+ * it will call ImageProvider::findOrCreate. The client's derived version of this class should
+ * return a Graphite-backed version of the provided SkImage that meets the specified
+ * requirements.
+ *
+ * Skia requires that 'findOrCreate' return a Graphite-backed image that preserves the
+ * dimensions and alpha type of the original image. The bit depth of the
+ * individual channels can change (e.g., 4444 -> 8888 is allowed) as well as the channels - as
+ * long as the returned image has a superset of the original image's channels
+ * (e.g., 565 -> 8888 opaque is allowed).
+ *
+ * Wrt mipmapping, the returned image can have different mipmap settings than requested. If
+ * mipmapping was requested but not returned, the sampling level will be reduced to linear.
+ * If the requirements are not met by the returned image (modulo the flexibility wrt mipmapping)
+ * Graphite will drop the draw.
+ *
+ * All returned images must be backed by textures that have a TopLeft origin. If Skia is used to
+ * create the texture (e.g. using makeTextureImage) then this is always guaranteed. If the client
+ * returns a texture they created themselves and wrapped in Skia, they must ensure that texture has
+ * a TopLeft origin.
+ *
+ * Note: by default, Graphite will not perform any caching of images
+ *
+ * Threading concerns:
+ *   If the same ImageProvider is given to multiple Recorders it is up to the
+ *   client to handle any required thread synchronization. This is not limited to just
+ *   restricting access to whatever map a derived class may have but extends to ensuring
+ *   that an image created on one Recorder has had its creation work submitted before it
+ *   is used by any work submitted by another Recording. Please note, this requirement
+ *   (re the submission of creation work and image usage on different threads) is common to all
+ *   graphite SkImages and isn't unique to SkImages returned by the ImageProvider.
+ *
+ * TODO(b/240996632): add documentation re shutdown order.
+ * TODO(b/240997067): add unit tests
+ */
+class SK_API ImageProvider : public SkRefCnt {
+public:
+    // If the client's derived class already has a Graphite-backed image that has the same
+    // contents as 'image' and meets the requirements, then it can be returned.
+    // makeTextureImage can always be called to create an acceptable Graphite-backed image
+    // which could then be cached.
+    virtual sk_sp<SkImage> findOrCreate(Recorder* recorder,
+                                        const SkImage* image,
+                                        SkImage::RequiredProperties) = 0;
+};
+
+} // namespace skgpu::graphite
+
+#endif // skgpu_graphite_ImageProvider_DEFINED

package/cpp/skia/include/gpu/graphite/Recorder.h

@@ -0,0 +1,251 @@
+/*
+ * 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_Recorder_DEFINED
+#define skgpu_graphite_Recorder_DEFINED
+
+#include "include/core/SkRefCnt.h"
+#include "include/core/SkSize.h"
+#include "include/gpu/graphite/GraphiteTypes.h"
+#include "include/gpu/graphite/Recording.h"
+#include "include/private/base/SingleOwner.h"
+#include "include/private/base/SkTArray.h"
+
+#include <chrono>
+#include <vector>
+
+struct AHardwareBuffer;
+class SkCanvas;
+struct SkImageInfo;
+class SkPixmap;
+class SkTraceMemoryDump;
+
+namespace skgpu {
+class RefCntedCallback;
+class TokenTracker;
+}
+
+namespace sktext::gpu {
+class StrikeCache;
+class TextBlobRedrawCoordinator;
+}
+
+namespace skgpu::graphite {
+
+class AtlasProvider;
+class BackendTexture;
+class Caps;
+class Context;
+class Device;
+class DrawBufferManager;
+class GlobalCache;
+class ImageProvider;
+class ProxyCache;
+class RecorderPriv;
+class ResourceProvider;
+class RuntimeEffectDictionary;
+class SharedContext;
+class Task;
+class TaskGraph;
+class TextureDataBlock;
+class TextureInfo;
+class UniformDataBlock;
+class UploadBufferManager;
+
+template<typename T> class PipelineDataCache;
+using UniformDataCache = PipelineDataCache<UniformDataBlock>;
+using TextureDataCache = PipelineDataCache<TextureDataBlock>;
+
+struct SK_API RecorderOptions final {
+    RecorderOptions();
+    RecorderOptions(const RecorderOptions&);
+    ~RecorderOptions();
+
+    sk_sp<ImageProvider> fImageProvider;
+
+    static constexpr size_t kDefaultRecorderBudget = 256 * (1 << 20);
+    // What is the budget for GPU resources allocated and held by this Recorder.
+    size_t fGpuBudgetInBytes = kDefaultRecorderBudget;
+};
+
+class SK_API Recorder final {
+public:
+    Recorder(const Recorder&) = delete;
+    Recorder(Recorder&&) = delete;
+    Recorder& operator=(const Recorder&) = delete;
+    Recorder& operator=(Recorder&&) = delete;
+
+    ~Recorder();
+
+    BackendApi backend() const;
+
+    std::unique_ptr<Recording> snap();
+
+    ImageProvider* clientImageProvider() { return fClientImageProvider.get(); }
+    const ImageProvider* clientImageProvider() const { return fClientImageProvider.get(); }
+
+    /**
+     * Creates a new backend gpu texture matching the dimensions and TextureInfo. If an invalid
+     * TextureInfo or a TextureInfo Skia can't support is passed in, this will return an invalid
+     * BackendTexture. Thus the client should check isValid on the returned BackendTexture to know
+     * if it succeeded or not.
+     *
+     * If this does return a valid BackendTexture, the caller is required to use
+     * Recorder::deleteBackendTexture or Context::deleteBackendTexture to delete the texture. It is
+     * safe to use the Context that created this Recorder or any other Recorder created from the
+     * same Context to call deleteBackendTexture.
+     */
+    BackendTexture createBackendTexture(SkISize dimensions, const TextureInfo&);
+
+#ifdef SK_BUILD_FOR_ANDROID
+    BackendTexture createBackendTexture(AHardwareBuffer*,
+                                        bool isRenderable,
+                                        bool isProtectedContent,
+                                        SkISize dimensions,
+                                        bool fromAndroidWindow = false) const;
+#endif
+
+    /**
+     * If possible, updates a backend texture with the provided pixmap data. The client
+     * should check the return value to see if the update was successful. The client is required
+     * to insert a Recording into the Context and call `submit` to send the upload work to the gpu.
+     * The backend texture must be compatible with the provided pixmap(s). Compatible, in this case,
+     * means that the backend format is compatible with the base pixmap's colortype. The src data
+     * can be deleted when this call returns.
+     * If the backend texture is mip mapped, the data for all the mipmap levels must be provided.
+     * In the mipmapped case all the colortypes of the provided pixmaps must be the same.
+     * Additionally, all the miplevels must be sized correctly (please see
+     * SkMipmap::ComputeLevelSize and ComputeLevelCount).
+     * Note: the pixmap's alphatypes and colorspaces are ignored.
+     * For the Vulkan backend after a successful update the layout of the created VkImage will be:
+     *      VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL
+     */
+    bool updateBackendTexture(const BackendTexture&,
+                              const SkPixmap srcData[],
+                              int numLevels);
+
+    /**
+     * Called to delete the passed in BackendTexture. This should only be called if the
+     * BackendTexture was created by calling Recorder::createBackendTexture on a Recorder that is
+     * associated with the same Context. If the BackendTexture is not valid or does not match the
+     * BackendApi of the Recorder then nothing happens.
+     *
+     * Otherwise this will delete/release the backend object that is wrapped in the BackendTexture.
+     * The BackendTexture will be reset to an invalid state and should not be used again.
+     */
+    void deleteBackendTexture(const BackendTexture&);
+
+    // Adds a proc that will be moved to the Recording upon snap, subsequently attached to the
+    // CommandBuffer when the Recording is added, and called when that CommandBuffer is submitted
+    // and finishes. If the Recorder or Recording is deleted before the proc is added to the
+    // CommandBuffer, it will be called with result Failure.
+    void addFinishInfo(const InsertFinishInfo&);
+
+    // Returns a canvas that will record to a proxy surface, which must be instantiated on replay.
+    // This can only be called once per Recording; subsequent calls will return null until a
+    // Recording is snapped. Additionally, the returned SkCanvas is only valid until the next
+    // Recording snap, at which point it is deleted.
+    SkCanvas* makeDeferredCanvas(const SkImageInfo&, const TextureInfo&);
+
+    /**
+     * Frees GPU resources created and held by the Recorder. Can be called to reduce GPU memory
+     * pressure. Any resources that are still in use (e.g. being used by work submitted to the GPU)
+     * will not be deleted by this call. If the caller wants to make sure all resources are freed,
+     * then they should first make sure to submit and wait on any outstanding work.
+     */
+    void freeGpuResources();
+
+    /**
+     * Purge GPU resources on the Recorder that haven't been used in the past 'msNotUsed'
+     * milliseconds or are otherwise marked for deletion, regardless of whether the context is under
+     * budget.
+     */
+    void performDeferredCleanup(std::chrono::milliseconds msNotUsed);
+
+    /**
+     * Returns the number of bytes of gpu memory currently budgeted in the Recorder's cache.
+     */
+    size_t currentBudgetedBytes() const;
+
+    /**
+     * Enumerates all cached GPU resources owned by the Recorder and dumps their memory to
+     * traceMemoryDump.
+     */
+    void dumpMemoryStatistics(SkTraceMemoryDump* traceMemoryDump) const;
+
+    // Provides access to functions that aren't part of the public API.
+    RecorderPriv priv();
+    const RecorderPriv priv() const;  // NOLINT(readability-const-return-type)
+
+private:
+    friend class Context; // For ctor
+    friend class Device; // For registering and deregistering Devices;
+    friend class RecorderPriv; // for ctor and hidden methods
+
+    Recorder(sk_sp<SharedContext>, const RecorderOptions&);
+
+    SingleOwner* singleOwner() const { return &fSingleOwner; }
+
+    // We keep track of all Devices that are connected to a Recorder. This allows the client to
+    // safely delete an SkSurface or a Recorder in any order. If the client deletes the Recorder
+    // we need to notify all Devices that the Recorder is no longer valid. If we delete the
+    // SkSurface/Device first we will flush all the Device's into the Recorder before deregistering
+    // it from the Recorder.
+    //
+    // We do not need to take a ref on the Device since the Device will flush and deregister itself
+    // in its dtor. There is no other need for the Recorder to know about the Device after this
+    // point.
+    //
+    // Note: We could probably get by with only registering Devices directly connected to
+    // SkSurfaces. All other one off Devices will be created in a controlled scope where the
+    // Recorder should still be valid by the time they need to flush their work when the Device is
+    // deleted. We would have to make sure we safely handle cases where a client calls saveLayer
+    // then either deletes the SkSurface or Recorder before calling restore. For simplicity we just
+    // register every device for now, but if we see extra overhead in pushing back the extra
+    // pointers, we can look into only registering SkSurface Devices.
+    void registerDevice(Device*);
+    void deregisterDevice(const Device*);
+
+    sk_sp<SharedContext> fSharedContext;
+    std::unique_ptr<ResourceProvider> fResourceProvider;
+    std::unique_ptr<RuntimeEffectDictionary> fRuntimeEffectDict;
+
+    std::unique_ptr<TaskGraph> fGraph;
+    std::unique_ptr<UniformDataCache> fUniformDataCache;
+    std::unique_ptr<TextureDataCache> fTextureDataCache;
+    std::unique_ptr<DrawBufferManager> fDrawBufferManager;
+    std::unique_ptr<UploadBufferManager> fUploadBufferManager;
+    std::vector<Device*> fTrackedDevices;
+
+    uint32_t fUniqueID;  // Needed for MessageBox handling for text
+    uint32_t fNextRecordingID = 1;
+    std::unique_ptr<AtlasProvider> fAtlasProvider;
+    std::unique_ptr<TokenTracker> fTokenTracker;
+    std::unique_ptr<sktext::gpu::StrikeCache> fStrikeCache;
+    std::unique_ptr<sktext::gpu::TextBlobRedrawCoordinator> fTextBlobCache;
+    sk_sp<ImageProvider> fClientImageProvider;
+
+    // In debug builds we guard against improper thread handling
+    // This guard is passed to the ResourceCache.
+    // TODO: Should we also pass this to Device, DrawContext, and similar classes?
+    mutable SingleOwner fSingleOwner;
+
+    sk_sp<Device> fTargetProxyDevice;
+    std::unique_ptr<SkCanvas> fTargetProxyCanvas;
+    std::unique_ptr<Recording::LazyProxyData> fTargetProxyData;
+
+    skia_private::TArray<sk_sp<RefCntedCallback>> fFinishedProcs;
+
+#if defined(GRAPHITE_TEST_UTILS)
+    // For testing use only -- the Context used to create this Recorder
+    Context* fContext = nullptr;
+#endif
+};
+
+} // namespace skgpu::graphite
+
+#endif // skgpu_graphite_Recorder_DEFINED