blob: 46b4710d3c671942440db174258d5aa6501ab05e [file] [log] [blame]
bsalomond309e7a2015-04-30 14:18:54 -07001/*
2 * Copyright 2015 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 GrResourceProvider_DEFINED
9#define GrResourceProvider_DEFINED
10
Mike Kleinc0bd9f92019-04-23 12:05:21 -050011#include "include/gpu/GrContextOptions.h"
12#include "include/private/SkImageInfoPriv.h"
13#include "src/core/SkScalerContext.h"
14#include "src/gpu/GrGpuBuffer.h"
15#include "src/gpu/GrResourceCache.h"
bsalomond309e7a2015-04-30 14:18:54 -070016
Greg Danielbcf612b2017-05-01 13:50:58 +000017class GrBackendRenderTarget;
Greg Daniela5cb7812017-06-16 09:45:32 -040018class GrBackendSemaphore;
19class GrBackendTexture;
Robert Phillips009e9af2017-06-15 14:01:04 -040020class GrGpu;
bsalomon706f08f2015-05-22 07:35:58 -070021class GrPath;
egdanielec00d942015-09-14 12:56:10 -070022class GrRenderTarget;
Greg Daniel8982dc12018-01-05 12:56:15 -050023class GrResourceProviderPriv;
Robert Phillips646e4292017-06-13 12:44:56 -040024class GrSemaphore;
joshualitt6d0872d2016-01-11 08:27:48 -080025class GrSingleOwner;
egdanielec00d942015-09-14 12:56:10 -070026class GrStencilAttachment;
Robert Phillips646e4292017-06-13 12:44:56 -040027class GrTexture;
Greg Danielb46add82019-01-02 14:51:29 -050028struct GrVkDrawableInfo;
Robert Phillips646e4292017-06-13 12:44:56 -040029
bsalomon6663acf2016-05-10 09:14:17 -070030class GrStyle;
bsalomon706f08f2015-05-22 07:35:58 -070031class SkDescriptor;
32class SkPath;
33class SkTypeface;
bsalomoned0bcad2015-05-04 10:36:42 -070034
bsalomond309e7a2015-04-30 14:18:54 -070035/**
Brian Osman32342f02017-03-04 08:12:46 -050036 * A factory for arbitrary resource types. This class is intended for use within the Gr code base.
bsalomoneae62002015-07-31 13:59:30 -070037 *
Brian Osman32342f02017-03-04 08:12:46 -050038 * Some members force callers to make a flags (pendingIO) decision. This can be relaxed once
39 * https://bug.skia.org/4156 is fixed.
bsalomond309e7a2015-04-30 14:18:54 -070040 */
Brian Osman32342f02017-03-04 08:12:46 -050041class GrResourceProvider {
bsalomond309e7a2015-04-30 14:18:54 -070042public:
Chris Daltond004e0b2018-09-27 09:28:03 -060043 /** These flags govern which scratch resources we are allowed to return */
44 enum class Flags {
45 kNone = 0x0,
46
47 /** If the caller intends to do direct reads/writes to/from the CPU then this flag must be
48 * set when accessing resources during a GrOpList flush. This includes the execution of
49 * GrOp objects. The reason is that these memory operations are done immediately and
50 * will occur out of order WRT the operations being flushed.
51 * Make this automatic: https://bug.skia.org/4156
52 */
53 kNoPendingIO = 0x1,
Chris Daltond004e0b2018-09-27 09:28:03 -060054 };
55
Robert Phillips12c46292019-04-23 07:36:17 -040056 GrResourceProvider(GrGpu*, GrResourceCache*, GrSingleOwner*);
bsalomoned0bcad2015-05-04 10:36:42 -070057
Brian Salomond28a79d2017-10-16 13:01:07 -040058 /**
59 * Finds a resource in the cache, based on the specified key. Prior to calling this, the caller
60 * must be sure that if a resource of exists in the cache with the given unique key then it is
61 * of type T.
62 */
Brian Salomondbf70722019-02-07 11:31:24 -050063 template <typename T = GrGpuResource>
64 typename std::enable_if<std::is_base_of<GrGpuResource, T>::value, sk_sp<T>>::type
65 findByUniqueKey(const GrUniqueKey& key) {
Brian Salomond28a79d2017-10-16 13:01:07 -040066 return sk_sp<T>(static_cast<T*>(this->findResourceByUniqueKey(key).release()));
bsalomoned0bcad2015-05-04 10:36:42 -070067 }
68
Brian Osman32342f02017-03-04 08:12:46 -050069 ///////////////////////////////////////////////////////////////////////////
70 // Textures
71
Brian Osman32342f02017-03-04 08:12:46 -050072 /**
73 * Finds a texture that approximately matches the descriptor. Will be at least as large in width
74 * and height as desc specifies. If desc specifies that the texture should be a render target
75 * then result will be a render target. Format and sample count will always match the request.
Robert Phillips67d52cf2017-06-05 13:38:13 -040076 * The contents of the texture are undefined.
Brian Osman32342f02017-03-04 08:12:46 -050077 */
Chris Daltond004e0b2018-09-27 09:28:03 -060078 sk_sp<GrTexture> createApproxTexture(const GrSurfaceDesc&, Flags);
Brian Osman32342f02017-03-04 08:12:46 -050079
Robert Phillipse78b7252017-04-06 07:59:41 -040080 /** Create an exact fit texture with no initial data to upload.
81 */
Chris Daltond004e0b2018-09-27 09:28:03 -060082 sk_sp<GrTexture> createTexture(const GrSurfaceDesc&, SkBudgeted, Flags = Flags::kNone);
Robert Phillips45fdae12017-04-17 12:57:27 -040083
Brian Salomon58389b92018-03-07 13:01:25 -050084 sk_sp<GrTexture> createTexture(const GrSurfaceDesc&, SkBudgeted, const GrMipLevel texels[],
Brian Osman2b23c4b2018-06-01 12:25:08 -040085 int mipLevelCount);
Robert Phillips8e8c7552017-07-10 12:06:05 -040086
Robert Phillips1afd4cd2018-01-08 13:40:32 -050087 // Create a potentially loose fit texture with the provided data
Greg Danielfb3abcd2018-02-02 15:48:33 -050088 sk_sp<GrTexture> createTexture(const GrSurfaceDesc&, SkBudgeted, SkBackingFit,
Chris Daltond004e0b2018-09-27 09:28:03 -060089 const GrMipLevel&, Flags);
Robert Phillipse78b7252017-04-06 07:59:41 -040090
Brian Salomonbb8dde82019-06-27 10:52:13 -040091 // Creates a compressed texture. The GrGpu must support the SkImageImage::Compression type.
92 // This does not currently support MIP maps.
93 sk_sp<GrTexture> createCompressedTexture(int width, int height, SkImage::CompressionType,
94 SkBudgeted, SkData* data);
95
Brian Osman32342f02017-03-04 08:12:46 -050096 ///////////////////////////////////////////////////////////////////////////
97 // Wrapped Backend Surfaces
98
99 /**
100 * Wraps an existing texture with a GrTexture object.
101 *
Brian Salomonc67c31c2018-12-06 10:00:03 -0500102 * GrIOType must either be kRead or kRW. kRead blocks any operations that would modify the
103 * pixels (e.g. dst for a copy, regenerating MIP levels, write pixels).
104 *
Brian Osman32342f02017-03-04 08:12:46 -0500105 * OpenGL: if the object is a texture Gr may change its GL texture params
106 * when it is drawn.
107 *
108 * @return GrTexture object or NULL on failure.
109 */
Brian Salomonaa6ca0a2019-01-24 16:03:07 -0500110 sk_sp<GrTexture> wrapBackendTexture(const GrBackendTexture& tex, GrWrapOwnership,
111 GrWrapCacheable, GrIOType);
Brian Osman32342f02017-03-04 08:12:46 -0500112
113 /**
Brian Salomonbdecacf2018-02-02 20:32:49 -0500114 * This makes the backend texture be renderable. If sampleCnt is > 1 and the underlying API
Brian Salomond17f6582017-07-19 18:28:58 -0400115 * uses separate MSAA render buffers then a MSAA render buffer is created that resolves
116 * to the texture.
117 */
118 sk_sp<GrTexture> wrapRenderableBackendTexture(const GrBackendTexture& tex,
Brian Salomond17f6582017-07-19 18:28:58 -0400119 int sampleCnt,
Brian Salomonaa6ca0a2019-01-24 16:03:07 -0500120 GrWrapOwnership,
121 GrWrapCacheable);
Brian Salomond17f6582017-07-19 18:28:58 -0400122
123 /**
Brian Osman32342f02017-03-04 08:12:46 -0500124 * Wraps an existing render target with a GrRenderTarget object. It is
125 * similar to wrapBackendTexture but can be used to draw into surfaces
126 * that are not also textures (e.g. FBO 0 in OpenGL, or an MSAA buffer that
127 * the client will resolve to a texture). Currently wrapped render targets
Brian Salomonaa6ca0a2019-01-24 16:03:07 -0500128 * always use the kBorrow_GrWrapOwnership and GrWrapCacheable::kNo semantics.
Brian Osman32342f02017-03-04 08:12:46 -0500129 *
130 * @return GrRenderTarget object or NULL on failure.
131 */
Robert Phillipsb0e93a22017-08-29 08:26:54 -0400132 sk_sp<GrRenderTarget> wrapBackendRenderTarget(const GrBackendRenderTarget&);
Brian Osman32342f02017-03-04 08:12:46 -0500133
Greg Danielb46add82019-01-02 14:51:29 -0500134 sk_sp<GrRenderTarget> wrapVulkanSecondaryCBAsRenderTarget(const SkImageInfo&,
135 const GrVkDrawableInfo&);
136
Robert Phillips1bfece82017-06-01 13:56:52 -0400137 static const uint32_t kMinScratchTextureSize;
Brian Osman32342f02017-03-04 08:12:46 -0500138
bsalomoned0bcad2015-05-04 10:36:42 -0700139 /**
Chris Dalton5d2de082017-12-19 10:40:23 -0700140 * Either finds and refs, or creates a static buffer with the given parameters and contents.
141 *
142 * @param intendedType hint to the graphics subsystem about what the buffer will be used for.
143 * @param size minimum size of buffer to return.
144 * @param data optional data with which to initialize the buffer.
145 * @param key Key to be assigned to the buffer.
146 *
147 * @return The buffer if successful, otherwise nullptr.
148 */
Brian Salomondbf70722019-02-07 11:31:24 -0500149 sk_sp<const GrGpuBuffer> findOrMakeStaticBuffer(GrGpuBufferType intendedType, size_t size,
150 const void* data, const GrUniqueKey& key);
Chris Dalton5d2de082017-12-19 10:40:23 -0700151
152 /**
Chris Daltonff926502017-05-03 14:36:54 -0400153 * Either finds and refs, or creates an index buffer with a repeating pattern for drawing
154 * contiguous vertices of a repeated mesh. If the return is non-null, the caller owns a ref on
155 * the returned GrBuffer.
bsalomoned0bcad2015-05-04 10:36:42 -0700156 *
157 * @param pattern the pattern of indices to repeat
158 * @param patternSize size in bytes of the pattern
159 * @param reps number of times to repeat the pattern
160 * @param vertCount number of vertices the pattern references
161 * @param key Key to be assigned to the index buffer.
162 *
halcanary96fcdcc2015-08-27 07:41:13 -0700163 * @return The index buffer if successful, otherwise nullptr.
bsalomoned0bcad2015-05-04 10:36:42 -0700164 */
Brian Salomondbf70722019-02-07 11:31:24 -0500165 sk_sp<const GrGpuBuffer> findOrCreatePatternedIndexBuffer(const uint16_t* pattern,
166 int patternSize,
167 int reps,
168 int vertCount,
169 const GrUniqueKey& key) {
Brian Salomona29dd9d2019-02-07 13:27:18 -0500170 if (auto buffer = this->findByUniqueKey<const GrGpuBuffer>(key)) {
171 return buffer;
bsalomoned0bcad2015-05-04 10:36:42 -0700172 }
Brian Salomona29dd9d2019-02-07 13:27:18 -0500173 return this->createPatternedIndexBuffer(pattern, patternSize, reps, vertCount, &key);
bsalomoned0bcad2015-05-04 10:36:42 -0700174 }
175
176 /**
177 * Returns an index buffer that can be used to render quads.
Brian Salomon57caa662017-10-18 12:21:05 +0000178 * Six indices per quad: 0, 1, 2, 2, 1, 3, etc.
Brian Salomon763abf02018-05-01 18:49:38 +0000179 * The max number of quads is the buffer's index capacity divided by 6.
Chris Dalton3809bab2017-06-13 10:55:06 -0600180 * Draw with GrPrimitiveType::kTriangles
Brian Salomon763abf02018-05-01 18:49:38 +0000181 * @ return the quad index buffer
bsalomoned0bcad2015-05-04 10:36:42 -0700182 */
Brian Salomondbf70722019-02-07 11:31:24 -0500183 sk_sp<const GrGpuBuffer> refQuadIndexBuffer() {
Brian Salomona29dd9d2019-02-07 13:27:18 -0500184 if (!fQuadIndexBuffer) {
185 fQuadIndexBuffer = this->createQuadIndexBuffer();
bsalomoned0bcad2015-05-04 10:36:42 -0700186 }
Brian Salomona29dd9d2019-02-07 13:27:18 -0500187 return fQuadIndexBuffer;
bsalomoned0bcad2015-05-04 10:36:42 -0700188 }
189
Brian Salomon34169692017-08-28 15:32:01 -0400190 static int QuadCountOfQuadBuffer();
191
bsalomon706f08f2015-05-22 07:35:58 -0700192 /**
Ben Wagner3746ac22018-03-29 11:46:24 -0400193 * Factories for GrPath objects. It's an error to call these if path rendering
bsalomon706f08f2015-05-22 07:35:58 -0700194 * is not supported.
195 */
Robert Phillips67d52cf2017-06-05 13:38:13 -0400196 sk_sp<GrPath> createPath(const SkPath&, const GrStyle&);
bsalomon706f08f2015-05-22 07:35:58 -0700197
cdaltone2e71c22016-04-07 18:13:29 -0700198 /**
199 * Returns a buffer.
200 *
201 * @param size minimum size of buffer to return.
202 * @param intendedType hint to the graphics subsystem about what the buffer will be used for.
203 * @param GrAccessPattern hint to the graphics subsystem about how the data will be accessed.
204 * @param flags see Flags enum.
cdalton1bf3e712016-04-19 10:00:02 -0700205 * @param data optional data with which to initialize the buffer.
cdaltone2e71c22016-04-07 18:13:29 -0700206 *
207 * @return the buffer if successful, otherwise nullptr.
208 */
Brian Salomondbf70722019-02-07 11:31:24 -0500209 sk_sp<GrGpuBuffer> createBuffer(size_t size, GrGpuBufferType intendedType, GrAccessPattern,
210 const void* data = nullptr);
robertphillips1b8e1b52015-06-24 06:54:10 -0700211
Brian Salomon2ee084e2016-12-16 18:59:19 -0500212 /**
Chris Daltoneffee202019-07-01 22:28:03 -0600213 * If passed in render target already has a stencil buffer with at least "numSamples" samples,
214 * return true. Otherwise attempt to attach one and return true on success.
egdanielec00d942015-09-14 12:56:10 -0700215 */
Chris Daltoneffee202019-07-01 22:28:03 -0600216 bool attachStencilAttachment(GrRenderTarget* rt, int numStencilSamples);
egdanielec00d942015-09-14 12:56:10 -0700217
ericrkf7b8b8a2016-02-24 14:49:51 -0800218 /**
219 * Wraps an existing texture with a GrRenderTarget object. This is useful when the provided
220 * texture has a format that cannot be textured from by Skia, but we want to raster to it.
221 *
kkinnunen49c4c222016-04-01 04:50:37 -0700222 * The texture is wrapped as borrowed. The texture object will not be freed once the
223 * render target is destroyed.
224 *
ericrkf7b8b8a2016-02-24 14:49:51 -0800225 * @return GrRenderTarget object or NULL on failure.
226 */
Greg Daniel7ef28f32017-04-20 16:41:55 +0000227 sk_sp<GrRenderTarget> wrapBackendTextureAsRenderTarget(const GrBackendTexture&,
Greg Daniel7ef28f32017-04-20 16:41:55 +0000228 int sampleCnt);
ericrkf7b8b8a2016-02-24 14:49:51 -0800229
Brian Osman32342f02017-03-04 08:12:46 -0500230 /**
231 * Assigns a unique key to a resource. If the key is associated with another resource that
232 * association is removed and replaced by this resource.
233 */
234 void assignUniqueKeyToResource(const GrUniqueKey&, GrGpuResource*);
235
Greg Daniela5cb7812017-06-16 09:45:32 -0400236 sk_sp<GrSemaphore> SK_WARN_UNUSED_RESULT makeSemaphore(bool isOwned = true);
237
Greg Daniel17b7c052018-01-09 13:55:33 -0500238 enum class SemaphoreWrapType {
239 kWillSignal,
240 kWillWait,
241 };
242
Greg Daniela5cb7812017-06-16 09:45:32 -0400243 sk_sp<GrSemaphore> wrapBackendSemaphore(const GrBackendSemaphore&,
Greg Daniel17b7c052018-01-09 13:55:33 -0500244 SemaphoreWrapType wrapType,
Greg Daniela5cb7812017-06-16 09:45:32 -0400245 GrWrapOwnership = kBorrow_GrWrapOwnership);
Greg Danield85f97d2017-03-07 13:37:21 -0500246
Brian Osman32342f02017-03-04 08:12:46 -0500247 void abandon() {
Robert Phillips26c90e02017-03-14 14:39:29 -0400248 fCache = nullptr;
249 fGpu = nullptr;
Brian Osman32342f02017-03-04 08:12:46 -0500250 }
251
Brian Salomon238069b2018-07-11 15:58:57 -0400252 uint32_t contextUniqueID() const { return fCache->contextUniqueID(); }
Robert Phillips26c90e02017-03-14 14:39:29 -0400253 const GrCaps* caps() const { return fCaps.get(); }
Robert Phillipseafd48a2017-11-16 07:52:08 -0500254 bool overBudget() const { return fCache->overBudget(); }
Robert Phillips26c90e02017-03-14 14:39:29 -0400255
Greg Daniel8982dc12018-01-05 12:56:15 -0500256 inline GrResourceProviderPriv priv();
257 inline const GrResourceProviderPriv priv() const;
258
bsalomoned0bcad2015-05-04 10:36:42 -0700259private:
Brian Salomond28a79d2017-10-16 13:01:07 -0400260 sk_sp<GrGpuResource> findResourceByUniqueKey(const GrUniqueKey&);
Robert Phillips3798c862017-03-27 11:08:16 -0400261
Greg Daniel29bf84f2017-09-25 12:25:12 -0400262 // Attempts to find a resource in the cache that exactly matches the GrSurfaceDesc. Failing that
263 // it returns null. If non-null, the resulting texture is always budgeted.
Chris Daltond004e0b2018-09-27 09:28:03 -0600264 sk_sp<GrTexture> refScratchTexture(const GrSurfaceDesc&, Flags);
Brian Osman32342f02017-03-04 08:12:46 -0500265
Robert Phillips45fdae12017-04-17 12:57:27 -0400266 /*
267 * Try to find an existing scratch texture that exactly matches 'desc'. If successful
268 * update the budgeting accordingly.
269 */
Chris Daltond004e0b2018-09-27 09:28:03 -0600270 sk_sp<GrTexture> getExactScratch(const GrSurfaceDesc&, SkBudgeted, Flags);
Robert Phillips45fdae12017-04-17 12:57:27 -0400271
Brian Osman32342f02017-03-04 08:12:46 -0500272 GrResourceCache* cache() { return fCache; }
273 const GrResourceCache* cache() const { return fCache; }
274
Greg Daniel8982dc12018-01-05 12:56:15 -0500275 friend class GrResourceProviderPriv;
276
277 // Method made available via GrResourceProviderPriv
Brian Osman32342f02017-03-04 08:12:46 -0500278 GrGpu* gpu() { return fGpu; }
279 const GrGpu* gpu() const { return fGpu; }
280
281 bool isAbandoned() const {
282 SkASSERT(SkToBool(fGpu) == SkToBool(fCache));
283 return !SkToBool(fCache);
284 }
285
Brian Salomondbf70722019-02-07 11:31:24 -0500286 sk_sp<const GrGpuBuffer> createPatternedIndexBuffer(const uint16_t* pattern,
287 int patternSize,
288 int reps,
289 int vertCount,
Brian Salomona29dd9d2019-02-07 13:27:18 -0500290 const GrUniqueKey* key);
bsalomoned0bcad2015-05-04 10:36:42 -0700291
Brian Salomondbf70722019-02-07 11:31:24 -0500292 sk_sp<const GrGpuBuffer> createQuadIndexBuffer();
bsalomoned0bcad2015-05-04 10:36:42 -0700293
Brian Salomona29dd9d2019-02-07 13:27:18 -0500294 GrResourceCache* fCache;
295 GrGpu* fGpu;
Robert Phillips26c90e02017-03-14 14:39:29 -0400296 sk_sp<const GrCaps> fCaps;
Brian Salomona29dd9d2019-02-07 13:27:18 -0500297 sk_sp<const GrGpuBuffer> fQuadIndexBuffer;
bsalomoned0bcad2015-05-04 10:36:42 -0700298
Brian Osman32342f02017-03-04 08:12:46 -0500299 // In debug builds we guard against improper thread handling
300 SkDEBUGCODE(mutable GrSingleOwner* fSingleOwner;)
bsalomond309e7a2015-04-30 14:18:54 -0700301};
302
Chris Daltond004e0b2018-09-27 09:28:03 -0600303GR_MAKE_BITFIELD_CLASS_OPS(GrResourceProvider::Flags);
304
bsalomond309e7a2015-04-30 14:18:54 -0700305#endif