1 /* 2 * Copyright 2012 Google Inc. 3 * 4 * Use of this source code is governed by a BSD-style license that can be 5 * found in the LICENSE file. 6 */ 7 8 #ifndef GrSurface_DEFINED 9 #define GrSurface_DEFINED 10 11 #include "include/core/SkImageInfo.h" 12 #include "include/core/SkRect.h" 13 #include "include/gpu/GrBackendSurface.h" 14 #include "include/gpu/GrGpuResource.h" 15 #include "include/gpu/GrTypes.h" 16 17 class GrRenderTarget; 18 class GrSurfacePriv; 19 class GrTexture; 20 21 class SK_API GrSurface : public GrGpuResource { 22 public: 23 /** 24 * Retrieves the width of the surface. 25 */ width()26 int width() const { return fWidth; } 27 28 /** 29 * Retrieves the height of the surface. 30 */ height()31 int height() const { return fHeight; } 32 33 /** 34 * Helper that gets the width and height of the surface as a bounding rectangle. 35 */ getBoundsRect()36 SkRect getBoundsRect() const { return SkRect::MakeIWH(this->width(), this->height()); } 37 38 /** 39 * Retrieves the pixel config specified when the surface was created. 40 * For render targets this can be kUnknown_GrPixelConfig 41 * if client asked us to render to a target that has a pixel 42 * config that isn't equivalent with one of our configs. 43 */ config()44 GrPixelConfig config() const { return fConfig; } 45 46 virtual GrBackendFormat backendFormat() const = 0; 47 setRelease(sk_sp<GrRefCntedCallback> releaseHelper)48 void setRelease(sk_sp<GrRefCntedCallback> releaseHelper) { 49 this->onSetRelease(releaseHelper); 50 fReleaseHelper = std::move(releaseHelper); 51 } 52 53 // These match the definitions in SkImage, from whence they came. 54 // TODO: Remove Chrome's need to call this on a GrTexture 55 typedef void* ReleaseCtx; 56 typedef void (*ReleaseProc)(ReleaseCtx); setRelease(ReleaseProc proc,ReleaseCtx ctx)57 void setRelease(ReleaseProc proc, ReleaseCtx ctx) { 58 sk_sp<GrRefCntedCallback> helper(new GrRefCntedCallback(proc, ctx)); 59 this->setRelease(std::move(helper)); 60 } 61 62 /** 63 * @return the texture associated with the surface, may be null. 64 */ asTexture()65 virtual GrTexture* asTexture() { return nullptr; } asTexture()66 virtual const GrTexture* asTexture() const { return nullptr; } 67 68 /** 69 * @return the render target underlying this surface, may be null. 70 */ asRenderTarget()71 virtual GrRenderTarget* asRenderTarget() { return nullptr; } asRenderTarget()72 virtual const GrRenderTarget* asRenderTarget() const { return nullptr; } 73 74 /** Access methods that are only to be used within Skia code. */ 75 inline GrSurfacePriv surfacePriv(); 76 inline const GrSurfacePriv surfacePriv() const; 77 78 static size_t WorstCaseSize(const GrSurfaceDesc& desc, GrRenderable renderable, 79 int renderTargetSampleCnt, bool binSize = false); 80 static size_t ComputeSize(GrPixelConfig config, int width, int height, int colorSamplesPerPixel, 81 GrMipMapped, bool binSize = false); 82 83 /** 84 * The pixel values of this surface cannot be modified (e.g. doesn't support write pixels or 85 * MIP map level regen). 86 */ readOnly()87 bool readOnly() const { return fSurfaceFlags & GrInternalSurfaceFlags::kReadOnly; } 88 89 // Returns true if we are working with protected content. isProtected()90 bool isProtected() const { return fIsProtected == GrProtected::kYes; } 91 92 protected: setGLRTFBOIDIs0()93 void setGLRTFBOIDIs0() { 94 SkASSERT(this->asRenderTarget()); 95 fSurfaceFlags |= GrInternalSurfaceFlags::kGLRTFBOIDIs0; 96 } glRTFBOIDis0()97 bool glRTFBOIDis0() const { 98 return fSurfaceFlags & GrInternalSurfaceFlags::kGLRTFBOIDIs0; 99 } 100 setReadOnly()101 void setReadOnly() { 102 SkASSERT(!this->asRenderTarget()); 103 fSurfaceFlags |= GrInternalSurfaceFlags::kReadOnly; 104 } 105 106 // Methods made available via GrSurfacePriv 107 bool hasPendingRead() const; 108 bool hasPendingWrite() const; 109 bool hasPendingIO() const; 110 111 // Provides access to methods that should be public within Skia code. 112 friend class GrSurfacePriv; 113 GrSurface(GrGpu * gpu,const SkISize & size,GrPixelConfig config,GrProtected isProtected)114 GrSurface(GrGpu* gpu, const SkISize& size, GrPixelConfig config, GrProtected isProtected) 115 : INHERITED(gpu) 116 , fConfig(config) 117 , fWidth(size.width()) 118 , fHeight(size.height()) 119 , fSurfaceFlags(GrInternalSurfaceFlags::kNone) 120 , fIsProtected(isProtected) {} 121 ~GrSurface()122 ~GrSurface() override { 123 // check that invokeReleaseProc has been called (if needed) 124 SkASSERT(!fReleaseHelper); 125 } 126 127 void onRelease() override; 128 void onAbandon() override; 129 130 private: getResourceType()131 const char* getResourceType() const override { return "Surface"; } 132 133 // Unmanaged backends (e.g. Vulkan) may want to specially handle the release proc in order to 134 // ensure it isn't called until GPU work related to the resource is completed. onSetRelease(sk_sp<GrRefCntedCallback>)135 virtual void onSetRelease(sk_sp<GrRefCntedCallback>) {} 136 invokeReleaseProc()137 void invokeReleaseProc() { 138 // Depending on the ref count of fReleaseHelper this may or may not actually trigger the 139 // ReleaseProc to be called. 140 fReleaseHelper.reset(); 141 } 142 143 GrPixelConfig fConfig; 144 int fWidth; 145 int fHeight; 146 GrInternalSurfaceFlags fSurfaceFlags; 147 GrProtected fIsProtected; 148 sk_sp<GrRefCntedCallback> fReleaseHelper; 149 150 typedef GrGpuResource INHERITED; 151 }; 152 153 #endif 154