include/core/SkRecorder.h

/*
 * Copyright 2025 Google LLC
 *
 * Use of this source code is governed by a BSD-style license that can be
 * found in the LICENSE file.
 */
#ifndef SkRecorder_DEFINED
#define SkRecorder_DEFINED

#include "include/core/SkPicture.h"
#include "include/private/SkAPI.h"
#include "include/private/SkTArray.h"

class SkCanvas;
class SkSurface;

namespace skcpu {
class Recorder;
}

class SK_API SkRecorder {
public:
    SkRecorder() = default;
    virtual ~SkRecorder() = default;
    SkRecorder(const SkRecorder&) = delete;
    SkRecorder(SkRecorder&&) = delete;
    SkRecorder& operator=(const SkRecorder&) = delete;

    enum class Type {
        kCPU,
        kGanesh,
        kGraphite,
    };

    virtual Type type() const = 0;

    /** Returns a non-null global CPU recorder. Can be used as a means of transitioning onto
     *  new APIs when a Context/Recorder has not been piped down into the code paths.
     */
    static SkRecorder* TODO();

    virtual skcpu::Recorder* cpuRecorder() = 0;

protected:
    skia_private::TArray<sk_sp<SkPicture>> fCapturedPictures;

private:

    /**
    * Attempts to create and return an SkCaptureCanvas that wraps the provided base canvas.
    * Returns nullptr if capture is not enabled.
    *
    * TODO: When implementing in all Recorder subclasses, see if the implementations can be shared
    * and moved here.
    */
    virtual SkCanvas* makeCaptureCanvas(SkCanvas*) = 0;
    virtual void createCaptureBreakpoint(SkSurface*) = 0;
    virtual void deregisterCaptureCanvas(SkCanvas*) = 0;

    friend class SkSurface_Base; // for capture functionality
};

#endif