1 /* 2 * Copyright 2016 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 GrTextureProxy_DEFINED 9 #define GrTextureProxy_DEFINED 10 11 #include "include/gpu/GrBackendSurface.h" 12 #include "src/gpu/GrSamplerState.h" 13 #include "src/gpu/GrSurfaceProxy.h" 14 15 class GrCaps; 16 class GrDeferredProxyUploader; 17 class GrProxyProvider; 18 class GrResourceProvider; 19 class GrTextureProxyPriv; 20 21 // This class delays the acquisition of textures until they are actually required 22 class GrTextureProxy : virtual public GrSurfaceProxy { 23 public: asTextureProxy()24 GrTextureProxy* asTextureProxy() override { return this; } asTextureProxy()25 const GrTextureProxy* asTextureProxy() const override { return this; } 26 27 // Actually instantiate the backing texture, if necessary 28 bool instantiate(GrResourceProvider*) override; 29 30 // If we are instantiated and have a target, return the mip state of that target. Otherwise 31 // returns the proxy's mip state from creation time. This is useful for lazy proxies which may 32 // claim to not need mips at creation time, but the instantiation happens to give us a mipped 33 // target. In that case we should use that for our benefit to avoid possible copies/mip 34 // generation later. 35 GrMipmapped mipmapped() const; 36 mipmapsAreDirty()37 bool mipmapsAreDirty() const { 38 SkASSERT((GrMipmapped::kNo == fMipmapped) == 39 (GrMipmapStatus::kNotAllocated == fMipmapStatus)); 40 return GrMipmapped::kYes == fMipmapped && GrMipmapStatus::kValid != fMipmapStatus; 41 } markMipmapsDirty()42 void markMipmapsDirty() { 43 SkASSERT(GrMipmapped::kYes == fMipmapped); 44 fMipmapStatus = GrMipmapStatus::kDirty; 45 } markMipmapsClean()46 void markMipmapsClean() { 47 SkASSERT(GrMipmapped::kYes == fMipmapped); 48 fMipmapStatus = GrMipmapStatus::kValid; 49 } 50 51 // Returns the GrMipmapped value of the proxy from creation time regardless of whether it has 52 // been instantiated or not. proxyMipmapped()53 GrMipmapped proxyMipmapped() const { return fMipmapped; } 54 textureType()55 GrTextureType textureType() const { return this->backendFormat().textureType(); } 56 57 /** If true then the texture does not support MIP maps and only supports clamp wrap mode. */ hasRestrictedSampling()58 bool hasRestrictedSampling() const { 59 return GrTextureTypeHasRestrictedSampling(this->textureType()); 60 } 61 62 // Returns true if the passed in proxies can be used as dynamic state together when flushing 63 // draws to the gpu. This accepts GrSurfaceProxy since the information needed is defined on 64 // that type, but this function exists in GrTextureProxy because it's only relevant when the 65 // proxies are being used as textures. 66 static bool ProxiesAreCompatibleAsDynamicState(const GrSurfaceProxy* first, 67 const GrSurfaceProxy* second); 68 69 /** 70 * Return the texture proxy's unique key. It will be invalid if the proxy doesn't have one. 71 */ getUniqueKey()72 const GrUniqueKey& getUniqueKey() const override { 73 #ifdef SK_DEBUG 74 if (this->isInstantiated() && fUniqueKey.isValid() && fSyncTargetKey && 75 fCreatingProvider == GrDDLProvider::kNo) { 76 GrSurface* surface = this->peekSurface(); 77 SkASSERT(surface); 78 79 SkASSERT(surface->getUniqueKey().isValid()); 80 // It is possible for a non-keyed proxy to have a uniquely keyed resource assigned to 81 // it. This just means that a future user of the resource will be filling it with unique 82 // data. However, if the proxy has a unique key its attached resource should also 83 // have that key. 84 SkASSERT(fUniqueKey == surface->getUniqueKey()); 85 } 86 #endif 87 88 return fUniqueKey; 89 } 90 91 /** 92 * Internal-only helper class used for manipulations of the resource by the cache. 93 */ 94 class CacheAccess; 95 inline CacheAccess cacheAccess(); 96 inline const CacheAccess cacheAccess() const; // NOLINT(readability-const-return-type) 97 98 // Provides access to special purpose functions. 99 GrTextureProxyPriv texPriv(); 100 const GrTextureProxyPriv texPriv() const; // NOLINT(readability-const-return-type) 101 102 SkDEBUGCODE(GrDDLProvider creatingProvider() const { return fCreatingProvider; }) 103 104 protected: 105 // DDL TODO: rm the GrSurfaceProxy friending 106 friend class GrSurfaceProxy; // for ctors 107 friend class GrProxyProvider; // for ctors 108 friend class GrTextureProxyPriv; 109 friend class GrSurfaceProxyPriv; // ability to change key sync state after lazy instantiation. 110 111 // Deferred version - no data. 112 GrTextureProxy(const GrBackendFormat&, 113 SkISize, 114 GrMipmapped, 115 GrMipmapStatus, 116 SkBackingFit, 117 SkBudgeted, 118 GrProtected, 119 GrInternalSurfaceFlags, 120 UseAllocator, 121 GrDDLProvider creatingProvider); 122 123 // Lazy-callback version 124 // There are two main use cases for lazily-instantiated proxies: 125 // basic knowledge - width, height, config, origin are known 126 // minimal knowledge - only config is known. 127 // 128 // The basic knowledge version is used for DDL where we know the type of proxy we are going to 129 // use, but we don't have access to the GPU yet to instantiate it. 130 // 131 // The minimal knowledge version is used for when we are generating an atlas but we do not know 132 // the final size until we have finished adding to it. 133 GrTextureProxy(LazyInstantiateCallback&&, 134 const GrBackendFormat&, 135 SkISize, 136 GrMipmapped, 137 GrMipmapStatus, 138 SkBackingFit, 139 SkBudgeted, 140 GrProtected, 141 GrInternalSurfaceFlags, 142 UseAllocator, 143 GrDDLProvider creatingProvider); 144 145 // Wrapped version 146 GrTextureProxy(sk_sp<GrSurface>, UseAllocator, GrDDLProvider creatingProvider); 147 148 ~GrTextureProxy() override; 149 150 sk_sp<GrSurface> createSurface(GrResourceProvider*) const override; 151 152 // By default uniqueKeys are propagated from a textureProxy to its backing GrTexture. 153 // Setting syncTargetKey to false disables this behavior and only keeps the unique key 154 // on the proxy. setTargetKeySync(bool sync)155 void setTargetKeySync(bool sync) { fSyncTargetKey = sync; } 156 157 private: 158 // WARNING: Be careful when adding or removing fields here. ASAN is likely to trigger warnings 159 // when instantiating GrTextureRenderTargetProxy. The std::function in GrSurfaceProxy makes 160 // each class in the diamond require 16 byte alignment. Clang appears to layout the fields for 161 // each class to achieve the necessary alignment. However, ASAN checks the alignment of 'this' 162 // in the constructors, and always looks for the full 16 byte alignment, even if the fields in 163 // that particular class don't require it. Changing the size of this object can move the start 164 // address of other types, leading to this problem. 165 166 GrMipmapped fMipmapped; 167 168 // This tracks the mipmap status at the proxy level and is thus somewhat distinct from the 169 // backing GrTexture's mipmap status. In particular, this status is used to determine when 170 // mipmap levels need to be explicitly regenerated during the execution of a DAG of opsTasks. 171 GrMipmapStatus fMipmapStatus; 172 // TEMPORARY: We are in the process of moving GrMipmapStatus from the texture to the proxy. 173 // We track the fInitialMipmapStatus here so we can assert that the proxy did indeed expect 174 // the correct mipmap status immediately after instantiation. 175 // 176 // NOTE: fMipmapStatus may no longer be equal to fInitialMipmapStatus by the time the texture 177 // is instantiated, since it tracks mipmaps in the time frame in which the DAG is being built. 178 SkDEBUGCODE(const GrMipmapStatus fInitialMipmapStatus;) 179 180 bool fSyncTargetKey = true; // Should target's unique key be sync'ed with ours. 181 182 // For GrTextureProxies created in a DDL recording thread it is possible for the uniqueKey 183 // to be cleared on the backing GrTexture while the uniqueKey remains on the proxy. 184 // A fCreatingProvider of DDLProvider::kYes loosens up asserts that the key of an instantiated 185 // uniquely-keyed textureProxy is also always set on the backing GrTexture. 186 GrDDLProvider fCreatingProvider = GrDDLProvider::kNo; 187 188 GrUniqueKey fUniqueKey; 189 GrProxyProvider* fProxyProvider; // only set when fUniqueKey is valid 190 191 LazySurfaceDesc callbackDesc() const override; 192 193 // Only used for proxies whose contents are being prepared on a worker thread. This object 194 // stores the texture data, allowing the proxy to remain uninstantiated until flush. At that 195 // point, the proxy is instantiated, and this data is used to perform an ASAP upload. 196 std::unique_ptr<GrDeferredProxyUploader> fDeferredUploader; 197 198 size_t onUninstantiatedGpuMemorySize() const override; 199 200 // Methods made available via GrTextureProxy::CacheAccess 201 void setUniqueKey(GrProxyProvider*, const GrUniqueKey&); 202 void clearUniqueKey(); 203 204 SkDEBUGCODE(void onValidateSurface(const GrSurface*) override;) 205 206 using INHERITED = GrSurfaceProxy; 207 }; 208 209 #endif 210