blob: 791ca36e1d157f57ca683893c7aaf7cc2b0ffdb7 [file] [log] [blame]
/*
* Copyright 2012 Google Inc.
*
* Use of this source code is governed by a BSD-style license that can be
* found in the LICENSE file.
*/
#ifndef GrSurface_DEFINED
#define GrSurface_DEFINED
#include "include/core/SkImageInfo.h"
#include "include/core/SkRect.h"
#include "include/gpu/GrBackendSurface.h"
#include "include/gpu/GrGpuResource.h"
#include "include/gpu/GrTypes.h"
class GrRenderTarget;
class GrSurfacePriv;
class GrTexture;
class GrSurface : public GrGpuResource {
public:
/**
* Retrieves the dimensions of the surface.
*/
SkISize dimensions() const { return fDimensions; }
/**
* Retrieves the width of the surface.
*/
int width() const { return fDimensions.width(); }
/**
* Retrieves the height of the surface.
*/
int height() const { return fDimensions.height(); }
/**
* Helper that gets the width and height of the surface as a bounding rectangle.
*/
SkRect getBoundsRect() const { return SkRect::Make(this->dimensions()); }
virtual GrBackendFormat backendFormat() const = 0;
SK_API void setRelease(sk_sp<GrRefCntedCallback> releaseHelper) {
this->onSetRelease(releaseHelper);
fReleaseHelper = std::move(releaseHelper);
}
// These match the definitions in SkImage, from whence they came.
// TODO: Remove Chrome's need to call this on a GrTexture
typedef void* ReleaseCtx;
typedef void (*ReleaseProc)(ReleaseCtx);
SK_API void setRelease(ReleaseProc proc, ReleaseCtx ctx) {
sk_sp<GrRefCntedCallback> helper(new GrRefCntedCallback(proc, ctx));
this->setRelease(std::move(helper));
}
/**
* @return the texture associated with the surface, may be null.
*/
virtual GrTexture* asTexture() { return nullptr; }
virtual const GrTexture* asTexture() const { return nullptr; }
/**
* @return the render target underlying this surface, may be null.
*/
virtual GrRenderTarget* asRenderTarget() { return nullptr; }
virtual const GrRenderTarget* asRenderTarget() const { return nullptr; }
/** Access methods that are only to be used within Skia code. */
inline GrSurfacePriv surfacePriv();
inline const GrSurfacePriv surfacePriv() const;
static size_t ComputeSize(const GrCaps&, const GrBackendFormat&, SkISize dimensions,
int colorSamplesPerPixel, GrMipMapped, bool binSize = false);
/**
* The pixel values of this surface cannot be modified (e.g. doesn't support write pixels or
* MIP map level regen).
*/
bool readOnly() const { return fSurfaceFlags & GrInternalSurfaceFlags::kReadOnly; }
bool framebufferOnly() const {
return fSurfaceFlags & GrInternalSurfaceFlags::kFramebufferOnly;
}
// Returns true if we are working with protected content.
bool isProtected() const { return fIsProtected == GrProtected::kYes; }
void setFramebufferOnly() {
SkASSERT(this->asRenderTarget());
fSurfaceFlags |= GrInternalSurfaceFlags::kFramebufferOnly;
}
protected:
void setGLRTFBOIDIs0() {
SkASSERT(!this->requiresManualMSAAResolve());
SkASSERT(!this->asTexture());
SkASSERT(this->asRenderTarget());
fSurfaceFlags |= GrInternalSurfaceFlags::kGLRTFBOIDIs0;
}
bool glRTFBOIDis0() const {
return fSurfaceFlags & GrInternalSurfaceFlags::kGLRTFBOIDIs0;
}
void setRequiresManualMSAAResolve() {
SkASSERT(!this->glRTFBOIDis0());
SkASSERT(this->asRenderTarget());
fSurfaceFlags |= GrInternalSurfaceFlags::kRequiresManualMSAAResolve;
}
bool requiresManualMSAAResolve() const {
return fSurfaceFlags & GrInternalSurfaceFlags::kRequiresManualMSAAResolve;
}
void setReadOnly() {
SkASSERT(!this->asRenderTarget());
fSurfaceFlags |= GrInternalSurfaceFlags::kReadOnly;
}
// Provides access to methods that should be public within Skia code.
friend class GrSurfacePriv;
GrSurface(GrGpu* gpu, const SkISize& dimensions, GrProtected isProtected)
: INHERITED(gpu)
, fDimensions(dimensions)
, fSurfaceFlags(GrInternalSurfaceFlags::kNone)
, fIsProtected(isProtected) {}
~GrSurface() override {
// check that invokeReleaseProc has been called (if needed)
SkASSERT(!fReleaseHelper);
}
void onRelease() override;
void onAbandon() override;
private:
const char* getResourceType() const override { return "Surface"; }
// Unmanaged backends (e.g. Vulkan) may want to specially handle the release proc in order to
// ensure it isn't called until GPU work related to the resource is completed.
virtual void onSetRelease(sk_sp<GrRefCntedCallback>) {}
void invokeReleaseProc() {
// Depending on the ref count of fReleaseHelper this may or may not actually trigger the
// ReleaseProc to be called.
fReleaseHelper.reset();
}
SkISize fDimensions;
GrInternalSurfaceFlags fSurfaceFlags;
GrProtected fIsProtected;
sk_sp<GrRefCntedCallback> fReleaseHelper;
typedef GrGpuResource INHERITED;
};
#endif