skia2/include/private/GrContext_Base.h
Adlai Holler e3ad527e3f Add a convenience to downcast contexts into GrDirectContext
This pattern of needing a safe downcast will continue to grow as we
add more explicit use of GrDirectContext and it's causing long ternary
operations that span multiple lines.

Change-Id: I9e2ebe5156e4245524a52d7c92ed3a8509e53151
Reviewed-on: https://skia-review.googlesource.com/c/skia/+/300901
Commit-Queue: Adlai Holler <adlai@google.com>
Commit-Queue: Robert Phillips <robertphillips@google.com>
Auto-Submit: Adlai Holler <adlai@google.com>
Reviewed-by: Robert Phillips <robertphillips@google.com>
2020-07-07 18:13:50 +00:00

100 lines
3.0 KiB
C++

/*
* 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/GrBackendSurface.h"
#include "include/gpu/GrContextOptions.h"
#include "include/gpu/GrTypes.h"
class GrBaseContextPriv;
class GrCaps;
class GrContextThreadSafeProxy;
class GrDirectContext;
class GrImageContext;
class GrRecordingContext;
class GrContext_Base : public SkRefCnt {
public:
virtual ~GrContext_Base();
/*
* 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 SkSurfaceCharacterization-based createBackendTexture methods.
*
* The caller should check that the returned format is valid.
*/
SK_API GrBackendFormat defaultBackendFormat(SkColorType, GrRenderable) const;
SK_API GrBackendFormat compressedBackendFormat(SkImage::CompressionType) 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;
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->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:
typedef SkRefCnt INHERITED;
};
/**
* Safely cast a base context to direct context.
*/
static inline GrDirectContext* GrAsDirectContext(GrContext_Base* base) {
return base ? base->asDirectContext() : nullptr;
}
#endif