Robert Phillips | 1afd4cd | 2018-01-08 13:40:32 -0500 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2018 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 GrProxyProvider_DEFINED |
| 9 | #define GrProxyProvider_DEFINED |
| 10 | |
Robert Phillips | c4039ea | 2018-03-01 11:36:45 -0500 | [diff] [blame] | 11 | #include "GrCaps.h" |
Robert Phillips | 1afd4cd | 2018-01-08 13:40:32 -0500 | [diff] [blame] | 12 | #include "GrResourceKey.h" |
| 13 | #include "GrTextureProxy.h" |
| 14 | #include "GrTypes.h" |
| 15 | #include "SkRefCnt.h" |
| 16 | #include "SkTDynamicHash.h" |
| 17 | |
Robert Phillips | 1afd4cd | 2018-01-08 13:40:32 -0500 | [diff] [blame] | 18 | class GrResourceProvider; |
| 19 | class GrSingleOwner; |
Robert Phillips | 0bd24dc | 2018-01-16 08:06:32 -0500 | [diff] [blame] | 20 | class GrBackendRenderTarget; |
Greg Daniel | a4ead65 | 2018-02-07 10:21:48 -0500 | [diff] [blame] | 21 | class SkBitmap; |
Greg Daniel | 9d86f1d | 2018-01-29 09:33:59 -0500 | [diff] [blame] | 22 | class SkImage; |
Robert Phillips | 1afd4cd | 2018-01-08 13:40:32 -0500 | [diff] [blame] | 23 | |
| 24 | /* |
| 25 | * A factory for creating GrSurfaceProxy-derived objects. |
| 26 | */ |
| 27 | class GrProxyProvider { |
| 28 | public: |
| 29 | GrProxyProvider(GrResourceProvider*, GrResourceCache*, sk_sp<const GrCaps>, GrSingleOwner*); |
| 30 | |
| 31 | ~GrProxyProvider(); |
| 32 | |
| 33 | /* |
| 34 | * Assigns a unique key to a proxy. The proxy will be findable via this key using |
| 35 | * findProxyByUniqueKey(). It is an error if an existing proxy already has a key. |
| 36 | */ |
Robert Phillips | adbe132 | 2018-01-17 13:35:46 -0500 | [diff] [blame] | 37 | bool assignUniqueKeyToProxy(const GrUniqueKey&, GrTextureProxy*); |
Robert Phillips | 1afd4cd | 2018-01-08 13:40:32 -0500 | [diff] [blame] | 38 | |
| 39 | /* |
| 40 | * Sets the unique key of the provided proxy to the unique key of the surface. The surface must |
| 41 | * have a valid unique key. |
| 42 | */ |
| 43 | void adoptUniqueKeyFromSurface(GrTextureProxy* proxy, const GrSurface*); |
| 44 | |
| 45 | /* |
| 46 | * Removes a unique key from a proxy. If the proxy has already been instantiated, it will |
| 47 | * also remove the unique key from the target GrSurface. |
| 48 | */ |
| 49 | void removeUniqueKeyFromProxy(const GrUniqueKey&, GrTextureProxy*); |
| 50 | |
| 51 | /* |
| 52 | * Finds a proxy by unique key. |
| 53 | */ |
| 54 | sk_sp<GrTextureProxy> findProxyByUniqueKey(const GrUniqueKey&, GrSurfaceOrigin); |
| 55 | |
| 56 | /* |
| 57 | * Finds a proxy by unique key or creates a new one that wraps a resource matching the unique |
| 58 | * key. |
| 59 | */ |
| 60 | sk_sp<GrTextureProxy> findOrCreateProxyByUniqueKey(const GrUniqueKey&, GrSurfaceOrigin); |
| 61 | |
| 62 | /* |
Robert Phillips | 0bd24dc | 2018-01-16 08:06:32 -0500 | [diff] [blame] | 63 | * Create a texture proxy that is backed by an instantiated GrSurface. This is almost entirely |
| 64 | * used by Skia's testing code. |
| 65 | * DDL TODO: remove the remaining Skia-internal use of this method and make it truly |
| 66 | * testing-only. |
Robert Phillips | 1afd4cd | 2018-01-08 13:40:32 -0500 | [diff] [blame] | 67 | */ |
Brian Salomon | 2a4f983 | 2018-03-03 22:43:43 -0500 | [diff] [blame] | 68 | sk_sp<GrTextureProxy> createInstantiatedProxy(const GrSurfaceDesc&, GrSurfaceOrigin, |
Robert Phillips | fe0253f | 2018-03-16 16:47:25 -0400 | [diff] [blame^] | 69 | SkBackingFit, SkBudgeted, |
| 70 | GrSurfaceDescFlags = kNone_GrSurfaceFlags); |
Robert Phillips | 0bd24dc | 2018-01-16 08:06:32 -0500 | [diff] [blame] | 71 | |
| 72 | /* |
| 73 | * Create an un-mipmapped texture proxy with data. |
| 74 | * DDL TODO: need to refine ownership semantics of 'srcData' if we're in completely |
| 75 | * deferred mode |
| 76 | */ |
Brian Salomon | 58389b9 | 2018-03-07 13:01:25 -0500 | [diff] [blame] | 77 | sk_sp<GrTextureProxy> createTextureProxy(const GrSurfaceDesc&, SkBudgeted, const void* srcData, |
| 78 | size_t rowBytes); |
Robert Phillips | 1afd4cd | 2018-01-08 13:40:32 -0500 | [diff] [blame] | 79 | |
| 80 | /* |
Greg Daniel | 9d86f1d | 2018-01-29 09:33:59 -0500 | [diff] [blame] | 81 | * Create an un-mipmapped texture proxy with data. The SkImage must be a raster backend image. |
| 82 | * Since the SkImage is ref counted, we simply take a ref on it to keep the data alive until we |
| 83 | * actually upload the data to the gpu. |
| 84 | */ |
| 85 | sk_sp<GrTextureProxy> createTextureProxy(sk_sp<SkImage> srcImage, |
Robert Phillips | fe0253f | 2018-03-16 16:47:25 -0400 | [diff] [blame^] | 86 | GrSurfaceDescFlags descFlags, |
Greg Daniel | 9d86f1d | 2018-01-29 09:33:59 -0500 | [diff] [blame] | 87 | int sampleCnt, |
Greg Daniel | fb3abcd | 2018-02-02 15:48:33 -0500 | [diff] [blame] | 88 | SkBudgeted budgeted, |
| 89 | SkBackingFit fit); |
Greg Daniel | 9d86f1d | 2018-01-29 09:33:59 -0500 | [diff] [blame] | 90 | |
| 91 | /* |
Robert Phillips | 0bd24dc | 2018-01-16 08:06:32 -0500 | [diff] [blame] | 92 | * Create a mipmapped texture proxy without any data. |
| 93 | * |
| 94 | * Like the call above but there are no texels to upload. A texture proxy is returned that |
| 95 | * simply has space allocated for the mips. We will allocated the full amount of mip levels |
| 96 | * based on the width and height in the GrSurfaceDesc. |
| 97 | */ |
Brian Salomon | 2a4f983 | 2018-03-03 22:43:43 -0500 | [diff] [blame] | 98 | sk_sp<GrTextureProxy> createMipMapProxy(const GrSurfaceDesc&, GrSurfaceOrigin, SkBudgeted); |
Robert Phillips | 0bd24dc | 2018-01-16 08:06:32 -0500 | [diff] [blame] | 99 | |
| 100 | /* |
Greg Daniel | a4ead65 | 2018-02-07 10:21:48 -0500 | [diff] [blame] | 101 | * Creates a new mipmapped texture proxy for the bitmap with mip levels generated by the cpu. |
| 102 | */ |
| 103 | sk_sp<GrTextureProxy> createMipMapProxyFromBitmap(const SkBitmap& bitmap, |
| 104 | SkColorSpace* dstColorSpace); |
| 105 | |
| 106 | /* |
Robert Phillips | 0bd24dc | 2018-01-16 08:06:32 -0500 | [diff] [blame] | 107 | * Create a GrSurfaceProxy without any data. |
| 108 | */ |
Brian Salomon | 2a4f983 | 2018-03-03 22:43:43 -0500 | [diff] [blame] | 109 | sk_sp<GrTextureProxy> createProxy(const GrSurfaceDesc&, GrSurfaceOrigin, GrMipMapped, |
Robert Phillips | fe0253f | 2018-03-16 16:47:25 -0400 | [diff] [blame^] | 110 | SkBackingFit, SkBudgeted, GrInternalSurfaceFlags); |
Greg Daniel | f6f7b67 | 2018-02-15 13:06:26 -0500 | [diff] [blame] | 111 | |
Robert Phillips | fe0253f | 2018-03-16 16:47:25 -0400 | [diff] [blame^] | 112 | sk_sp<GrTextureProxy> createProxy( |
| 113 | const GrSurfaceDesc& desc, GrSurfaceOrigin origin, |
| 114 | SkBackingFit fit, SkBudgeted budgeted, |
| 115 | GrInternalSurfaceFlags surfaceFlags = GrInternalSurfaceFlags::kNone) { |
| 116 | return this->createProxy(desc, origin, GrMipMapped::kNo, fit, budgeted, surfaceFlags); |
Greg Daniel | f6f7b67 | 2018-02-15 13:06:26 -0500 | [diff] [blame] | 117 | } |
Robert Phillips | 0bd24dc | 2018-01-16 08:06:32 -0500 | [diff] [blame] | 118 | |
Robert Phillips | adbe132 | 2018-01-17 13:35:46 -0500 | [diff] [blame] | 119 | // These match the definitions in SkImage & GrTexture.h, for whence they came |
| 120 | typedef void* ReleaseContext; |
| 121 | typedef void (*ReleaseProc)(ReleaseContext); |
| 122 | |
Robert Phillips | 0bd24dc | 2018-01-16 08:06:32 -0500 | [diff] [blame] | 123 | /* |
| 124 | * Create a texture proxy that wraps a (non-renderable) backend texture. |
| 125 | */ |
Brian Salomon | 7578f3e | 2018-03-07 14:39:54 -0500 | [diff] [blame] | 126 | sk_sp<GrTextureProxy> wrapBackendTexture(const GrBackendTexture&, GrSurfaceOrigin, |
| 127 | GrWrapOwnership = kBorrow_GrWrapOwnership, |
| 128 | ReleaseProc = nullptr, ReleaseContext = nullptr); |
Robert Phillips | 0bd24dc | 2018-01-16 08:06:32 -0500 | [diff] [blame] | 129 | |
| 130 | /* |
| 131 | * Create a texture proxy that wraps a backend texture and is both texture-able and renderable |
| 132 | */ |
Brian Salomon | 7578f3e | 2018-03-07 14:39:54 -0500 | [diff] [blame] | 133 | sk_sp<GrTextureProxy> wrapRenderableBackendTexture(const GrBackendTexture&, |
| 134 | GrSurfaceOrigin, |
Brian Salomon | 02bd295 | 2018-03-07 15:20:21 -0500 | [diff] [blame] | 135 | int sampleCnt, |
| 136 | GrWrapOwnership = kBorrow_GrWrapOwnership); |
Robert Phillips | 0bd24dc | 2018-01-16 08:06:32 -0500 | [diff] [blame] | 137 | |
| 138 | /* |
| 139 | * Create a render target proxy that wraps a backend rendertarget |
| 140 | */ |
Brian Salomon | 7578f3e | 2018-03-07 14:39:54 -0500 | [diff] [blame] | 141 | sk_sp<GrSurfaceProxy> wrapBackendRenderTarget(const GrBackendRenderTarget&, GrSurfaceOrigin); |
Robert Phillips | 0bd24dc | 2018-01-16 08:06:32 -0500 | [diff] [blame] | 142 | |
| 143 | /* |
Brian Salomon | 7578f3e | 2018-03-07 14:39:54 -0500 | [diff] [blame] | 144 | * Create a render target proxy that wraps a backend texture |
Robert Phillips | 0bd24dc | 2018-01-16 08:06:32 -0500 | [diff] [blame] | 145 | */ |
Kevin Lubick | b5502b2 | 2018-03-12 10:17:06 -0400 | [diff] [blame] | 146 | sk_sp<GrSurfaceProxy> wrapBackendTextureAsRenderTarget(const GrBackendTexture& backendTex, |
Brian Salomon | 7578f3e | 2018-03-07 14:39:54 -0500 | [diff] [blame] | 147 | GrSurfaceOrigin origin, |
| 148 | int sampleCnt); |
Robert Phillips | 1afd4cd | 2018-01-08 13:40:32 -0500 | [diff] [blame] | 149 | |
Robert Phillips | ce5209a | 2018-02-13 11:13:51 -0500 | [diff] [blame] | 150 | using LazyInstantiateCallback = std::function<sk_sp<GrSurface>(GrResourceProvider*)>; |
Robert Phillips | e8fabb2 | 2018-02-04 14:33:21 -0500 | [diff] [blame] | 151 | enum class Textureable : bool { |
| 152 | kNo = false, |
| 153 | kYes = true |
| 154 | }; |
| 155 | |
Robert Phillips | 777707b | 2018-01-17 11:40:14 -0500 | [diff] [blame] | 156 | enum class Renderable : bool { |
| 157 | kNo = false, |
| 158 | kYes = true |
| 159 | }; |
| 160 | |
Greg Daniel | a8d9211 | 2018-03-09 12:05:04 -0500 | [diff] [blame] | 161 | using LazyInstantiationType = GrSurfaceProxy::LazyInstantiationType; |
Robert Phillips | 777707b | 2018-01-17 11:40:14 -0500 | [diff] [blame] | 162 | /** |
| 163 | * Creates a texture proxy that will be instantiated by a user-supplied callback during flush. |
| 164 | * (Stencil is not supported by this method.) The width and height must either both be greater |
| 165 | * than 0 or both less than or equal to zero. A non-positive value is a signal that the width |
| 166 | * and height are currently unknown. |
| 167 | * |
| 168 | * When called, the callback must be able to cleanup any resources that it captured at creation. |
| 169 | * It also must support being passed in a null GrResourceProvider. When this happens, the |
| 170 | * callback should cleanup any resources it captured and return an empty sk_sp<GrTextureProxy>. |
| 171 | */ |
| 172 | sk_sp<GrTextureProxy> createLazyProxy(LazyInstantiateCallback&&, const GrSurfaceDesc&, |
Robert Phillips | fe0253f | 2018-03-16 16:47:25 -0400 | [diff] [blame^] | 173 | GrSurfaceOrigin, GrMipMapped, GrInternalSurfaceFlags, |
Greg Daniel | a8d9211 | 2018-03-09 12:05:04 -0500 | [diff] [blame] | 174 | SkBackingFit, SkBudgeted, LazyInstantiationType); |
| 175 | |
| 176 | sk_sp<GrTextureProxy> createLazyProxy(LazyInstantiateCallback&&, const GrSurfaceDesc&, |
Robert Phillips | fe0253f | 2018-03-16 16:47:25 -0400 | [diff] [blame^] | 177 | GrSurfaceOrigin, GrMipMapped, GrInternalSurfaceFlags, |
Brian Salomon | 2a4f983 | 2018-03-03 22:43:43 -0500 | [diff] [blame] | 178 | SkBackingFit, SkBudgeted); |
Greg Daniel | 2a30390 | 2018-02-20 10:25:54 -0500 | [diff] [blame] | 179 | |
| 180 | sk_sp<GrTextureProxy> createLazyProxy(LazyInstantiateCallback&&, const GrSurfaceDesc&, |
Brian Salomon | 2a4f983 | 2018-03-03 22:43:43 -0500 | [diff] [blame] | 181 | GrSurfaceOrigin, GrMipMapped, SkBackingFit, SkBudgeted); |
Robert Phillips | 777707b | 2018-01-17 11:40:14 -0500 | [diff] [blame] | 182 | |
Robert Phillips | ce5209a | 2018-02-13 11:13:51 -0500 | [diff] [blame] | 183 | /** |
| 184 | * Fully lazy proxies have unspecified width and height. Methods that rely on those values |
| 185 | * (e.g., width, height, getBoundsRect) should be avoided. |
| 186 | */ |
Robert Phillips | 777707b | 2018-01-17 11:40:14 -0500 | [diff] [blame] | 187 | sk_sp<GrTextureProxy> createFullyLazyProxy(LazyInstantiateCallback&&, |
Robert Phillips | ce5209a | 2018-02-13 11:13:51 -0500 | [diff] [blame] | 188 | Renderable, GrSurfaceOrigin, GrPixelConfig); |
Robert Phillips | 777707b | 2018-01-17 11:40:14 -0500 | [diff] [blame] | 189 | |
Robert Phillips | e8fabb2 | 2018-02-04 14:33:21 -0500 | [diff] [blame] | 190 | sk_sp<GrRenderTargetProxy> createLazyRenderTargetProxy(LazyInstantiateCallback&&, |
Greg Daniel | 2a30390 | 2018-02-20 10:25:54 -0500 | [diff] [blame] | 191 | const GrSurfaceDesc&, |
Brian Salomon | 2a4f983 | 2018-03-03 22:43:43 -0500 | [diff] [blame] | 192 | GrSurfaceOrigin origin, |
Robert Phillips | fe0253f | 2018-03-16 16:47:25 -0400 | [diff] [blame^] | 193 | GrInternalSurfaceFlags, Textureable, |
Robert Phillips | e8fabb2 | 2018-02-04 14:33:21 -0500 | [diff] [blame] | 194 | GrMipMapped, SkBackingFit, SkBudgeted); |
| 195 | |
Robert Phillips | 1afd4cd | 2018-01-08 13:40:32 -0500 | [diff] [blame] | 196 | // 'proxy' is about to be used as a texture src or drawn to. This query can be used to |
| 197 | // determine if it is going to need a texture domain or a full clear. |
| 198 | static bool IsFunctionallyExact(GrSurfaceProxy* proxy); |
| 199 | |
| 200 | /** |
| 201 | * Either the proxy attached to the unique key is being deleted (in which case we |
| 202 | * don't want it cluttering up the hash table) or the client has indicated that |
| 203 | * it will never refer to the unique key again. In either case, remove the key |
| 204 | * from the hash table. |
| 205 | * Note: this does not, by itself, alter unique key attached to the underlying GrTexture. |
| 206 | */ |
| 207 | void processInvalidProxyUniqueKey(const GrUniqueKey&); |
| 208 | |
| 209 | /** |
| 210 | * Same as above, but you must pass in a GrTextureProxy to save having to search for it. The |
| 211 | * GrUniqueKey of the proxy must be valid and it must match the passed in key. This function |
| 212 | * also gives the option to invalidate the GrUniqueKey on the underlying GrTexture. |
| 213 | */ |
| 214 | void processInvalidProxyUniqueKey(const GrUniqueKey&, GrTextureProxy*, bool invalidateSurface); |
| 215 | |
| 216 | const GrCaps* caps() const { return fCaps.get(); } |
Robert Phillips | c4039ea | 2018-03-01 11:36:45 -0500 | [diff] [blame] | 217 | sk_sp<const GrCaps> refCaps() const { return fCaps; } |
Robert Phillips | 1afd4cd | 2018-01-08 13:40:32 -0500 | [diff] [blame] | 218 | |
| 219 | void abandon() { |
| 220 | fResourceCache = nullptr; |
| 221 | fResourceProvider = nullptr; |
Robert Phillips | 4d12051 | 2018-01-19 13:22:07 -0500 | [diff] [blame] | 222 | fAbandoned = true; |
Robert Phillips | 1afd4cd | 2018-01-08 13:40:32 -0500 | [diff] [blame] | 223 | } |
| 224 | |
| 225 | bool isAbandoned() const { |
Robert Phillips | 4d12051 | 2018-01-19 13:22:07 -0500 | [diff] [blame] | 226 | #ifdef SK_DEBUG |
| 227 | if (fAbandoned) { |
| 228 | SkASSERT(!fResourceCache && !fResourceProvider); |
| 229 | } |
| 230 | #endif |
| 231 | return fAbandoned; |
Robert Phillips | 1afd4cd | 2018-01-08 13:40:32 -0500 | [diff] [blame] | 232 | } |
| 233 | |
| 234 | int numUniqueKeyProxies_TestOnly() const; |
| 235 | |
| 236 | void removeAllUniqueKeys(); |
| 237 | |
Greg Daniel | 7e1912a | 2018-02-08 09:15:33 -0500 | [diff] [blame] | 238 | /** |
| 239 | * Helper function for callers who are wrapping a bitmap into an SkImage so they know whether or |
| 240 | * not that bitmap should be copied or not. |
| 241 | */ |
| 242 | bool mutableBitmapsNeedCopy() const { return !SkToBool(fResourceProvider); } |
| 243 | |
Robert Phillips | 1afd4cd | 2018-01-08 13:40:32 -0500 | [diff] [blame] | 244 | private: |
Robert Phillips | adbe132 | 2018-01-17 13:35:46 -0500 | [diff] [blame] | 245 | friend class GrAHardwareBufferImageGenerator; // for createWrapped |
| 246 | |
| 247 | sk_sp<GrTextureProxy> createWrapped(sk_sp<GrTexture> tex, GrSurfaceOrigin origin); |
| 248 | |
Robert Phillips | 1afd4cd | 2018-01-08 13:40:32 -0500 | [diff] [blame] | 249 | struct UniquelyKeyedProxyHashTraits { |
| 250 | static const GrUniqueKey& GetKey(const GrTextureProxy& p) { return p.getUniqueKey(); } |
| 251 | |
| 252 | static uint32_t Hash(const GrUniqueKey& key) { return key.hash(); } |
| 253 | }; |
| 254 | typedef SkTDynamicHash<GrTextureProxy, GrUniqueKey, UniquelyKeyedProxyHashTraits> UniquelyKeyedProxyHash; |
| 255 | |
| 256 | // This holds the texture proxies that have unique keys. The resourceCache does not get a ref |
| 257 | // on these proxies but they must send a message to the resourceCache when they are deleted. |
| 258 | UniquelyKeyedProxyHash fUniquelyKeyedProxies; |
| 259 | |
| 260 | GrResourceProvider* fResourceProvider; |
| 261 | GrResourceCache* fResourceCache; |
Robert Phillips | 4d12051 | 2018-01-19 13:22:07 -0500 | [diff] [blame] | 262 | bool fAbandoned; |
Robert Phillips | 1afd4cd | 2018-01-08 13:40:32 -0500 | [diff] [blame] | 263 | sk_sp<const GrCaps> fCaps; |
| 264 | |
| 265 | // In debug builds we guard against improper thread handling |
| 266 | SkDEBUGCODE(mutable GrSingleOwner* fSingleOwner;) |
| 267 | }; |
| 268 | |
| 269 | #endif |