blob: f49590dcaea520111048071835b949ae263f556a [file] [log] [blame]
reed@google.comac10a2d2010-12-22 21:39:39 +00001/*
epoger@google.comec3ed6a2011-07-28 14:26:00 +00002 * Copyright 2011 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.
reed@google.comac10a2d2010-12-22 21:39:39 +00006 */
7
reed@google.comac10a2d2010-12-22 21:39:39 +00008#ifndef GrGpu_DEFINED
9#define GrGpu_DEFINED
10
Mike Kleinc0bd9f92019-04-23 12:05:21 -050011#include "include/core/SkPath.h"
12#include "include/core/SkSurface.h"
13#include "include/gpu/GrTypes.h"
14#include "include/private/SkTArray.h"
15#include "src/gpu/GrAllocator.h"
16#include "src/gpu/GrCaps.h"
17#include "src/gpu/GrGpuCommandBuffer.h"
18#include "src/gpu/GrProgramDesc.h"
19#include "src/gpu/GrSamplePatternDictionary.h"
20#include "src/gpu/GrSwizzle.h"
21#include "src/gpu/GrTextureProducer.h"
22#include "src/gpu/GrXferProcessor.h"
csmartdalton0d28e572016-07-06 09:59:43 -070023#include <map>
sugoi@google.com12b4e272012-12-06 20:13:11 +000024
Greg Danielbcf612b2017-05-01 13:50:58 +000025class GrBackendRenderTarget;
Greg Daniela5cb7812017-06-16 09:45:32 -040026class GrBackendSemaphore;
Brian Salomondbf70722019-02-07 11:31:24 -050027class GrGpuBuffer;
bsalomon@google.com669fdc42011-04-05 17:08:27 +000028class GrContext;
robertphillips28a838e2016-06-23 14:07:00 -070029struct GrContextOptions;
reedf9ad5582015-06-25 21:29:25 -070030class GrGLContext;
Chris Daltonbca46e22017-05-15 11:03:26 -060031class GrMesh;
bsalomon@google.com64aef2b2012-06-11 15:36:13 +000032class GrPath;
bsalomon@google.com30085192011-08-19 15:42:31 +000033class GrPathRenderer;
34class GrPathRendererChain;
kkinnunencabe20c2015-06-01 01:37:26 -070035class GrPathRendering;
egdaniel8dd688b2015-01-22 10:16:09 -080036class GrPipeline;
joshualitt873ad0e2015-01-20 09:08:51 -080037class GrPrimitiveProcessor;
kkinnunencabe20c2015-06-01 01:37:26 -070038class GrRenderTarget;
Greg Daniel6be35232017-03-01 17:01:09 -050039class GrSemaphore;
egdaniel8dc7c3a2015-04-16 11:22:42 -070040class GrStencilAttachment;
cdalton93a379b2016-05-11 13:58:08 -070041class GrStencilSettings;
kkinnunencabe20c2015-06-01 01:37:26 -070042class GrSurface;
43class GrTexture;
Brian Osman71a18892017-08-10 10:23:25 -040044class SkJSONWriter;
reed@google.comac10a2d2010-12-22 21:39:39 +000045
joshualitt3322fa42014-11-07 08:48:51 -080046class GrGpu : public SkRefCnt {
reed@google.comac10a2d2010-12-22 21:39:39 +000047public:
bsalomon@google.com6e4e6502013-02-25 20:12:45 +000048 GrGpu(GrContext* context);
mtklein36352bf2015-03-25 18:17:31 -070049 ~GrGpu() override;
reed@google.comac10a2d2010-12-22 21:39:39 +000050
joshualitt3322fa42014-11-07 08:48:51 -080051 GrContext* getContext() { return fContext; }
52 const GrContext* getContext() const { return fContext; }
53
54 /**
55 * Gets the capabilities of the draw target.
56 */
bsalomon4b91f762015-05-19 09:29:46 -070057 const GrCaps* caps() const { return fCaps.get(); }
Robert Phillipse42edcc2017-12-13 11:50:22 -050058 sk_sp<const GrCaps> refCaps() const { return fCaps; }
joshualitt3322fa42014-11-07 08:48:51 -080059
kkinnunencabe20c2015-06-01 01:37:26 -070060 GrPathRendering* pathRendering() { return fPathRendering.get(); }
kkinnunenccdaa042014-08-20 01:36:23 -070061
bsalomon6e2aad42016-04-01 11:54:31 -070062 enum class DisconnectType {
63 // No cleanup should be attempted, immediately cease making backend API calls
64 kAbandon,
65 // Free allocated resources (not known by GrResourceCache) before returning and
66 // ensure no backend backend 3D API calls will be made after disconnect() returns.
67 kCleanup,
68 };
69
70 // Called by GrContext when the underlying backend context is already or will be destroyed
71 // before GrContext.
72 virtual void disconnect(DisconnectType);
bsalomonc8dc1f72014-08-21 13:02:13 -070073
reed@google.comac10a2d2010-12-22 21:39:39 +000074 /**
75 * The GrGpu object normally assumes that no outsider is setting state
76 * within the underlying 3D API's context/device/whatever. This call informs
bsalomon@google.coma7f84e12011-03-10 14:13:19 +000077 * the GrGpu that the state was modified and it shouldn't make assumptions
78 * about the state.
reed@google.comac10a2d2010-12-22 21:39:39 +000079 */
mtkleinb9eb4ac2015-02-02 18:26:03 -080080 void markContextDirty(uint32_t state = kAll_GrBackendState) { fResetBits |= state; }
reed@google.comac10a2d2010-12-22 21:39:39 +000081
82 /**
bsalomon6d467ec2014-11-18 07:36:19 -080083 * Creates a texture object. If kRenderTarget_GrSurfaceFlag the texture can
84 * be used as a render target by calling GrTexture::asRenderTarget(). Not all
85 * pixel configs can be used as render targets. Support for configs as textures
bsalomon4b91f762015-05-19 09:29:46 -070086 * or render targets can be checked using GrCaps.
bsalomon@google.com1da07462011-03-10 14:51:57 +000087 *
Brian Salomon58389b92018-03-07 13:01:25 -050088 * @param desc describes the texture to be created.
89 * @param budgeted does this texture count against the resource cache budget?
90 * @param texels array of mipmap levels containing texel data to load.
91 * Each level begins with full-size palette data for paletted textures.
92 * It contains width*height texels. If there is only one
93 * element and it contains nullptr fPixels, texture data is
94 * uninitialized.
95 * @param mipLevelCount the number of levels in 'texels'
96 * @return The texture object if successful, otherwise nullptr.
reed@google.comac10a2d2010-12-22 21:39:39 +000097 */
Brian Salomon58389b92018-03-07 13:01:25 -050098 sk_sp<GrTexture> createTexture(const GrSurfaceDesc&, SkBudgeted, const GrMipLevel texels[],
99 int mipLevelCount);
cblume55f2d2d2016-02-26 13:20:48 -0800100
101 /**
bsalomone699d0c2016-03-09 06:25:15 -0800102 * Simplified createTexture() interface for when there is no initial texel data to upload.
cblume55f2d2d2016-02-26 13:20:48 -0800103 */
Robert Phillips16d8ec62017-07-27 16:16:25 -0400104 sk_sp<GrTexture> createTexture(const GrSurfaceDesc& desc, SkBudgeted);
bsalomone699d0c2016-03-09 06:25:15 -0800105
bsalomon@google.come269f212011-11-07 13:29:52 +0000106 /**
Brian Osman32342f02017-03-04 08:12:46 -0500107 * Implements GrResourceProvider::wrapBackendTexture
bsalomon@google.come269f212011-11-07 13:29:52 +0000108 */
Brian Salomonfa2ebea2019-01-24 15:58:58 -0500109 sk_sp<GrTexture> wrapBackendTexture(const GrBackendTexture&, GrWrapOwnership, GrWrapCacheable,
110 GrIOType);
Brian Salomond17f6582017-07-19 18:28:58 -0400111
112 /**
113 * Implements GrResourceProvider::wrapRenderableBackendTexture
114 */
Brian Salomonaa6ca0a2019-01-24 16:03:07 -0500115 sk_sp<GrTexture> wrapRenderableBackendTexture(const GrBackendTexture&, int sampleCnt,
116 GrWrapOwnership, GrWrapCacheable);
bsalomon@google.come269f212011-11-07 13:29:52 +0000117
118 /**
Brian Osman32342f02017-03-04 08:12:46 -0500119 * Implements GrResourceProvider::wrapBackendRenderTarget
bsalomon@google.come269f212011-11-07 13:29:52 +0000120 */
Robert Phillipsb0e93a22017-08-29 08:26:54 -0400121 sk_sp<GrRenderTarget> wrapBackendRenderTarget(const GrBackendRenderTarget&);
bsalomon@google.come269f212011-11-07 13:29:52 +0000122
123 /**
Brian Osman32342f02017-03-04 08:12:46 -0500124 * Implements GrResourceProvider::wrapBackendTextureAsRenderTarget
ericrkf7b8b8a2016-02-24 14:49:51 -0800125 */
Greg Daniel7ef28f32017-04-20 16:41:55 +0000126 sk_sp<GrRenderTarget> wrapBackendTextureAsRenderTarget(const GrBackendTexture&,
Greg Daniel7ef28f32017-04-20 16:41:55 +0000127 int sampleCnt);
ericrkf7b8b8a2016-02-24 14:49:51 -0800128
129 /**
Greg Danielb46add82019-01-02 14:51:29 -0500130 * Implements GrResourceProvider::wrapVulkanSecondaryCBAsRenderTarget
131 */
132 sk_sp<GrRenderTarget> wrapVulkanSecondaryCBAsRenderTarget(const SkImageInfo&,
133 const GrVkDrawableInfo&);
134
135 /**
csmartdalton485a1202016-07-13 10:16:32 -0700136 * Creates a buffer in GPU memory. For a client-side buffer use GrBuffer::CreateCPUBacked.
reed@google.comac10a2d2010-12-22 21:39:39 +0000137 *
cdaltone2e71c22016-04-07 18:13:29 -0700138 * @param size size of buffer to create.
139 * @param intendedType hint to the graphics subsystem about what the buffer will be used for.
140 * @param accessPattern hint to the graphics subsystem about how the data will be accessed.
cdalton1bf3e712016-04-19 10:00:02 -0700141 * @param data optional data with which to initialize the buffer.
cdaltone2e71c22016-04-07 18:13:29 -0700142 *
cdalton397536c2016-03-25 12:15:03 -0700143 * @return the buffer if successful, otherwise nullptr.
reed@google.comac10a2d2010-12-22 21:39:39 +0000144 */
Brian Salomondbf70722019-02-07 11:31:24 -0500145 sk_sp<GrGpuBuffer> createBuffer(size_t size, GrGpuBufferType intendedType,
146 GrAccessPattern accessPattern, const void* data = nullptr);
halcanary9d524f22016-03-29 09:03:52 -0700147
reed@google.comac10a2d2010-12-22 21:39:39 +0000148 /**
bsalomon@google.com75f9f252012-01-31 13:35:56 +0000149 * Resolves MSAA.
150 */
Brian Salomon1fabd512018-02-09 09:54:25 -0500151 void resolveRenderTarget(GrRenderTarget*);
bsalomon@google.com75f9f252012-01-31 13:35:56 +0000152
bsalomon@google.coma85449d2011-11-19 02:36:05 +0000153 /**
Brian Salomon930f9392018-06-20 16:25:26 -0400154 * Uses the base of the texture to recompute the contents of the other levels.
155 */
156 bool regenerateMipMapLevels(GrTexture*);
157
158 /**
Brian Salomon1f05d452019-02-08 12:33:08 -0500159 * If the backend API has stateful texture bindings, this resets them back to defaults.
160 */
161 void resetTextureBindings();
162
163 /**
Brian Salomon9b009bb2018-02-14 13:53:55 -0500164 * Reads a rectangle of pixels from a render target. No sRGB/linear conversions are performed.
bsalomon@google.comc4364992011-11-07 15:54:49 +0000165 *
bsalomon6cb3cbe2015-07-30 07:34:27 -0700166 * @param surface The surface to read from
bsalomon@google.com669fdc42011-04-05 17:08:27 +0000167 * @param left left edge of the rectangle to read (inclusive)
168 * @param top top edge of the rectangle to read (inclusive)
169 * @param width width of rectangle to read in pixels.
170 * @param height height of rectangle to read in pixels.
Brian Salomonc320b152018-02-20 14:05:36 -0500171 * @param dstColorType the color type of the destination buffer.
bsalomon@google.com669fdc42011-04-05 17:08:27 +0000172 * @param buffer memory to read the rectangle into.
bsalomon@google.comc6980972011-11-02 19:57:21 +0000173 * @param rowBytes the number of bytes between consecutive rows. Zero
174 * means rows are tightly packed.
bsalomon@google.comc4364992011-11-07 15:54:49 +0000175 * @param invertY buffer should be populated bottom-to-top as opposed
176 * to top-to-bottom (skia's usual order)
bsalomon@google.coma7f84e12011-03-10 14:13:19 +0000177 *
178 * @return true if the read succeeded, false if not. The read can fail
179 * because of a unsupported pixel config or because no render
180 * target is currently set.
181 */
Brian Salomon19eaf2d2018-03-19 16:06:44 -0400182 bool readPixels(GrSurface* surface, int left, int top, int width, int height,
Brian Salomona6948702018-06-01 15:33:20 -0400183 GrColorType dstColorType, void* buffer, size_t rowBytes);
reed@google.comac10a2d2010-12-22 21:39:39 +0000184
bsalomon@google.com6f379512011-11-16 20:36:03 +0000185 /**
Brian Salomon9b009bb2018-02-14 13:53:55 -0500186 * Updates the pixels in a rectangle of a surface. No sRGB/linear conversions are performed.
bsalomon@google.coma85449d2011-11-19 02:36:05 +0000187 *
bsalomon6cb3cbe2015-07-30 07:34:27 -0700188 * @param surface The surface to write to.
bsalomon@google.com6f379512011-11-16 20:36:03 +0000189 * @param left left edge of the rectangle to write (inclusive)
190 * @param top top edge of the rectangle to write (inclusive)
191 * @param width width of rectangle to write in pixels.
192 * @param height height of rectangle to write in pixels.
Brian Salomonc320b152018-02-20 14:05:36 -0500193 * @param srcColorType the color type of the source buffer.
cblume55f2d2d2016-02-26 13:20:48 -0800194 * @param texels array of mipmap levels containing texture data
Robert Phillips590533f2017-07-11 14:22:35 -0400195 * @param mipLevelCount number of levels in 'texels'
cblume55f2d2d2016-02-26 13:20:48 -0800196 */
Brian Salomona9b04b92018-06-01 15:04:28 -0400197 bool writePixels(GrSurface* surface, int left, int top, int width, int height,
198 GrColorType srcColorType, const GrMipLevel texels[], int mipLevelCount);
cblume55f2d2d2016-02-26 13:20:48 -0800199
200 /**
Brian Salomona9b04b92018-06-01 15:04:28 -0400201 * Helper for the case of a single level.
Brian Salomon5f33a8c2018-02-26 14:32:39 -0500202 */
203 bool writePixels(GrSurface* surface, int left, int top, int width, int height,
204 GrColorType srcColorType, const void* buffer, size_t rowBytes) {
Brian Salomona9b04b92018-06-01 15:04:28 -0400205 GrMipLevel mipLevel = {buffer, rowBytes};
206 return this->writePixels(surface, left, top, width, height, srcColorType, &mipLevel, 1);
Brian Salomon5f33a8c2018-02-26 14:32:39 -0500207 }
208
209 /**
Brian Salomone05ba5a2019-04-08 11:59:07 -0400210 * Updates the pixels in a rectangle of a texture using a buffer. If the texture is MIP mapped,
211 * the base level is written to.
Jim Van Verth2e5eaf02017-06-21 15:55:46 -0400212 *
213 * @param texture The texture to write to.
cdalton397536c2016-03-25 12:15:03 -0700214 * @param left left edge of the rectangle to write (inclusive)
215 * @param top top edge of the rectangle to write (inclusive)
216 * @param width width of rectangle to write in pixels.
217 * @param height height of rectangle to write in pixels.
Brian Salomonc320b152018-02-20 14:05:36 -0500218 * @param bufferColorType the color type of the transfer buffer's pixel data
Jim Van Verth2e5eaf02017-06-21 15:55:46 -0400219 * @param transferBuffer GrBuffer to read pixels from (type must be "kXferCpuToGpu")
cdalton397536c2016-03-25 12:15:03 -0700220 * @param offset offset from the start of the buffer
Jim Van Verth2e5eaf02017-06-21 15:55:46 -0400221 * @param rowBytes number of bytes between consecutive rows in the buffer. Zero
cdalton397536c2016-03-25 12:15:03 -0700222 * means rows are tightly packed.
jvanverth17aa0472016-01-05 10:41:27 -0800223 */
Brian Salomone05ba5a2019-04-08 11:59:07 -0400224 bool transferPixelsTo(GrTexture* texture, int left, int top, int width, int height,
225 GrColorType bufferColorType, GrGpuBuffer* transferBuffer, size_t offset,
226 size_t rowBytes);
227
228 /**
229 * Reads the pixels from a rectangle of a surface into a buffer. Use
Brian Salomon26de56e2019-04-10 12:14:26 -0400230 * GrCaps::transferFromOffsetAlignment to determine the requirements for the buffer offset
231 * alignment. If the surface is a MIP mapped texture, the base level is read.
Brian Salomone05ba5a2019-04-08 11:59:07 -0400232 *
Brian Salomon26de56e2019-04-10 12:14:26 -0400233 * If successful the row bytes in the buffer is always:
234 * GrColorTypeBytesPerPixel(bufferColorType) * width
235 *
236 * Asserts that the caller has passed a properly aligned offset and that the buffer is
237 * large enough to hold the result
Brian Salomone05ba5a2019-04-08 11:59:07 -0400238 *
239 * @param surface The surface to read from.
240 * @param left left edge of the rectangle to read (inclusive)
241 * @param top top edge of the rectangle to read (inclusive)
242 * @param width width of rectangle to read in pixels.
243 * @param height height of rectangle to read in pixels.
244 * @param bufferColorType the color type of the transfer buffer's pixel data
245 * @param transferBuffer GrBuffer to write pixels to (type must be "kXferGpuToCpu")
246 * @param offset offset from the start of the buffer
247 */
Brian Salomon26de56e2019-04-10 12:14:26 -0400248 bool transferPixelsFrom(GrSurface* surface, int left, int top, int width, int height,
249 GrColorType bufferColorType, GrGpuBuffer* transferBuffer,
250 size_t offset);
jvanverth17aa0472016-01-05 10:41:27 -0800251
bsalomon@google.com80d09b92011-11-05 21:21:13 +0000252 // After the client interacts directly with the 3D context state the GrGpu
253 // must resync its internal state and assumptions about 3D context state.
254 // Each time this occurs the GrGpu bumps a timestamp.
255 // state of the 3D context
256 // At 10 resets / frame and 60fps a 64bit timestamp will overflow in about
257 // a billion years.
258 typedef uint64_t ResetTimestamp;
259
260 // This timestamp is always older than the current timestamp
261 static const ResetTimestamp kExpiredTimestamp = 0;
262 // Returns a timestamp based on the number of times the context was reset.
263 // This timestamp can be used to lazily detect when cached 3D context state
264 // is dirty.
bsalomon6d467ec2014-11-18 07:36:19 -0800265 ResetTimestamp getResetTimestamp() const { return fResetTimestamp; }
bsalomon@google.com80d09b92011-11-05 21:21:13 +0000266
bsalomonf90a02b2014-11-26 12:28:00 -0800267 // Called to perform a surface to surface copy. Fallbacks to issuing a draw from the src to dst
Robert Phillipsf2361d22016-10-25 14:20:06 -0400268 // take place at the GrOpList level and this function implement faster copy paths. The rect
bsalomonf90a02b2014-11-26 12:28:00 -0800269 // and point are pre-clipped. The src rect and implied dst rect are guaranteed to be within the
Greg Daniel55fa6472018-03-16 16:13:10 -0400270 // src/dst bounds and non-empty. If canDiscardOutsideDstRect is set to true then we don't need
271 // to preserve any data on the dst surface outside of the copy.
Robert Phillipsb0e93a22017-08-29 08:26:54 -0400272 bool copySurface(GrSurface* dst, GrSurfaceOrigin dstOrigin,
273 GrSurface* src, GrSurfaceOrigin srcOrigin,
joshualitt1cbdcde2015-08-21 11:53:29 -0700274 const SkIRect& srcRect,
Greg Daniel55fa6472018-03-16 16:13:10 -0400275 const SkIPoint& dstPoint,
276 bool canDiscardOutsideDstRect = false);
joshualitt3322fa42014-11-07 08:48:51 -0800277
Chris Daltond7291ba2019-03-07 14:17:03 -0700278 // Queries the per-pixel HW sample locations for the given render target, and then finds or
279 // assigns a key that uniquely identifies the sample pattern. The actual sample locations can be
280 // retrieved with retrieveSampleLocations().
Chris Dalton8c4cafd2019-04-15 19:14:36 -0600281 int findOrAssignSamplePatternKey(GrRenderTarget*);
Chris Daltond7291ba2019-03-07 14:17:03 -0700282
283 // Retrieves the per-pixel HW sample locations for the given sample pattern key, and, as a
284 // by-product, the actual number of samples in use. (This may differ from the number of samples
285 // requested by the render target.) Sample locations are returned as 0..1 offsets relative to
286 // the top-left corner of the pixel.
287 const SkTArray<SkPoint>& retrieveSampleLocations(int samplePatternKey) const {
288 return fSamplePatternDictionary.retrieveSampleLocations(samplePatternKey);
289 }
290
Robert Phillips5b5d84c2018-08-09 15:12:18 -0400291 // Returns a GrGpuRTCommandBuffer which GrOpLists send draw commands to instead of directly
Ethan Nicholas56d19a52018-10-15 11:26:20 -0400292 // to the Gpu object. The 'bounds' rect is the content rect of the destination.
Robert Phillips5b5d84c2018-08-09 15:12:18 -0400293 virtual GrGpuRTCommandBuffer* getCommandBuffer(
Ethan Nicholas56d19a52018-10-15 11:26:20 -0400294 GrRenderTarget*, GrSurfaceOrigin, const SkRect& bounds,
Greg Daniel500d58b2017-08-24 15:59:33 -0400295 const GrGpuRTCommandBuffer::LoadAndStoreInfo&,
296 const GrGpuRTCommandBuffer::StencilLoadAndStoreInfo&) = 0;
297
Robert Phillips5b5d84c2018-08-09 15:12:18 -0400298 // Returns a GrGpuTextureCommandBuffer which GrOpLists send texture commands to instead of
Greg Daniel500d58b2017-08-24 15:59:33 -0400299 // directly to the Gpu object.
Robert Phillips5b5d84c2018-08-09 15:12:18 -0400300 virtual GrGpuTextureCommandBuffer* getCommandBuffer(GrTexture*, GrSurfaceOrigin) = 0;
bsalomon3e791242014-12-17 13:43:13 -0800301
Robert Phillips18e94842017-05-15 13:06:44 -0400302 // Called by GrDrawingManager when flushing.
Greg Daniel51316782017-08-02 15:10:09 +0000303 // Provides a hook for post-flush actions (e.g. Vulkan command buffer submits). This will also
304 // insert any numSemaphore semaphores on the gpu and set the backendSemaphores to match the
305 // inserted semaphores.
Brian Salomonf9a1fdf2019-05-09 10:30:12 -0400306 GrSemaphoresSubmitted finishFlush(GrSurfaceProxy*[], int n,
Greg Daniel797efca2019-05-09 14:04:20 -0400307 SkSurface::BackendSurfaceAccess access, const GrFlushInfo&,
308 const GrPrepareForExternalIORequests&);
ethannicholas22793252016-01-30 09:59:10 -0800309
Robert Phillips5b5d84c2018-08-09 15:12:18 -0400310 virtual void submit(GrGpuCommandBuffer*) = 0;
311
Greg Daniel6be35232017-03-01 17:01:09 -0500312 virtual GrFence SK_WARN_UNUSED_RESULT insertFence() = 0;
313 virtual bool waitFence(GrFence, uint64_t timeout = 1000) = 0;
jvanverth84741b32016-09-30 08:39:02 -0700314 virtual void deleteFence(GrFence) const = 0;
315
Greg Daniela5cb7812017-06-16 09:45:32 -0400316 virtual sk_sp<GrSemaphore> SK_WARN_UNUSED_RESULT makeSemaphore(bool isOwned = true) = 0;
Greg Daniel48661b82018-01-22 16:11:35 -0500317 virtual sk_sp<GrSemaphore> wrapBackendSemaphore(const GrBackendSemaphore& semaphore,
318 GrResourceProvider::SemaphoreWrapType wrapType,
319 GrWrapOwnership ownership) = 0;
Greg Daniel858e12c2018-12-06 11:11:37 -0500320 virtual void insertSemaphore(sk_sp<GrSemaphore> semaphore) = 0;
Greg Daniel48661b82018-01-22 16:11:35 -0500321 virtual void waitSemaphore(sk_sp<GrSemaphore> semaphore) = 0;
Greg Daniel6be35232017-03-01 17:01:09 -0500322
Brian Salomonb0d8b762019-05-06 16:58:22 -0400323 virtual void checkFinishProcs() = 0;
324
Brian Osman13dddce2017-05-09 13:19:50 -0400325 /**
326 * Put this texture in a safe and known state for use across multiple GrContexts. Depending on
327 * the backend, this may return a GrSemaphore. If so, other contexts should wait on that
328 * semaphore before using this texture.
329 */
330 virtual sk_sp<GrSemaphore> prepareTextureForCrossContextUsage(GrTexture*) = 0;
331
mtkleinb9eb4ac2015-02-02 18:26:03 -0800332 ///////////////////////////////////////////////////////////////////////////
333 // Debugging and Stats
334
335 class Stats {
336 public:
337#if GR_GPU_STATS
Brian Salomone05ba5a2019-04-08 11:59:07 -0400338 Stats() = default;
mtkleinb9eb4ac2015-02-02 18:26:03 -0800339
Brian Salomone05ba5a2019-04-08 11:59:07 -0400340 void reset() { *this = {}; }
mtkleinb9eb4ac2015-02-02 18:26:03 -0800341
342 int renderTargetBinds() const { return fRenderTargetBinds; }
343 void incRenderTargetBinds() { fRenderTargetBinds++; }
344 int shaderCompilations() const { return fShaderCompilations; }
345 void incShaderCompilations() { fShaderCompilations++; }
bsalomonb12ea412015-02-02 21:19:50 -0800346 int textureCreates() const { return fTextureCreates; }
347 void incTextureCreates() { fTextureCreates++; }
348 int textureUploads() const { return fTextureUploads; }
349 void incTextureUploads() { fTextureUploads++; }
jvanverth17aa0472016-01-05 10:41:27 -0800350 int transfersToTexture() const { return fTransfersToTexture; }
Brian Salomone05ba5a2019-04-08 11:59:07 -0400351 int transfersFromSurface() const { return fTransfersFromSurface; }
jvanverth17aa0472016-01-05 10:41:27 -0800352 void incTransfersToTexture() { fTransfersToTexture++; }
Brian Salomone05ba5a2019-04-08 11:59:07 -0400353 void incTransfersFromSurface() { fTransfersFromSurface++; }
egdaniel8dc7c3a2015-04-16 11:22:42 -0700354 void incStencilAttachmentCreates() { fStencilAttachmentCreates++; }
joshualitt87a5c9f2015-09-08 13:42:05 -0700355 void incNumDraws() { fNumDraws++; }
bsalomon1d417a82016-03-23 11:50:26 -0700356 void incNumFailedDraws() { ++fNumFailedDraws; }
Greg Danield2073452018-12-07 11:20:33 -0500357 void incNumFinishFlushes() { ++fNumFinishFlushes; }
Robert Phillipsdbaf3172019-02-06 15:12:53 -0500358#if GR_TEST_UTILS
mtkleinb9eb4ac2015-02-02 18:26:03 -0800359 void dump(SkString*);
joshualitte45c81c2015-12-02 09:05:37 -0800360 void dumpKeyValuePairs(SkTArray<SkString>* keys, SkTArray<double>* values);
Robert Phillipsdbaf3172019-02-06 15:12:53 -0500361#endif
bsalomon1d417a82016-03-23 11:50:26 -0700362 int numDraws() const { return fNumDraws; }
363 int numFailedDraws() const { return fNumFailedDraws; }
Greg Danield2073452018-12-07 11:20:33 -0500364 int numFinishFlushes() const { return fNumFinishFlushes; }
mtkleinb9eb4ac2015-02-02 18:26:03 -0800365 private:
Brian Salomone05ba5a2019-04-08 11:59:07 -0400366 int fRenderTargetBinds = 0;
367 int fShaderCompilations = 0;
368 int fTextureCreates = 0;
369 int fTextureUploads = 0;
370 int fTransfersToTexture = 0;
371 int fTransfersFromSurface = 0;
372 int fStencilAttachmentCreates = 0;
373 int fNumDraws = 0;
374 int fNumFailedDraws = 0;
375 int fNumFinishFlushes = 0;
mtkleinb9eb4ac2015-02-02 18:26:03 -0800376#else
Robert Phillipsdbaf3172019-02-06 15:12:53 -0500377
378#if GR_TEST_UTILS
joshualitte45c81c2015-12-02 09:05:37 -0800379 void dump(SkString*) {}
380 void dumpKeyValuePairs(SkTArray<SkString>*, SkTArray<double>*) {}
Robert Phillipsdbaf3172019-02-06 15:12:53 -0500381#endif
mtkleinb9eb4ac2015-02-02 18:26:03 -0800382 void incRenderTargetBinds() {}
383 void incShaderCompilations() {}
bsalomonb12ea412015-02-02 21:19:50 -0800384 void incTextureCreates() {}
385 void incTextureUploads() {}
jvanverth17aa0472016-01-05 10:41:27 -0800386 void incTransfersToTexture() {}
egdaniel8dc7c3a2015-04-16 11:22:42 -0700387 void incStencilAttachmentCreates() {}
joshualitt87a5c9f2015-09-08 13:42:05 -0700388 void incNumDraws() {}
bsalomon1d417a82016-03-23 11:50:26 -0700389 void incNumFailedDraws() {}
Greg Danield2073452018-12-07 11:20:33 -0500390 void incNumFinishFlushes() {}
mtkleinb9eb4ac2015-02-02 18:26:03 -0800391#endif
392 };
393
394 Stats* stats() { return &fStats; }
Brian Osman71a18892017-08-10 10:23:25 -0400395 void dumpJSON(SkJSONWriter*) const;
mtkleinb9eb4ac2015-02-02 18:26:03 -0800396
Robert Phillips9dbcdcc2019-05-13 10:40:06 -0400397 GrBackendTexture createTestingOnlyBackendTexture(int w, int h, SkColorType,
398 GrMipMapped, GrRenderable,
399 const void* pixels = nullptr,
400 size_t rowBytes = 0);
Robert Phillips646f6372018-09-25 09:31:10 -0400401
bsalomon67d76202015-11-11 12:40:42 -0800402 /** Creates a texture directly in the backend API without wrapping it in a GrTexture. This is
403 only to be used for testing (particularly for testing the methods that import an externally
404 created texture into Skia. Must be matched with a call to deleteTestingOnlyTexture(). */
Robert Phillips9dbcdcc2019-05-13 10:40:06 -0400405 virtual GrBackendTexture createTestingOnlyBackendTexture(int w, int h, const GrBackendFormat&,
406 GrMipMapped, GrRenderable,
407 const void* pixels = nullptr,
408 size_t rowBytes = 0) = 0;
Robert Phillips646f6372018-09-25 09:31:10 -0400409
Brian Salomone64b0642018-03-07 11:47:54 -0500410 /**
411 * Frees a texture created by createTestingOnlyBackendTexture(). If ownership of the backend
412 * texture has been transferred to a GrContext using adopt semantics this should not be called.
413 */
Brian Salomon26102cb2018-03-09 09:33:19 -0500414 virtual void deleteTestingOnlyBackendTexture(const GrBackendTexture&) = 0;
jvanverth672bb7f2015-07-13 07:19:57 -0700415
Robert Phillipsf0ced622019-05-16 09:06:25 -0400416#if GR_TEST_UTILS
417 /** Check a handle represents an actual texture in the backend API that has not been freed. */
418 virtual bool isTestingOnlyBackendTexture(const GrBackendTexture&) const = 0;
419
Brian Osman2d010b62018-08-09 10:55:09 -0400420 virtual GrBackendRenderTarget createTestingOnlyBackendRenderTarget(int w, int h,
421 GrColorType) = 0;
Brian Salomonf865b052018-03-09 09:01:53 -0500422
423 virtual void deleteTestingOnlyBackendRenderTarget(const GrBackendRenderTarget&) = 0;
424
425 // This is only to be used in GL-specific tests.
426 virtual const GrGLContext* glContextForTesting() const { return nullptr; }
427
428 // This is only to be used by testing code
429 virtual void resetShaderCacheForTesting() const {}
430
Greg Daniel26b50a42018-03-08 09:49:58 -0500431 /**
432 * Flushes all work to the gpu and forces the GPU to wait until all the gpu work has completed.
433 * This is for testing purposes only.
434 */
435 virtual void testingOnly_flushGpuAndSync() = 0;
Brian Salomonf865b052018-03-09 09:01:53 -0500436#endif
Greg Daniel26b50a42018-03-08 09:49:58 -0500437
egdanielec00d942015-09-14 12:56:10 -0700438 // width and height may be larger than rt (if underlying API allows it).
439 // Returns nullptr if compatible sb could not be created, otherwise the caller owns the ref on
440 // the GrStencilAttachment.
441 virtual GrStencilAttachment* createStencilAttachmentForRenderTarget(const GrRenderTarget*,
442 int width,
443 int height) = 0;
bsalomon6bc1b5f2015-02-23 09:06:38 -0800444
bsalomone179a912016-01-20 06:18:10 -0800445 // Determines whether a texture will need to be rescaled in order to be used with the
Robert Phillipsabf7b762018-03-21 12:13:37 -0400446 // GrSamplerState.
Greg Daniel8f5bbda2018-06-08 17:22:23 -0400447 static bool IsACopyNeededForRepeatWrapMode(const GrCaps*, GrTextureProxy* texProxy,
448 int width, int height,
449 GrSamplerState::Filter,
450 GrTextureProducer::CopyParams*,
451 SkScalar scaleAdjust[2]);
452
453 // Determines whether a texture will need to be copied because the draw requires mips but the
454 // texutre doesn't have any. This call should be only checked if IsACopyNeededForTextureParams
455 // fails. If the previous call succeeds, then a copy should be done using those params and the
456 // mip mapping requirements will be handled there.
457 static bool IsACopyNeededForMips(const GrCaps* caps, const GrTextureProxy* texProxy,
458 GrSamplerState::Filter filter,
459 GrTextureProducer::CopyParams* copyParams);
bsalomone179a912016-01-20 06:18:10 -0800460
egdaniel9cb63402016-06-23 08:37:05 -0700461 void handleDirtyContext() {
462 if (fResetBits) {
463 this->resetContext();
464 }
465 }
466
Greg Daniel7a82edf2018-12-04 10:54:34 -0500467 /**
468 * Returns a key that represents the sampler that will be created for the passed in parameters.
469 * Currently this key is only used when we are building a vulkan pipeline with immutable
470 * samplers. In that case, we need our cache key to also contain this key.
471 *
472 * A return value of 0 indicates that the program/pipeline we are creating is not affected by
473 * the sampler.
474 */
475 virtual uint32_t getExtraSamplerKeyForProgram(const GrSamplerState&, const GrBackendFormat&) {
476 return 0;
477 }
478
Greg Daniela870b462019-01-08 15:49:46 -0500479 virtual void storeVkPipelineCacheData() {}
480
joshualittd53a8272014-11-10 16:03:14 -0800481protected:
Brian Salomon1fabd512018-02-09 09:54:25 -0500482 // Handles cases where a surface will be updated without a call to flushRenderTarget.
483 void didWriteToSurface(GrSurface* surface, GrSurfaceOrigin origin, const SkIRect* bounds,
484 uint32_t mipLevels = 1) const;
jvanverth900bd4a2016-04-29 13:53:12 -0700485
Ben Wagner145dbcd2016-11-03 14:40:50 -0400486 Stats fStats;
487 std::unique_ptr<GrPathRendering> fPathRendering;
joshualitt3322fa42014-11-07 08:48:51 -0800488 // Subclass must initialize this in its constructor.
Hal Canary144caf52016-11-07 17:57:18 -0500489 sk_sp<const GrCaps> fCaps;
joshualitt3322fa42014-11-07 08:48:51 -0800490
bsalomon@google.com02ddc8b2013-01-28 15:35:28 +0000491private:
bsalomon@google.comb635d392011-11-05 12:47:43 +0000492 // called when the 3D context state is unknown. Subclass should emit any
bsalomon@google.comc8f7f472012-06-18 13:44:51 +0000493 // assumed 3D context state and dirty any state cache.
bsalomon@google.com0a208a12013-06-28 18:57:35 +0000494 virtual void onResetContext(uint32_t resetBits) = 0;
bsalomon@google.coma7f84e12011-03-10 14:13:19 +0000495
Brian Salomon1f05d452019-02-08 12:33:08 -0500496 // Implementation of resetTextureBindings.
497 virtual void onResetTextureBindings() {}
498
Chris Daltond7291ba2019-03-07 14:17:03 -0700499 // Queries the effective number of samples in use by the hardware for the given render target,
500 // and queries the individual sample locations.
Chris Dalton8c4cafd2019-04-15 19:14:36 -0600501 virtual void querySampleLocations(GrRenderTarget*, SkTArray<SkPoint>*) = 0;
Chris Daltond7291ba2019-03-07 14:17:03 -0700502
bsalomoncb02b382015-08-12 11:14:50 -0700503 // Called before certain draws in order to guarantee coherent results from dst reads.
504 virtual void xferBarrier(GrRenderTarget*, GrXferBarrierType) = 0;
505
bsalomon@google.com16e3dde2012-10-25 18:43:28 +0000506 // overridden by backend-specific derived class to create objects.
egdanielb0e1be22015-04-22 13:27:39 -0700507 // Texture size and sample size will have already been validated in base class before
Robert Phillips92de6312017-05-23 07:43:48 -0400508 // onCreateTexture is called.
Robert Phillips16d8ec62017-07-27 16:16:25 -0400509 virtual sk_sp<GrTexture> onCreateTexture(const GrSurfaceDesc&, SkBudgeted,
Brian Salomon2a4f9832018-03-03 22:43:43 -0500510 const GrMipLevel texels[], int mipLevelCount) = 0;
cblume55f2d2d2016-02-26 13:20:48 -0800511
Greg Daniel2268ad22018-11-15 09:27:38 -0500512 virtual sk_sp<GrTexture> onWrapBackendTexture(const GrBackendTexture&, GrWrapOwnership,
Brian Salomonfa2ebea2019-01-24 15:58:58 -0500513 GrWrapCacheable, GrIOType) = 0;
Brian Salomonaa6ca0a2019-01-24 16:03:07 -0500514 virtual sk_sp<GrTexture> onWrapRenderableBackendTexture(const GrBackendTexture&, int sampleCnt,
515 GrWrapOwnership, GrWrapCacheable) = 0;
Robert Phillipsb0e93a22017-08-29 08:26:54 -0400516 virtual sk_sp<GrRenderTarget> onWrapBackendRenderTarget(const GrBackendRenderTarget&) = 0;
Greg Daniel7ef28f32017-04-20 16:41:55 +0000517 virtual sk_sp<GrRenderTarget> onWrapBackendTextureAsRenderTarget(const GrBackendTexture&,
Robert Phillipsb0e93a22017-08-29 08:26:54 -0400518 int sampleCnt) = 0;
Greg Danielb46add82019-01-02 14:51:29 -0500519 virtual sk_sp<GrRenderTarget> onWrapVulkanSecondaryCBAsRenderTarget(const SkImageInfo&,
520 const GrVkDrawableInfo&);
521
Brian Salomondbf70722019-02-07 11:31:24 -0500522 virtual sk_sp<GrGpuBuffer> onCreateBuffer(size_t size, GrGpuBufferType intendedType,
523 GrAccessPattern, const void* data) = 0;
bsalomon@google.coma7f84e12011-03-10 14:13:19 +0000524
bsalomon6cb3cbe2015-07-30 07:34:27 -0700525 // overridden by backend-specific derived class to perform the surface read
Brian Salomona6948702018-06-01 15:33:20 -0400526 virtual bool onReadPixels(GrSurface*, int left, int top, int width, int height, GrColorType,
527 void* buffer, size_t rowBytes) = 0;
bsalomon@google.coma7f84e12011-03-10 14:13:19 +0000528
bsalomon6cb3cbe2015-07-30 07:34:27 -0700529 // overridden by backend-specific derived class to perform the surface write
Brian Salomona9b04b92018-06-01 15:04:28 -0400530 virtual bool onWritePixels(GrSurface*, int left, int top, int width, int height, GrColorType,
531 const GrMipLevel texels[], int mipLevelCount) = 0;
bsalomon@google.com6f379512011-11-16 20:36:03 +0000532
Jim Van Verth2e5eaf02017-06-21 15:55:46 -0400533 // overridden by backend-specific derived class to perform the texture transfer
Brian Salomone05ba5a2019-04-08 11:59:07 -0400534 virtual bool onTransferPixelsTo(GrTexture*, int left, int top, int width, int height,
535 GrColorType colorType, GrGpuBuffer* transferBuffer,
536 size_t offset, size_t rowBytes) = 0;
537 // overridden by backend-specific derived class to perform the surface transfer
Brian Salomon26de56e2019-04-10 12:14:26 -0400538 virtual bool onTransferPixelsFrom(GrSurface*, int left, int top, int width, int height,
539 GrColorType colorType, GrGpuBuffer* transferBuffer,
540 size_t offset) = 0;
jvanverth17aa0472016-01-05 10:41:27 -0800541
bsalomon@google.com16e3dde2012-10-25 18:43:28 +0000542 // overridden by backend-specific derived class to perform the resolve
Brian Salomon1fabd512018-02-09 09:54:25 -0500543 virtual void onResolveRenderTarget(GrRenderTarget* target) = 0;
bsalomon@google.com75f9f252012-01-31 13:35:56 +0000544
Brian Salomon930f9392018-06-20 16:25:26 -0400545 // overridden by backend specific derived class to perform mip map level regeneration.
546 virtual bool onRegenerateMipMapLevels(GrTexture*) = 0;
547
joshualitt1cbdcde2015-08-21 11:53:29 -0700548 // overridden by backend specific derived class to perform the copy surface
Robert Phillipsb0e93a22017-08-29 08:26:54 -0400549 virtual bool onCopySurface(GrSurface* dst, GrSurfaceOrigin dstOrigin,
550 GrSurface* src, GrSurfaceOrigin srcOrigin,
Greg Daniel55fa6472018-03-16 16:13:10 -0400551 const SkIRect& srcRect, const SkIPoint& dstPoint,
552 bool canDiscardOutsideDstRect) = 0;
joshualitt1cbdcde2015-08-21 11:53:29 -0700553
Brian Salomonf9a1fdf2019-05-09 10:30:12 -0400554 virtual void onFinishFlush(GrSurfaceProxy*[], int n, SkSurface::BackendSurfaceAccess access,
Greg Daniel797efca2019-05-09 14:04:20 -0400555 const GrFlushInfo&, const GrPrepareForExternalIORequests&) = 0;
Greg Daniel51316782017-08-02 15:10:09 +0000556
Kevin Lubickf4def342018-10-04 12:52:50 -0400557#ifdef SK_ENABLE_DUMP_GPU
Brian Osman71a18892017-08-10 10:23:25 -0400558 virtual void onDumpJSON(SkJSONWriter*) const {}
Kevin Lubickf4def342018-10-04 12:52:50 -0400559#endif
Brian Osman71a18892017-08-10 10:23:25 -0400560
bsalomon@google.comb635d392011-11-05 12:47:43 +0000561 void resetContext() {
bsalomon@google.com0a208a12013-06-28 18:57:35 +0000562 this->onResetContext(fResetBits);
563 fResetBits = 0;
bsalomon@google.comb635d392011-11-05 12:47:43 +0000564 ++fResetTimestamp;
565 }
566
Chris Dalton535ba8d2018-02-20 09:51:59 -0700567 ResetTimestamp fResetTimestamp;
568 uint32_t fResetBits;
joshualitt3322fa42014-11-07 08:48:51 -0800569 // The context owns us, not vice-versa, so this ptr is not ref'ed by Gpu.
Chris Dalton535ba8d2018-02-20 09:51:59 -0700570 GrContext* fContext;
Chris Daltond7291ba2019-03-07 14:17:03 -0700571 GrSamplePatternDictionary fSamplePatternDictionary;
bsalomon@google.com02ddc8b2013-01-28 15:35:28 +0000572
kkinnunencabe20c2015-06-01 01:37:26 -0700573 friend class GrPathRendering;
joshualitt3322fa42014-11-07 08:48:51 -0800574 typedef SkRefCnt INHERITED;
reed@google.comac10a2d2010-12-22 21:39:39 +0000575};
576
577#endif