blob: 3e3a4cd676b0388ef72b41def0fc3f7d6f5e0256 [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
egdaniel066df7c2016-06-08 14:02:27 -070011#include "GrGpuCommandBuffer.h"
joshualitt79f8fae2014-10-28 17:59:26 -070012#include "GrProgramDesc.h"
bsalomon6c9cd552016-01-22 07:17:34 -080013#include "GrSwizzle.h"
cdalton28f45b92016-03-07 13:58:26 -080014#include "GrAllocator.h"
bsalomon045802d2015-10-20 07:58:01 -070015#include "GrTextureParamsAdjuster.h"
cblume55f2d2d2016-02-26 13:20:48 -080016#include "GrTypes.h"
kkinnunencabe20c2015-06-01 01:37:26 -070017#include "GrXferProcessor.h"
sugoi@google.com12b4e272012-12-06 20:13:11 +000018#include "SkPath.h"
cblume55f2d2d2016-02-26 13:20:48 -080019#include "SkTArray.h"
csmartdalton0d28e572016-07-06 09:59:43 -070020#include <map>
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;
robertphillips28a838e2016-06-23 14:07:00 -070025struct GrContextOptions;
reedf9ad5582015-06-25 21:29:25 -070026class GrGLContext;
egdaniel0e1853c2016-03-17 11:35:45 -070027class GrMesh;
bsalomone64eb572015-05-07 11:35:55 -070028class GrNonInstancedVertices;
bsalomon@google.com64aef2b2012-06-11 15:36:13 +000029class GrPath;
cdaltonb85a0aa2014-07-21 15:32:44 -070030class GrPathRange;
bsalomon@google.com30085192011-08-19 15:42:31 +000031class GrPathRenderer;
32class GrPathRendererChain;
kkinnunencabe20c2015-06-01 01:37:26 -070033class GrPathRendering;
egdaniel8dd688b2015-01-22 10:16:09 -080034class GrPipeline;
joshualitt873ad0e2015-01-20 09:08:51 -080035class GrPrimitiveProcessor;
kkinnunencabe20c2015-06-01 01:37:26 -070036class GrRenderTarget;
egdaniel8dc7c3a2015-04-16 11:22:42 -070037class GrStencilAttachment;
cdalton93a379b2016-05-11 13:58:08 -070038class GrStencilSettings;
kkinnunencabe20c2015-06-01 01:37:26 -070039class GrSurface;
40class GrTexture;
reed@google.comac10a2d2010-12-22 21:39:39 +000041
csmartdaltona7f29642016-07-07 08:49:11 -070042namespace gr_instanced { class InstancedRendering; }
43
joshualitt3322fa42014-11-07 08:48:51 -080044class GrGpu : public SkRefCnt {
reed@google.comac10a2d2010-12-22 21:39:39 +000045public:
46 /**
bsalomon@google.com16e3dde2012-10-25 18:43:28 +000047 * Create an instance of GrGpu that matches the specified backend. If the requested backend is
halcanary96fcdcc2015-08-27 07:41:13 -070048 * not supported (at compile-time or run-time) this returns nullptr. The context will not be
bsalomon@google.com6e4e6502013-02-25 20:12:45 +000049 * fully constructed and should not be used by GrGpu until after this function returns.
reed@google.comac10a2d2010-12-22 21:39:39 +000050 */
bsalomon682c2692015-05-22 14:01:46 -070051 static GrGpu* Create(GrBackend, GrBackendContext, const GrContextOptions&, GrContext* context);
reed@google.comac10a2d2010-12-22 21:39:39 +000052
53 ////////////////////////////////////////////////////////////////////////////
54
bsalomon@google.com6e4e6502013-02-25 20:12:45 +000055 GrGpu(GrContext* context);
mtklein36352bf2015-03-25 18:17:31 -070056 ~GrGpu() override;
reed@google.comac10a2d2010-12-22 21:39:39 +000057
joshualitt3322fa42014-11-07 08:48:51 -080058 GrContext* getContext() { return fContext; }
59 const GrContext* getContext() const { return fContext; }
60
61 /**
62 * Gets the capabilities of the draw target.
63 */
bsalomon4b91f762015-05-19 09:29:46 -070064 const GrCaps* caps() const { return fCaps.get(); }
joshualitt3322fa42014-11-07 08:48:51 -080065
kkinnunencabe20c2015-06-01 01:37:26 -070066 GrPathRendering* pathRendering() { return fPathRendering.get(); }
kkinnunenccdaa042014-08-20 01:36:23 -070067
bsalomon6e2aad42016-04-01 11:54:31 -070068 enum class DisconnectType {
69 // No cleanup should be attempted, immediately cease making backend API calls
70 kAbandon,
71 // Free allocated resources (not known by GrResourceCache) before returning and
72 // ensure no backend backend 3D API calls will be made after disconnect() returns.
73 kCleanup,
74 };
75
76 // Called by GrContext when the underlying backend context is already or will be destroyed
77 // before GrContext.
78 virtual void disconnect(DisconnectType);
bsalomonc8dc1f72014-08-21 13:02:13 -070079
reed@google.comac10a2d2010-12-22 21:39:39 +000080 /**
81 * The GrGpu object normally assumes that no outsider is setting state
82 * within the underlying 3D API's context/device/whatever. This call informs
bsalomon@google.coma7f84e12011-03-10 14:13:19 +000083 * the GrGpu that the state was modified and it shouldn't make assumptions
84 * about the state.
reed@google.comac10a2d2010-12-22 21:39:39 +000085 */
mtkleinb9eb4ac2015-02-02 18:26:03 -080086 void markContextDirty(uint32_t state = kAll_GrBackendState) { fResetBits |= state; }
reed@google.comac10a2d2010-12-22 21:39:39 +000087
88 /**
bsalomon6d467ec2014-11-18 07:36:19 -080089 * Creates a texture object. If kRenderTarget_GrSurfaceFlag the texture can
90 * be used as a render target by calling GrTexture::asRenderTarget(). Not all
91 * pixel configs can be used as render targets. Support for configs as textures
bsalomon4b91f762015-05-19 09:29:46 -070092 * or render targets can be checked using GrCaps.
bsalomon@google.com1da07462011-03-10 14:51:57 +000093 *
reed@google.comac10a2d2010-12-22 21:39:39 +000094 * @param desc describes the texture to be created.
bsalomon5236cf42015-01-14 10:42:08 -080095 * @param budgeted does this texture count against the resource cache budget?
cblume55f2d2d2016-02-26 13:20:48 -080096 * @param texels array of mipmap levels containing texel data to load.
97 * Each level begins with full-size palette data for paletted textures.
98 * For compressed formats the level contains the compressed pixel data.
99 * Otherwise, it contains width*height texels. If there is only one
100 * element and it contains nullptr fPixels, texture data is
101 * uninitialized.
halcanary96fcdcc2015-08-27 07:41:13 -0700102 * @return The texture object if successful, otherwise nullptr.
reed@google.comac10a2d2010-12-22 21:39:39 +0000103 */
bsalomon5ec26ae2016-02-25 08:33:02 -0800104 GrTexture* createTexture(const GrSurfaceDesc& desc, SkBudgeted budgeted,
cblume55f2d2d2016-02-26 13:20:48 -0800105 const SkTArray<GrMipLevel>& texels);
106
107 /**
bsalomone699d0c2016-03-09 06:25:15 -0800108 * Simplified createTexture() interface for when there is no initial texel data to upload.
cblume55f2d2d2016-02-26 13:20:48 -0800109 */
bsalomone699d0c2016-03-09 06:25:15 -0800110 GrTexture* createTexture(const GrSurfaceDesc& desc, SkBudgeted budgeted) {
111 return this->createTexture(desc, budgeted, SkTArray<GrMipLevel>());
112 }
113
114 /** Simplified createTexture() interface for when there is only a base level */
115 GrTexture* createTexture(const GrSurfaceDesc& desc, SkBudgeted budgeted, const void* level0Data,
116 size_t rowBytes) {
117 SkASSERT(level0Data);
118 GrMipLevel level = { level0Data, rowBytes };
119 SkSTArray<1, GrMipLevel> array;
120 array.push_back() = level;
121 return this->createTexture(desc, budgeted, array);
122 }
bsalomond3312592016-03-04 07:06:43 -0800123
bsalomon@google.come269f212011-11-07 13:29:52 +0000124 /**
ericrkf7b8b8a2016-02-24 14:49:51 -0800125 * Implements GrTextureProvider::wrapBackendTexture
bsalomon@google.come269f212011-11-07 13:29:52 +0000126 */
bsalomon6dc6f5f2015-06-18 09:12:16 -0700127 GrTexture* wrapBackendTexture(const GrBackendTextureDesc&, GrWrapOwnership);
bsalomon@google.come269f212011-11-07 13:29:52 +0000128
129 /**
brianosman436d9852016-02-25 13:40:42 -0800130 * Implements GrTextureProvider::wrapBackendRenderTarget
bsalomon@google.come269f212011-11-07 13:29:52 +0000131 */
bsalomon6dc6f5f2015-06-18 09:12:16 -0700132 GrRenderTarget* wrapBackendRenderTarget(const GrBackendRenderTargetDesc&, GrWrapOwnership);
bsalomon@google.come269f212011-11-07 13:29:52 +0000133
134 /**
ericrkf7b8b8a2016-02-24 14:49:51 -0800135 * Implements GrTextureProvider::wrapBackendTextureAsRenderTarget
136 */
kkinnunen49c4c222016-04-01 04:50:37 -0700137 GrRenderTarget* wrapBackendTextureAsRenderTarget(const GrBackendTextureDesc&);
ericrkf7b8b8a2016-02-24 14:49:51 -0800138
139 /**
csmartdalton485a1202016-07-13 10:16:32 -0700140 * Creates a buffer in GPU memory. For a client-side buffer use GrBuffer::CreateCPUBacked.
reed@google.comac10a2d2010-12-22 21:39:39 +0000141 *
cdaltone2e71c22016-04-07 18:13:29 -0700142 * @param size size of buffer to create.
143 * @param intendedType hint to the graphics subsystem about what the buffer will be used for.
144 * @param accessPattern hint to the graphics subsystem about how the data will be accessed.
cdalton1bf3e712016-04-19 10:00:02 -0700145 * @param data optional data with which to initialize the buffer.
cdaltone2e71c22016-04-07 18:13:29 -0700146 *
cdalton397536c2016-03-25 12:15:03 -0700147 * @return the buffer if successful, otherwise nullptr.
reed@google.comac10a2d2010-12-22 21:39:39 +0000148 */
cdalton1bf3e712016-04-19 10:00:02 -0700149 GrBuffer* createBuffer(size_t size, GrBufferType intendedType, GrAccessPattern accessPattern,
150 const void* data = nullptr);
halcanary9d524f22016-03-29 09:03:52 -0700151
reed@google.comac10a2d2010-12-22 21:39:39 +0000152 /**
csmartdaltona7f29642016-07-07 08:49:11 -0700153 * Creates an instanced rendering object if it is supported on this platform.
154 */
csmartdaltone0d36292016-07-29 08:14:20 -0700155 gr_instanced::InstancedRendering* createInstancedRendering();
csmartdaltona7f29642016-07-07 08:49:11 -0700156
157 /**
bsalomon@google.com75f9f252012-01-31 13:35:56 +0000158 * Resolves MSAA.
159 */
160 void resolveRenderTarget(GrRenderTarget* target);
161
bsalomonf0674512015-07-28 13:26:15 -0700162 /** Info struct returned by getReadPixelsInfo about performing intermediate draws before
bsalomon39826022015-07-23 08:07:21 -0700163 reading pixels for performance or correctness. */
164 struct ReadPixelTempDrawInfo {
165 /** If the GrGpu is requesting that the caller do a draw to an intermediate surface then
166 this is descriptor for the temp surface. The draw should always be a rect with
167 dst 0,0,w,h. */
168 GrSurfaceDesc fTempSurfaceDesc;
169 /** Indicates whether there is a performance advantage to using an exact match texture
170 (in terms of width and height) for the intermediate texture instead of approximate. */
bsalomonb117ff12016-07-19 07:24:40 -0700171 SkBackingFit fTempSurfaceFit;
bsalomon6c9cd552016-01-22 07:17:34 -0800172 /** Swizzle to apply during the draw. This is used to compensate for either feature or
173 performance limitations in the underlying 3D API. */
174 GrSwizzle fSwizzle;
175 /** The config that should be used to read from the temp surface after the draw. This may be
176 different than the original read config in order to compensate for swizzling. The
177 read data will effectively be in the original read config. */
178 GrPixelConfig fReadConfig;
bsalomon39826022015-07-23 08:07:21 -0700179 };
bsalomon6c9cd552016-01-22 07:17:34 -0800180
bsalomon39826022015-07-23 08:07:21 -0700181 /** Describes why an intermediate draw must/should be performed before readPixels. */
182 enum DrawPreference {
183 /** On input means that the caller would proceed without draw if the GrGpu doesn't request
184 one.
185 On output means that the GrGpu is not requesting a draw. */
186 kNoDraw_DrawPreference,
187 /** Means that the client would prefer a draw for performance of the readback but
188 can satisfy a straight readPixels call on the inputs without an intermediate draw.
189 getReadPixelsInfo will never set the draw preference to this value but may leave
190 it set. */
191 kCallerPrefersDraw_DrawPreference,
192 /** On output means that GrGpu would prefer a draw for performance of the readback but
193 can satisfy a straight readPixels call on the inputs without an intermediate draw. The
194 caller of getReadPixelsInfo should never specify this on intput. */
195 kGpuPrefersDraw_DrawPreference,
196 /** On input means that the caller requires a draw to do a transformation and there is no
197 CPU fallback.
198 On output means that GrGpu can only satisfy the readPixels request if the intermediate
199 draw is performed.
200 */
201 kRequireDraw_DrawPreference
202 };
203
bsalomonf0674512015-07-28 13:26:15 -0700204 /**
205 * Used to negotiate whether and how an intermediate draw should or must be performed before
206 * a readPixels call. If this returns false then GrGpu could not deduce an intermediate draw
207 * that would allow a successful readPixels call. The passed width, height, and rowBytes,
208 * must be non-zero and already reflect clipping to the src bounds.
209 */
210 bool getReadPixelsInfo(GrSurface* srcSurface, int readWidth, int readHeight, size_t rowBytes,
211 GrPixelConfig readConfig, DrawPreference*, ReadPixelTempDrawInfo*);
212
cblume61214052016-01-26 09:10:48 -0800213 /** Info struct returned by getWritePixelsInfo about performing an intermediate draw in order
bsalomonf0674512015-07-28 13:26:15 -0700214 to write pixels to a GrSurface for either performance or correctness reasons. */
215 struct WritePixelTempDrawInfo {
216 /** If the GrGpu is requesting that the caller upload to an intermediate surface and draw
217 that to the dst then this is the descriptor for the intermediate surface. The caller
218 should upload the pixels such that the upper left pixel of the upload rect is at 0,0 in
219 the intermediate surface.*/
220 GrSurfaceDesc fTempSurfaceDesc;
bsalomon6c9cd552016-01-22 07:17:34 -0800221 /** Swizzle to apply during the draw. This is used to compensate for either feature or
222 performance limitations in the underlying 3D API. */
223 GrSwizzle fSwizzle;
224 /** The config that should be specified when uploading the *original* data to the temp
225 surface before the draw. This may be different than the original src data config in
226 order to compensate for swizzling that will occur when drawing. */
227 GrPixelConfig fWriteConfig;
bsalomonf0674512015-07-28 13:26:15 -0700228 };
bsalomon39826022015-07-23 08:07:21 -0700229
bsalomon@google.com75f9f252012-01-31 13:35:56 +0000230 /**
bsalomonf0674512015-07-28 13:26:15 -0700231 * Used to negotiate whether and how an intermediate surface should be used to write pixels to
232 * a GrSurface. If this returns false then GrGpu could not deduce an intermediate draw
233 * that would allow a successful transfer of the src pixels to the dst. The passed width,
234 * height, and rowBytes, must be non-zero and already reflect clipping to the dst bounds.
bsalomon@google.com0a97be22011-11-08 19:20:57 +0000235 */
cblumeed828002016-02-16 13:00:01 -0800236 bool getWritePixelsInfo(GrSurface* dstSurface, int width, int height,
bsalomonf0674512015-07-28 13:26:15 -0700237 GrPixelConfig srcConfig, DrawPreference*, WritePixelTempDrawInfo*);
bsalomon@google.coma85449d2011-11-19 02:36:05 +0000238
239 /**
bsalomon@google.coma04e8e82012-08-27 12:53:13 +0000240 * Reads a rectangle of pixels from a render target.
bsalomon@google.comc4364992011-11-07 15:54:49 +0000241 *
bsalomon6cb3cbe2015-07-30 07:34:27 -0700242 * @param surface The surface to read from
bsalomon@google.com669fdc42011-04-05 17:08:27 +0000243 * @param left left edge of the rectangle to read (inclusive)
244 * @param top top edge of the rectangle to read (inclusive)
245 * @param width width of rectangle to read in pixels.
246 * @param height height of rectangle to read in pixels.
247 * @param config the pixel config of the destination buffer
248 * @param buffer memory to read the rectangle into.
bsalomon@google.comc6980972011-11-02 19:57:21 +0000249 * @param rowBytes the number of bytes between consecutive rows. Zero
250 * means rows are tightly packed.
bsalomon@google.comc4364992011-11-07 15:54:49 +0000251 * @param invertY buffer should be populated bottom-to-top as opposed
252 * to top-to-bottom (skia's usual order)
bsalomon@google.coma7f84e12011-03-10 14:13:19 +0000253 *
254 * @return true if the read succeeded, false if not. The read can fail
255 * because of a unsupported pixel config or because no render
256 * target is currently set.
257 */
bsalomon6cb3cbe2015-07-30 07:34:27 -0700258 bool readPixels(GrSurface* surface,
bsalomon@google.com669fdc42011-04-05 17:08:27 +0000259 int left, int top, int width, int height,
senorblanco@chromium.org3cb406b2013-02-05 19:50:46 +0000260 GrPixelConfig config, void* buffer, size_t rowBytes);
reed@google.comac10a2d2010-12-22 21:39:39 +0000261
bsalomon@google.com6f379512011-11-16 20:36:03 +0000262 /**
bsalomon6cb3cbe2015-07-30 07:34:27 -0700263 * Updates the pixels in a rectangle of a surface.
bsalomon@google.coma85449d2011-11-19 02:36:05 +0000264 *
bsalomon6cb3cbe2015-07-30 07:34:27 -0700265 * @param surface The surface to write to.
bsalomon@google.com6f379512011-11-16 20:36:03 +0000266 * @param left left edge of the rectangle to write (inclusive)
267 * @param top top edge of the rectangle to write (inclusive)
268 * @param width width of rectangle to write in pixels.
269 * @param height height of rectangle to write in pixels.
270 * @param config the pixel config of the source buffer
cblume55f2d2d2016-02-26 13:20:48 -0800271 * @param texels array of mipmap levels containing texture data
272 */
273 bool writePixels(GrSurface* surface,
274 int left, int top, int width, int height,
275 GrPixelConfig config,
276 const SkTArray<GrMipLevel>& texels);
277
278 /**
279 * This function is a shim which creates a SkTArray<GrMipLevel> of size 1.
280 * It then calls writePixels with that SkTArray.
281 *
282 * @param buffer memory to read pixels from.
283 * @param rowBytes number of bytes between consecutive rows. Zero
284 * means rows are tightly packed.
bsalomon@google.com6f379512011-11-16 20:36:03 +0000285 */
bsalomon6cb3cbe2015-07-30 07:34:27 -0700286 bool writePixels(GrSurface* surface,
287 int left, int top, int width, int height,
288 GrPixelConfig config, const void* buffer,
289 size_t rowBytes);
bsalomon@google.com6f379512011-11-16 20:36:03 +0000290
joshualitt3322fa42014-11-07 08:48:51 -0800291 /**
jvanverthc3d706f2016-04-20 10:33:27 -0700292 * Updates the pixels in a rectangle of a surface using a buffer
jvanverth17aa0472016-01-05 10:41:27 -0800293 *
jvanverthc3d706f2016-04-20 10:33:27 -0700294 * @param surface The surface to write to.
cdalton397536c2016-03-25 12:15:03 -0700295 * @param left left edge of the rectangle to write (inclusive)
296 * @param top top edge of the rectangle to write (inclusive)
297 * @param width width of rectangle to write in pixels.
298 * @param height height of rectangle to write in pixels.
299 * @param config the pixel config of the source buffer
300 * @param transferBuffer GrBuffer to read pixels from (type must be "kCpuToGpu")
301 * @param offset offset from the start of the buffer
302 * @param rowBytes number of bytes between consecutive rows. Zero
303 * means rows are tightly packed.
jvanverth17aa0472016-01-05 10:41:27 -0800304 */
jvanverthc3d706f2016-04-20 10:33:27 -0700305 bool transferPixels(GrSurface* surface,
jvanverth17aa0472016-01-05 10:41:27 -0800306 int left, int top, int width, int height,
cdalton397536c2016-03-25 12:15:03 -0700307 GrPixelConfig config, GrBuffer* transferBuffer,
jvanverth17aa0472016-01-05 10:41:27 -0800308 size_t offset, size_t rowBytes);
309
310 /**
egdaniel4bcd62e2016-08-31 07:37:31 -0700311 * This is can be called before allocating a texture to be a dst for copySurface. This is only
312 * used for doing dst copies needed in blends, thus the src is always a GrRenderTarget. It will
bsalomonf90a02b2014-11-26 12:28:00 -0800313 * populate the origin, config, and flags fields of the desc such that copySurface can
egdaniel4bcd62e2016-08-31 07:37:31 -0700314 * efficiently succeed.
joshualitt3322fa42014-11-07 08:48:51 -0800315 */
egdaniel4bcd62e2016-08-31 07:37:31 -0700316 virtual bool initDescForDstCopy(const GrRenderTarget* src, GrSurfaceDesc* desc) const = 0;
joshualitt6db519c2014-10-29 08:48:18 -0700317
bsalomon@google.com80d09b92011-11-05 21:21:13 +0000318 // After the client interacts directly with the 3D context state the GrGpu
319 // must resync its internal state and assumptions about 3D context state.
320 // Each time this occurs the GrGpu bumps a timestamp.
321 // state of the 3D context
322 // At 10 resets / frame and 60fps a 64bit timestamp will overflow in about
323 // a billion years.
324 typedef uint64_t ResetTimestamp;
325
326 // This timestamp is always older than the current timestamp
327 static const ResetTimestamp kExpiredTimestamp = 0;
328 // Returns a timestamp based on the number of times the context was reset.
329 // This timestamp can be used to lazily detect when cached 3D context state
330 // is dirty.
bsalomon6d467ec2014-11-18 07:36:19 -0800331 ResetTimestamp getResetTimestamp() const { return fResetTimestamp; }
bsalomon@google.com80d09b92011-11-05 21:21:13 +0000332
bsalomonf90a02b2014-11-26 12:28:00 -0800333 // Called to perform a surface to surface copy. Fallbacks to issuing a draw from the src to dst
334 // take place at the GrDrawTarget level and this function implement faster copy paths. The rect
335 // and point are pre-clipped. The src rect and implied dst rect are guaranteed to be within the
336 // src/dst bounds and non-empty.
joshualitt1cbdcde2015-08-21 11:53:29 -0700337 bool copySurface(GrSurface* dst,
338 GrSurface* src,
339 const SkIRect& srcRect,
340 const SkIPoint& dstPoint);
joshualitt3322fa42014-11-07 08:48:51 -0800341
cdalton28f45b92016-03-07 13:58:26 -0800342 struct MultisampleSpecs {
csmartdalton0d28e572016-07-06 09:59:43 -0700343 MultisampleSpecs(uint8_t uniqueID, int effectiveSampleCnt, const SkPoint* locations)
344 : fUniqueID(uniqueID),
345 fEffectiveSampleCnt(effectiveSampleCnt),
346 fSampleLocations(locations) {}
347
cdalton28f45b92016-03-07 13:58:26 -0800348 // Nonzero ID that uniquely identifies these multisample specs.
csmartdalton0d28e572016-07-06 09:59:43 -0700349 uint8_t fUniqueID;
cdalton28f45b92016-03-07 13:58:26 -0800350 // The actual number of samples the GPU will run. NOTE: this value can be greater than the
351 // the render target's sample count.
csmartdalton0d28e572016-07-06 09:59:43 -0700352 int fEffectiveSampleCnt;
353 // If sample locations are supported, points to the subpixel locations at which the GPU will
354 // sample. Pixel center is at (.5, .5), and (0, 0) indicates the top left corner.
355 const SkPoint* fSampleLocations;
cdalton28f45b92016-03-07 13:58:26 -0800356 };
357
358 // Finds a render target's multisample specs. The stencil settings are only needed to flush the
359 // draw state prior to querying multisample information; they should not have any effect on the
360 // multisample information itself.
361 const MultisampleSpecs& getMultisampleSpecs(GrRenderTarget*, const GrStencilSettings&);
362
egdaniel066df7c2016-06-08 14:02:27 -0700363 // Creates a GrGpuCommandBuffer in which the GrDrawTarget can send draw commands to instead of
364 // directly to the Gpu object.
egdaniel9cb63402016-06-23 08:37:05 -0700365 virtual GrGpuCommandBuffer* createCommandBuffer(
366 GrRenderTarget* target,
367 const GrGpuCommandBuffer::LoadAndStoreInfo& colorInfo,
368 const GrGpuCommandBuffer::LoadAndStoreInfo& stencilInfo) = 0;
bsalomon3e791242014-12-17 13:43:13 -0800369
halcanary9d524f22016-03-29 09:03:52 -0700370 // Called by drawtarget when flushing.
jvanverthd2d2eb92016-02-17 14:04:46 -0800371 // Provides a hook for post-flush actions (e.g. PLS reset and Vulkan command buffer submits).
372 virtual void finishDrawTarget() {}
ethannicholas22793252016-01-30 09:59:10 -0800373
mtkleinb9eb4ac2015-02-02 18:26:03 -0800374 ///////////////////////////////////////////////////////////////////////////
375 // Debugging and Stats
376
377 class Stats {
378 public:
379#if GR_GPU_STATS
380 Stats() { this->reset(); }
381
bsalomonb12ea412015-02-02 21:19:50 -0800382 void reset() {
383 fRenderTargetBinds = 0;
384 fShaderCompilations = 0;
385 fTextureCreates = 0;
386 fTextureUploads = 0;
jvanverth17aa0472016-01-05 10:41:27 -0800387 fTransfersToTexture = 0;
egdaniel8dc7c3a2015-04-16 11:22:42 -0700388 fStencilAttachmentCreates = 0;
joshualitt87a5c9f2015-09-08 13:42:05 -0700389 fNumDraws = 0;
bsalomon1d417a82016-03-23 11:50:26 -0700390 fNumFailedDraws = 0;
bsalomonb12ea412015-02-02 21:19:50 -0800391 }
mtkleinb9eb4ac2015-02-02 18:26:03 -0800392
393 int renderTargetBinds() const { return fRenderTargetBinds; }
394 void incRenderTargetBinds() { fRenderTargetBinds++; }
395 int shaderCompilations() const { return fShaderCompilations; }
396 void incShaderCompilations() { fShaderCompilations++; }
bsalomonb12ea412015-02-02 21:19:50 -0800397 int textureCreates() const { return fTextureCreates; }
398 void incTextureCreates() { fTextureCreates++; }
399 int textureUploads() const { return fTextureUploads; }
400 void incTextureUploads() { fTextureUploads++; }
jvanverth17aa0472016-01-05 10:41:27 -0800401 int transfersToTexture() const { return fTransfersToTexture; }
402 void incTransfersToTexture() { fTransfersToTexture++; }
egdaniel8dc7c3a2015-04-16 11:22:42 -0700403 void incStencilAttachmentCreates() { fStencilAttachmentCreates++; }
joshualitt87a5c9f2015-09-08 13:42:05 -0700404 void incNumDraws() { fNumDraws++; }
bsalomon1d417a82016-03-23 11:50:26 -0700405 void incNumFailedDraws() { ++fNumFailedDraws; }
mtkleinb9eb4ac2015-02-02 18:26:03 -0800406 void dump(SkString*);
joshualitte45c81c2015-12-02 09:05:37 -0800407 void dumpKeyValuePairs(SkTArray<SkString>* keys, SkTArray<double>* values);
bsalomon1d417a82016-03-23 11:50:26 -0700408 int numDraws() const { return fNumDraws; }
409 int numFailedDraws() const { return fNumFailedDraws; }
mtkleinb9eb4ac2015-02-02 18:26:03 -0800410 private:
411 int fRenderTargetBinds;
412 int fShaderCompilations;
bsalomonb12ea412015-02-02 21:19:50 -0800413 int fTextureCreates;
414 int fTextureUploads;
jvanverth17aa0472016-01-05 10:41:27 -0800415 int fTransfersToTexture;
egdaniel8dc7c3a2015-04-16 11:22:42 -0700416 int fStencilAttachmentCreates;
joshualitt87a5c9f2015-09-08 13:42:05 -0700417 int fNumDraws;
bsalomon1d417a82016-03-23 11:50:26 -0700418 int fNumFailedDraws;
mtkleinb9eb4ac2015-02-02 18:26:03 -0800419#else
joshualitte45c81c2015-12-02 09:05:37 -0800420 void dump(SkString*) {}
421 void dumpKeyValuePairs(SkTArray<SkString>*, SkTArray<double>*) {}
mtkleinb9eb4ac2015-02-02 18:26:03 -0800422 void incRenderTargetBinds() {}
423 void incShaderCompilations() {}
bsalomonb12ea412015-02-02 21:19:50 -0800424 void incTextureCreates() {}
425 void incTextureUploads() {}
jvanverth17aa0472016-01-05 10:41:27 -0800426 void incTransfersToTexture() {}
egdaniel8dc7c3a2015-04-16 11:22:42 -0700427 void incStencilAttachmentCreates() {}
joshualitt87a5c9f2015-09-08 13:42:05 -0700428 void incNumDraws() {}
bsalomon1d417a82016-03-23 11:50:26 -0700429 void incNumFailedDraws() {}
mtkleinb9eb4ac2015-02-02 18:26:03 -0800430#endif
431 };
432
433 Stats* stats() { return &fStats; }
434
bsalomon67d76202015-11-11 12:40:42 -0800435 /** Creates a texture directly in the backend API without wrapping it in a GrTexture. This is
436 only to be used for testing (particularly for testing the methods that import an externally
437 created texture into Skia. Must be matched with a call to deleteTestingOnlyTexture(). */
jvanverth88957922015-07-14 11:02:52 -0700438 virtual GrBackendObject createTestingOnlyBackendTexture(void* pixels, int w, int h,
egdaniel0a3a7f72016-06-24 09:22:31 -0700439 GrPixelConfig config,
440 bool isRenderTarget = false) = 0;
bsalomon67d76202015-11-11 12:40:42 -0800441 /** Check a handle represents an actual texture in the backend API that has not been freed. */
442 virtual bool isTestingOnlyBackendTexture(GrBackendObject) const = 0;
443 /** If ownership of the backend texture has been transferred pass true for abandonTexture. This
444 will do any necessary cleanup of the handle without freeing the texture in the backend
445 API. */
446 virtual void deleteTestingOnlyBackendTexture(GrBackendObject,
bsalomone63ffef2016-02-05 07:17:34 -0800447 bool abandonTexture = false) = 0;
jvanverth672bb7f2015-07-13 07:19:57 -0700448
egdanielec00d942015-09-14 12:56:10 -0700449 // width and height may be larger than rt (if underlying API allows it).
450 // Returns nullptr if compatible sb could not be created, otherwise the caller owns the ref on
451 // the GrStencilAttachment.
452 virtual GrStencilAttachment* createStencilAttachmentForRenderTarget(const GrRenderTarget*,
453 int width,
454 int height) = 0;
455 // clears target's entire stencil buffer to 0
456 virtual void clearStencil(GrRenderTarget* target) = 0;
bsalomon6bc1b5f2015-02-23 09:06:38 -0800457
bsalomon6dea83f2015-12-03 12:58:06 -0800458 // draws an outline rectangle for debugging/visualization purposes.
459 virtual void drawDebugWireRect(GrRenderTarget*, const SkIRect&, GrColor) = 0;
bsalomon045802d2015-10-20 07:58:01 -0700460
bsalomone179a912016-01-20 06:18:10 -0800461 // Determines whether a texture will need to be rescaled in order to be used with the
462 // GrTextureParams. This variation is called when the caller will create a new texture using the
463 // texture provider from a non-texture src (cpu-backed image, ...).
bsalomon045802d2015-10-20 07:58:01 -0700464 bool makeCopyForTextureParams(int width, int height, const GrTextureParams&,
bsalomone179a912016-01-20 06:18:10 -0800465 GrTextureProducer::CopyParams*) const;
466
467 // Like the above but this variation should be called when the caller is not creating the
468 // original texture but rather was handed the original texture. It adds additional checks
469 // relevant to original textures that were created external to Skia via
470 // GrTextureProvider::wrap methods.
471 bool makeCopyForTextureParams(GrTexture* texture, const GrTextureParams& params,
472 GrTextureProducer::CopyParams* copyParams) const {
473 if (this->makeCopyForTextureParams(texture->width(), texture->height(), params,
474 copyParams)) {
475 return true;
476 }
477 return this->onMakeCopyForTextureParams(texture, params, copyParams);
478 }
bsalomon045802d2015-10-20 07:58:01 -0700479
jvanverth672bb7f2015-07-13 07:19:57 -0700480 // This is only to be used in GL-specific tests.
halcanary96fcdcc2015-08-27 07:41:13 -0700481 virtual const GrGLContext* glContextForTesting() const { return nullptr; }
bsalomon993a4212015-05-29 11:37:25 -0700482
joshualitt8fd844f2015-12-02 13:36:47 -0800483 // This is only to be used by testing code
484 virtual void resetShaderCacheForTesting() const {}
485
egdaniel9cb63402016-06-23 08:37:05 -0700486 void handleDirtyContext() {
487 if (fResetBits) {
488 this->resetContext();
489 }
490 }
491
joshualittd53a8272014-11-10 16:03:14 -0800492protected:
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
jvanverth900bd4a2016-04-29 13:53:12 -0700503 // Handles cases where a surface will be updated without a call to flushRenderTarget
504 void didWriteToSurface(GrSurface* surface, const SkIRect* bounds, uint32_t mipLevels = 1) const;
505
mtkleinb9eb4ac2015-02-02 18:26:03 -0800506 Stats fStats;
507 SkAutoTDelete<GrPathRendering> fPathRendering;
joshualitt3322fa42014-11-07 08:48:51 -0800508 // Subclass must initialize this in its constructor.
bsalomon4b91f762015-05-19 09:29:46 -0700509 SkAutoTUnref<const GrCaps> fCaps;
joshualitt3322fa42014-11-07 08:48:51 -0800510
csmartdalton0d28e572016-07-06 09:59:43 -0700511 typedef SkTArray<SkPoint, true> SamplePattern;
512
bsalomon@google.com02ddc8b2013-01-28 15:35:28 +0000513private:
bsalomon@google.comb635d392011-11-05 12:47:43 +0000514 // called when the 3D context state is unknown. Subclass should emit any
bsalomon@google.comc8f7f472012-06-18 13:44:51 +0000515 // assumed 3D context state and dirty any state cache.
bsalomon@google.com0a208a12013-06-28 18:57:35 +0000516 virtual void onResetContext(uint32_t resetBits) = 0;
bsalomon@google.coma7f84e12011-03-10 14:13:19 +0000517
bsalomoncb02b382015-08-12 11:14:50 -0700518 // Called before certain draws in order to guarantee coherent results from dst reads.
519 virtual void xferBarrier(GrRenderTarget*, GrXferBarrierType) = 0;
520
bsalomon@google.com16e3dde2012-10-25 18:43:28 +0000521 // overridden by backend-specific derived class to create objects.
egdanielb0e1be22015-04-22 13:27:39 -0700522 // Texture size and sample size will have already been validated in base class before
523 // onCreateTexture/CompressedTexture are called.
524 virtual GrTexture* onCreateTexture(const GrSurfaceDesc& desc,
kkinnunen2e6055b2016-04-22 01:48:29 -0700525 SkBudgeted budgeted,
cblume55f2d2d2016-02-26 13:20:48 -0800526 const SkTArray<GrMipLevel>& texels) = 0;
egdanielb0e1be22015-04-22 13:27:39 -0700527 virtual GrTexture* onCreateCompressedTexture(const GrSurfaceDesc& desc,
kkinnunen2e6055b2016-04-22 01:48:29 -0700528 SkBudgeted budgeted,
cblume55f2d2d2016-02-26 13:20:48 -0800529 const SkTArray<GrMipLevel>& texels) = 0;
530
bsalomon6dc6f5f2015-06-18 09:12:16 -0700531 virtual GrTexture* onWrapBackendTexture(const GrBackendTextureDesc&, GrWrapOwnership) = 0;
532 virtual GrRenderTarget* onWrapBackendRenderTarget(const GrBackendRenderTargetDesc&,
533 GrWrapOwnership) = 0;
kkinnunen49c4c222016-04-01 04:50:37 -0700534 virtual GrRenderTarget* onWrapBackendTextureAsRenderTarget(const GrBackendTextureDesc&) = 0;
cdalton1bf3e712016-04-19 10:00:02 -0700535 virtual GrBuffer* onCreateBuffer(size_t size, GrBufferType intendedType, GrAccessPattern,
536 const void* data) = 0;
bsalomon@google.coma7f84e12011-03-10 14:13:19 +0000537
csmartdaltone0d36292016-07-29 08:14:20 -0700538 virtual gr_instanced::InstancedRendering* onCreateInstancedRendering() = 0;
539
bsalomone179a912016-01-20 06:18:10 -0800540 virtual bool onMakeCopyForTextureParams(GrTexture* texture, const GrTextureParams&,
541 GrTextureProducer::CopyParams*) const { return false; }
542
bsalomonf0674512015-07-28 13:26:15 -0700543 virtual bool onGetReadPixelsInfo(GrSurface* srcSurface, int readWidth, int readHeight,
544 size_t rowBytes, GrPixelConfig readConfig, DrawPreference*,
545 ReadPixelTempDrawInfo*) = 0;
cblumeed828002016-02-16 13:00:01 -0800546 virtual bool onGetWritePixelsInfo(GrSurface* dstSurface, int width, int height,
bsalomonf0674512015-07-28 13:26:15 -0700547 GrPixelConfig srcConfig, DrawPreference*,
548 WritePixelTempDrawInfo*) = 0;
549
bsalomon6cb3cbe2015-07-30 07:34:27 -0700550 // overridden by backend-specific derived class to perform the surface read
551 virtual bool onReadPixels(GrSurface*,
egdaniel6d901da2015-07-30 12:02:15 -0700552 int left, int top,
553 int width, int height,
bsalomon@google.comc4364992011-11-07 15:54:49 +0000554 GrPixelConfig,
555 void* buffer,
senorblanco@chromium.org3cb406b2013-02-05 19:50:46 +0000556 size_t rowBytes) = 0;
bsalomon@google.coma7f84e12011-03-10 14:13:19 +0000557
bsalomon6cb3cbe2015-07-30 07:34:27 -0700558 // overridden by backend-specific derived class to perform the surface write
559 virtual bool onWritePixels(GrSurface*,
560 int left, int top, int width, int height,
cblume55f2d2d2016-02-26 13:20:48 -0800561 GrPixelConfig config,
562 const SkTArray<GrMipLevel>& texels) = 0;
bsalomon@google.com6f379512011-11-16 20:36:03 +0000563
jvanverthc3d706f2016-04-20 10:33:27 -0700564 // overridden by backend-specific derived class to perform the surface write
565 virtual bool onTransferPixels(GrSurface*,
jvanverth17aa0472016-01-05 10:41:27 -0800566 int left, int top, int width, int height,
cdalton397536c2016-03-25 12:15:03 -0700567 GrPixelConfig config, GrBuffer* transferBuffer,
jvanverth17aa0472016-01-05 10:41:27 -0800568 size_t offset, size_t rowBytes) = 0;
569
bsalomon@google.com16e3dde2012-10-25 18:43:28 +0000570 // overridden by backend-specific derived class to perform the resolve
bsalomon@google.com75f9f252012-01-31 13:35:56 +0000571 virtual void onResolveRenderTarget(GrRenderTarget* target) = 0;
572
joshualitt1cbdcde2015-08-21 11:53:29 -0700573 // overridden by backend specific derived class to perform the copy surface
574 virtual bool onCopySurface(GrSurface* dst,
575 GrSurface* src,
576 const SkIRect& srcRect,
577 const SkIPoint& dstPoint) = 0;
578
cdalton28f45b92016-03-07 13:58:26 -0800579 // overridden by backend specific derived class to perform the multisample queries
csmartdalton0d28e572016-07-06 09:59:43 -0700580 virtual void onGetMultisampleSpecs(GrRenderTarget*, const GrStencilSettings&,
581 int* effectiveSampleCnt, SamplePattern*) = 0;
cdalton28f45b92016-03-07 13:58:26 -0800582
bsalomon@google.comb635d392011-11-05 12:47:43 +0000583 void resetContext() {
bsalomon@google.com0a208a12013-06-28 18:57:35 +0000584 this->onResetContext(fResetBits);
585 fResetBits = 0;
bsalomon@google.comb635d392011-11-05 12:47:43 +0000586 ++fResetTimestamp;
587 }
588
csmartdalton0d28e572016-07-06 09:59:43 -0700589 struct SamplePatternComparator {
590 bool operator()(const SamplePattern&, const SamplePattern&) const;
591 };
592
593 typedef std::map<SamplePattern, uint8_t, SamplePatternComparator> MultisampleSpecsIdMap;
594
595 ResetTimestamp fResetTimestamp;
596 uint32_t fResetBits;
597 MultisampleSpecsIdMap fMultisampleSpecsIdMap;
598 SkSTArray<1, MultisampleSpecs, true> fMultisampleSpecs;
joshualitt3322fa42014-11-07 08:48:51 -0800599 // The context owns us, not vice-versa, so this ptr is not ref'ed by Gpu.
csmartdalton0d28e572016-07-06 09:59:43 -0700600 GrContext* fContext;
bsalomon@google.com02ddc8b2013-01-28 15:35:28 +0000601
kkinnunencabe20c2015-06-01 01:37:26 -0700602 friend class GrPathRendering;
csmartdaltona7f29642016-07-07 08:49:11 -0700603 friend class gr_instanced::InstancedRendering;
joshualitt3322fa42014-11-07 08:48:51 -0800604 typedef SkRefCnt INHERITED;
reed@google.comac10a2d2010-12-22 21:39:39 +0000605};
606
607#endif