blob: 275d7e06fa023dfdc1b51c486943530bfe557f0d [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 GrInOrderDrawBuffer_DEFINED
9#define GrInOrderDrawBuffer_DEFINED
10
11#include "GrDrawTarget.h"
12#include "GrAllocPool.h"
13#include "GrAllocator.h"
bsalomon@google.comded4f4b2012-06-28 18:48:06 +000014#include "GrPath.h"
reed@google.comac10a2d2010-12-22 21:39:39 +000015
robertphillips@google.com641f8b12012-07-31 19:15:58 +000016#include "SkClipStack.h"
bsalomon@google.comded4f4b2012-06-28 18:48:06 +000017#include "SkTemplates.h"
commit-bot@chromium.orga0b40282013-09-18 13:00:55 +000018#include "SkTypes.h"
bsalomon@google.comded4f4b2012-06-28 18:48:06 +000019
bsalomon@google.com471d4712011-08-23 15:45:25 +000020class GrGpu;
bsalomon@google.com1c13c962011-02-14 16:51:21 +000021class GrIndexBufferAllocPool;
bsalomon@google.com471d4712011-08-23 15:45:25 +000022class GrVertexBufferAllocPool;
reed@google.comac10a2d2010-12-22 21:39:39 +000023
bsalomon@google.com1c13c962011-02-14 16:51:21 +000024/**
bsalomon@google.com55e4a202013-01-11 13:54:21 +000025 * GrInOrderDrawBuffer is an implementation of GrDrawTarget that queues up draws for eventual
26 * playback into a GrGpu. In theory one draw buffer could playback into another. When index or
27 * vertex buffers are used as geometry sources it is the callers the draw buffer only holds
28 * references to the buffers. It is the callers responsibility to ensure that the data is still
29 * valid when the draw buffer is played back into a GrGpu. Similarly, it is the caller's
30 * responsibility to ensure that all referenced textures, buffers, and render-targets are associated
31 * in the GrGpu object that the buffer is played back into. The buffer requires VB and IB pools to
32 * store geometry.
skia.committer@gmail.com07d3a652013-04-10 07:01:15 +000033 */
reed@google.comac10a2d2010-12-22 21:39:39 +000034class GrInOrderDrawBuffer : public GrDrawTarget {
35public:
36
bsalomon@google.com86afc2a2011-02-16 16:12:19 +000037 /**
38 * Creates a GrInOrderDrawBuffer
39 *
bsalomon@google.com6e4e6502013-02-25 20:12:45 +000040 * @param gpu the gpu object that this draw buffer flushes to.
bsalomon@google.com86afc2a2011-02-16 16:12:19 +000041 * @param vertexPool pool where vertices for queued draws will be saved when
42 * the vertex source is either reserved or array.
43 * @param indexPool pool where indices for queued draws will be saved when
44 * the index source is either reserved or array.
45 */
bsalomon@google.com6e4e6502013-02-25 20:12:45 +000046 GrInOrderDrawBuffer(GrGpu* gpu,
bsalomon@google.com471d4712011-08-23 15:45:25 +000047 GrVertexBufferAllocPool* vertexPool,
bsalomon@google.com1c13c962011-02-14 16:51:21 +000048 GrIndexBufferAllocPool* indexPool);
reed@google.comac10a2d2010-12-22 21:39:39 +000049
50 virtual ~GrInOrderDrawBuffer();
51
bsalomon@google.com86afc2a2011-02-16 16:12:19 +000052 /**
bsalomon@google.com55e4a202013-01-11 13:54:21 +000053 * Empties the draw buffer of any queued up draws. This must not be called while inside an
54 * unbalanced pushGeometrySource(). The current draw state and clip are preserved.
bsalomon@google.com86afc2a2011-02-16 16:12:19 +000055 */
56 void reset();
57
58 /**
bsalomon@google.com6e4e6502013-02-25 20:12:45 +000059 * This plays the queued up draws to its GrGpu target. It also resets this object (i.e. flushing
bsalomon@google.com55e4a202013-01-11 13:54:21 +000060 * is destructive). This buffer must not have an active reserved vertex or index source. Any
61 * reserved geometry on the target will be finalized because it's geometry source will be pushed
62 * before flushing and popped afterwards.
bsalomon@google.com86afc2a2011-02-16 16:12:19 +000063 */
robertphillips@google.com1267fbd2013-07-03 18:37:27 +000064 void flush();
bsalomon@google.com97805382012-03-13 14:32:07 +000065
commit-bot@chromium.orga8916ff2013-08-16 15:53:46 +000066 // tracking for draws
67 virtual DrawToken getCurrentDrawToken() { return DrawToken(this, fDrawID); }
68
bsalomon@google.com86afc2a2011-02-16 16:12:19 +000069 // overrides from GrDrawTarget
jvanverth@google.comb75b0a02013-02-05 20:33:30 +000070 virtual bool geometryHints(int* vertexCount,
bsalomon@google.com97805382012-03-13 14:32:07 +000071 int* indexCount) const SK_OVERRIDE;
commit-bot@chromium.orgfd03d4a2013-07-17 21:39:42 +000072 virtual void clear(const SkIRect* rect,
robertphillips@google.comc82a8b72012-06-21 20:15:48 +000073 GrColor color,
74 GrRenderTarget* renderTarget = NULL) SK_OVERRIDE;
bsalomon@google.com0b335c12011-04-25 19:17:44 +000075
bsalomon@google.comeb851172013-04-15 13:51:00 +000076 virtual void initCopySurfaceDstDesc(const GrSurface* src, GrTextureDesc* desc) SK_OVERRIDE;
77
bsalomon@google.com97805382012-03-13 14:32:07 +000078protected:
bsalomon@google.com02ddc8b2013-01-28 15:35:28 +000079 virtual void clipWillBeSet(const GrClipData* newClip) SK_OVERRIDE;
80
reed@google.comac10a2d2010-12-22 21:39:39 +000081private:
bsalomon@google.coma4f6b102012-06-26 21:04:22 +000082 enum Cmd {
bsalomon@google.comded4f4b2012-06-28 18:48:06 +000083 kDraw_Cmd = 1,
84 kStencilPath_Cmd = 2,
85 kSetState_Cmd = 3,
86 kSetClip_Cmd = 4,
87 kClear_Cmd = 5,
bsalomon@google.com116ad842013-04-09 15:38:19 +000088 kCopySurface_Cmd = 6,
commit-bot@chromium.org32184d82013-10-09 15:14:18 +000089 kDrawPath_Cmd = 7,
bsalomon@google.coma4f6b102012-06-26 21:04:22 +000090 };
91
bsalomon@google.comd62e88e2013-02-01 14:19:27 +000092 class DrawRecord : public DrawInfo {
93 public:
94 DrawRecord(const DrawInfo& info) : DrawInfo(info) {}
bsalomon@google.com1c13c962011-02-14 16:51:21 +000095 const GrVertexBuffer* fVertexBuffer;
96 const GrIndexBuffer* fIndexBuffer;
reed@google.comac10a2d2010-12-22 21:39:39 +000097 };
98
commit-bot@chromium.orga0b40282013-09-18 13:00:55 +000099 struct StencilPath : public ::SkNoncopyable {
sugoi@google.com5f74cf82012-12-17 21:16:45 +0000100 StencilPath();
101
bsalomon@google.comded4f4b2012-06-28 18:48:06 +0000102 SkAutoTUnref<const GrPath> fPath;
sugoi@google.com12b4e272012-12-06 20:13:11 +0000103 SkPath::FillType fFill;
bsalomon@google.comded4f4b2012-06-28 18:48:06 +0000104 };
105
commit-bot@chromium.org32184d82013-10-09 15:14:18 +0000106 struct DrawPath : public ::SkNoncopyable {
107 DrawPath();
commit-bot@chromium.orgc4dc0ad2013-10-09 14:11:33 +0000108
109 SkAutoTUnref<const GrPath> fPath;
commit-bot@chromium.orgc4dc0ad2013-10-09 14:11:33 +0000110 SkPath::FillType fFill;
111 GrDeviceCoordTexture fDstCopy;
112 };
113
commit-bot@chromium.orga0b40282013-09-18 13:00:55 +0000114 struct Clear : public ::SkNoncopyable {
robertphillips@google.comc82a8b72012-06-21 20:15:48 +0000115 Clear() : fRenderTarget(NULL) {}
commit-bot@chromium.orga4de8c22013-09-09 13:38:37 +0000116 ~Clear() { SkSafeUnref(fRenderTarget); }
robertphillips@google.comc82a8b72012-06-21 20:15:48 +0000117
commit-bot@chromium.orgfd03d4a2013-07-17 21:39:42 +0000118 SkIRect fRect;
robertphillips@google.comc82a8b72012-06-21 20:15:48 +0000119 GrColor fColor;
120 GrRenderTarget* fRenderTarget;
bsalomon@google.com0b335c12011-04-25 19:17:44 +0000121 };
122
commit-bot@chromium.orga0b40282013-09-18 13:00:55 +0000123 struct CopySurface : public ::SkNoncopyable {
bsalomon@google.com116ad842013-04-09 15:38:19 +0000124 SkAutoTUnref<GrSurface> fDst;
125 SkAutoTUnref<GrSurface> fSrc;
126 SkIRect fSrcRect;
127 SkIPoint fDstPoint;
128 };
129
bsalomon@google.com25fb21f2011-06-21 18:17:25 +0000130 // overrides from GrDrawTarget
bsalomon@google.com74749cd2013-01-30 16:12:41 +0000131 virtual void onDraw(const DrawInfo&) SK_OVERRIDE;
commit-bot@chromium.orgfd03d4a2013-07-17 21:39:42 +0000132 virtual void onDrawRect(const SkRect& rect,
bsalomon@google.com0406b9e2013-04-02 21:00:15 +0000133 const SkMatrix* matrix,
commit-bot@chromium.orgfd03d4a2013-07-17 21:39:42 +0000134 const SkRect* localRect,
bsalomon@google.com0406b9e2013-04-02 21:00:15 +0000135 const SkMatrix* localMatrix) SK_OVERRIDE;
commit-bot@chromium.org32184d82013-10-09 15:14:18 +0000136
137 virtual void onStencilPath(const GrPath*, SkPath::FillType) SK_OVERRIDE;
138 virtual void onDrawPath(const GrPath*, SkPath::FillType,
commit-bot@chromium.orgc4dc0ad2013-10-09 14:11:33 +0000139 const GrDeviceCoordTexture* dstCopy) SK_OVERRIDE;
commit-bot@chromium.org32184d82013-10-09 15:14:18 +0000140
jvanverth@google.coma6338982013-01-31 21:34:25 +0000141 virtual bool onReserveVertexSpace(size_t vertexSize,
bsalomon@google.com25fb21f2011-06-21 18:17:25 +0000142 int vertexCount,
bsalomon@google.com13f1b6f2012-05-31 12:52:43 +0000143 void** vertices) SK_OVERRIDE;
144 virtual bool onReserveIndexSpace(int indexCount,
145 void** indices) SK_OVERRIDE;
146 virtual void releaseReservedVertexSpace() SK_OVERRIDE;
147 virtual void releaseReservedIndexSpace() SK_OVERRIDE;
bsalomon@google.combcdbbe62011-04-12 15:40:00 +0000148 virtual void onSetVertexSourceToArray(const void* vertexArray,
bsalomon@google.com13f1b6f2012-05-31 12:52:43 +0000149 int vertexCount) SK_OVERRIDE;
bsalomon@google.combcdbbe62011-04-12 15:40:00 +0000150 virtual void onSetIndexSourceToArray(const void* indexArray,
bsalomon@google.com13f1b6f2012-05-31 12:52:43 +0000151 int indexCount) SK_OVERRIDE;
152 virtual void releaseVertexArray() SK_OVERRIDE;
153 virtual void releaseIndexArray() SK_OVERRIDE;
154 virtual void geometrySourceWillPush() SK_OVERRIDE;
bsalomon@google.com02ddc8b2013-01-28 15:35:28 +0000155 virtual void geometrySourceWillPop(const GeometrySrcState& restoredState) SK_OVERRIDE;
jvanverth@google.comb75b0a02013-02-05 20:33:30 +0000156 virtual void willReserveVertexAndIndexSpace(int vertexCount,
bsalomon@google.com02ddc8b2013-01-28 15:35:28 +0000157 int indexCount) SK_OVERRIDE;
bsalomon@google.com116ad842013-04-09 15:38:19 +0000158 virtual bool onCopySurface(GrSurface* dst,
159 GrSurface* src,
160 const SkIRect& srcRect,
161 const SkIPoint& dstPoint) SK_OVERRIDE;
162 virtual bool onCanCopySurface(GrSurface* dst,
163 GrSurface* src,
164 const SkIRect& srcRect,
165 const SkIPoint& dstPoint) SK_OVERRIDE;
166
bsalomon@google.comd62e88e2013-02-01 14:19:27 +0000167 bool quickInsideClip(const SkRect& devBounds);
bsalomon@google.com02ddc8b2013-01-28 15:35:28 +0000168
bsalomon@google.comd62e88e2013-02-01 14:19:27 +0000169 // Attempts to concat instances from info onto the previous draw. info must represent an
170 // instanced draw. The caller must have already recorded a new draw state and clip if necessary.
171 int concatInstancedDraw(const DrawInfo& info);
bsalomon@google.com1c13c962011-02-14 16:51:21 +0000172
bsalomon@google.comd62e88e2013-02-01 14:19:27 +0000173 // we lazily record state and clip changes in order to skip clips and states that have no
174 // effect.
bsalomon@google.com86afc2a2011-02-16 16:12:19 +0000175 bool needsNewState() const;
176 bool needsNewClip() const;
reed@google.comac10a2d2010-12-22 21:39:39 +0000177
bsalomon@google.coma4f6b102012-06-26 21:04:22 +0000178 // these functions record a command
bsalomon@google.comded4f4b2012-06-28 18:48:06 +0000179 void recordState();
bsalomon@google.comded4f4b2012-06-28 18:48:06 +0000180 void recordClip();
bsalomon@google.com74749cd2013-01-30 16:12:41 +0000181 DrawRecord* recordDraw(const DrawInfo&);
bsalomon@google.comded4f4b2012-06-28 18:48:06 +0000182 StencilPath* recordStencilPath();
commit-bot@chromium.org32184d82013-10-09 15:14:18 +0000183 DrawPath* recordDrawPath();
bsalomon@google.comded4f4b2012-06-28 18:48:06 +0000184 Clear* recordClear();
bsalomon@google.com116ad842013-04-09 15:38:19 +0000185 CopySurface* recordCopySurface();
bsalomon@google.com934c5702012-03-20 21:17:58 +0000186
bsalomon@google.com116ad842013-04-09 15:38:19 +0000187 // TODO: Use a single allocator for commands and records
bsalomon@google.com4b90c622011-09-28 17:52:15 +0000188 enum {
bsalomon@google.coma4f6b102012-06-26 21:04:22 +0000189 kCmdPreallocCnt = 32,
bsalomon@google.com4b90c622011-09-28 17:52:15 +0000190 kDrawPreallocCnt = 8,
bsalomon@google.comded4f4b2012-06-28 18:48:06 +0000191 kStencilPathPreallocCnt = 8,
commit-bot@chromium.org32184d82013-10-09 15:14:18 +0000192 kDrawPathPreallocCnt = 8,
bsalomon@google.com4b90c622011-09-28 17:52:15 +0000193 kStatePreallocCnt = 8,
194 kClipPreallocCnt = 8,
195 kClearPreallocCnt = 4,
196 kGeoPoolStatePreAllocCnt = 4,
bsalomon@google.com116ad842013-04-09 15:38:19 +0000197 kCopySurfacePreallocCnt = 4,
bsalomon@google.com4b90c622011-09-28 17:52:15 +0000198 };
reed@google.comac10a2d2010-12-22 21:39:39 +0000199
bsalomon@google.comca432082013-01-23 19:53:46 +0000200 SkSTArray<kCmdPreallocCnt, uint8_t, true> fCmds;
bsalomon@google.com74749cd2013-01-30 16:12:41 +0000201 GrSTAllocator<kDrawPreallocCnt, DrawRecord> fDraws;
bsalomon@google.comca432082013-01-23 19:53:46 +0000202 GrSTAllocator<kStatePreallocCnt, StencilPath> fStencilPaths;
commit-bot@chromium.org32184d82013-10-09 15:14:18 +0000203 GrSTAllocator<kStatePreallocCnt, DrawPath> fDrawPaths;
bsalomon@google.comca432082013-01-23 19:53:46 +0000204 GrSTAllocator<kStatePreallocCnt, GrDrawState::DeferredState> fStates;
205 GrSTAllocator<kClearPreallocCnt, Clear> fClears;
bsalomon@google.com116ad842013-04-09 15:38:19 +0000206 GrSTAllocator<kCopySurfacePreallocCnt, CopySurface> fCopySurfaces;
207 GrSTAllocator<kClipPreallocCnt, SkClipStack> fClips;
208 GrSTAllocator<kClipPreallocCnt, SkIPoint> fClipOrigins;
bsalomon@google.com97805382012-03-13 14:32:07 +0000209
bsalomon@google.com6e4e6502013-02-25 20:12:45 +0000210 GrDrawTarget* fDstGpu;
bsalomon@google.com97805382012-03-13 14:32:07 +0000211
bsalomon@google.com86afc2a2011-02-16 16:12:19 +0000212 bool fClipSet;
213
bsalomon@google.comd62e88e2013-02-01 14:19:27 +0000214 enum ClipProxyState {
215 kUnknown_ClipProxyState,
216 kValid_ClipProxyState,
217 kInvalid_ClipProxyState
218 };
219 ClipProxyState fClipProxyState;
220 SkRect fClipProxy;
221
bsalomon@google.com934c5702012-03-20 21:17:58 +0000222 GrVertexBufferAllocPool& fVertexPool;
223
224 GrIndexBufferAllocPool& fIndexPool;
225
bsalomon@google.com25fb21f2011-06-21 18:17:25 +0000226 struct GeometryPoolState {
227 const GrVertexBuffer* fPoolVertexBuffer;
228 int fPoolStartVertex;
229 const GrIndexBuffer* fPoolIndexBuffer;
230 int fPoolStartIndex;
231 // caller may conservatively over reserve vertices / indices.
232 // we release unused space back to allocator if possible
233 // can only do this if there isn't an intervening pushGeometrySource()
234 size_t fUsedPoolVertexBytes;
235 size_t fUsedPoolIndexBytes;
236 };
bsalomon@google.com92669012011-09-27 19:10:05 +0000237 SkSTArray<kGeoPoolStatePreAllocCnt, GeometryPoolState> fGeoPoolStateStack;
reed@google.comac10a2d2010-12-22 21:39:39 +0000238
commit-bot@chromium.orga8916ff2013-08-16 15:53:46 +0000239 virtual bool isIssued(uint32_t drawID) { return drawID != fDrawID; }
skia.committer@gmail.com74758112013-08-17 07:01:54 +0000240
robertphillips@google.comc82a8b72012-06-21 20:15:48 +0000241 bool fFlushing;
commit-bot@chromium.orga8916ff2013-08-16 15:53:46 +0000242 uint32_t fDrawID;
robertphillips@google.comc82a8b72012-06-21 20:15:48 +0000243
bsalomon@google.com86afc2a2011-02-16 16:12:19 +0000244 typedef GrDrawTarget INHERITED;
reed@google.comac10a2d2010-12-22 21:39:39 +0000245};
246
247#endif