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 "GrTypes.h"
12 #include "GrBackendSurface.h"
13 #include "GrGpuResource.h"
14 #include "SkImageInfo.h"
15 #include "SkRect.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, bool useNextPow2 = false);
79     static size_t ComputeSize(GrPixelConfig config, int width, int height, int colorSamplesPerPixel,
80                               GrMipMapped, bool useNextPow2 = false);
81 
82     /**
83      * The pixel values of this surface cannot be modified (e.g. doesn't support write pixels or
84      * MIP map level regen).
85      */
readOnly()86     bool readOnly() const { return fSurfaceFlags & GrInternalSurfaceFlags::kReadOnly; }
87 
88 protected:
setHasMixedSamples()89     void setHasMixedSamples() {
90         SkASSERT(this->asRenderTarget());
91         fSurfaceFlags |= GrInternalSurfaceFlags::kMixedSampled;
92     }
hasMixedSamples()93     bool hasMixedSamples() const { return fSurfaceFlags & GrInternalSurfaceFlags::kMixedSampled; }
94 
setGLRTFBOIDIs0()95     void setGLRTFBOIDIs0() {
96         SkASSERT(this->asRenderTarget());
97         fSurfaceFlags |= GrInternalSurfaceFlags::kGLRTFBOIDIs0;
98     }
glRTFBOIDis0()99     bool glRTFBOIDis0() const {
100         return fSurfaceFlags & GrInternalSurfaceFlags::kGLRTFBOIDIs0;
101     }
102 
setReadOnly()103     void setReadOnly() {
104         SkASSERT(!this->asRenderTarget());
105         fSurfaceFlags |= GrInternalSurfaceFlags::kReadOnly;
106     }
107 
108     // Methods made available via GrSurfacePriv
109     bool hasPendingRead() const;
110     bool hasPendingWrite() const;
111     bool hasPendingIO() const;
112 
113     // Provides access to methods that should be public within Skia code.
114     friend class GrSurfacePriv;
115 
GrSurface(GrGpu * gpu,const GrSurfaceDesc & desc)116     GrSurface(GrGpu* gpu, const GrSurfaceDesc& desc)
117             : INHERITED(gpu)
118             , fConfig(desc.fConfig)
119             , fWidth(desc.fWidth)
120             , fHeight(desc.fHeight)
121             , fSurfaceFlags(GrInternalSurfaceFlags::kNone) {
122     }
123 
~GrSurface()124     ~GrSurface() override {
125         // check that invokeReleaseProc has been called (if needed)
126         SkASSERT(!fReleaseHelper);
127     }
128 
129     void onRelease() override;
130     void onAbandon() override;
131 
132 private:
getResourceType()133     const char* getResourceType() const override { return "Surface"; }
134 
135     // Unmanaged backends (e.g. Vulkan) may want to specially handle the release proc in order to
136     // ensure it isn't called until GPU work related to the resource is completed.
onSetRelease(sk_sp<GrRefCntedCallback>)137     virtual void onSetRelease(sk_sp<GrRefCntedCallback>) {}
138 
invokeReleaseProc()139     void invokeReleaseProc() {
140         // Depending on the ref count of fReleaseHelper this may or may not actually trigger the
141         // ReleaseProc to be called.
142         fReleaseHelper.reset();
143     }
144 
145     GrPixelConfig              fConfig;
146     int                        fWidth;
147     int                        fHeight;
148     GrInternalSurfaceFlags     fSurfaceFlags;
149     sk_sp<GrRefCntedCallback>  fReleaseHelper;
150 
151     typedef GrGpuResource INHERITED;
152 };
153 
154 #endif
155