blob: b3251dc14fa6bc2ca03a37f89d7cdda6ff16b56b [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
kkinnunencabe20c2015-06-01 01:37:26 -070011#include "GrPipelineBuilder.h"
joshualitt79f8fae2014-10-28 17:59:26 -070012#include "GrProgramDesc.h"
kkinnunencabe20c2015-06-01 01:37:26 -070013#include "GrStencil.h"
bsalomon6c9cd552016-01-22 07:17:34 -080014#include "GrSwizzle.h"
cdalton28f45b92016-03-07 13:58:26 -080015#include "GrAllocator.h"
bsalomon045802d2015-10-20 07:58:01 -070016#include "GrTextureParamsAdjuster.h"
cblume55f2d2d2016-02-26 13:20:48 -080017#include "GrTypes.h"
kkinnunencabe20c2015-06-01 01:37:26 -070018#include "GrXferProcessor.h"
sugoi@google.com12b4e272012-12-06 20:13:11 +000019#include "SkPath.h"
cblume55f2d2d2016-02-26 13:20:48 -080020#include "SkTArray.h"
sugoi@google.com12b4e272012-12-06 20:13:11 +000021
kkinnunencabe20c2015-06-01 01:37:26 -070022class GrBatchTracker;
cdalton397536c2016-03-25 12:15:03 -070023class GrBuffer;
bsalomon@google.com669fdc42011-04-05 17:08:27 +000024class GrContext;
reedf9ad5582015-06-25 21:29:25 -070025class GrGLContext;
egdaniel0e1853c2016-03-17 11:35:45 -070026class GrMesh;
bsalomone64eb572015-05-07 11:35:55 -070027class GrNonInstancedVertices;
bsalomon@google.com64aef2b2012-06-11 15:36:13 +000028class GrPath;
cdaltonb85a0aa2014-07-21 15:32:44 -070029class GrPathRange;
bsalomon@google.com30085192011-08-19 15:42:31 +000030class GrPathRenderer;
31class GrPathRendererChain;
kkinnunencabe20c2015-06-01 01:37:26 -070032class GrPathRendering;
egdaniel8dd688b2015-01-22 10:16:09 -080033class GrPipeline;
joshualitt873ad0e2015-01-20 09:08:51 -080034class GrPrimitiveProcessor;
kkinnunencabe20c2015-06-01 01:37:26 -070035class GrRenderTarget;
egdaniel8dc7c3a2015-04-16 11:22:42 -070036class GrStencilAttachment;
kkinnunencabe20c2015-06-01 01:37:26 -070037class GrSurface;
38class GrTexture;
reed@google.comac10a2d2010-12-22 21:39:39 +000039
joshualitt3322fa42014-11-07 08:48:51 -080040class GrGpu : public SkRefCnt {
reed@google.comac10a2d2010-12-22 21:39:39 +000041public:
42 /**
bsalomon@google.com16e3dde2012-10-25 18:43:28 +000043 * Create an instance of GrGpu that matches the specified backend. If the requested backend is
halcanary96fcdcc2015-08-27 07:41:13 -070044 * not supported (at compile-time or run-time) this returns nullptr. The context will not be
bsalomon@google.com6e4e6502013-02-25 20:12:45 +000045 * fully constructed and should not be used by GrGpu until after this function returns.
reed@google.comac10a2d2010-12-22 21:39:39 +000046 */
bsalomon682c2692015-05-22 14:01:46 -070047 static GrGpu* Create(GrBackend, GrBackendContext, const GrContextOptions&, GrContext* context);
reed@google.comac10a2d2010-12-22 21:39:39 +000048
49 ////////////////////////////////////////////////////////////////////////////
50
bsalomon@google.com6e4e6502013-02-25 20:12:45 +000051 GrGpu(GrContext* context);
mtklein36352bf2015-03-25 18:17:31 -070052 ~GrGpu() override;
reed@google.comac10a2d2010-12-22 21:39:39 +000053
joshualitt3322fa42014-11-07 08:48:51 -080054 GrContext* getContext() { return fContext; }
55 const GrContext* getContext() const { return fContext; }
56
57 /**
58 * Gets the capabilities of the draw target.
59 */
bsalomon4b91f762015-05-19 09:29:46 -070060 const GrCaps* caps() const { return fCaps.get(); }
joshualitt3322fa42014-11-07 08:48:51 -080061
kkinnunencabe20c2015-06-01 01:37:26 -070062 GrPathRendering* pathRendering() { return fPathRendering.get(); }
kkinnunenccdaa042014-08-20 01:36:23 -070063
bsalomon6e2aad42016-04-01 11:54:31 -070064 enum class DisconnectType {
65 // No cleanup should be attempted, immediately cease making backend API calls
66 kAbandon,
67 // Free allocated resources (not known by GrResourceCache) before returning and
68 // ensure no backend backend 3D API calls will be made after disconnect() returns.
69 kCleanup,
70 };
71
72 // Called by GrContext when the underlying backend context is already or will be destroyed
73 // before GrContext.
74 virtual void disconnect(DisconnectType);
bsalomonc8dc1f72014-08-21 13:02:13 -070075
reed@google.comac10a2d2010-12-22 21:39:39 +000076 /**
77 * The GrGpu object normally assumes that no outsider is setting state
78 * within the underlying 3D API's context/device/whatever. This call informs
bsalomon@google.coma7f84e12011-03-10 14:13:19 +000079 * the GrGpu that the state was modified and it shouldn't make assumptions
80 * about the state.
reed@google.comac10a2d2010-12-22 21:39:39 +000081 */
mtkleinb9eb4ac2015-02-02 18:26:03 -080082 void markContextDirty(uint32_t state = kAll_GrBackendState) { fResetBits |= state; }
reed@google.comac10a2d2010-12-22 21:39:39 +000083
84 /**
bsalomon6d467ec2014-11-18 07:36:19 -080085 * Creates a texture object. If kRenderTarget_GrSurfaceFlag the texture can
86 * be used as a render target by calling GrTexture::asRenderTarget(). Not all
87 * pixel configs can be used as render targets. Support for configs as textures
bsalomon4b91f762015-05-19 09:29:46 -070088 * or render targets can be checked using GrCaps.
bsalomon@google.com1da07462011-03-10 14:51:57 +000089 *
reed@google.comac10a2d2010-12-22 21:39:39 +000090 * @param desc describes the texture to be created.
bsalomon5236cf42015-01-14 10:42:08 -080091 * @param budgeted does this texture count against the resource cache budget?
cblume55f2d2d2016-02-26 13:20:48 -080092 * @param texels array of mipmap levels containing texel data to load.
93 * Each level begins with full-size palette data for paletted textures.
94 * For compressed formats the level contains the compressed pixel data.
95 * Otherwise, it contains width*height texels. If there is only one
96 * element and it contains nullptr fPixels, texture data is
97 * uninitialized.
halcanary96fcdcc2015-08-27 07:41:13 -070098 * @return The texture object if successful, otherwise nullptr.
reed@google.comac10a2d2010-12-22 21:39:39 +000099 */
bsalomon5ec26ae2016-02-25 08:33:02 -0800100 GrTexture* createTexture(const GrSurfaceDesc& desc, SkBudgeted budgeted,
cblume55f2d2d2016-02-26 13:20:48 -0800101 const SkTArray<GrMipLevel>& texels);
102
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 */
bsalomone699d0c2016-03-09 06:25:15 -0800106 GrTexture* createTexture(const GrSurfaceDesc& desc, SkBudgeted budgeted) {
107 return this->createTexture(desc, budgeted, SkTArray<GrMipLevel>());
108 }
109
110 /** Simplified createTexture() interface for when there is only a base level */
111 GrTexture* createTexture(const GrSurfaceDesc& desc, SkBudgeted budgeted, const void* level0Data,
112 size_t rowBytes) {
113 SkASSERT(level0Data);
114 GrMipLevel level = { level0Data, rowBytes };
115 SkSTArray<1, GrMipLevel> array;
116 array.push_back() = level;
117 return this->createTexture(desc, budgeted, array);
118 }
bsalomond3312592016-03-04 07:06:43 -0800119
bsalomon@google.come269f212011-11-07 13:29:52 +0000120 /**
ericrkf7b8b8a2016-02-24 14:49:51 -0800121 * Implements GrTextureProvider::wrapBackendTexture
bsalomon@google.come269f212011-11-07 13:29:52 +0000122 */
bsalomon6dc6f5f2015-06-18 09:12:16 -0700123 GrTexture* wrapBackendTexture(const GrBackendTextureDesc&, GrWrapOwnership);
bsalomon@google.come269f212011-11-07 13:29:52 +0000124
125 /**
brianosman436d9852016-02-25 13:40:42 -0800126 * Implements GrTextureProvider::wrapBackendRenderTarget
bsalomon@google.come269f212011-11-07 13:29:52 +0000127 */
bsalomon6dc6f5f2015-06-18 09:12:16 -0700128 GrRenderTarget* wrapBackendRenderTarget(const GrBackendRenderTargetDesc&, GrWrapOwnership);
bsalomon@google.come269f212011-11-07 13:29:52 +0000129
130 /**
ericrkf7b8b8a2016-02-24 14:49:51 -0800131 * Implements GrTextureProvider::wrapBackendTextureAsRenderTarget
132 */
kkinnunen49c4c222016-04-01 04:50:37 -0700133 GrRenderTarget* wrapBackendTextureAsRenderTarget(const GrBackendTextureDesc&);
ericrkf7b8b8a2016-02-24 14:49:51 -0800134
135 /**
cdalton397536c2016-03-25 12:15:03 -0700136 * Creates a buffer.
reed@google.comac10a2d2010-12-22 21:39:39 +0000137 *
cdalton397536c2016-03-25 12:15:03 -0700138 * @return the buffer if successful, otherwise nullptr.
reed@google.comac10a2d2010-12-22 21:39:39 +0000139 */
mtklein044d3c12016-04-06 18:24:34 -0700140 GrBuffer* createBuffer(GrBufferType, size_t size, GrAccessPattern);
halcanary9d524f22016-03-29 09:03:52 -0700141
reed@google.comac10a2d2010-12-22 21:39:39 +0000142 /**
bsalomon@google.com75f9f252012-01-31 13:35:56 +0000143 * Resolves MSAA.
144 */
145 void resolveRenderTarget(GrRenderTarget* target);
146
bsalomonf0674512015-07-28 13:26:15 -0700147 /** Info struct returned by getReadPixelsInfo about performing intermediate draws before
bsalomon39826022015-07-23 08:07:21 -0700148 reading pixels for performance or correctness. */
149 struct ReadPixelTempDrawInfo {
150 /** If the GrGpu is requesting that the caller do a draw to an intermediate surface then
151 this is descriptor for the temp surface. The draw should always be a rect with
152 dst 0,0,w,h. */
153 GrSurfaceDesc fTempSurfaceDesc;
154 /** Indicates whether there is a performance advantage to using an exact match texture
155 (in terms of width and height) for the intermediate texture instead of approximate. */
156 bool fUseExactScratch;
bsalomon6c9cd552016-01-22 07:17:34 -0800157 /** Swizzle to apply during the draw. This is used to compensate for either feature or
158 performance limitations in the underlying 3D API. */
159 GrSwizzle fSwizzle;
160 /** The config that should be used to read from the temp surface after the draw. This may be
161 different than the original read config in order to compensate for swizzling. The
162 read data will effectively be in the original read config. */
163 GrPixelConfig fReadConfig;
bsalomon39826022015-07-23 08:07:21 -0700164 };
bsalomon6c9cd552016-01-22 07:17:34 -0800165
bsalomon39826022015-07-23 08:07:21 -0700166 /** Describes why an intermediate draw must/should be performed before readPixels. */
167 enum DrawPreference {
168 /** On input means that the caller would proceed without draw if the GrGpu doesn't request
169 one.
170 On output means that the GrGpu is not requesting a draw. */
171 kNoDraw_DrawPreference,
172 /** Means that the client would prefer a draw for performance of the readback but
173 can satisfy a straight readPixels call on the inputs without an intermediate draw.
174 getReadPixelsInfo will never set the draw preference to this value but may leave
175 it set. */
176 kCallerPrefersDraw_DrawPreference,
177 /** On output means that GrGpu would prefer a draw for performance of the readback but
178 can satisfy a straight readPixels call on the inputs without an intermediate draw. The
179 caller of getReadPixelsInfo should never specify this on intput. */
180 kGpuPrefersDraw_DrawPreference,
181 /** On input means that the caller requires a draw to do a transformation and there is no
182 CPU fallback.
183 On output means that GrGpu can only satisfy the readPixels request if the intermediate
184 draw is performed.
185 */
186 kRequireDraw_DrawPreference
187 };
188
bsalomonf0674512015-07-28 13:26:15 -0700189 /**
190 * Used to negotiate whether and how an intermediate draw should or must be performed before
191 * a readPixels call. If this returns false then GrGpu could not deduce an intermediate draw
192 * that would allow a successful readPixels call. The passed width, height, and rowBytes,
193 * must be non-zero and already reflect clipping to the src bounds.
194 */
195 bool getReadPixelsInfo(GrSurface* srcSurface, int readWidth, int readHeight, size_t rowBytes,
196 GrPixelConfig readConfig, DrawPreference*, ReadPixelTempDrawInfo*);
197
cblume61214052016-01-26 09:10:48 -0800198 /** Info struct returned by getWritePixelsInfo about performing an intermediate draw in order
bsalomonf0674512015-07-28 13:26:15 -0700199 to write pixels to a GrSurface for either performance or correctness reasons. */
200 struct WritePixelTempDrawInfo {
201 /** If the GrGpu is requesting that the caller upload to an intermediate surface and draw
202 that to the dst then this is the descriptor for the intermediate surface. The caller
203 should upload the pixels such that the upper left pixel of the upload rect is at 0,0 in
204 the intermediate surface.*/
205 GrSurfaceDesc fTempSurfaceDesc;
bsalomon6c9cd552016-01-22 07:17:34 -0800206 /** Swizzle to apply during the draw. This is used to compensate for either feature or
207 performance limitations in the underlying 3D API. */
208 GrSwizzle fSwizzle;
209 /** The config that should be specified when uploading the *original* data to the temp
210 surface before the draw. This may be different than the original src data config in
211 order to compensate for swizzling that will occur when drawing. */
212 GrPixelConfig fWriteConfig;
bsalomonf0674512015-07-28 13:26:15 -0700213 };
bsalomon39826022015-07-23 08:07:21 -0700214
bsalomon@google.com75f9f252012-01-31 13:35:56 +0000215 /**
bsalomonf0674512015-07-28 13:26:15 -0700216 * Used to negotiate whether and how an intermediate surface should be used to write pixels to
217 * a GrSurface. If this returns false then GrGpu could not deduce an intermediate draw
218 * that would allow a successful transfer of the src pixels to the dst. The passed width,
219 * height, and rowBytes, must be non-zero and already reflect clipping to the dst bounds.
bsalomon@google.com0a97be22011-11-08 19:20:57 +0000220 */
cblumeed828002016-02-16 13:00:01 -0800221 bool getWritePixelsInfo(GrSurface* dstSurface, int width, int height,
bsalomonf0674512015-07-28 13:26:15 -0700222 GrPixelConfig srcConfig, DrawPreference*, WritePixelTempDrawInfo*);
bsalomon@google.coma85449d2011-11-19 02:36:05 +0000223
224 /**
bsalomon@google.coma04e8e82012-08-27 12:53:13 +0000225 * Reads a rectangle of pixels from a render target.
bsalomon@google.comc4364992011-11-07 15:54:49 +0000226 *
bsalomon6cb3cbe2015-07-30 07:34:27 -0700227 * @param surface The surface to read from
bsalomon@google.com669fdc42011-04-05 17:08:27 +0000228 * @param left left edge of the rectangle to read (inclusive)
229 * @param top top edge of the rectangle to read (inclusive)
230 * @param width width of rectangle to read in pixels.
231 * @param height height of rectangle to read in pixels.
232 * @param config the pixel config of the destination buffer
233 * @param buffer memory to read the rectangle into.
bsalomon@google.comc6980972011-11-02 19:57:21 +0000234 * @param rowBytes the number of bytes between consecutive rows. Zero
235 * means rows are tightly packed.
bsalomon@google.comc4364992011-11-07 15:54:49 +0000236 * @param invertY buffer should be populated bottom-to-top as opposed
237 * to top-to-bottom (skia's usual order)
bsalomon@google.coma7f84e12011-03-10 14:13:19 +0000238 *
239 * @return true if the read succeeded, false if not. The read can fail
240 * because of a unsupported pixel config or because no render
241 * target is currently set.
242 */
bsalomon6cb3cbe2015-07-30 07:34:27 -0700243 bool readPixels(GrSurface* surface,
bsalomon@google.com669fdc42011-04-05 17:08:27 +0000244 int left, int top, int width, int height,
senorblanco@chromium.org3cb406b2013-02-05 19:50:46 +0000245 GrPixelConfig config, void* buffer, size_t rowBytes);
reed@google.comac10a2d2010-12-22 21:39:39 +0000246
bsalomon@google.com6f379512011-11-16 20:36:03 +0000247 /**
bsalomon6cb3cbe2015-07-30 07:34:27 -0700248 * Updates the pixels in a rectangle of a surface.
bsalomon@google.coma85449d2011-11-19 02:36:05 +0000249 *
bsalomon6cb3cbe2015-07-30 07:34:27 -0700250 * @param surface The surface to write to.
bsalomon@google.com6f379512011-11-16 20:36:03 +0000251 * @param left left edge of the rectangle to write (inclusive)
252 * @param top top edge of the rectangle to write (inclusive)
253 * @param width width of rectangle to write in pixels.
254 * @param height height of rectangle to write in pixels.
255 * @param config the pixel config of the source buffer
cblume55f2d2d2016-02-26 13:20:48 -0800256 * @param texels array of mipmap levels containing texture data
257 */
258 bool writePixels(GrSurface* surface,
259 int left, int top, int width, int height,
260 GrPixelConfig config,
261 const SkTArray<GrMipLevel>& texels);
262
263 /**
264 * This function is a shim which creates a SkTArray<GrMipLevel> of size 1.
265 * It then calls writePixels with that SkTArray.
266 *
267 * @param buffer memory to read pixels from.
268 * @param rowBytes number of bytes between consecutive rows. Zero
269 * means rows are tightly packed.
bsalomon@google.com6f379512011-11-16 20:36:03 +0000270 */
bsalomon6cb3cbe2015-07-30 07:34:27 -0700271 bool writePixels(GrSurface* surface,
272 int left, int top, int width, int height,
273 GrPixelConfig config, const void* buffer,
274 size_t rowBytes);
bsalomon@google.com6f379512011-11-16 20:36:03 +0000275
joshualitt3322fa42014-11-07 08:48:51 -0800276 /**
cdalton397536c2016-03-25 12:15:03 -0700277 * Updates the pixels in a rectangle of a surface using a buffer
jvanverth17aa0472016-01-05 10:41:27 -0800278 *
cdalton397536c2016-03-25 12:15:03 -0700279 * @param surface The surface to write to.
280 * @param left left edge of the rectangle to write (inclusive)
281 * @param top top edge of the rectangle to write (inclusive)
282 * @param width width of rectangle to write in pixels.
283 * @param height height of rectangle to write in pixels.
284 * @param config the pixel config of the source buffer
285 * @param transferBuffer GrBuffer to read pixels from (type must be "kCpuToGpu")
286 * @param offset offset from the start of the buffer
287 * @param rowBytes number of bytes between consecutive rows. Zero
288 * means rows are tightly packed.
jvanverth17aa0472016-01-05 10:41:27 -0800289 */
290 bool transferPixels(GrSurface* surface,
291 int left, int top, int width, int height,
cdalton397536c2016-03-25 12:15:03 -0700292 GrPixelConfig config, GrBuffer* transferBuffer,
jvanverth17aa0472016-01-05 10:41:27 -0800293 size_t offset, size_t rowBytes);
294
295 /**
egdaniel51c8d402015-08-06 10:54:13 -0700296 * Clear the passed in render target. Ignores the draw state and clip.
joshualitt3322fa42014-11-07 08:48:51 -0800297 */
egdaniel51c8d402015-08-06 10:54:13 -0700298 void clear(const SkIRect& rect, GrColor color, GrRenderTarget* renderTarget);
joshualitt3322fa42014-11-07 08:48:51 -0800299
300
bsalomon6d467ec2014-11-18 07:36:19 -0800301 void clearStencilClip(const SkIRect& rect, bool insideClip, GrRenderTarget* renderTarget);
joshualitt3322fa42014-11-07 08:48:51 -0800302
303 /**
halcanary96fcdcc2015-08-27 07:41:13 -0700304 * Discards the contents render target. nullptr indicates that the current render target should
joshualitt3322fa42014-11-07 08:48:51 -0800305 * be discarded.
306 **/
halcanary96fcdcc2015-08-27 07:41:13 -0700307 virtual void discard(GrRenderTarget* = nullptr) = 0;
joshualitt3322fa42014-11-07 08:48:51 -0800308
309 /**
310 * This is can be called before allocating a texture to be a dst for copySurface. It will
bsalomonf90a02b2014-11-26 12:28:00 -0800311 * populate the origin, config, and flags fields of the desc such that copySurface can
312 * efficiently succeed. It should only succeed if it can allow copySurface to perform a copy
313 * that would be more effecient than drawing the src to a dst render target.
joshualitt3322fa42014-11-07 08:48:51 -0800314 */
joshualitt1c735482015-07-13 08:08:25 -0700315 virtual bool initCopySurfaceDstDesc(const GrSurface* src, GrSurfaceDesc* desc) const = 0;
joshualitt6db519c2014-10-29 08:48:18 -0700316
bsalomon@google.com80d09b92011-11-05 21:21:13 +0000317 // After the client interacts directly with the 3D context state the GrGpu
318 // must resync its internal state and assumptions about 3D context state.
319 // Each time this occurs the GrGpu bumps a timestamp.
320 // state of the 3D context
321 // At 10 resets / frame and 60fps a 64bit timestamp will overflow in about
322 // a billion years.
323 typedef uint64_t ResetTimestamp;
324
325 // This timestamp is always older than the current timestamp
326 static const ResetTimestamp kExpiredTimestamp = 0;
327 // Returns a timestamp based on the number of times the context was reset.
328 // This timestamp can be used to lazily detect when cached 3D context state
329 // is dirty.
bsalomon6d467ec2014-11-18 07:36:19 -0800330 ResetTimestamp getResetTimestamp() const { return fResetTimestamp; }
bsalomon@google.com80d09b92011-11-05 21:21:13 +0000331
bsalomonf90a02b2014-11-26 12:28:00 -0800332 // Called to perform a surface to surface copy. Fallbacks to issuing a draw from the src to dst
333 // take place at the GrDrawTarget level and this function implement faster copy paths. The rect
334 // and point are pre-clipped. The src rect and implied dst rect are guaranteed to be within the
335 // src/dst bounds and non-empty.
joshualitt1cbdcde2015-08-21 11:53:29 -0700336 bool copySurface(GrSurface* dst,
337 GrSurface* src,
338 const SkIRect& srcRect,
339 const SkIPoint& dstPoint);
joshualitt3322fa42014-11-07 08:48:51 -0800340
cdalton28f45b92016-03-07 13:58:26 -0800341 struct MultisampleSpecs {
342 // Nonzero ID that uniquely identifies these multisample specs.
343 uint8_t fUniqueID;
344 // The actual number of samples the GPU will run. NOTE: this value can be greater than the
345 // the render target's sample count.
346 int fEffectiveSampleCnt;
347 // If sample locations are supported, contains the subpixel locations at which the GPU will
348 // sample. Pixel center is at (.5, .5) and (0, 0) indicates the top left corner.
349 SkAutoTDeleteArray<const SkPoint> fSampleLocations;
350 };
351
352 // Finds a render target's multisample specs. The stencil settings are only needed to flush the
353 // draw state prior to querying multisample information; they should not have any effect on the
354 // multisample information itself.
355 const MultisampleSpecs& getMultisampleSpecs(GrRenderTarget*, const GrStencilSettings&);
356
egdaniel0e1853c2016-03-17 11:35:45 -0700357 // We pass in an array of meshCount GrMesh to the draw. The backend should loop over each
358 // GrMesh object and emit a draw for it. Each draw will use the same GrPipeline and
bsalomon7dbd45d2016-03-23 10:40:53 -0700359 // GrPrimitiveProcessor. This may fail if the draw would exceed any resource limits (e.g.
360 // number of vertex attributes is too large).
361 bool draw(const GrPipeline&,
egdaniel0e1853c2016-03-17 11:35:45 -0700362 const GrPrimitiveProcessor&,
363 const GrMesh*,
364 int meshCount);
bsalomon3e791242014-12-17 13:43:13 -0800365
halcanary9d524f22016-03-29 09:03:52 -0700366 // Called by drawtarget when flushing.
jvanverthd2d2eb92016-02-17 14:04:46 -0800367 // Provides a hook for post-flush actions (e.g. PLS reset and Vulkan command buffer submits).
368 virtual void finishDrawTarget() {}
ethannicholas22793252016-01-30 09:59:10 -0800369
mtkleinb9eb4ac2015-02-02 18:26:03 -0800370 ///////////////////////////////////////////////////////////////////////////
371 // Debugging and Stats
372
373 class Stats {
374 public:
375#if GR_GPU_STATS
376 Stats() { this->reset(); }
377
bsalomonb12ea412015-02-02 21:19:50 -0800378 void reset() {
379 fRenderTargetBinds = 0;
380 fShaderCompilations = 0;
381 fTextureCreates = 0;
382 fTextureUploads = 0;
jvanverth17aa0472016-01-05 10:41:27 -0800383 fTransfersToTexture = 0;
egdaniel8dc7c3a2015-04-16 11:22:42 -0700384 fStencilAttachmentCreates = 0;
joshualitt87a5c9f2015-09-08 13:42:05 -0700385 fNumDraws = 0;
bsalomon1d417a82016-03-23 11:50:26 -0700386 fNumFailedDraws = 0;
bsalomonb12ea412015-02-02 21:19:50 -0800387 }
mtkleinb9eb4ac2015-02-02 18:26:03 -0800388
389 int renderTargetBinds() const { return fRenderTargetBinds; }
390 void incRenderTargetBinds() { fRenderTargetBinds++; }
391 int shaderCompilations() const { return fShaderCompilations; }
392 void incShaderCompilations() { fShaderCompilations++; }
bsalomonb12ea412015-02-02 21:19:50 -0800393 int textureCreates() const { return fTextureCreates; }
394 void incTextureCreates() { fTextureCreates++; }
395 int textureUploads() const { return fTextureUploads; }
396 void incTextureUploads() { fTextureUploads++; }
jvanverth17aa0472016-01-05 10:41:27 -0800397 int transfersToTexture() const { return fTransfersToTexture; }
398 void incTransfersToTexture() { fTransfersToTexture++; }
egdaniel8dc7c3a2015-04-16 11:22:42 -0700399 void incStencilAttachmentCreates() { fStencilAttachmentCreates++; }
joshualitt87a5c9f2015-09-08 13:42:05 -0700400 void incNumDraws() { fNumDraws++; }
bsalomon1d417a82016-03-23 11:50:26 -0700401 void incNumFailedDraws() { ++fNumFailedDraws; }
mtkleinb9eb4ac2015-02-02 18:26:03 -0800402 void dump(SkString*);
joshualitte45c81c2015-12-02 09:05:37 -0800403 void dumpKeyValuePairs(SkTArray<SkString>* keys, SkTArray<double>* values);
bsalomon1d417a82016-03-23 11:50:26 -0700404 int numDraws() const { return fNumDraws; }
405 int numFailedDraws() const { return fNumFailedDraws; }
mtkleinb9eb4ac2015-02-02 18:26:03 -0800406 private:
407 int fRenderTargetBinds;
408 int fShaderCompilations;
bsalomonb12ea412015-02-02 21:19:50 -0800409 int fTextureCreates;
410 int fTextureUploads;
jvanverth17aa0472016-01-05 10:41:27 -0800411 int fTransfersToTexture;
egdaniel8dc7c3a2015-04-16 11:22:42 -0700412 int fStencilAttachmentCreates;
joshualitt87a5c9f2015-09-08 13:42:05 -0700413 int fNumDraws;
bsalomon1d417a82016-03-23 11:50:26 -0700414 int fNumFailedDraws;
mtkleinb9eb4ac2015-02-02 18:26:03 -0800415#else
joshualitte45c81c2015-12-02 09:05:37 -0800416 void dump(SkString*) {}
417 void dumpKeyValuePairs(SkTArray<SkString>*, SkTArray<double>*) {}
mtkleinb9eb4ac2015-02-02 18:26:03 -0800418 void incRenderTargetBinds() {}
419 void incShaderCompilations() {}
bsalomonb12ea412015-02-02 21:19:50 -0800420 void incTextureCreates() {}
421 void incTextureUploads() {}
jvanverth17aa0472016-01-05 10:41:27 -0800422 void incTransfersToTexture() {}
egdaniel8dc7c3a2015-04-16 11:22:42 -0700423 void incStencilAttachmentCreates() {}
joshualitt87a5c9f2015-09-08 13:42:05 -0700424 void incNumDraws() {}
bsalomon1d417a82016-03-23 11:50:26 -0700425 void incNumFailedDraws() {}
mtkleinb9eb4ac2015-02-02 18:26:03 -0800426#endif
427 };
428
429 Stats* stats() { return &fStats; }
430
bsalomon67d76202015-11-11 12:40:42 -0800431 /** Creates a texture directly in the backend API without wrapping it in a GrTexture. This is
432 only to be used for testing (particularly for testing the methods that import an externally
433 created texture into Skia. Must be matched with a call to deleteTestingOnlyTexture(). */
jvanverth88957922015-07-14 11:02:52 -0700434 virtual GrBackendObject createTestingOnlyBackendTexture(void* pixels, int w, int h,
bsalomone63ffef2016-02-05 07:17:34 -0800435 GrPixelConfig config) = 0;
bsalomon67d76202015-11-11 12:40:42 -0800436 /** Check a handle represents an actual texture in the backend API that has not been freed. */
437 virtual bool isTestingOnlyBackendTexture(GrBackendObject) const = 0;
438 /** If ownership of the backend texture has been transferred pass true for abandonTexture. This
439 will do any necessary cleanup of the handle without freeing the texture in the backend
440 API. */
441 virtual void deleteTestingOnlyBackendTexture(GrBackendObject,
bsalomone63ffef2016-02-05 07:17:34 -0800442 bool abandonTexture = false) = 0;
jvanverth672bb7f2015-07-13 07:19:57 -0700443
egdanielec00d942015-09-14 12:56:10 -0700444 // width and height may be larger than rt (if underlying API allows it).
445 // Returns nullptr if compatible sb could not be created, otherwise the caller owns the ref on
446 // the GrStencilAttachment.
447 virtual GrStencilAttachment* createStencilAttachmentForRenderTarget(const GrRenderTarget*,
448 int width,
449 int height) = 0;
450 // clears target's entire stencil buffer to 0
451 virtual void clearStencil(GrRenderTarget* target) = 0;
bsalomon6bc1b5f2015-02-23 09:06:38 -0800452
bsalomon6dea83f2015-12-03 12:58:06 -0800453 // draws an outline rectangle for debugging/visualization purposes.
454 virtual void drawDebugWireRect(GrRenderTarget*, const SkIRect&, GrColor) = 0;
bsalomon045802d2015-10-20 07:58:01 -0700455
bsalomone179a912016-01-20 06:18:10 -0800456 // Determines whether a texture will need to be rescaled in order to be used with the
457 // GrTextureParams. This variation is called when the caller will create a new texture using the
458 // texture provider from a non-texture src (cpu-backed image, ...).
bsalomon045802d2015-10-20 07:58:01 -0700459 bool makeCopyForTextureParams(int width, int height, const GrTextureParams&,
bsalomone179a912016-01-20 06:18:10 -0800460 GrTextureProducer::CopyParams*) const;
461
462 // Like the above but this variation should be called when the caller is not creating the
463 // original texture but rather was handed the original texture. It adds additional checks
464 // relevant to original textures that were created external to Skia via
465 // GrTextureProvider::wrap methods.
466 bool makeCopyForTextureParams(GrTexture* texture, const GrTextureParams& params,
467 GrTextureProducer::CopyParams* copyParams) const {
468 if (this->makeCopyForTextureParams(texture->width(), texture->height(), params,
469 copyParams)) {
470 return true;
471 }
472 return this->onMakeCopyForTextureParams(texture, params, copyParams);
473 }
bsalomon045802d2015-10-20 07:58:01 -0700474
jvanverth672bb7f2015-07-13 07:19:57 -0700475 // This is only to be used in GL-specific tests.
halcanary96fcdcc2015-08-27 07:41:13 -0700476 virtual const GrGLContext* glContextForTesting() const { return nullptr; }
bsalomon993a4212015-05-29 11:37:25 -0700477
joshualitt8fd844f2015-12-02 13:36:47 -0800478 // This is only to be used by testing code
479 virtual void resetShaderCacheForTesting() const {}
480
joshualittd53a8272014-11-10 16:03:14 -0800481protected:
bsalomon@google.comd302f142011-03-03 13:54:13 +0000482 // Functions used to map clip-respecting stencil tests into normal
483 // stencil funcs supported by GPUs.
bsalomon@google.coma7f84e12011-03-10 14:13:19 +0000484 static GrStencilFunc ConvertStencilFunc(bool stencilInClip,
bsalomon@google.comd302f142011-03-03 13:54:13 +0000485 GrStencilFunc func);
486 static void ConvertStencilFuncAndMask(GrStencilFunc func,
487 bool clipInStencil,
488 unsigned int clipBit,
489 unsigned int userBits,
490 unsigned int* ref,
491 unsigned int* mask);
492
bsalomonf0674512015-07-28 13:26:15 -0700493 static void ElevateDrawPreference(GrGpu::DrawPreference* preference,
494 GrGpu::DrawPreference elevation) {
495 GR_STATIC_ASSERT(GrGpu::kCallerPrefersDraw_DrawPreference > GrGpu::kNoDraw_DrawPreference);
496 GR_STATIC_ASSERT(GrGpu::kGpuPrefersDraw_DrawPreference >
497 GrGpu::kCallerPrefersDraw_DrawPreference);
498 GR_STATIC_ASSERT(GrGpu::kRequireDraw_DrawPreference >
499 GrGpu::kGpuPrefersDraw_DrawPreference);
500 *preference = SkTMax(*preference, elevation);
501 }
502
joshualitt93316b92015-10-23 09:08:08 -0700503 void handleDirtyContext() {
504 if (fResetBits) {
505 this->resetContext();
506 }
507 }
508
mtkleinb9eb4ac2015-02-02 18:26:03 -0800509 Stats fStats;
510 SkAutoTDelete<GrPathRendering> fPathRendering;
joshualitt3322fa42014-11-07 08:48:51 -0800511 // Subclass must initialize this in its constructor.
bsalomon4b91f762015-05-19 09:29:46 -0700512 SkAutoTUnref<const GrCaps> fCaps;
joshualitt3322fa42014-11-07 08:48:51 -0800513
bsalomon@google.com02ddc8b2013-01-28 15:35:28 +0000514private:
bsalomon@google.comb635d392011-11-05 12:47:43 +0000515 // called when the 3D context state is unknown. Subclass should emit any
bsalomon@google.comc8f7f472012-06-18 13:44:51 +0000516 // assumed 3D context state and dirty any state cache.
bsalomon@google.com0a208a12013-06-28 18:57:35 +0000517 virtual void onResetContext(uint32_t resetBits) = 0;
bsalomon@google.coma7f84e12011-03-10 14:13:19 +0000518
bsalomoncb02b382015-08-12 11:14:50 -0700519 // Called before certain draws in order to guarantee coherent results from dst reads.
520 virtual void xferBarrier(GrRenderTarget*, GrXferBarrierType) = 0;
521
bsalomon@google.com16e3dde2012-10-25 18:43:28 +0000522 // overridden by backend-specific derived class to create objects.
egdanielb0e1be22015-04-22 13:27:39 -0700523 // Texture size and sample size will have already been validated in base class before
524 // onCreateTexture/CompressedTexture are called.
525 virtual GrTexture* onCreateTexture(const GrSurfaceDesc& desc,
526 GrGpuResource::LifeCycle lifeCycle,
cblume55f2d2d2016-02-26 13:20:48 -0800527 const SkTArray<GrMipLevel>& texels) = 0;
egdanielb0e1be22015-04-22 13:27:39 -0700528 virtual GrTexture* onCreateCompressedTexture(const GrSurfaceDesc& desc,
529 GrGpuResource::LifeCycle lifeCycle,
cblume55f2d2d2016-02-26 13:20:48 -0800530 const SkTArray<GrMipLevel>& texels) = 0;
531
bsalomon6dc6f5f2015-06-18 09:12:16 -0700532 virtual GrTexture* onWrapBackendTexture(const GrBackendTextureDesc&, GrWrapOwnership) = 0;
533 virtual GrRenderTarget* onWrapBackendRenderTarget(const GrBackendRenderTargetDesc&,
534 GrWrapOwnership) = 0;
kkinnunen49c4c222016-04-01 04:50:37 -0700535 virtual GrRenderTarget* onWrapBackendTextureAsRenderTarget(const GrBackendTextureDesc&) = 0;
mtklein044d3c12016-04-06 18:24:34 -0700536 virtual GrBuffer* onCreateBuffer(GrBufferType, size_t size, GrAccessPattern) = 0;
bsalomon@google.coma7f84e12011-03-10 14:13:19 +0000537
bsalomon63b21962014-11-05 07:05:34 -0800538 // overridden by backend-specific derived class to perform the clear.
egdaniel51c8d402015-08-06 10:54:13 -0700539 virtual void onClear(GrRenderTarget*, const SkIRect& rect, GrColor color) = 0;
bsalomon@google.coma7f84e12011-03-10 14:13:19 +0000540
joshualitt6db519c2014-10-29 08:48:18 -0700541 // Overridden by backend specific classes to perform a clear of the stencil clip bits. This is
542 // ONLY used by the the clip target
mtkleinb9eb4ac2015-02-02 18:26:03 -0800543 virtual void onClearStencilClip(GrRenderTarget*, const SkIRect& rect, bool insideClip) = 0;
joshualitt6db519c2014-10-29 08:48:18 -0700544
bsalomon@google.com16e3dde2012-10-25 18:43:28 +0000545 // overridden by backend-specific derived class to perform the draw call.
egdaniel0e1853c2016-03-17 11:35:45 -0700546 virtual void onDraw(const GrPipeline&,
547 const GrPrimitiveProcessor&,
548 const GrMesh*,
549 int meshCount) = 0;
bsalomon3e791242014-12-17 13:43:13 -0800550
bsalomone179a912016-01-20 06:18:10 -0800551 virtual bool onMakeCopyForTextureParams(GrTexture* texture, const GrTextureParams&,
552 GrTextureProducer::CopyParams*) const { return false; }
553
bsalomonf0674512015-07-28 13:26:15 -0700554 virtual bool onGetReadPixelsInfo(GrSurface* srcSurface, int readWidth, int readHeight,
555 size_t rowBytes, GrPixelConfig readConfig, DrawPreference*,
556 ReadPixelTempDrawInfo*) = 0;
cblumeed828002016-02-16 13:00:01 -0800557 virtual bool onGetWritePixelsInfo(GrSurface* dstSurface, int width, int height,
bsalomonf0674512015-07-28 13:26:15 -0700558 GrPixelConfig srcConfig, DrawPreference*,
559 WritePixelTempDrawInfo*) = 0;
560
bsalomon6cb3cbe2015-07-30 07:34:27 -0700561 // overridden by backend-specific derived class to perform the surface read
562 virtual bool onReadPixels(GrSurface*,
egdaniel6d901da2015-07-30 12:02:15 -0700563 int left, int top,
564 int width, int height,
bsalomon@google.comc4364992011-11-07 15:54:49 +0000565 GrPixelConfig,
566 void* buffer,
senorblanco@chromium.org3cb406b2013-02-05 19:50:46 +0000567 size_t rowBytes) = 0;
bsalomon@google.coma7f84e12011-03-10 14:13:19 +0000568
bsalomon6cb3cbe2015-07-30 07:34:27 -0700569 // overridden by backend-specific derived class to perform the surface write
570 virtual bool onWritePixels(GrSurface*,
571 int left, int top, int width, int height,
cblume55f2d2d2016-02-26 13:20:48 -0800572 GrPixelConfig config,
573 const SkTArray<GrMipLevel>& texels) = 0;
bsalomon@google.com6f379512011-11-16 20:36:03 +0000574
jvanverth17aa0472016-01-05 10:41:27 -0800575 // overridden by backend-specific derived class to perform the surface write
576 virtual bool onTransferPixels(GrSurface*,
577 int left, int top, int width, int height,
cdalton397536c2016-03-25 12:15:03 -0700578 GrPixelConfig config, GrBuffer* transferBuffer,
jvanverth17aa0472016-01-05 10:41:27 -0800579 size_t offset, size_t rowBytes) = 0;
580
bsalomon@google.com16e3dde2012-10-25 18:43:28 +0000581 // overridden by backend-specific derived class to perform the resolve
bsalomon@google.com75f9f252012-01-31 13:35:56 +0000582 virtual void onResolveRenderTarget(GrRenderTarget* target) = 0;
583
joshualitt1cbdcde2015-08-21 11:53:29 -0700584 // overridden by backend specific derived class to perform the copy surface
585 virtual bool onCopySurface(GrSurface* dst,
586 GrSurface* src,
587 const SkIRect& srcRect,
588 const SkIPoint& dstPoint) = 0;
589
cdalton28f45b92016-03-07 13:58:26 -0800590 // overridden by backend specific derived class to perform the multisample queries
591 virtual void onGetMultisampleSpecs(GrRenderTarget*,
592 const GrStencilSettings&,
593 int* effectiveSampleCnt,
594 SkAutoTDeleteArray<SkPoint>* sampleLocations) = 0;
595
bsalomon@google.comb635d392011-11-05 12:47:43 +0000596 void resetContext() {
bsalomon@google.com0a208a12013-06-28 18:57:35 +0000597 this->onResetContext(fResetBits);
598 fResetBits = 0;
bsalomon@google.comb635d392011-11-05 12:47:43 +0000599 ++fResetTimestamp;
600 }
601
bsalomon@google.com02ddc8b2013-01-28 15:35:28 +0000602 ResetTimestamp fResetTimestamp;
bsalomon@google.com0a208a12013-06-28 18:57:35 +0000603 uint32_t fResetBits;
cdalton28f45b92016-03-07 13:58:26 -0800604 SkTArray<const MultisampleSpecs*, true> fMultisampleSpecsMap;
605 GrTAllocator<MultisampleSpecs> fMultisampleSpecsAllocator;
joshualitt3322fa42014-11-07 08:48:51 -0800606 // The context owns us, not vice-versa, so this ptr is not ref'ed by Gpu.
607 GrContext* fContext;
bsalomon@google.com02ddc8b2013-01-28 15:35:28 +0000608
kkinnunencabe20c2015-06-01 01:37:26 -0700609 friend class GrPathRendering;
joshualitt3322fa42014-11-07 08:48:51 -0800610 typedef SkRefCnt INHERITED;
reed@google.comac10a2d2010-12-22 21:39:39 +0000611};
612
613#endif