blob: 8562d1e50959371a22b322ca75909d76ff15c655 [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
bsalomonc8dc1f72014-08-21 13:02:13 -070064 // Called by GrContext when the underlying backend context has been destroyed.
65 // GrGpu should use this to ensure that no backend API calls will be made from
66 // here onward, including in its destructor. Subclasses should call
robertphillipse3371302014-09-17 06:01:06 -070067 // INHERITED::contextAbandoned() if they override this.
68 virtual void contextAbandoned();
bsalomonc8dc1f72014-08-21 13:02:13 -070069
reed@google.comac10a2d2010-12-22 21:39:39 +000070 /**
71 * The GrGpu object normally assumes that no outsider is setting state
72 * within the underlying 3D API's context/device/whatever. This call informs
bsalomon@google.coma7f84e12011-03-10 14:13:19 +000073 * the GrGpu that the state was modified and it shouldn't make assumptions
74 * about the state.
reed@google.comac10a2d2010-12-22 21:39:39 +000075 */
mtkleinb9eb4ac2015-02-02 18:26:03 -080076 void markContextDirty(uint32_t state = kAll_GrBackendState) { fResetBits |= state; }
reed@google.comac10a2d2010-12-22 21:39:39 +000077
78 /**
bsalomon6d467ec2014-11-18 07:36:19 -080079 * Creates a texture object. If kRenderTarget_GrSurfaceFlag the texture can
80 * be used as a render target by calling GrTexture::asRenderTarget(). Not all
81 * pixel configs can be used as render targets. Support for configs as textures
bsalomon4b91f762015-05-19 09:29:46 -070082 * or render targets can be checked using GrCaps.
bsalomon@google.com1da07462011-03-10 14:51:57 +000083 *
reed@google.comac10a2d2010-12-22 21:39:39 +000084 * @param desc describes the texture to be created.
bsalomon5236cf42015-01-14 10:42:08 -080085 * @param budgeted does this texture count against the resource cache budget?
cblume55f2d2d2016-02-26 13:20:48 -080086 * @param texels array of mipmap levels containing texel data to load.
87 * Each level begins with full-size palette data for paletted textures.
88 * For compressed formats the level contains the compressed pixel data.
89 * Otherwise, it contains width*height texels. If there is only one
90 * element and it contains nullptr fPixels, texture data is
91 * uninitialized.
halcanary96fcdcc2015-08-27 07:41:13 -070092 * @return The texture object if successful, otherwise nullptr.
reed@google.comac10a2d2010-12-22 21:39:39 +000093 */
bsalomon5ec26ae2016-02-25 08:33:02 -080094 GrTexture* createTexture(const GrSurfaceDesc& desc, SkBudgeted budgeted,
cblume55f2d2d2016-02-26 13:20:48 -080095 const SkTArray<GrMipLevel>& texels);
96
97 /**
bsalomone699d0c2016-03-09 06:25:15 -080098 * Simplified createTexture() interface for when there is no initial texel data to upload.
cblume55f2d2d2016-02-26 13:20:48 -080099 */
bsalomone699d0c2016-03-09 06:25:15 -0800100 GrTexture* createTexture(const GrSurfaceDesc& desc, SkBudgeted budgeted) {
101 return this->createTexture(desc, budgeted, SkTArray<GrMipLevel>());
102 }
103
104 /** Simplified createTexture() interface for when there is only a base level */
105 GrTexture* createTexture(const GrSurfaceDesc& desc, SkBudgeted budgeted, const void* level0Data,
106 size_t rowBytes) {
107 SkASSERT(level0Data);
108 GrMipLevel level = { level0Data, rowBytes };
109 SkSTArray<1, GrMipLevel> array;
110 array.push_back() = level;
111 return this->createTexture(desc, budgeted, array);
112 }
bsalomond3312592016-03-04 07:06:43 -0800113
bsalomon@google.come269f212011-11-07 13:29:52 +0000114 /**
ericrkf7b8b8a2016-02-24 14:49:51 -0800115 * Implements GrTextureProvider::wrapBackendTexture
bsalomon@google.come269f212011-11-07 13:29:52 +0000116 */
bsalomon6dc6f5f2015-06-18 09:12:16 -0700117 GrTexture* wrapBackendTexture(const GrBackendTextureDesc&, GrWrapOwnership);
bsalomon@google.come269f212011-11-07 13:29:52 +0000118
119 /**
brianosman436d9852016-02-25 13:40:42 -0800120 * Implements GrTextureProvider::wrapBackendRenderTarget
bsalomon@google.come269f212011-11-07 13:29:52 +0000121 */
bsalomon6dc6f5f2015-06-18 09:12:16 -0700122 GrRenderTarget* wrapBackendRenderTarget(const GrBackendRenderTargetDesc&, GrWrapOwnership);
bsalomon@google.come269f212011-11-07 13:29:52 +0000123
124 /**
ericrkf7b8b8a2016-02-24 14:49:51 -0800125 * Implements GrTextureProvider::wrapBackendTextureAsRenderTarget
126 */
127 GrRenderTarget* wrapBackendTextureAsRenderTarget(const GrBackendTextureDesc&, GrWrapOwnership);
128
129 /**
cdalton397536c2016-03-25 12:15:03 -0700130 * Creates a buffer.
reed@google.comac10a2d2010-12-22 21:39:39 +0000131 *
cdalton397536c2016-03-25 12:15:03 -0700132 * @return the buffer if successful, otherwise nullptr.
reed@google.comac10a2d2010-12-22 21:39:39 +0000133 */
cdalton397536c2016-03-25 12:15:03 -0700134 GrBuffer* createBuffer(GrBufferType, size_t size, GrAccessPattern);
halcanary9d524f22016-03-29 09:03:52 -0700135
reed@google.comac10a2d2010-12-22 21:39:39 +0000136 /**
bsalomon@google.com75f9f252012-01-31 13:35:56 +0000137 * Resolves MSAA.
138 */
139 void resolveRenderTarget(GrRenderTarget* target);
140
bsalomonf0674512015-07-28 13:26:15 -0700141 /** Info struct returned by getReadPixelsInfo about performing intermediate draws before
bsalomon39826022015-07-23 08:07:21 -0700142 reading pixels for performance or correctness. */
143 struct ReadPixelTempDrawInfo {
144 /** If the GrGpu is requesting that the caller do a draw to an intermediate surface then
145 this is descriptor for the temp surface. The draw should always be a rect with
146 dst 0,0,w,h. */
147 GrSurfaceDesc fTempSurfaceDesc;
148 /** Indicates whether there is a performance advantage to using an exact match texture
149 (in terms of width and height) for the intermediate texture instead of approximate. */
150 bool fUseExactScratch;
bsalomon6c9cd552016-01-22 07:17:34 -0800151 /** Swizzle to apply during the draw. This is used to compensate for either feature or
152 performance limitations in the underlying 3D API. */
153 GrSwizzle fSwizzle;
154 /** The config that should be used to read from the temp surface after the draw. This may be
155 different than the original read config in order to compensate for swizzling. The
156 read data will effectively be in the original read config. */
157 GrPixelConfig fReadConfig;
bsalomon39826022015-07-23 08:07:21 -0700158 };
bsalomon6c9cd552016-01-22 07:17:34 -0800159
bsalomon39826022015-07-23 08:07:21 -0700160 /** Describes why an intermediate draw must/should be performed before readPixels. */
161 enum DrawPreference {
162 /** On input means that the caller would proceed without draw if the GrGpu doesn't request
163 one.
164 On output means that the GrGpu is not requesting a draw. */
165 kNoDraw_DrawPreference,
166 /** Means that the client would prefer a draw for performance of the readback but
167 can satisfy a straight readPixels call on the inputs without an intermediate draw.
168 getReadPixelsInfo will never set the draw preference to this value but may leave
169 it set. */
170 kCallerPrefersDraw_DrawPreference,
171 /** On output means that GrGpu would prefer a draw for performance of the readback but
172 can satisfy a straight readPixels call on the inputs without an intermediate draw. The
173 caller of getReadPixelsInfo should never specify this on intput. */
174 kGpuPrefersDraw_DrawPreference,
175 /** On input means that the caller requires a draw to do a transformation and there is no
176 CPU fallback.
177 On output means that GrGpu can only satisfy the readPixels request if the intermediate
178 draw is performed.
179 */
180 kRequireDraw_DrawPreference
181 };
182
bsalomonf0674512015-07-28 13:26:15 -0700183 /**
184 * Used to negotiate whether and how an intermediate draw should or must be performed before
185 * a readPixels call. If this returns false then GrGpu could not deduce an intermediate draw
186 * that would allow a successful readPixels call. The passed width, height, and rowBytes,
187 * must be non-zero and already reflect clipping to the src bounds.
188 */
189 bool getReadPixelsInfo(GrSurface* srcSurface, int readWidth, int readHeight, size_t rowBytes,
190 GrPixelConfig readConfig, DrawPreference*, ReadPixelTempDrawInfo*);
191
cblume61214052016-01-26 09:10:48 -0800192 /** Info struct returned by getWritePixelsInfo about performing an intermediate draw in order
bsalomonf0674512015-07-28 13:26:15 -0700193 to write pixels to a GrSurface for either performance or correctness reasons. */
194 struct WritePixelTempDrawInfo {
195 /** If the GrGpu is requesting that the caller upload to an intermediate surface and draw
196 that to the dst then this is the descriptor for the intermediate surface. The caller
197 should upload the pixels such that the upper left pixel of the upload rect is at 0,0 in
198 the intermediate surface.*/
199 GrSurfaceDesc fTempSurfaceDesc;
bsalomon6c9cd552016-01-22 07:17:34 -0800200 /** Swizzle to apply during the draw. This is used to compensate for either feature or
201 performance limitations in the underlying 3D API. */
202 GrSwizzle fSwizzle;
203 /** The config that should be specified when uploading the *original* data to the temp
204 surface before the draw. This may be different than the original src data config in
205 order to compensate for swizzling that will occur when drawing. */
206 GrPixelConfig fWriteConfig;
bsalomonf0674512015-07-28 13:26:15 -0700207 };
bsalomon39826022015-07-23 08:07:21 -0700208
bsalomon@google.com75f9f252012-01-31 13:35:56 +0000209 /**
bsalomonf0674512015-07-28 13:26:15 -0700210 * Used to negotiate whether and how an intermediate surface should be used to write pixels to
211 * a GrSurface. If this returns false then GrGpu could not deduce an intermediate draw
212 * that would allow a successful transfer of the src pixels to the dst. The passed width,
213 * height, and rowBytes, must be non-zero and already reflect clipping to the dst bounds.
bsalomon@google.com0a97be22011-11-08 19:20:57 +0000214 */
cblumeed828002016-02-16 13:00:01 -0800215 bool getWritePixelsInfo(GrSurface* dstSurface, int width, int height,
bsalomonf0674512015-07-28 13:26:15 -0700216 GrPixelConfig srcConfig, DrawPreference*, WritePixelTempDrawInfo*);
bsalomon@google.coma85449d2011-11-19 02:36:05 +0000217
218 /**
bsalomon@google.coma04e8e82012-08-27 12:53:13 +0000219 * Reads a rectangle of pixels from a render target.
bsalomon@google.comc4364992011-11-07 15:54:49 +0000220 *
bsalomon6cb3cbe2015-07-30 07:34:27 -0700221 * @param surface The surface to read from
bsalomon@google.com669fdc42011-04-05 17:08:27 +0000222 * @param left left edge of the rectangle to read (inclusive)
223 * @param top top edge of the rectangle to read (inclusive)
224 * @param width width of rectangle to read in pixels.
225 * @param height height of rectangle to read in pixels.
226 * @param config the pixel config of the destination buffer
227 * @param buffer memory to read the rectangle into.
bsalomon@google.comc6980972011-11-02 19:57:21 +0000228 * @param rowBytes the number of bytes between consecutive rows. Zero
229 * means rows are tightly packed.
bsalomon@google.comc4364992011-11-07 15:54:49 +0000230 * @param invertY buffer should be populated bottom-to-top as opposed
231 * to top-to-bottom (skia's usual order)
bsalomon@google.coma7f84e12011-03-10 14:13:19 +0000232 *
233 * @return true if the read succeeded, false if not. The read can fail
234 * because of a unsupported pixel config or because no render
235 * target is currently set.
236 */
bsalomon6cb3cbe2015-07-30 07:34:27 -0700237 bool readPixels(GrSurface* surface,
bsalomon@google.com669fdc42011-04-05 17:08:27 +0000238 int left, int top, int width, int height,
senorblanco@chromium.org3cb406b2013-02-05 19:50:46 +0000239 GrPixelConfig config, void* buffer, size_t rowBytes);
reed@google.comac10a2d2010-12-22 21:39:39 +0000240
bsalomon@google.com6f379512011-11-16 20:36:03 +0000241 /**
bsalomon6cb3cbe2015-07-30 07:34:27 -0700242 * Updates the pixels in a rectangle of a surface.
bsalomon@google.coma85449d2011-11-19 02:36:05 +0000243 *
bsalomon6cb3cbe2015-07-30 07:34:27 -0700244 * @param surface The surface to write to.
bsalomon@google.com6f379512011-11-16 20:36:03 +0000245 * @param left left edge of the rectangle to write (inclusive)
246 * @param top top edge of the rectangle to write (inclusive)
247 * @param width width of rectangle to write in pixels.
248 * @param height height of rectangle to write in pixels.
249 * @param config the pixel config of the source buffer
cblume55f2d2d2016-02-26 13:20:48 -0800250 * @param texels array of mipmap levels containing texture data
251 */
252 bool writePixels(GrSurface* surface,
253 int left, int top, int width, int height,
254 GrPixelConfig config,
255 const SkTArray<GrMipLevel>& texels);
256
257 /**
258 * This function is a shim which creates a SkTArray<GrMipLevel> of size 1.
259 * It then calls writePixels with that SkTArray.
260 *
261 * @param buffer memory to read pixels from.
262 * @param rowBytes number of bytes between consecutive rows. Zero
263 * means rows are tightly packed.
bsalomon@google.com6f379512011-11-16 20:36:03 +0000264 */
bsalomon6cb3cbe2015-07-30 07:34:27 -0700265 bool writePixels(GrSurface* surface,
266 int left, int top, int width, int height,
267 GrPixelConfig config, const void* buffer,
268 size_t rowBytes);
bsalomon@google.com6f379512011-11-16 20:36:03 +0000269
joshualitt3322fa42014-11-07 08:48:51 -0800270 /**
cdalton397536c2016-03-25 12:15:03 -0700271 * Updates the pixels in a rectangle of a surface using a buffer
jvanverth17aa0472016-01-05 10:41:27 -0800272 *
cdalton397536c2016-03-25 12:15:03 -0700273 * @param surface The surface to write to.
274 * @param left left edge of the rectangle to write (inclusive)
275 * @param top top edge of the rectangle to write (inclusive)
276 * @param width width of rectangle to write in pixels.
277 * @param height height of rectangle to write in pixels.
278 * @param config the pixel config of the source buffer
279 * @param transferBuffer GrBuffer to read pixels from (type must be "kCpuToGpu")
280 * @param offset offset from the start of the buffer
281 * @param rowBytes number of bytes between consecutive rows. Zero
282 * means rows are tightly packed.
jvanverth17aa0472016-01-05 10:41:27 -0800283 */
284 bool transferPixels(GrSurface* surface,
285 int left, int top, int width, int height,
cdalton397536c2016-03-25 12:15:03 -0700286 GrPixelConfig config, GrBuffer* transferBuffer,
jvanverth17aa0472016-01-05 10:41:27 -0800287 size_t offset, size_t rowBytes);
288
289 /**
egdaniel51c8d402015-08-06 10:54:13 -0700290 * Clear the passed in render target. Ignores the draw state and clip.
joshualitt3322fa42014-11-07 08:48:51 -0800291 */
egdaniel51c8d402015-08-06 10:54:13 -0700292 void clear(const SkIRect& rect, GrColor color, GrRenderTarget* renderTarget);
joshualitt3322fa42014-11-07 08:48:51 -0800293
294
bsalomon6d467ec2014-11-18 07:36:19 -0800295 void clearStencilClip(const SkIRect& rect, bool insideClip, GrRenderTarget* renderTarget);
joshualitt3322fa42014-11-07 08:48:51 -0800296
297 /**
halcanary96fcdcc2015-08-27 07:41:13 -0700298 * Discards the contents render target. nullptr indicates that the current render target should
joshualitt3322fa42014-11-07 08:48:51 -0800299 * be discarded.
300 **/
halcanary96fcdcc2015-08-27 07:41:13 -0700301 virtual void discard(GrRenderTarget* = nullptr) = 0;
joshualitt3322fa42014-11-07 08:48:51 -0800302
303 /**
304 * This is can be called before allocating a texture to be a dst for copySurface. It will
bsalomonf90a02b2014-11-26 12:28:00 -0800305 * populate the origin, config, and flags fields of the desc such that copySurface can
306 * efficiently succeed. It should only succeed if it can allow copySurface to perform a copy
307 * that would be more effecient than drawing the src to a dst render target.
joshualitt3322fa42014-11-07 08:48:51 -0800308 */
joshualitt1c735482015-07-13 08:08:25 -0700309 virtual bool initCopySurfaceDstDesc(const GrSurface* src, GrSurfaceDesc* desc) const = 0;
joshualitt6db519c2014-10-29 08:48:18 -0700310
bsalomon@google.com80d09b92011-11-05 21:21:13 +0000311 // After the client interacts directly with the 3D context state the GrGpu
312 // must resync its internal state and assumptions about 3D context state.
313 // Each time this occurs the GrGpu bumps a timestamp.
314 // state of the 3D context
315 // At 10 resets / frame and 60fps a 64bit timestamp will overflow in about
316 // a billion years.
317 typedef uint64_t ResetTimestamp;
318
319 // This timestamp is always older than the current timestamp
320 static const ResetTimestamp kExpiredTimestamp = 0;
321 // Returns a timestamp based on the number of times the context was reset.
322 // This timestamp can be used to lazily detect when cached 3D context state
323 // is dirty.
bsalomon6d467ec2014-11-18 07:36:19 -0800324 ResetTimestamp getResetTimestamp() const { return fResetTimestamp; }
bsalomon@google.com80d09b92011-11-05 21:21:13 +0000325
bsalomonf90a02b2014-11-26 12:28:00 -0800326 // Called to perform a surface to surface copy. Fallbacks to issuing a draw from the src to dst
327 // take place at the GrDrawTarget level and this function implement faster copy paths. The rect
328 // and point are pre-clipped. The src rect and implied dst rect are guaranteed to be within the
329 // src/dst bounds and non-empty.
joshualitt1cbdcde2015-08-21 11:53:29 -0700330 bool copySurface(GrSurface* dst,
331 GrSurface* src,
332 const SkIRect& srcRect,
333 const SkIPoint& dstPoint);
joshualitt3322fa42014-11-07 08:48:51 -0800334
cdalton28f45b92016-03-07 13:58:26 -0800335 struct MultisampleSpecs {
336 // Nonzero ID that uniquely identifies these multisample specs.
337 uint8_t fUniqueID;
338 // The actual number of samples the GPU will run. NOTE: this value can be greater than the
339 // the render target's sample count.
340 int fEffectiveSampleCnt;
341 // If sample locations are supported, contains the subpixel locations at which the GPU will
342 // sample. Pixel center is at (.5, .5) and (0, 0) indicates the top left corner.
343 SkAutoTDeleteArray<const SkPoint> fSampleLocations;
344 };
345
346 // Finds a render target's multisample specs. The stencil settings are only needed to flush the
347 // draw state prior to querying multisample information; they should not have any effect on the
348 // multisample information itself.
349 const MultisampleSpecs& getMultisampleSpecs(GrRenderTarget*, const GrStencilSettings&);
350
egdaniel0e1853c2016-03-17 11:35:45 -0700351 // We pass in an array of meshCount GrMesh to the draw. The backend should loop over each
352 // GrMesh object and emit a draw for it. Each draw will use the same GrPipeline and
bsalomon7dbd45d2016-03-23 10:40:53 -0700353 // GrPrimitiveProcessor. This may fail if the draw would exceed any resource limits (e.g.
354 // number of vertex attributes is too large).
355 bool draw(const GrPipeline&,
egdaniel0e1853c2016-03-17 11:35:45 -0700356 const GrPrimitiveProcessor&,
357 const GrMesh*,
358 int meshCount);
bsalomon3e791242014-12-17 13:43:13 -0800359
halcanary9d524f22016-03-29 09:03:52 -0700360 // Called by drawtarget when flushing.
jvanverthd2d2eb92016-02-17 14:04:46 -0800361 // Provides a hook for post-flush actions (e.g. PLS reset and Vulkan command buffer submits).
362 virtual void finishDrawTarget() {}
ethannicholas22793252016-01-30 09:59:10 -0800363
mtkleinb9eb4ac2015-02-02 18:26:03 -0800364 ///////////////////////////////////////////////////////////////////////////
365 // Debugging and Stats
366
367 class Stats {
368 public:
369#if GR_GPU_STATS
370 Stats() { this->reset(); }
371
bsalomonb12ea412015-02-02 21:19:50 -0800372 void reset() {
373 fRenderTargetBinds = 0;
374 fShaderCompilations = 0;
375 fTextureCreates = 0;
376 fTextureUploads = 0;
jvanverth17aa0472016-01-05 10:41:27 -0800377 fTransfersToTexture = 0;
egdaniel8dc7c3a2015-04-16 11:22:42 -0700378 fStencilAttachmentCreates = 0;
joshualitt87a5c9f2015-09-08 13:42:05 -0700379 fNumDraws = 0;
bsalomon1d417a82016-03-23 11:50:26 -0700380 fNumFailedDraws = 0;
bsalomonb12ea412015-02-02 21:19:50 -0800381 }
mtkleinb9eb4ac2015-02-02 18:26:03 -0800382
383 int renderTargetBinds() const { return fRenderTargetBinds; }
384 void incRenderTargetBinds() { fRenderTargetBinds++; }
385 int shaderCompilations() const { return fShaderCompilations; }
386 void incShaderCompilations() { fShaderCompilations++; }
bsalomonb12ea412015-02-02 21:19:50 -0800387 int textureCreates() const { return fTextureCreates; }
388 void incTextureCreates() { fTextureCreates++; }
389 int textureUploads() const { return fTextureUploads; }
390 void incTextureUploads() { fTextureUploads++; }
jvanverth17aa0472016-01-05 10:41:27 -0800391 int transfersToTexture() const { return fTransfersToTexture; }
392 void incTransfersToTexture() { fTransfersToTexture++; }
egdaniel8dc7c3a2015-04-16 11:22:42 -0700393 void incStencilAttachmentCreates() { fStencilAttachmentCreates++; }
joshualitt87a5c9f2015-09-08 13:42:05 -0700394 void incNumDraws() { fNumDraws++; }
bsalomon1d417a82016-03-23 11:50:26 -0700395 void incNumFailedDraws() { ++fNumFailedDraws; }
mtkleinb9eb4ac2015-02-02 18:26:03 -0800396 void dump(SkString*);
joshualitte45c81c2015-12-02 09:05:37 -0800397 void dumpKeyValuePairs(SkTArray<SkString>* keys, SkTArray<double>* values);
bsalomon1d417a82016-03-23 11:50:26 -0700398 int numDraws() const { return fNumDraws; }
399 int numFailedDraws() const { return fNumFailedDraws; }
mtkleinb9eb4ac2015-02-02 18:26:03 -0800400 private:
401 int fRenderTargetBinds;
402 int fShaderCompilations;
bsalomonb12ea412015-02-02 21:19:50 -0800403 int fTextureCreates;
404 int fTextureUploads;
jvanverth17aa0472016-01-05 10:41:27 -0800405 int fTransfersToTexture;
egdaniel8dc7c3a2015-04-16 11:22:42 -0700406 int fStencilAttachmentCreates;
joshualitt87a5c9f2015-09-08 13:42:05 -0700407 int fNumDraws;
bsalomon1d417a82016-03-23 11:50:26 -0700408 int fNumFailedDraws;
mtkleinb9eb4ac2015-02-02 18:26:03 -0800409#else
joshualitte45c81c2015-12-02 09:05:37 -0800410 void dump(SkString*) {}
411 void dumpKeyValuePairs(SkTArray<SkString>*, SkTArray<double>*) {}
mtkleinb9eb4ac2015-02-02 18:26:03 -0800412 void incRenderTargetBinds() {}
413 void incShaderCompilations() {}
bsalomonb12ea412015-02-02 21:19:50 -0800414 void incTextureCreates() {}
415 void incTextureUploads() {}
jvanverth17aa0472016-01-05 10:41:27 -0800416 void incTransfersToTexture() {}
egdaniel8dc7c3a2015-04-16 11:22:42 -0700417 void incStencilAttachmentCreates() {}
joshualitt87a5c9f2015-09-08 13:42:05 -0700418 void incNumDraws() {}
bsalomon1d417a82016-03-23 11:50:26 -0700419 void incNumFailedDraws() {}
mtkleinb9eb4ac2015-02-02 18:26:03 -0800420#endif
421 };
422
423 Stats* stats() { return &fStats; }
424
bsalomon67d76202015-11-11 12:40:42 -0800425 /** Creates a texture directly in the backend API without wrapping it in a GrTexture. This is
426 only to be used for testing (particularly for testing the methods that import an externally
427 created texture into Skia. Must be matched with a call to deleteTestingOnlyTexture(). */
jvanverth88957922015-07-14 11:02:52 -0700428 virtual GrBackendObject createTestingOnlyBackendTexture(void* pixels, int w, int h,
bsalomone63ffef2016-02-05 07:17:34 -0800429 GrPixelConfig config) = 0;
bsalomon67d76202015-11-11 12:40:42 -0800430 /** Check a handle represents an actual texture in the backend API that has not been freed. */
431 virtual bool isTestingOnlyBackendTexture(GrBackendObject) const = 0;
432 /** If ownership of the backend texture has been transferred pass true for abandonTexture. This
433 will do any necessary cleanup of the handle without freeing the texture in the backend
434 API. */
435 virtual void deleteTestingOnlyBackendTexture(GrBackendObject,
bsalomone63ffef2016-02-05 07:17:34 -0800436 bool abandonTexture = false) = 0;
jvanverth672bb7f2015-07-13 07:19:57 -0700437
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;
444 // clears target's entire stencil buffer to 0
445 virtual void clearStencil(GrRenderTarget* target) = 0;
bsalomon6bc1b5f2015-02-23 09:06:38 -0800446
bsalomon6dea83f2015-12-03 12:58:06 -0800447 // draws an outline rectangle for debugging/visualization purposes.
448 virtual void drawDebugWireRect(GrRenderTarget*, const SkIRect&, GrColor) = 0;
bsalomon045802d2015-10-20 07:58:01 -0700449
bsalomone179a912016-01-20 06:18:10 -0800450 // Determines whether a texture will need to be rescaled in order to be used with the
451 // GrTextureParams. This variation is called when the caller will create a new texture using the
452 // texture provider from a non-texture src (cpu-backed image, ...).
bsalomon045802d2015-10-20 07:58:01 -0700453 bool makeCopyForTextureParams(int width, int height, const GrTextureParams&,
bsalomone179a912016-01-20 06:18:10 -0800454 GrTextureProducer::CopyParams*) const;
455
456 // Like the above but this variation should be called when the caller is not creating the
457 // original texture but rather was handed the original texture. It adds additional checks
458 // relevant to original textures that were created external to Skia via
459 // GrTextureProvider::wrap methods.
460 bool makeCopyForTextureParams(GrTexture* texture, const GrTextureParams& params,
461 GrTextureProducer::CopyParams* copyParams) const {
462 if (this->makeCopyForTextureParams(texture->width(), texture->height(), params,
463 copyParams)) {
464 return true;
465 }
466 return this->onMakeCopyForTextureParams(texture, params, copyParams);
467 }
bsalomon045802d2015-10-20 07:58:01 -0700468
jvanverth672bb7f2015-07-13 07:19:57 -0700469 // This is only to be used in GL-specific tests.
halcanary96fcdcc2015-08-27 07:41:13 -0700470 virtual const GrGLContext* glContextForTesting() const { return nullptr; }
bsalomon993a4212015-05-29 11:37:25 -0700471
joshualitt8fd844f2015-12-02 13:36:47 -0800472 // This is only to be used by testing code
473 virtual void resetShaderCacheForTesting() const {}
474
joshualittd53a8272014-11-10 16:03:14 -0800475protected:
bsalomon@google.comd302f142011-03-03 13:54:13 +0000476 // Functions used to map clip-respecting stencil tests into normal
477 // stencil funcs supported by GPUs.
bsalomon@google.coma7f84e12011-03-10 14:13:19 +0000478 static GrStencilFunc ConvertStencilFunc(bool stencilInClip,
bsalomon@google.comd302f142011-03-03 13:54:13 +0000479 GrStencilFunc func);
480 static void ConvertStencilFuncAndMask(GrStencilFunc func,
481 bool clipInStencil,
482 unsigned int clipBit,
483 unsigned int userBits,
484 unsigned int* ref,
485 unsigned int* mask);
486
bsalomonf0674512015-07-28 13:26:15 -0700487 static void ElevateDrawPreference(GrGpu::DrawPreference* preference,
488 GrGpu::DrawPreference elevation) {
489 GR_STATIC_ASSERT(GrGpu::kCallerPrefersDraw_DrawPreference > GrGpu::kNoDraw_DrawPreference);
490 GR_STATIC_ASSERT(GrGpu::kGpuPrefersDraw_DrawPreference >
491 GrGpu::kCallerPrefersDraw_DrawPreference);
492 GR_STATIC_ASSERT(GrGpu::kRequireDraw_DrawPreference >
493 GrGpu::kGpuPrefersDraw_DrawPreference);
494 *preference = SkTMax(*preference, elevation);
495 }
496
joshualitt93316b92015-10-23 09:08:08 -0700497 void handleDirtyContext() {
498 if (fResetBits) {
499 this->resetContext();
500 }
501 }
502
mtkleinb9eb4ac2015-02-02 18:26:03 -0800503 Stats fStats;
504 SkAutoTDelete<GrPathRendering> fPathRendering;
joshualitt3322fa42014-11-07 08:48:51 -0800505 // Subclass must initialize this in its constructor.
bsalomon4b91f762015-05-19 09:29:46 -0700506 SkAutoTUnref<const GrCaps> fCaps;
joshualitt3322fa42014-11-07 08:48:51 -0800507
bsalomon@google.com02ddc8b2013-01-28 15:35:28 +0000508private:
bsalomon@google.comb635d392011-11-05 12:47:43 +0000509 // called when the 3D context state is unknown. Subclass should emit any
bsalomon@google.comc8f7f472012-06-18 13:44:51 +0000510 // assumed 3D context state and dirty any state cache.
bsalomon@google.com0a208a12013-06-28 18:57:35 +0000511 virtual void onResetContext(uint32_t resetBits) = 0;
bsalomon@google.coma7f84e12011-03-10 14:13:19 +0000512
bsalomoncb02b382015-08-12 11:14:50 -0700513 // Called before certain draws in order to guarantee coherent results from dst reads.
514 virtual void xferBarrier(GrRenderTarget*, GrXferBarrierType) = 0;
515
bsalomon@google.com16e3dde2012-10-25 18:43:28 +0000516 // overridden by backend-specific derived class to create objects.
egdanielb0e1be22015-04-22 13:27:39 -0700517 // Texture size and sample size will have already been validated in base class before
518 // onCreateTexture/CompressedTexture are called.
519 virtual GrTexture* onCreateTexture(const GrSurfaceDesc& desc,
520 GrGpuResource::LifeCycle lifeCycle,
cblume55f2d2d2016-02-26 13:20:48 -0800521 const SkTArray<GrMipLevel>& texels) = 0;
egdanielb0e1be22015-04-22 13:27:39 -0700522 virtual GrTexture* onCreateCompressedTexture(const GrSurfaceDesc& desc,
523 GrGpuResource::LifeCycle lifeCycle,
cblume55f2d2d2016-02-26 13:20:48 -0800524 const SkTArray<GrMipLevel>& texels) = 0;
525
bsalomon6dc6f5f2015-06-18 09:12:16 -0700526 virtual GrTexture* onWrapBackendTexture(const GrBackendTextureDesc&, GrWrapOwnership) = 0;
527 virtual GrRenderTarget* onWrapBackendRenderTarget(const GrBackendRenderTargetDesc&,
528 GrWrapOwnership) = 0;
ericrkf7b8b8a2016-02-24 14:49:51 -0800529 virtual GrRenderTarget* onWrapBackendTextureAsRenderTarget(const GrBackendTextureDesc&,
530 GrWrapOwnership) = 0;
cdalton397536c2016-03-25 12:15:03 -0700531 virtual GrBuffer* onCreateBuffer(GrBufferType, size_t size, GrAccessPattern) = 0;
bsalomon@google.coma7f84e12011-03-10 14:13:19 +0000532
bsalomon63b21962014-11-05 07:05:34 -0800533 // overridden by backend-specific derived class to perform the clear.
egdaniel51c8d402015-08-06 10:54:13 -0700534 virtual void onClear(GrRenderTarget*, const SkIRect& rect, GrColor color) = 0;
bsalomon@google.coma7f84e12011-03-10 14:13:19 +0000535
joshualitt6db519c2014-10-29 08:48:18 -0700536 // Overridden by backend specific classes to perform a clear of the stencil clip bits. This is
537 // ONLY used by the the clip target
mtkleinb9eb4ac2015-02-02 18:26:03 -0800538 virtual void onClearStencilClip(GrRenderTarget*, const SkIRect& rect, bool insideClip) = 0;
joshualitt6db519c2014-10-29 08:48:18 -0700539
bsalomon@google.com16e3dde2012-10-25 18:43:28 +0000540 // overridden by backend-specific derived class to perform the draw call.
egdaniel0e1853c2016-03-17 11:35:45 -0700541 virtual void onDraw(const GrPipeline&,
542 const GrPrimitiveProcessor&,
543 const GrMesh*,
544 int meshCount) = 0;
bsalomon3e791242014-12-17 13:43:13 -0800545
bsalomone179a912016-01-20 06:18:10 -0800546 virtual bool onMakeCopyForTextureParams(GrTexture* texture, const GrTextureParams&,
547 GrTextureProducer::CopyParams*) const { return false; }
548
bsalomonf0674512015-07-28 13:26:15 -0700549 virtual bool onGetReadPixelsInfo(GrSurface* srcSurface, int readWidth, int readHeight,
550 size_t rowBytes, GrPixelConfig readConfig, DrawPreference*,
551 ReadPixelTempDrawInfo*) = 0;
cblumeed828002016-02-16 13:00:01 -0800552 virtual bool onGetWritePixelsInfo(GrSurface* dstSurface, int width, int height,
bsalomonf0674512015-07-28 13:26:15 -0700553 GrPixelConfig srcConfig, DrawPreference*,
554 WritePixelTempDrawInfo*) = 0;
555
bsalomon6cb3cbe2015-07-30 07:34:27 -0700556 // overridden by backend-specific derived class to perform the surface read
557 virtual bool onReadPixels(GrSurface*,
egdaniel6d901da2015-07-30 12:02:15 -0700558 int left, int top,
559 int width, int height,
bsalomon@google.comc4364992011-11-07 15:54:49 +0000560 GrPixelConfig,
561 void* buffer,
senorblanco@chromium.org3cb406b2013-02-05 19:50:46 +0000562 size_t rowBytes) = 0;
bsalomon@google.coma7f84e12011-03-10 14:13:19 +0000563
bsalomon6cb3cbe2015-07-30 07:34:27 -0700564 // overridden by backend-specific derived class to perform the surface write
565 virtual bool onWritePixels(GrSurface*,
566 int left, int top, int width, int height,
cblume55f2d2d2016-02-26 13:20:48 -0800567 GrPixelConfig config,
568 const SkTArray<GrMipLevel>& texels) = 0;
bsalomon@google.com6f379512011-11-16 20:36:03 +0000569
jvanverth17aa0472016-01-05 10:41:27 -0800570 // overridden by backend-specific derived class to perform the surface write
571 virtual bool onTransferPixels(GrSurface*,
572 int left, int top, int width, int height,
cdalton397536c2016-03-25 12:15:03 -0700573 GrPixelConfig config, GrBuffer* transferBuffer,
jvanverth17aa0472016-01-05 10:41:27 -0800574 size_t offset, size_t rowBytes) = 0;
575
bsalomon@google.com16e3dde2012-10-25 18:43:28 +0000576 // overridden by backend-specific derived class to perform the resolve
bsalomon@google.com75f9f252012-01-31 13:35:56 +0000577 virtual void onResolveRenderTarget(GrRenderTarget* target) = 0;
578
joshualitt1cbdcde2015-08-21 11:53:29 -0700579 // overridden by backend specific derived class to perform the copy surface
580 virtual bool onCopySurface(GrSurface* dst,
581 GrSurface* src,
582 const SkIRect& srcRect,
583 const SkIPoint& dstPoint) = 0;
584
cdalton28f45b92016-03-07 13:58:26 -0800585 // overridden by backend specific derived class to perform the multisample queries
586 virtual void onGetMultisampleSpecs(GrRenderTarget*,
587 const GrStencilSettings&,
588 int* effectiveSampleCnt,
589 SkAutoTDeleteArray<SkPoint>* sampleLocations) = 0;
590
bsalomon@google.comb635d392011-11-05 12:47:43 +0000591 void resetContext() {
bsalomon@google.com0a208a12013-06-28 18:57:35 +0000592 this->onResetContext(fResetBits);
593 fResetBits = 0;
bsalomon@google.comb635d392011-11-05 12:47:43 +0000594 ++fResetTimestamp;
595 }
596
bsalomon@google.com02ddc8b2013-01-28 15:35:28 +0000597 ResetTimestamp fResetTimestamp;
bsalomon@google.com0a208a12013-06-28 18:57:35 +0000598 uint32_t fResetBits;
cdalton28f45b92016-03-07 13:58:26 -0800599 SkTArray<const MultisampleSpecs*, true> fMultisampleSpecsMap;
600 GrTAllocator<MultisampleSpecs> fMultisampleSpecsAllocator;
joshualitt3322fa42014-11-07 08:48:51 -0800601 // The context owns us, not vice-versa, so this ptr is not ref'ed by Gpu.
602 GrContext* fContext;
bsalomon@google.com02ddc8b2013-01-28 15:35:28 +0000603
kkinnunencabe20c2015-06-01 01:37:26 -0700604 friend class GrPathRendering;
joshualitt3322fa42014-11-07 08:48:51 -0800605 typedef SkRefCnt INHERITED;
reed@google.comac10a2d2010-12-22 21:39:39 +0000606};
607
608#endif