blob: 695eb022e396b255b1958b7fbcd9a76a63a123ee [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
Brian Salomonf2c2ba92019-07-17 09:59:59 -040074 * and height as desc specifies. If renderable is kYes then the GrTexture will also be a
75 * GrRenderTarget. The texture's 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 */
Brian Salomon27b4d8d2019-07-22 14:23:45 -040078 sk_sp<GrTexture> createApproxTexture(const GrSurfaceDesc&, GrRenderable,
79 int renderTargetSampleCnt, GrProtected, Flags);
Brian Osman32342f02017-03-04 08:12:46 -050080
Brian Salomonf2c2ba92019-07-17 09:59:59 -040081 /** Create an exact fit texture with no initial data to upload. */
Brian Salomon27b4d8d2019-07-22 14:23:45 -040082 sk_sp<GrTexture> createTexture(const GrSurfaceDesc&, GrRenderable, int renderTargetSampleCnt,
83 SkBudgeted, GrProtected, Flags = Flags::kNone);
Brian Salomonf2c2ba92019-07-17 09:59:59 -040084
Brian Salomon27b4d8d2019-07-22 14:23:45 -040085 sk_sp<GrTexture> createTexture(const GrSurfaceDesc&, GrRenderable, int renderTargetSampleCnt,
86 SkBudgeted, GrProtected, const GrMipLevel texels[],
87 int mipLevelCount);
Brian Salomonf2c2ba92019-07-17 09:59:59 -040088
89 /** Create a potentially loose fit texture with the provided data */
Brian Salomon27b4d8d2019-07-22 14:23:45 -040090 sk_sp<GrTexture> createTexture(const GrSurfaceDesc&, GrRenderable, int renderTargetSampleCnt,
91 SkBudgeted, SkBackingFit, GrProtected, const GrMipLevel&, Flags);
Brian Salomonf2c2ba92019-07-17 09:59:59 -040092
93 /**
94 * Creates a compressed texture. The GrGpu must support the SkImageImage::Compression type.
95 * This does not currently support MIP maps. It will not be renderable.
Robert Phillipse78b7252017-04-06 07:59:41 -040096 */
Brian Salomonbb8dde82019-06-27 10:52:13 -040097 sk_sp<GrTexture> createCompressedTexture(int width, int height, SkImage::CompressionType,
98 SkBudgeted, SkData* data);
99
Brian Osman32342f02017-03-04 08:12:46 -0500100 ///////////////////////////////////////////////////////////////////////////
101 // Wrapped Backend Surfaces
102
103 /**
104 * Wraps an existing texture with a GrTexture object.
105 *
Brian Salomonc67c31c2018-12-06 10:00:03 -0500106 * GrIOType must either be kRead or kRW. kRead blocks any operations that would modify the
107 * pixels (e.g. dst for a copy, regenerating MIP levels, write pixels).
108 *
Brian Osman32342f02017-03-04 08:12:46 -0500109 * OpenGL: if the object is a texture Gr may change its GL texture params
110 * when it is drawn.
111 *
112 * @return GrTexture object or NULL on failure.
113 */
Robert Phillipsdd399802019-07-18 12:28:00 +0000114 sk_sp<GrTexture> wrapBackendTexture(const GrBackendTexture& tex, GrWrapOwnership,
Brian Salomonaa6ca0a2019-01-24 16:03:07 -0500115 GrWrapCacheable, GrIOType);
Brian Osman32342f02017-03-04 08:12:46 -0500116
117 /**
Brian Salomonbdecacf2018-02-02 20:32:49 -0500118 * This makes the backend texture be renderable. If sampleCnt is > 1 and the underlying API
Brian Salomond17f6582017-07-19 18:28:58 -0400119 * uses separate MSAA render buffers then a MSAA render buffer is created that resolves
120 * to the texture.
121 */
122 sk_sp<GrTexture> wrapRenderableBackendTexture(const GrBackendTexture& tex,
Brian Salomond17f6582017-07-19 18:28:58 -0400123 int sampleCnt,
Robert Phillips0902c982019-07-16 07:47:56 -0400124 GrColorType,
Brian Salomonaa6ca0a2019-01-24 16:03:07 -0500125 GrWrapOwnership,
126 GrWrapCacheable);
Brian Salomond17f6582017-07-19 18:28:58 -0400127
128 /**
Brian Osman32342f02017-03-04 08:12:46 -0500129 * Wraps an existing render target with a GrRenderTarget object. It is
130 * similar to wrapBackendTexture but can be used to draw into surfaces
131 * that are not also textures (e.g. FBO 0 in OpenGL, or an MSAA buffer that
132 * the client will resolve to a texture). Currently wrapped render targets
Brian Salomonaa6ca0a2019-01-24 16:03:07 -0500133 * always use the kBorrow_GrWrapOwnership and GrWrapCacheable::kNo semantics.
Brian Osman32342f02017-03-04 08:12:46 -0500134 *
135 * @return GrRenderTarget object or NULL on failure.
136 */
Robert Phillipsdd399802019-07-18 12:28:00 +0000137 sk_sp<GrRenderTarget> wrapBackendRenderTarget(const GrBackendRenderTarget&);
Brian Osman32342f02017-03-04 08:12:46 -0500138
Greg Danielb46add82019-01-02 14:51:29 -0500139 sk_sp<GrRenderTarget> wrapVulkanSecondaryCBAsRenderTarget(const SkImageInfo&,
140 const GrVkDrawableInfo&);
141
Robert Phillips1bfece82017-06-01 13:56:52 -0400142 static const uint32_t kMinScratchTextureSize;
Brian Osman32342f02017-03-04 08:12:46 -0500143
bsalomoned0bcad2015-05-04 10:36:42 -0700144 /**
Chris Dalton5d2de082017-12-19 10:40:23 -0700145 * Either finds and refs, or creates a static buffer with the given parameters and contents.
146 *
147 * @param intendedType hint to the graphics subsystem about what the buffer will be used for.
148 * @param size minimum size of buffer to return.
149 * @param data optional data with which to initialize the buffer.
150 * @param key Key to be assigned to the buffer.
151 *
152 * @return The buffer if successful, otherwise nullptr.
153 */
Brian Salomondbf70722019-02-07 11:31:24 -0500154 sk_sp<const GrGpuBuffer> findOrMakeStaticBuffer(GrGpuBufferType intendedType, size_t size,
155 const void* data, const GrUniqueKey& key);
Chris Dalton5d2de082017-12-19 10:40:23 -0700156
157 /**
Chris Daltonff926502017-05-03 14:36:54 -0400158 * Either finds and refs, or creates an index buffer with a repeating pattern for drawing
159 * contiguous vertices of a repeated mesh. If the return is non-null, the caller owns a ref on
160 * the returned GrBuffer.
bsalomoned0bcad2015-05-04 10:36:42 -0700161 *
162 * @param pattern the pattern of indices to repeat
163 * @param patternSize size in bytes of the pattern
164 * @param reps number of times to repeat the pattern
165 * @param vertCount number of vertices the pattern references
166 * @param key Key to be assigned to the index buffer.
167 *
halcanary96fcdcc2015-08-27 07:41:13 -0700168 * @return The index buffer if successful, otherwise nullptr.
bsalomoned0bcad2015-05-04 10:36:42 -0700169 */
Brian Salomondbf70722019-02-07 11:31:24 -0500170 sk_sp<const GrGpuBuffer> findOrCreatePatternedIndexBuffer(const uint16_t* pattern,
171 int patternSize,
172 int reps,
173 int vertCount,
174 const GrUniqueKey& key) {
Brian Salomona29dd9d2019-02-07 13:27:18 -0500175 if (auto buffer = this->findByUniqueKey<const GrGpuBuffer>(key)) {
176 return buffer;
bsalomoned0bcad2015-05-04 10:36:42 -0700177 }
Brian Salomona29dd9d2019-02-07 13:27:18 -0500178 return this->createPatternedIndexBuffer(pattern, patternSize, reps, vertCount, &key);
bsalomoned0bcad2015-05-04 10:36:42 -0700179 }
180
181 /**
182 * Returns an index buffer that can be used to render quads.
Brian Salomon57caa662017-10-18 12:21:05 +0000183 * Six indices per quad: 0, 1, 2, 2, 1, 3, etc.
Brian Salomon763abf02018-05-01 18:49:38 +0000184 * The max number of quads is the buffer's index capacity divided by 6.
Chris Dalton3809bab2017-06-13 10:55:06 -0600185 * Draw with GrPrimitiveType::kTriangles
Brian Salomon763abf02018-05-01 18:49:38 +0000186 * @ return the quad index buffer
bsalomoned0bcad2015-05-04 10:36:42 -0700187 */
Brian Salomondbf70722019-02-07 11:31:24 -0500188 sk_sp<const GrGpuBuffer> refQuadIndexBuffer() {
Brian Salomona29dd9d2019-02-07 13:27:18 -0500189 if (!fQuadIndexBuffer) {
190 fQuadIndexBuffer = this->createQuadIndexBuffer();
bsalomoned0bcad2015-05-04 10:36:42 -0700191 }
Brian Salomona29dd9d2019-02-07 13:27:18 -0500192 return fQuadIndexBuffer;
bsalomoned0bcad2015-05-04 10:36:42 -0700193 }
194
Brian Salomon34169692017-08-28 15:32:01 -0400195 static int QuadCountOfQuadBuffer();
196
bsalomon706f08f2015-05-22 07:35:58 -0700197 /**
Ben Wagner3746ac22018-03-29 11:46:24 -0400198 * Factories for GrPath objects. It's an error to call these if path rendering
bsalomon706f08f2015-05-22 07:35:58 -0700199 * is not supported.
200 */
Robert Phillips67d52cf2017-06-05 13:38:13 -0400201 sk_sp<GrPath> createPath(const SkPath&, const GrStyle&);
bsalomon706f08f2015-05-22 07:35:58 -0700202
cdaltone2e71c22016-04-07 18:13:29 -0700203 /**
204 * Returns a buffer.
205 *
206 * @param size minimum size of buffer to return.
207 * @param intendedType hint to the graphics subsystem about what the buffer will be used for.
208 * @param GrAccessPattern hint to the graphics subsystem about how the data will be accessed.
209 * @param flags see Flags enum.
cdalton1bf3e712016-04-19 10:00:02 -0700210 * @param data optional data with which to initialize the buffer.
cdaltone2e71c22016-04-07 18:13:29 -0700211 *
212 * @return the buffer if successful, otherwise nullptr.
213 */
Brian Salomondbf70722019-02-07 11:31:24 -0500214 sk_sp<GrGpuBuffer> createBuffer(size_t size, GrGpuBufferType intendedType, GrAccessPattern,
215 const void* data = nullptr);
robertphillips1b8e1b52015-06-24 06:54:10 -0700216
Brian Salomon2ee084e2016-12-16 18:59:19 -0500217 /**
Chris Daltoneffee202019-07-01 22:28:03 -0600218 * If passed in render target already has a stencil buffer with at least "numSamples" samples,
219 * return true. Otherwise attempt to attach one and return true on success.
egdanielec00d942015-09-14 12:56:10 -0700220 */
Chris Daltoneffee202019-07-01 22:28:03 -0600221 bool attachStencilAttachment(GrRenderTarget* rt, int numStencilSamples);
egdanielec00d942015-09-14 12:56:10 -0700222
ericrkf7b8b8a2016-02-24 14:49:51 -0800223 /**
224 * Wraps an existing texture with a GrRenderTarget object. This is useful when the provided
225 * texture has a format that cannot be textured from by Skia, but we want to raster to it.
226 *
kkinnunen49c4c222016-04-01 04:50:37 -0700227 * The texture is wrapped as borrowed. The texture object will not be freed once the
228 * render target is destroyed.
229 *
ericrkf7b8b8a2016-02-24 14:49:51 -0800230 * @return GrRenderTarget object or NULL on failure.
231 */
Greg Daniel7ef28f32017-04-20 16:41:55 +0000232 sk_sp<GrRenderTarget> wrapBackendTextureAsRenderTarget(const GrBackendTexture&,
Robert Phillipsdd399802019-07-18 12:28:00 +0000233 int sampleCnt);
ericrkf7b8b8a2016-02-24 14:49:51 -0800234
Brian Osman32342f02017-03-04 08:12:46 -0500235 /**
236 * Assigns a unique key to a resource. If the key is associated with another resource that
237 * association is removed and replaced by this resource.
238 */
239 void assignUniqueKeyToResource(const GrUniqueKey&, GrGpuResource*);
240
Greg Daniela5cb7812017-06-16 09:45:32 -0400241 sk_sp<GrSemaphore> SK_WARN_UNUSED_RESULT makeSemaphore(bool isOwned = true);
242
Greg Daniel17b7c052018-01-09 13:55:33 -0500243 enum class SemaphoreWrapType {
244 kWillSignal,
245 kWillWait,
246 };
247
Greg Daniela5cb7812017-06-16 09:45:32 -0400248 sk_sp<GrSemaphore> wrapBackendSemaphore(const GrBackendSemaphore&,
Greg Daniel17b7c052018-01-09 13:55:33 -0500249 SemaphoreWrapType wrapType,
Greg Daniela5cb7812017-06-16 09:45:32 -0400250 GrWrapOwnership = kBorrow_GrWrapOwnership);
Greg Danield85f97d2017-03-07 13:37:21 -0500251
Brian Osman32342f02017-03-04 08:12:46 -0500252 void abandon() {
Robert Phillips26c90e02017-03-14 14:39:29 -0400253 fCache = nullptr;
254 fGpu = nullptr;
Brian Osman32342f02017-03-04 08:12:46 -0500255 }
256
Brian Salomon238069b2018-07-11 15:58:57 -0400257 uint32_t contextUniqueID() const { return fCache->contextUniqueID(); }
Robert Phillips26c90e02017-03-14 14:39:29 -0400258 const GrCaps* caps() const { return fCaps.get(); }
Robert Phillipseafd48a2017-11-16 07:52:08 -0500259 bool overBudget() const { return fCache->overBudget(); }
Robert Phillips26c90e02017-03-14 14:39:29 -0400260
Robert Phillipsf9fcf7f2019-07-11 09:03:27 -0400261 static uint32_t MakeApprox(uint32_t value);
262
Greg Daniel8982dc12018-01-05 12:56:15 -0500263 inline GrResourceProviderPriv priv();
264 inline const GrResourceProviderPriv priv() const;
265
bsalomoned0bcad2015-05-04 10:36:42 -0700266private:
Brian Salomond28a79d2017-10-16 13:01:07 -0400267 sk_sp<GrGpuResource> findResourceByUniqueKey(const GrUniqueKey&);
Robert Phillips3798c862017-03-27 11:08:16 -0400268
Greg Daniel29bf84f2017-09-25 12:25:12 -0400269 // Attempts to find a resource in the cache that exactly matches the GrSurfaceDesc. Failing that
270 // it returns null. If non-null, the resulting texture is always budgeted.
Brian Salomon27b4d8d2019-07-22 14:23:45 -0400271 sk_sp<GrTexture> refScratchTexture(const GrSurfaceDesc&, GrRenderable,
272 int renderTargetSampleCnt, GrProtected, Flags);
Brian Osman32342f02017-03-04 08:12:46 -0500273
Robert Phillips45fdae12017-04-17 12:57:27 -0400274 /*
275 * Try to find an existing scratch texture that exactly matches 'desc'. If successful
276 * update the budgeting accordingly.
277 */
Brian Salomon27b4d8d2019-07-22 14:23:45 -0400278 sk_sp<GrTexture> getExactScratch(const GrSurfaceDesc&, GrRenderable, int renderTargetSampleCnt,
279 SkBudgeted, GrProtected, Flags);
Robert Phillips45fdae12017-04-17 12:57:27 -0400280
Brian Osman32342f02017-03-04 08:12:46 -0500281 GrResourceCache* cache() { return fCache; }
282 const GrResourceCache* cache() const { return fCache; }
283
Greg Daniel8982dc12018-01-05 12:56:15 -0500284 friend class GrResourceProviderPriv;
285
286 // Method made available via GrResourceProviderPriv
Brian Osman32342f02017-03-04 08:12:46 -0500287 GrGpu* gpu() { return fGpu; }
288 const GrGpu* gpu() const { return fGpu; }
289
290 bool isAbandoned() const {
291 SkASSERT(SkToBool(fGpu) == SkToBool(fCache));
292 return !SkToBool(fCache);
293 }
294
Brian Salomondbf70722019-02-07 11:31:24 -0500295 sk_sp<const GrGpuBuffer> createPatternedIndexBuffer(const uint16_t* pattern,
296 int patternSize,
297 int reps,
298 int vertCount,
Brian Salomona29dd9d2019-02-07 13:27:18 -0500299 const GrUniqueKey* key);
bsalomoned0bcad2015-05-04 10:36:42 -0700300
Brian Salomondbf70722019-02-07 11:31:24 -0500301 sk_sp<const GrGpuBuffer> createQuadIndexBuffer();
bsalomoned0bcad2015-05-04 10:36:42 -0700302
Brian Salomona29dd9d2019-02-07 13:27:18 -0500303 GrResourceCache* fCache;
304 GrGpu* fGpu;
Robert Phillips26c90e02017-03-14 14:39:29 -0400305 sk_sp<const GrCaps> fCaps;
Brian Salomona29dd9d2019-02-07 13:27:18 -0500306 sk_sp<const GrGpuBuffer> fQuadIndexBuffer;
bsalomoned0bcad2015-05-04 10:36:42 -0700307
Brian Osman32342f02017-03-04 08:12:46 -0500308 // In debug builds we guard against improper thread handling
309 SkDEBUGCODE(mutable GrSingleOwner* fSingleOwner;)
bsalomond309e7a2015-04-30 14:18:54 -0700310};
311
Chris Daltond004e0b2018-09-27 09:28:03 -0600312GR_MAKE_BITFIELD_CLASS_OPS(GrResourceProvider::Flags);
313
bsalomond309e7a2015-04-30 14:18:54 -0700314#endif