blob: cf5bbe21221b54b1a4a902bda8c110b6fe372828 [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"
Brian Salomon3ec1f542019-06-17 17:54:57 +000020#include "src/gpu/GrSwizzle.h"
Mike Kleinc0bd9f92019-04-23 12:05:21 -050021#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
Brian Salomon1047a492019-07-02 12:25:21 -040094 * uninitialized. Levels' row bytes Must be a multiple of
95 * config's bytes-per-pixel. Must be tight to width if
96 * !caps->writePixelsRowBytesSupport().
Brian Salomon58389b92018-03-07 13:01:25 -050097 * @param mipLevelCount the number of levels in 'texels'
98 * @return The texture object if successful, otherwise nullptr.
reed@google.comac10a2d2010-12-22 21:39:39 +000099 */
Brian Salomon58389b92018-03-07 13:01:25 -0500100 sk_sp<GrTexture> createTexture(const GrSurfaceDesc&, SkBudgeted, const GrMipLevel texels[],
101 int mipLevelCount);
cblume55f2d2d2016-02-26 13:20:48 -0800102
103 /**
bsalomone699d0c2016-03-09 06:25:15 -0800104 * Simplified createTexture() interface for when there is no initial texel data to upload.
cblume55f2d2d2016-02-26 13:20:48 -0800105 */
Robert Phillips16d8ec62017-07-27 16:16:25 -0400106 sk_sp<GrTexture> createTexture(const GrSurfaceDesc& desc, SkBudgeted);
bsalomone699d0c2016-03-09 06:25:15 -0800107
Brian Salomonbb8dde82019-06-27 10:52:13 -0400108 sk_sp<GrTexture> createCompressedTexture(int width, int height, SkImage::CompressionType,
109 SkBudgeted, const void* data, size_t dataSize);
110
bsalomon@google.come269f212011-11-07 13:29:52 +0000111 /**
Brian Osman32342f02017-03-04 08:12:46 -0500112 * Implements GrResourceProvider::wrapBackendTexture
bsalomon@google.come269f212011-11-07 13:29:52 +0000113 */
Brian Salomonfa2ebea2019-01-24 15:58:58 -0500114 sk_sp<GrTexture> wrapBackendTexture(const GrBackendTexture&, GrWrapOwnership, GrWrapCacheable,
115 GrIOType);
Brian Salomond17f6582017-07-19 18:28:58 -0400116
117 /**
118 * Implements GrResourceProvider::wrapRenderableBackendTexture
119 */
Brian Salomonaa6ca0a2019-01-24 16:03:07 -0500120 sk_sp<GrTexture> wrapRenderableBackendTexture(const GrBackendTexture&, int sampleCnt,
121 GrWrapOwnership, GrWrapCacheable);
bsalomon@google.come269f212011-11-07 13:29:52 +0000122
123 /**
Brian Osman32342f02017-03-04 08:12:46 -0500124 * Implements GrResourceProvider::wrapBackendRenderTarget
bsalomon@google.come269f212011-11-07 13:29:52 +0000125 */
Robert Phillipsb0e93a22017-08-29 08:26:54 -0400126 sk_sp<GrRenderTarget> wrapBackendRenderTarget(const GrBackendRenderTarget&);
bsalomon@google.come269f212011-11-07 13:29:52 +0000127
128 /**
Brian Osman32342f02017-03-04 08:12:46 -0500129 * Implements GrResourceProvider::wrapBackendTextureAsRenderTarget
ericrkf7b8b8a2016-02-24 14:49:51 -0800130 */
Greg Daniel7ef28f32017-04-20 16:41:55 +0000131 sk_sp<GrRenderTarget> wrapBackendTextureAsRenderTarget(const GrBackendTexture&,
Greg Daniel7ef28f32017-04-20 16:41:55 +0000132 int sampleCnt);
ericrkf7b8b8a2016-02-24 14:49:51 -0800133
134 /**
Greg Danielb46add82019-01-02 14:51:29 -0500135 * Implements GrResourceProvider::wrapVulkanSecondaryCBAsRenderTarget
136 */
137 sk_sp<GrRenderTarget> wrapVulkanSecondaryCBAsRenderTarget(const SkImageInfo&,
138 const GrVkDrawableInfo&);
139
140 /**
csmartdalton485a1202016-07-13 10:16:32 -0700141 * Creates a buffer in GPU memory. For a client-side buffer use GrBuffer::CreateCPUBacked.
reed@google.comac10a2d2010-12-22 21:39:39 +0000142 *
cdaltone2e71c22016-04-07 18:13:29 -0700143 * @param size size of buffer to create.
144 * @param intendedType hint to the graphics subsystem about what the buffer will be used for.
145 * @param accessPattern hint to the graphics subsystem about how the data will be accessed.
cdalton1bf3e712016-04-19 10:00:02 -0700146 * @param data optional data with which to initialize the buffer.
cdaltone2e71c22016-04-07 18:13:29 -0700147 *
cdalton397536c2016-03-25 12:15:03 -0700148 * @return the buffer if successful, otherwise nullptr.
reed@google.comac10a2d2010-12-22 21:39:39 +0000149 */
Brian Salomondbf70722019-02-07 11:31:24 -0500150 sk_sp<GrGpuBuffer> createBuffer(size_t size, GrGpuBufferType intendedType,
151 GrAccessPattern accessPattern, const void* data = nullptr);
halcanary9d524f22016-03-29 09:03:52 -0700152
reed@google.comac10a2d2010-12-22 21:39:39 +0000153 /**
bsalomon@google.com75f9f252012-01-31 13:35:56 +0000154 * Resolves MSAA.
155 */
Brian Salomon1fabd512018-02-09 09:54:25 -0500156 void resolveRenderTarget(GrRenderTarget*);
bsalomon@google.com75f9f252012-01-31 13:35:56 +0000157
bsalomon@google.coma85449d2011-11-19 02:36:05 +0000158 /**
Brian Salomon930f9392018-06-20 16:25:26 -0400159 * Uses the base of the texture to recompute the contents of the other levels.
160 */
161 bool regenerateMipMapLevels(GrTexture*);
162
163 /**
Brian Salomon1f05d452019-02-08 12:33:08 -0500164 * If the backend API has stateful texture bindings, this resets them back to defaults.
165 */
166 void resetTextureBindings();
167
168 /**
Brian Salomon9b009bb2018-02-14 13:53:55 -0500169 * Reads a rectangle of pixels from a render target. No sRGB/linear conversions are performed.
bsalomon@google.comc4364992011-11-07 15:54:49 +0000170 *
bsalomon6cb3cbe2015-07-30 07:34:27 -0700171 * @param surface The surface to read from
bsalomon@google.com669fdc42011-04-05 17:08:27 +0000172 * @param left left edge of the rectangle to read (inclusive)
173 * @param top top edge of the rectangle to read (inclusive)
174 * @param width width of rectangle to read in pixels.
175 * @param height height of rectangle to read in pixels.
Brian Salomonc320b152018-02-20 14:05:36 -0500176 * @param dstColorType the color type of the destination buffer.
bsalomon@google.com669fdc42011-04-05 17:08:27 +0000177 * @param buffer memory to read the rectangle into.
Brian Salomon1047a492019-07-02 12:25:21 -0400178 * @param rowBytes the number of bytes between consecutive rows. Must be a multiple of
179 * dstColorType's bytes-per-pixel. Must be tight to width if
180 * !caps->readPixelsRowBytesSupport().
bsalomon@google.comc4364992011-11-07 15:54:49 +0000181 * @param invertY buffer should be populated bottom-to-top as opposed
182 * to top-to-bottom (skia's usual order)
bsalomon@google.coma7f84e12011-03-10 14:13:19 +0000183 *
184 * @return true if the read succeeded, false if not. The read can fail
Brian Salomon1d435302019-07-01 13:05:28 -0400185 * because of the surface doesn't support reading, the color type
186 * is not allowed for the format of the surface or if the rectangle
187 * read is not contained in the surface.
bsalomon@google.coma7f84e12011-03-10 14:13:19 +0000188 */
Brian Salomon19eaf2d2018-03-19 16:06:44 -0400189 bool readPixels(GrSurface* surface, int left, int top, int width, int height,
Brian Salomona6948702018-06-01 15:33:20 -0400190 GrColorType dstColorType, void* buffer, size_t rowBytes);
reed@google.comac10a2d2010-12-22 21:39:39 +0000191
bsalomon@google.com6f379512011-11-16 20:36:03 +0000192 /**
Brian Salomon9b009bb2018-02-14 13:53:55 -0500193 * Updates the pixels in a rectangle of a surface. No sRGB/linear conversions are performed.
bsalomon@google.coma85449d2011-11-19 02:36:05 +0000194 *
bsalomon6cb3cbe2015-07-30 07:34:27 -0700195 * @param surface The surface to write to.
bsalomon@google.com6f379512011-11-16 20:36:03 +0000196 * @param left left edge of the rectangle to write (inclusive)
197 * @param top top edge of the rectangle to write (inclusive)
198 * @param width width of rectangle to write in pixels.
199 * @param height height of rectangle to write in pixels.
Brian Salomonc320b152018-02-20 14:05:36 -0500200 * @param srcColorType the color type of the source buffer.
Brian Salomon1047a492019-07-02 12:25:21 -0400201 * @param texels array of mipmap levels containing texture data. Row bytes must be a
202 * multiple of srcColorType's bytes-per-pixel. Must be tight to level width
203 * if !caps->writePixelsRowBytesSupport().
Robert Phillips590533f2017-07-11 14:22:35 -0400204 * @param mipLevelCount number of levels in 'texels'
Brian Salomon1d435302019-07-01 13:05:28 -0400205 *
206 * @return true if the write succeeded, false if not. The read can fail
207 * because of the surface doesn't support writing (e.g. read only),
208 * the color type is not allowed for the format of the surface or
209 * if the rectangle written is not contained in the surface.
cblume55f2d2d2016-02-26 13:20:48 -0800210 */
Brian Salomona9b04b92018-06-01 15:04:28 -0400211 bool writePixels(GrSurface* surface, int left, int top, int width, int height,
212 GrColorType srcColorType, const GrMipLevel texels[], int mipLevelCount);
cblume55f2d2d2016-02-26 13:20:48 -0800213
214 /**
Brian Salomona9b04b92018-06-01 15:04:28 -0400215 * Helper for the case of a single level.
Brian Salomon5f33a8c2018-02-26 14:32:39 -0500216 */
217 bool writePixels(GrSurface* surface, int left, int top, int width, int height,
218 GrColorType srcColorType, const void* buffer, size_t rowBytes) {
Brian Salomona9b04b92018-06-01 15:04:28 -0400219 GrMipLevel mipLevel = {buffer, rowBytes};
220 return this->writePixels(surface, left, top, width, height, srcColorType, &mipLevel, 1);
Brian Salomon5f33a8c2018-02-26 14:32:39 -0500221 }
222
223 /**
Brian Salomone05ba5a2019-04-08 11:59:07 -0400224 * Updates the pixels in a rectangle of a texture using a buffer. If the texture is MIP mapped,
225 * the base level is written to.
Jim Van Verth2e5eaf02017-06-21 15:55:46 -0400226 *
227 * @param texture The texture to write to.
cdalton397536c2016-03-25 12:15:03 -0700228 * @param left left edge of the rectangle to write (inclusive)
229 * @param top top edge of the rectangle to write (inclusive)
230 * @param width width of rectangle to write in pixels.
231 * @param height height of rectangle to write in pixels.
Brian Salomonc320b152018-02-20 14:05:36 -0500232 * @param bufferColorType the color type of the transfer buffer's pixel data
Jim Van Verth2e5eaf02017-06-21 15:55:46 -0400233 * @param transferBuffer GrBuffer to read pixels from (type must be "kXferCpuToGpu")
cdalton397536c2016-03-25 12:15:03 -0700234 * @param offset offset from the start of the buffer
Brian Salomon1047a492019-07-02 12:25:21 -0400235 * @param rowBytes number of bytes between consecutive rows in the buffer. Must be a
236 * multiple of bufferColorType's bytes-per-pixel. Must be tight to width
237 * if !caps->writePixelsRowBytesSupport().
jvanverth17aa0472016-01-05 10:41:27 -0800238 */
Brian Salomone05ba5a2019-04-08 11:59:07 -0400239 bool transferPixelsTo(GrTexture* texture, int left, int top, int width, int height,
240 GrColorType bufferColorType, GrGpuBuffer* transferBuffer, size_t offset,
241 size_t rowBytes);
242
243 /**
244 * Reads the pixels from a rectangle of a surface into a buffer. Use
Brian Salomon26de56e2019-04-10 12:14:26 -0400245 * GrCaps::transferFromOffsetAlignment to determine the requirements for the buffer offset
246 * alignment. If the surface is a MIP mapped texture, the base level is read.
Brian Salomone05ba5a2019-04-08 11:59:07 -0400247 *
Brian Salomon26de56e2019-04-10 12:14:26 -0400248 * If successful the row bytes in the buffer is always:
249 * GrColorTypeBytesPerPixel(bufferColorType) * width
250 *
251 * Asserts that the caller has passed a properly aligned offset and that the buffer is
252 * large enough to hold the result
Brian Salomone05ba5a2019-04-08 11:59:07 -0400253 *
254 * @param surface The surface to read from.
255 * @param left left edge of the rectangle to read (inclusive)
256 * @param top top edge of the rectangle to read (inclusive)
257 * @param width width of rectangle to read in pixels.
258 * @param height height of rectangle to read in pixels.
259 * @param bufferColorType the color type of the transfer buffer's pixel data
260 * @param transferBuffer GrBuffer to write pixels to (type must be "kXferGpuToCpu")
261 * @param offset offset from the start of the buffer
262 */
Brian Salomon26de56e2019-04-10 12:14:26 -0400263 bool transferPixelsFrom(GrSurface* surface, int left, int top, int width, int height,
264 GrColorType bufferColorType, GrGpuBuffer* transferBuffer,
265 size_t offset);
jvanverth17aa0472016-01-05 10:41:27 -0800266
bsalomon@google.com80d09b92011-11-05 21:21:13 +0000267
bsalomonf90a02b2014-11-26 12:28:00 -0800268 // 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 -0400269 // take place at the GrOpList level and this function implement faster copy paths. The rect
bsalomonf90a02b2014-11-26 12:28:00 -0800270 // and point are pre-clipped. The src rect and implied dst rect are guaranteed to be within the
Greg Daniel46cfbc62019-06-07 11:43:30 -0400271 // src/dst bounds and non-empty. They must also be in their exact device space coords, including
272 // already being transformed for origin if need be. If canDiscardOutsideDstRect is set to true
273 // then we don't need to preserve any data on the dst surface outside of the copy.
274 bool copySurface(GrSurface* dst, GrSurface* src, const SkIRect& srcRect,
275 const SkIPoint& dstPoint, bool canDiscardOutsideDstRect = false);
joshualitt3322fa42014-11-07 08:48:51 -0800276
Chris Daltond7291ba2019-03-07 14:17:03 -0700277 // Queries the per-pixel HW sample locations for the given render target, and then finds or
278 // assigns a key that uniquely identifies the sample pattern. The actual sample locations can be
279 // retrieved with retrieveSampleLocations().
Chris Dalton8c4cafd2019-04-15 19:14:36 -0600280 int findOrAssignSamplePatternKey(GrRenderTarget*);
Chris Daltond7291ba2019-03-07 14:17:03 -0700281
282 // Retrieves the per-pixel HW sample locations for the given sample pattern key, and, as a
283 // by-product, the actual number of samples in use. (This may differ from the number of samples
284 // requested by the render target.) Sample locations are returned as 0..1 offsets relative to
285 // the top-left corner of the pixel.
286 const SkTArray<SkPoint>& retrieveSampleLocations(int samplePatternKey) const {
287 return fSamplePatternDictionary.retrieveSampleLocations(samplePatternKey);
288 }
289
Robert Phillips5b5d84c2018-08-09 15:12:18 -0400290 // Returns a GrGpuRTCommandBuffer which GrOpLists send draw commands to instead of directly
Ethan Nicholas56d19a52018-10-15 11:26:20 -0400291 // to the Gpu object. The 'bounds' rect is the content rect of the destination.
Robert Phillips5b5d84c2018-08-09 15:12:18 -0400292 virtual GrGpuRTCommandBuffer* getCommandBuffer(
Ethan Nicholas56d19a52018-10-15 11:26:20 -0400293 GrRenderTarget*, GrSurfaceOrigin, const SkRect& bounds,
Greg Daniel500d58b2017-08-24 15:59:33 -0400294 const GrGpuRTCommandBuffer::LoadAndStoreInfo&,
295 const GrGpuRTCommandBuffer::StencilLoadAndStoreInfo&) = 0;
296
Robert Phillips5b5d84c2018-08-09 15:12:18 -0400297 // Returns a GrGpuTextureCommandBuffer which GrOpLists send texture commands to instead of
Greg Daniel500d58b2017-08-24 15:59:33 -0400298 // directly to the Gpu object.
Robert Phillips5b5d84c2018-08-09 15:12:18 -0400299 virtual GrGpuTextureCommandBuffer* getCommandBuffer(GrTexture*, GrSurfaceOrigin) = 0;
bsalomon3e791242014-12-17 13:43:13 -0800300
Robert Phillips18e94842017-05-15 13:06:44 -0400301 // Called by GrDrawingManager when flushing.
Greg Daniel51316782017-08-02 15:10:09 +0000302 // Provides a hook for post-flush actions (e.g. Vulkan command buffer submits). This will also
303 // insert any numSemaphore semaphores on the gpu and set the backendSemaphores to match the
304 // inserted semaphores.
Brian Salomonf9a1fdf2019-05-09 10:30:12 -0400305 GrSemaphoresSubmitted finishFlush(GrSurfaceProxy*[], int n,
Greg Daniel797efca2019-05-09 14:04:20 -0400306 SkSurface::BackendSurfaceAccess access, const GrFlushInfo&,
307 const GrPrepareForExternalIORequests&);
ethannicholas22793252016-01-30 09:59:10 -0800308
Robert Phillips5b5d84c2018-08-09 15:12:18 -0400309 virtual void submit(GrGpuCommandBuffer*) = 0;
310
Greg Daniel6be35232017-03-01 17:01:09 -0500311 virtual GrFence SK_WARN_UNUSED_RESULT insertFence() = 0;
312 virtual bool waitFence(GrFence, uint64_t timeout = 1000) = 0;
jvanverth84741b32016-09-30 08:39:02 -0700313 virtual void deleteFence(GrFence) const = 0;
314
Greg Daniela5cb7812017-06-16 09:45:32 -0400315 virtual sk_sp<GrSemaphore> SK_WARN_UNUSED_RESULT makeSemaphore(bool isOwned = true) = 0;
Greg Daniel48661b82018-01-22 16:11:35 -0500316 virtual sk_sp<GrSemaphore> wrapBackendSemaphore(const GrBackendSemaphore& semaphore,
317 GrResourceProvider::SemaphoreWrapType wrapType,
318 GrWrapOwnership ownership) = 0;
Greg Daniel858e12c2018-12-06 11:11:37 -0500319 virtual void insertSemaphore(sk_sp<GrSemaphore> semaphore) = 0;
Greg Daniel48661b82018-01-22 16:11:35 -0500320 virtual void waitSemaphore(sk_sp<GrSemaphore> semaphore) = 0;
Greg Daniel6be35232017-03-01 17:01:09 -0500321
Brian Salomonb0d8b762019-05-06 16:58:22 -0400322 virtual void checkFinishProcs() = 0;
323
Brian Osman13dddce2017-05-09 13:19:50 -0400324 /**
325 * Put this texture in a safe and known state for use across multiple GrContexts. Depending on
326 * the backend, this may return a GrSemaphore. If so, other contexts should wait on that
327 * semaphore before using this texture.
328 */
329 virtual sk_sp<GrSemaphore> prepareTextureForCrossContextUsage(GrTexture*) = 0;
330
mtkleinb9eb4ac2015-02-02 18:26:03 -0800331 ///////////////////////////////////////////////////////////////////////////
332 // Debugging and Stats
333
334 class Stats {
335 public:
336#if GR_GPU_STATS
Brian Salomone05ba5a2019-04-08 11:59:07 -0400337 Stats() = default;
mtkleinb9eb4ac2015-02-02 18:26:03 -0800338
Brian Salomone05ba5a2019-04-08 11:59:07 -0400339 void reset() { *this = {}; }
mtkleinb9eb4ac2015-02-02 18:26:03 -0800340
341 int renderTargetBinds() const { return fRenderTargetBinds; }
342 void incRenderTargetBinds() { fRenderTargetBinds++; }
343 int shaderCompilations() const { return fShaderCompilations; }
344 void incShaderCompilations() { fShaderCompilations++; }
bsalomonb12ea412015-02-02 21:19:50 -0800345 int textureCreates() const { return fTextureCreates; }
346 void incTextureCreates() { fTextureCreates++; }
347 int textureUploads() const { return fTextureUploads; }
348 void incTextureUploads() { fTextureUploads++; }
jvanverth17aa0472016-01-05 10:41:27 -0800349 int transfersToTexture() const { return fTransfersToTexture; }
Brian Salomone05ba5a2019-04-08 11:59:07 -0400350 int transfersFromSurface() const { return fTransfersFromSurface; }
jvanverth17aa0472016-01-05 10:41:27 -0800351 void incTransfersToTexture() { fTransfersToTexture++; }
Brian Salomone05ba5a2019-04-08 11:59:07 -0400352 void incTransfersFromSurface() { fTransfersFromSurface++; }
egdaniel8dc7c3a2015-04-16 11:22:42 -0700353 void incStencilAttachmentCreates() { fStencilAttachmentCreates++; }
joshualitt87a5c9f2015-09-08 13:42:05 -0700354 void incNumDraws() { fNumDraws++; }
bsalomon1d417a82016-03-23 11:50:26 -0700355 void incNumFailedDraws() { ++fNumFailedDraws; }
Greg Danield2073452018-12-07 11:20:33 -0500356 void incNumFinishFlushes() { ++fNumFinishFlushes; }
Robert Phillipsdbaf3172019-02-06 15:12:53 -0500357#if GR_TEST_UTILS
mtkleinb9eb4ac2015-02-02 18:26:03 -0800358 void dump(SkString*);
joshualitte45c81c2015-12-02 09:05:37 -0800359 void dumpKeyValuePairs(SkTArray<SkString>* keys, SkTArray<double>* values);
Robert Phillipsdbaf3172019-02-06 15:12:53 -0500360#endif
bsalomon1d417a82016-03-23 11:50:26 -0700361 int numDraws() const { return fNumDraws; }
362 int numFailedDraws() const { return fNumFailedDraws; }
Greg Danield2073452018-12-07 11:20:33 -0500363 int numFinishFlushes() const { return fNumFinishFlushes; }
mtkleinb9eb4ac2015-02-02 18:26:03 -0800364 private:
Brian Salomone05ba5a2019-04-08 11:59:07 -0400365 int fRenderTargetBinds = 0;
366 int fShaderCompilations = 0;
367 int fTextureCreates = 0;
368 int fTextureUploads = 0;
369 int fTransfersToTexture = 0;
370 int fTransfersFromSurface = 0;
371 int fStencilAttachmentCreates = 0;
372 int fNumDraws = 0;
373 int fNumFailedDraws = 0;
374 int fNumFinishFlushes = 0;
mtkleinb9eb4ac2015-02-02 18:26:03 -0800375#else
Robert Phillipsdbaf3172019-02-06 15:12:53 -0500376
377#if GR_TEST_UTILS
joshualitte45c81c2015-12-02 09:05:37 -0800378 void dump(SkString*) {}
379 void dumpKeyValuePairs(SkTArray<SkString>*, SkTArray<double>*) {}
Robert Phillipsdbaf3172019-02-06 15:12:53 -0500380#endif
mtkleinb9eb4ac2015-02-02 18:26:03 -0800381 void incRenderTargetBinds() {}
382 void incShaderCompilations() {}
bsalomonb12ea412015-02-02 21:19:50 -0800383 void incTextureCreates() {}
384 void incTextureUploads() {}
jvanverth17aa0472016-01-05 10:41:27 -0800385 void incTransfersToTexture() {}
egdaniel8dc7c3a2015-04-16 11:22:42 -0700386 void incStencilAttachmentCreates() {}
joshualitt87a5c9f2015-09-08 13:42:05 -0700387 void incNumDraws() {}
bsalomon1d417a82016-03-23 11:50:26 -0700388 void incNumFailedDraws() {}
Greg Danield2073452018-12-07 11:20:33 -0500389 void incNumFinishFlushes() {}
mtkleinb9eb4ac2015-02-02 18:26:03 -0800390#endif
391 };
392
393 Stats* stats() { return &fStats; }
Brian Osman71a18892017-08-10 10:23:25 -0400394 void dumpJSON(SkJSONWriter*) const;
mtkleinb9eb4ac2015-02-02 18:26:03 -0800395
Robert Phillipsf0313ee2019-05-21 13:51:11 -0400396 /**
397 * Creates a texture directly in the backend API without wrapping it in a GrTexture.
398 * Must be matched with a call to deleteBackendTexture().
Robert Phillips459b2952019-05-23 09:38:27 -0400399 * Right now, the color is ignored if pixel data is provided.
400 * In the future, if neither a color nor pixels are provided then the backend texture
401 * will be uninitialized.
Robert Phillipsf0313ee2019-05-21 13:51:11 -0400402 */
403 virtual GrBackendTexture createBackendTexture(int w, int h, const GrBackendFormat&,
404 GrMipMapped, GrRenderable,
Robert Phillips459b2952019-05-23 09:38:27 -0400405 const void* pixels, size_t rowBytes,
Emircan Uysaler23ca4e72019-06-24 10:53:09 -0400406 const SkColor4f* color,
407 GrProtected isProtected) = 0;
Robert Phillips646f6372018-09-25 09:31:10 -0400408
Brian Salomone64b0642018-03-07 11:47:54 -0500409 /**
Robert Phillipsf0313ee2019-05-21 13:51:11 -0400410 * Frees a texture created by createBackendTexture(). If ownership of the backend
Brian Salomone64b0642018-03-07 11:47:54 -0500411 * texture has been transferred to a GrContext using adopt semantics this should not be called.
412 */
Robert Phillipsf0313ee2019-05-21 13:51:11 -0400413 virtual void deleteBackendTexture(const GrBackendTexture&) = 0;
jvanverth672bb7f2015-07-13 07:19:57 -0700414
Robert Phillipsf0ced622019-05-16 09:06:25 -0400415#if GR_TEST_UTILS
416 /** Check a handle represents an actual texture in the backend API that has not been freed. */
417 virtual bool isTestingOnlyBackendTexture(const GrBackendTexture&) const = 0;
418
Brian Osman2d010b62018-08-09 10:55:09 -0400419 virtual GrBackendRenderTarget createTestingOnlyBackendRenderTarget(int w, int h,
420 GrColorType) = 0;
Brian Salomonf865b052018-03-09 09:01:53 -0500421
422 virtual void deleteTestingOnlyBackendRenderTarget(const GrBackendRenderTarget&) = 0;
423
424 // This is only to be used in GL-specific tests.
425 virtual const GrGLContext* glContextForTesting() const { return nullptr; }
426
427 // This is only to be used by testing code
428 virtual void resetShaderCacheForTesting() const {}
429
Greg Daniel26b50a42018-03-08 09:49:58 -0500430 /**
431 * Flushes all work to the gpu and forces the GPU to wait until all the gpu work has completed.
432 * This is for testing purposes only.
433 */
434 virtual void testingOnly_flushGpuAndSync() = 0;
Brian Salomonf865b052018-03-09 09:01:53 -0500435#endif
Greg Daniel26b50a42018-03-08 09:49:58 -0500436
egdanielec00d942015-09-14 12:56:10 -0700437 // width and height may be larger than rt (if underlying API allows it).
438 // Returns nullptr if compatible sb could not be created, otherwise the caller owns the ref on
439 // the GrStencilAttachment.
Chris Daltoneffee202019-07-01 22:28:03 -0600440 virtual GrStencilAttachment* createStencilAttachmentForRenderTarget(
441 const GrRenderTarget*, int width, int height, int numStencilSamples) = 0;
bsalomon6bc1b5f2015-02-23 09:06:38 -0800442
bsalomone179a912016-01-20 06:18:10 -0800443 // Determines whether a texture will need to be rescaled in order to be used with the
Robert Phillipsabf7b762018-03-21 12:13:37 -0400444 // GrSamplerState.
Greg Daniel8f5bbda2018-06-08 17:22:23 -0400445 static bool IsACopyNeededForRepeatWrapMode(const GrCaps*, GrTextureProxy* texProxy,
446 int width, int height,
447 GrSamplerState::Filter,
448 GrTextureProducer::CopyParams*,
449 SkScalar scaleAdjust[2]);
450
451 // Determines whether a texture will need to be copied because the draw requires mips but the
452 // texutre doesn't have any. This call should be only checked if IsACopyNeededForTextureParams
453 // fails. If the previous call succeeds, then a copy should be done using those params and the
454 // mip mapping requirements will be handled there.
455 static bool IsACopyNeededForMips(const GrCaps* caps, const GrTextureProxy* texProxy,
456 GrSamplerState::Filter filter,
457 GrTextureProducer::CopyParams* copyParams);
bsalomone179a912016-01-20 06:18:10 -0800458
egdaniel9cb63402016-06-23 08:37:05 -0700459 void handleDirtyContext() {
460 if (fResetBits) {
461 this->resetContext();
462 }
463 }
464
Greg Daniel7a82edf2018-12-04 10:54:34 -0500465 /**
466 * Returns a key that represents the sampler that will be created for the passed in parameters.
467 * Currently this key is only used when we are building a vulkan pipeline with immutable
468 * samplers. In that case, we need our cache key to also contain this key.
469 *
470 * A return value of 0 indicates that the program/pipeline we are creating is not affected by
471 * the sampler.
472 */
473 virtual uint32_t getExtraSamplerKeyForProgram(const GrSamplerState&, const GrBackendFormat&) {
474 return 0;
475 }
476
Greg Daniela870b462019-01-08 15:49:46 -0500477 virtual void storeVkPipelineCacheData() {}
478
joshualittd53a8272014-11-10 16:03:14 -0800479protected:
Brian Salomon1fabd512018-02-09 09:54:25 -0500480 // Handles cases where a surface will be updated without a call to flushRenderTarget.
481 void didWriteToSurface(GrSurface* surface, GrSurfaceOrigin origin, const SkIRect* bounds,
482 uint32_t mipLevels = 1) const;
jvanverth900bd4a2016-04-29 13:53:12 -0700483
Ben Wagner145dbcd2016-11-03 14:40:50 -0400484 Stats fStats;
485 std::unique_ptr<GrPathRendering> fPathRendering;
joshualitt3322fa42014-11-07 08:48:51 -0800486 // Subclass must initialize this in its constructor.
Hal Canary144caf52016-11-07 17:57:18 -0500487 sk_sp<const GrCaps> fCaps;
joshualitt3322fa42014-11-07 08:48:51 -0800488
bsalomon@google.com02ddc8b2013-01-28 15:35:28 +0000489private:
bsalomon@google.comb635d392011-11-05 12:47:43 +0000490 // called when the 3D context state is unknown. Subclass should emit any
bsalomon@google.comc8f7f472012-06-18 13:44:51 +0000491 // assumed 3D context state and dirty any state cache.
bsalomon@google.com0a208a12013-06-28 18:57:35 +0000492 virtual void onResetContext(uint32_t resetBits) = 0;
bsalomon@google.coma7f84e12011-03-10 14:13:19 +0000493
Brian Salomon1f05d452019-02-08 12:33:08 -0500494 // Implementation of resetTextureBindings.
495 virtual void onResetTextureBindings() {}
496
Chris Daltond7291ba2019-03-07 14:17:03 -0700497 // Queries the effective number of samples in use by the hardware for the given render target,
498 // and queries the individual sample locations.
Chris Dalton8c4cafd2019-04-15 19:14:36 -0600499 virtual void querySampleLocations(GrRenderTarget*, SkTArray<SkPoint>*) = 0;
Chris Daltond7291ba2019-03-07 14:17:03 -0700500
bsalomoncb02b382015-08-12 11:14:50 -0700501 // Called before certain draws in order to guarantee coherent results from dst reads.
502 virtual void xferBarrier(GrRenderTarget*, GrXferBarrierType) = 0;
503
bsalomon@google.com16e3dde2012-10-25 18:43:28 +0000504 // overridden by backend-specific derived class to create objects.
egdanielb0e1be22015-04-22 13:27:39 -0700505 // Texture size and sample size will have already been validated in base class before
Robert Phillips92de6312017-05-23 07:43:48 -0400506 // onCreateTexture is called.
Robert Phillips16d8ec62017-07-27 16:16:25 -0400507 virtual sk_sp<GrTexture> onCreateTexture(const GrSurfaceDesc&, SkBudgeted,
Brian Salomon2a4f9832018-03-03 22:43:43 -0500508 const GrMipLevel texels[], int mipLevelCount) = 0;
Brian Salomonbb8dde82019-06-27 10:52:13 -0400509 virtual sk_sp<GrTexture> onCreateCompressedTexture(int width, int height,
510 SkImage::CompressionType, SkBudgeted,
511 const void* data) = 0;
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
Greg Daniel46cfbc62019-06-07 11:43:30 -0400549 virtual bool onCopySurface(GrSurface* dst, GrSurface* src, const SkIRect& srcRect,
550 const SkIPoint& dstPoint, bool canDiscardOutsideDstRect) = 0;
joshualitt1cbdcde2015-08-21 11:53:29 -0700551
Brian Salomonf9a1fdf2019-05-09 10:30:12 -0400552 virtual void onFinishFlush(GrSurfaceProxy*[], int n, SkSurface::BackendSurfaceAccess access,
Greg Daniel797efca2019-05-09 14:04:20 -0400553 const GrFlushInfo&, const GrPrepareForExternalIORequests&) = 0;
Greg Daniel51316782017-08-02 15:10:09 +0000554
Kevin Lubickf4def342018-10-04 12:52:50 -0400555#ifdef SK_ENABLE_DUMP_GPU
Brian Osman71a18892017-08-10 10:23:25 -0400556 virtual void onDumpJSON(SkJSONWriter*) const {}
Kevin Lubickf4def342018-10-04 12:52:50 -0400557#endif
Brian Osman71a18892017-08-10 10:23:25 -0400558
bsalomon@google.comb635d392011-11-05 12:47:43 +0000559 void resetContext() {
bsalomon@google.com0a208a12013-06-28 18:57:35 +0000560 this->onResetContext(fResetBits);
561 fResetBits = 0;
bsalomon@google.comb635d392011-11-05 12:47:43 +0000562 }
563
Chris Dalton535ba8d2018-02-20 09:51:59 -0700564 uint32_t fResetBits;
joshualitt3322fa42014-11-07 08:48:51 -0800565 // The context owns us, not vice-versa, so this ptr is not ref'ed by Gpu.
Chris Dalton535ba8d2018-02-20 09:51:59 -0700566 GrContext* fContext;
Chris Daltond7291ba2019-03-07 14:17:03 -0700567 GrSamplePatternDictionary fSamplePatternDictionary;
bsalomon@google.com02ddc8b2013-01-28 15:35:28 +0000568
kkinnunencabe20c2015-06-01 01:37:26 -0700569 friend class GrPathRendering;
joshualitt3322fa42014-11-07 08:48:51 -0800570 typedef SkRefCnt INHERITED;
reed@google.comac10a2d2010-12-22 21:39:39 +0000571};
572
573#endif