/*

 * Copyright 2019 Google Inc.

 *

 * Use of this source code is governed by a BSD-style license that can be

 * found in the LICENSE file.

 */

#ifndef GrContext_Base_DEFINED

#define GrContext_Base_DEFINED

#include "include/core/SkRefCnt.h"

#include "include/gpu/GrTypes.h"

#include "include/private/base/SkAPI.h"

#include <cstdint>

class GrBaseContextPriv;

class GrCaps;

class GrContextThreadSafeProxy;

class GrDirectContext;

class GrImageContext;

class GrRecordingContext;

enum SkColorType : int;

enum class SkTextureCompressionType;

struct GrContextOptions;

class GrBackendFormat;

class GrContext_Base : public SkRefCnt {

public:

    ~GrContext_Base() override;

    /*

     * Safely downcast to a GrDirectContext.

     */

    virtual GrDirectContext* asDirectContext() { return nullptr; }

    /*

     * The 3D API backing this context

     */

    SK_API GrBackendApi backend() const;

    /*

     * Retrieve the default GrBackendFormat for a given SkColorType and renderability.

     * It is guaranteed that this backend format will be the one used by the GrContext

     * SkColorType and GrSurfaceCharacterization-based createBackendTexture methods.

     *

     * The caller should check that the returned format is valid.

     */

    SK_API GrBackendFormat defaultBackendFormat(SkColorType, GrRenderable) const;

    SK_API GrBackendFormat compressedBackendFormat(SkTextureCompressionType) const;

    /**

     * Gets the maximum supported sample count for a color type. 1 is returned if only non-MSAA

     * rendering is supported for the color type. 0 is returned if rendering to this color type

     * is not supported at all.

     */

    SK_API int maxSurfaceSampleCountForColorType(SkColorType colorType) const;

    // TODO: When the public version is gone, rename to refThreadSafeProxy and add raw ptr ver.

    sk_sp<GrContextThreadSafeProxy> threadSafeProxy();

    // Provides access to functions that aren't part of the public API.

    GrBaseContextPriv priv();

    const GrBaseContextPriv priv() const;  // NOLINT(readability-const-return-type)

protected:

    friend class GrBaseContextPriv; // for hidden functions

    GrContext_Base(sk_sp<GrContextThreadSafeProxy>);

    virtual bool init();

    /**

     * An identifier for this context. The id is used by all compatible contexts. For example,

     * if SkImages are created on one thread using an image creation context, then fed into a

     * DDL Recorder on second thread (which has a recording context) and finally replayed on

     * a third thread with a direct context, then all three contexts will report the same id.

     * It is an error for an image to be used with contexts that report different ids.

     */

    uint32_t contextID() const;

    bool matches(GrContext_Base* candidate) const {

        return candidate && candidate->contextID() == this->contextID();

    }

    /*

     * The options in effect for this context

     */

    const GrContextOptions& options() const;

    const GrCaps* caps() const;

    sk_sp<const GrCaps> refCaps() const;

    virtual GrImageContext* asImageContext() { return nullptr; }

    virtual GrRecordingContext* asRecordingContext() { return nullptr; }

    sk_sp<GrContextThreadSafeProxy>         fThreadSafeProxy;

private:

    using INHERITED = SkRefCnt;

};

#endif