egdaniel | 066df7c | 2016-06-08 14:02:27 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2016 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. |
| 6 | */ |
| 7 | |
| 8 | #ifndef GrGpuCommandBuffer_DEFINED |
| 9 | #define GrGpuCommandBuffer_DEFINED |
| 10 | |
| 11 | #include "GrColor.h" |
Chris Dalton | 46983b7 | 2017-06-06 12:27:16 -0600 | [diff] [blame] | 12 | #include "GrPipeline.h" |
Brian Salomon | 8952743 | 2016-12-16 09:52:16 -0500 | [diff] [blame] | 13 | #include "ops/GrDrawOp.h" |
egdaniel | 066df7c | 2016-06-08 14:02:27 -0700 | [diff] [blame] | 14 | |
Brian Salomon | 742e31d | 2016-12-07 17:06:19 -0500 | [diff] [blame] | 15 | class GrOpFlushState; |
csmartdalton | 29df760 | 2016-08-31 11:55:52 -0700 | [diff] [blame] | 16 | class GrFixedClip; |
egdaniel | 9cb6340 | 2016-06-23 08:37:05 -0700 | [diff] [blame] | 17 | class GrGpu; |
Chris Dalton | bca46e2 | 2017-05-15 11:03:26 -0600 | [diff] [blame] | 18 | class GrMesh; |
egdaniel | 9cb6340 | 2016-06-23 08:37:05 -0700 | [diff] [blame] | 19 | class GrPipeline; |
| 20 | class GrPrimitiveProcessor; |
egdaniel | 066df7c | 2016-06-08 14:02:27 -0700 | [diff] [blame] | 21 | class GrRenderTarget; |
egdaniel | 9cb6340 | 2016-06-23 08:37:05 -0700 | [diff] [blame] | 22 | struct SkIRect; |
Greg Daniel | 36a77ee | 2016-10-18 10:33:25 -0400 | [diff] [blame] | 23 | struct SkRect; |
egdaniel | 066df7c | 2016-06-08 14:02:27 -0700 | [diff] [blame] | 24 | |
Greg Daniel | 500d58b | 2017-08-24 15:59:33 -0400 | [diff] [blame] | 25 | class GrGpuRTCommandBuffer; |
| 26 | |
| 27 | class GrGpuCommandBuffer { |
| 28 | public: |
| 29 | virtual ~GrGpuCommandBuffer() {} |
| 30 | |
| 31 | // Copy src into current surface owned by either a GrGpuTextureCommandBuffer or |
| 32 | // GrGpuRenderTargetCommandBuffer. |
Robert Phillips | b0e93a2 | 2017-08-29 08:26:54 -0400 | [diff] [blame] | 33 | virtual void copy(GrSurface* src, GrSurfaceOrigin srcOrigin, |
| 34 | const SkIRect& srcRect, const SkIPoint& dstPoint) = 0; |
Greg Daniel | 500d58b | 2017-08-24 15:59:33 -0400 | [diff] [blame] | 35 | |
| 36 | virtual void insertEventMarker(const char*) = 0; |
| 37 | |
| 38 | virtual GrGpuRTCommandBuffer* asRTCommandBuffer() { return nullptr; } |
| 39 | |
| 40 | // Sends the command buffer off to the GPU object to execute the commands built up in the |
| 41 | // buffer. The gpu object is allowed to defer execution of the commands until it is flushed. |
| 42 | virtual void submit() = 0; |
| 43 | |
| 44 | protected: |
| 45 | GrGpuCommandBuffer(GrSurfaceOrigin origin) : fOrigin(origin) {} |
| 46 | |
| 47 | GrSurfaceOrigin fOrigin; |
| 48 | }; |
| 49 | |
| 50 | class GrGpuTextureCommandBuffer : public GrGpuCommandBuffer{ |
| 51 | public: |
| 52 | virtual ~GrGpuTextureCommandBuffer() {} |
| 53 | |
| 54 | virtual void submit() = 0; |
| 55 | |
| 56 | protected: |
| 57 | GrGpuTextureCommandBuffer(GrTexture* texture, GrSurfaceOrigin origin) |
| 58 | : INHERITED(origin) |
| 59 | , fTexture(texture) {} |
| 60 | |
| 61 | GrTexture* fTexture; |
| 62 | |
| 63 | private: |
| 64 | typedef GrGpuCommandBuffer INHERITED; |
| 65 | }; |
| 66 | |
egdaniel | 9cb6340 | 2016-06-23 08:37:05 -0700 | [diff] [blame] | 67 | /** |
Greg Daniel | 500d58b | 2017-08-24 15:59:33 -0400 | [diff] [blame] | 68 | * The GrGpuRenderTargetCommandBuffer is a series of commands (draws, clears, and discards), which |
| 69 | * all target the same render target. It is possible that these commands execute immediately (GL), |
| 70 | * or get buffered up for later execution (Vulkan). GrOps will execute their draw commands into a |
egdaniel | 9cb6340 | 2016-06-23 08:37:05 -0700 | [diff] [blame] | 71 | * GrGpuCommandBuffer. |
| 72 | */ |
Greg Daniel | 500d58b | 2017-08-24 15:59:33 -0400 | [diff] [blame] | 73 | class GrGpuRTCommandBuffer : public GrGpuCommandBuffer { |
egdaniel | 066df7c | 2016-06-08 14:02:27 -0700 | [diff] [blame] | 74 | public: |
egdaniel | 9cb6340 | 2016-06-23 08:37:05 -0700 | [diff] [blame] | 75 | struct LoadAndStoreInfo { |
Robert Phillips | 6b47c7d | 2017-08-29 07:24:09 -0400 | [diff] [blame] | 76 | GrLoadOp fLoadOp; |
| 77 | GrStoreOp fStoreOp; |
| 78 | GrColor fClearColor; |
egdaniel | 066df7c | 2016-06-08 14:02:27 -0700 | [diff] [blame] | 79 | }; |
| 80 | |
Robert Phillips | 9521447 | 2017-08-08 18:00:03 -0400 | [diff] [blame] | 81 | // Load-time clears of the stencil buffer are always to 0 so we don't store |
| 82 | // an 'fStencilClearValue' |
| 83 | struct StencilLoadAndStoreInfo { |
Robert Phillips | 6b47c7d | 2017-08-29 07:24:09 -0400 | [diff] [blame] | 84 | GrLoadOp fLoadOp; |
| 85 | GrStoreOp fStoreOp; |
Robert Phillips | 9521447 | 2017-08-08 18:00:03 -0400 | [diff] [blame] | 86 | }; |
| 87 | |
Greg Daniel | 500d58b | 2017-08-24 15:59:33 -0400 | [diff] [blame] | 88 | virtual ~GrGpuRTCommandBuffer() {} |
| 89 | |
| 90 | GrGpuRTCommandBuffer* asRTCommandBuffer() { return this; } |
egdaniel | 066df7c | 2016-06-08 14:02:27 -0700 | [diff] [blame] | 91 | |
Robert Phillips | 9521447 | 2017-08-08 18:00:03 -0400 | [diff] [blame] | 92 | virtual void begin() = 0; |
egdaniel | 066df7c | 2016-06-08 14:02:27 -0700 | [diff] [blame] | 93 | // Signals the end of recording to the command buffer and that it can now be submitted. |
| 94 | virtual void end() = 0; |
| 95 | |
egdaniel | 9cb6340 | 2016-06-23 08:37:05 -0700 | [diff] [blame] | 96 | // We pass in an array of meshCount GrMesh to the draw. The backend should loop over each |
| 97 | // GrMesh object and emit a draw for it. Each draw will use the same GrPipeline and |
| 98 | // GrPrimitiveProcessor. This may fail if the draw would exceed any resource limits (e.g. |
| 99 | // number of vertex attributes is too large). |
Brian Salomon | ff168d9 | 2018-06-23 15:17:27 -0400 | [diff] [blame] | 100 | bool draw(const GrPrimitiveProcessor&, |
| 101 | const GrPipeline&, |
Brian Salomon | 4934890 | 2018-06-26 09:12:38 -0400 | [diff] [blame] | 102 | const GrPipeline::FixedDynamicState*, |
| 103 | const GrPipeline::DynamicStateArrays*, |
Chris Dalton | bca46e2 | 2017-05-15 11:03:26 -0600 | [diff] [blame] | 104 | const GrMesh[], |
Greg Daniel | 36a77ee | 2016-10-18 10:33:25 -0400 | [diff] [blame] | 105 | int meshCount, |
| 106 | const SkRect& bounds); |
egdaniel | 9cb6340 | 2016-06-23 08:37:05 -0700 | [diff] [blame] | 107 | |
Greg Daniel | 77b53f6 | 2016-10-18 11:48:51 -0400 | [diff] [blame] | 108 | // Performs an upload of vertex data in the middle of a set of a set of draws |
Brian Salomon | 943ed79 | 2017-10-30 09:37:55 -0400 | [diff] [blame] | 109 | virtual void inlineUpload(GrOpFlushState*, GrDeferredTextureUploadFn&) = 0; |
Greg Daniel | 77b53f6 | 2016-10-18 11:48:51 -0400 | [diff] [blame] | 110 | |
egdaniel | 9cb6340 | 2016-06-23 08:37:05 -0700 | [diff] [blame] | 111 | /** |
Jim Van Verth | 6a40abc | 2017-11-02 16:56:09 +0000 | [diff] [blame] | 112 | * Clear the owned render target. Ignores the draw state and clip. |
Greg Daniel | 77b53f6 | 2016-10-18 11:48:51 -0400 | [diff] [blame] | 113 | */ |
Robert Phillips | 19e51dc | 2017-08-09 09:30:51 -0400 | [diff] [blame] | 114 | void clear(const GrFixedClip&, GrColor); |
egdaniel | 9cb6340 | 2016-06-23 08:37:05 -0700 | [diff] [blame] | 115 | |
Robert Phillips | 19e51dc | 2017-08-09 09:30:51 -0400 | [diff] [blame] | 116 | void clearStencilClip(const GrFixedClip&, bool insideStencilMask); |
Greg Daniel | 36a77ee | 2016-10-18 10:33:25 -0400 | [diff] [blame] | 117 | |
egdaniel | 9cb6340 | 2016-06-23 08:37:05 -0700 | [diff] [blame] | 118 | /** |
Robert Phillips | 19e51dc | 2017-08-09 09:30:51 -0400 | [diff] [blame] | 119 | * Discards the contents render target. |
Greg Daniel | 77b53f6 | 2016-10-18 11:48:51 -0400 | [diff] [blame] | 120 | */ |
egdaniel | 9cb6340 | 2016-06-23 08:37:05 -0700 | [diff] [blame] | 121 | // TODO: This should be removed in the future to favor using the load and store ops for discard |
Robert Phillips | 19e51dc | 2017-08-09 09:30:51 -0400 | [diff] [blame] | 122 | virtual void discard() = 0; |
egdaniel | 9cb6340 | 2016-06-23 08:37:05 -0700 | [diff] [blame] | 123 | |
Robert Phillips | 19e51dc | 2017-08-09 09:30:51 -0400 | [diff] [blame] | 124 | protected: |
Greg Daniel | 500d58b | 2017-08-24 15:59:33 -0400 | [diff] [blame] | 125 | GrGpuRTCommandBuffer(GrRenderTarget* rt, GrSurfaceOrigin origin) |
| 126 | : INHERITED(origin) |
| 127 | , fRenderTarget(rt) { |
| 128 | } |
| 129 | |
Robert Phillips | 19e51dc | 2017-08-09 09:30:51 -0400 | [diff] [blame] | 130 | GrRenderTarget* fRenderTarget; |
Robert Phillips | 65a88fa | 2017-08-08 08:36:22 -0400 | [diff] [blame] | 131 | |
egdaniel | 9cb6340 | 2016-06-23 08:37:05 -0700 | [diff] [blame] | 132 | private: |
| 133 | virtual GrGpu* gpu() = 0; |
Greg Daniel | 65a0927 | 2016-10-12 09:47:22 -0400 | [diff] [blame] | 134 | |
egdaniel | 9cb6340 | 2016-06-23 08:37:05 -0700 | [diff] [blame] | 135 | // overridden by backend-specific derived class to perform the draw call. |
Brian Salomon | ff168d9 | 2018-06-23 15:17:27 -0400 | [diff] [blame] | 136 | virtual void onDraw(const GrPrimitiveProcessor&, |
| 137 | const GrPipeline&, |
Brian Salomon | 4934890 | 2018-06-26 09:12:38 -0400 | [diff] [blame] | 138 | const GrPipeline::FixedDynamicState*, |
| 139 | const GrPipeline::DynamicStateArrays*, |
Chris Dalton | 46983b7 | 2017-06-06 12:27:16 -0600 | [diff] [blame] | 140 | const GrMesh[], |
Greg Daniel | 36a77ee | 2016-10-18 10:33:25 -0400 | [diff] [blame] | 141 | int meshCount, |
| 142 | const SkRect& bounds) = 0; |
egdaniel | 9cb6340 | 2016-06-23 08:37:05 -0700 | [diff] [blame] | 143 | |
| 144 | // overridden by backend-specific derived class to perform the clear. |
Robert Phillips | 19e51dc | 2017-08-09 09:30:51 -0400 | [diff] [blame] | 145 | virtual void onClear(const GrFixedClip&, GrColor) = 0; |
egdaniel | 9cb6340 | 2016-06-23 08:37:05 -0700 | [diff] [blame] | 146 | |
Robert Phillips | 19e51dc | 2017-08-09 09:30:51 -0400 | [diff] [blame] | 147 | virtual void onClearStencilClip(const GrFixedClip&, bool insideStencilMask) = 0; |
Greg Daniel | 500d58b | 2017-08-24 15:59:33 -0400 | [diff] [blame] | 148 | |
| 149 | typedef GrGpuCommandBuffer INHERITED; |
egdaniel | 066df7c | 2016-06-08 14:02:27 -0700 | [diff] [blame] | 150 | }; |
| 151 | |
| 152 | #endif |