blob: c5f34cd83606d5e37689cee45f1eeac9773eb560 [file] [log] [blame]
joshualitt374b2f72015-07-21 08:05:03 -07001/*
2 * Copyright 2015 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
Herb Derby86240592018-05-24 16:12:31 -04008#ifndef GrTextBlob_DEFINED
9#define GrTextBlob_DEFINED
joshualitt374b2f72015-07-21 08:05:03 -070010
joshualitt259fbf12015-07-21 11:39:34 -070011#include "GrColor.h"
Brian Salomon2ee084e2016-12-16 18:59:19 -050012#include "GrDrawOpAtlas.h"
Robert Phillipsc4039ea2018-03-01 11:36:45 -050013#include "GrGlyphCache.h"
Herb Derbyc1b482c2018-08-09 15:02:27 -040014#include "GrTextTarget.h"
joshualitt374b2f72015-07-21 08:05:03 -070015#include "SkDescriptor.h"
Mike Reed80747ef2018-01-23 15:29:32 -050016#include "SkMaskFilterBase.h"
mtklein4e976072016-08-08 09:06:27 -070017#include "SkOpts.h"
bsalomon8b6fa5e2016-05-19 16:23:47 -070018#include "SkPathEffect.h"
Brian Salomon5c6ac642017-12-19 11:09:32 -050019#include "SkPoint3.h"
Mike Reed274218e2018-01-08 15:05:02 -050020#include "SkRectPriv.h"
Herb Derbyc1b482c2018-08-09 15:02:27 -040021#include "SkStrikeCache.h"
joshualitt259fbf12015-07-21 11:39:34 -070022#include "SkSurfaceProps.h"
joshualitt374b2f72015-07-21 08:05:03 -070023#include "SkTInternalLList.h"
24
Robert Phillipsc4039ea2018-03-01 11:36:45 -050025class GrAtlasManager;
joshualitt2e2202e2015-12-10 11:22:08 -080026struct GrDistanceFieldAdjustTable;
Robert Phillipsc4039ea2018-03-01 11:36:45 -050027struct GrGlyph;
Robert Phillipsc4039ea2018-03-01 11:36:45 -050028
joshualitt2e2202e2015-12-10 11:22:08 -080029class SkTextBlob;
30class SkTextBlobRunIterator;
31
Herb Derby26cbe512018-05-24 14:39:01 -040032// With this flag enabled, the GrTextContext will, as a sanity check, regenerate every blob
joshualitt259fbf12015-07-21 11:39:34 -070033// that comes in to verify the integrity of its cache
joshualitt2f2ee832016-02-10 08:52:24 -080034#define CACHE_SANITY_CHECK 0
joshualitt259fbf12015-07-21 11:39:34 -070035
joshualitt374b2f72015-07-21 08:05:03 -070036/*
Herb Derby86240592018-05-24 16:12:31 -040037 * A GrTextBlob contains a fully processed SkTextBlob, suitable for nearly immediate drawing
joshualitt374b2f72015-07-21 08:05:03 -070038 * on the GPU. These are initially created with valid positions and colors, but invalid
Herb Derby86240592018-05-24 16:12:31 -040039 * texture coordinates. The GrTextBlob itself has a few Blob-wide properties, and also
joshualitt374b2f72015-07-21 08:05:03 -070040 * consists of a number of runs. Runs inside a blob are flushed individually so they can be
41 * reordered.
42 *
Herb Derby86240592018-05-24 16:12:31 -040043 * The only thing(aside from a memcopy) required to flush a GrTextBlob is to ensure that
joshualitt374b2f72015-07-21 08:05:03 -070044 * the GrAtlas will not evict anything the Blob needs.
45 *
46 * Note: This struct should really be named GrCachedAtasTextBlob, but that is too verbose.
joshualitt259fbf12015-07-21 11:39:34 -070047 *
48 * *WARNING* If you add new fields to this struct, then you may need to to update AssertEqual
joshualitt374b2f72015-07-21 08:05:03 -070049 */
Mike Klein0fb1ee92018-10-30 07:53:43 -040050class GrTextBlob : public SkRefCnt {
joshualitt2e2202e2015-12-10 11:22:08 -080051public:
Herb Derby86240592018-05-24 16:12:31 -040052 SK_DECLARE_INTERNAL_LLIST_INTERFACE(GrTextBlob);
joshualitt374b2f72015-07-21 08:05:03 -070053
Brian Salomon18923f92017-11-06 16:26:02 -050054 class VertexRegenerator;
55
Herb Derby86240592018-05-24 16:12:31 -040056 static sk_sp<GrTextBlob> Make(int glyphCount, int runCount);
joshualitt323c2eb2016-01-20 06:48:47 -080057
Brian Salomon5c6ac642017-12-19 11:09:32 -050058 /**
59 * We currently force regeneration of a blob if old or new matrix differ in having perspective.
60 * If we ever change that then the key must contain the perspectiveness when there are distance
61 * fields as perspective distance field use 3 component vertex positions and non-perspective
62 * uses 2.
63 */
joshualitt323c2eb2016-01-20 06:48:47 -080064 struct Key {
65 Key() {
66 sk_bzero(this, sizeof(Key));
67 }
68 uint32_t fUniqueID;
69 // Color may affect the gamma of the mask we generate, but in a fairly limited way.
70 // Each color is assigned to on of a fixed number of buckets based on its
71 // luminance. For each luminance bucket there is a "canonical color" that
72 // represents the bucket. This functionality is currently only supported for A8
73 SkColor fCanonicalColor;
74 SkPaint::Style fStyle;
75 SkPixelGeometry fPixelGeometry;
76 bool fHasBlur;
brianosman8d7ffce2016-04-21 08:29:06 -070077 uint32_t fScalerContextFlags;
joshualitt323c2eb2016-01-20 06:48:47 -080078
79 bool operator==(const Key& other) const {
80 return 0 == memcmp(this, &other, sizeof(Key));
81 }
82 };
83
Herb Derby86240592018-05-24 16:12:31 -040084 void setupKey(const GrTextBlob::Key& key,
Mike Reed80747ef2018-01-23 15:29:32 -050085 const SkMaskFilterBase::BlurRec& blurRec,
joshualitt92303772016-02-10 11:55:52 -080086 const SkPaint& paint) {
87 fKey = key;
88 if (key.fHasBlur) {
89 fBlurRec = blurRec;
90 }
91 if (key.fStyle != SkPaint::kFill_Style) {
92 fStrokeInfo.fFrameWidth = paint.getStrokeWidth();
93 fStrokeInfo.fMiterLimit = paint.getStrokeMiter();
94 fStrokeInfo.fJoin = paint.getStrokeJoin();
95 }
96 }
97
Herb Derby86240592018-05-24 16:12:31 -040098 static const Key& GetKey(const GrTextBlob& blob) {
joshualitt323c2eb2016-01-20 06:48:47 -080099 return blob.fKey;
100 }
101
102 static uint32_t Hash(const Key& key) {
mtklein4e976072016-08-08 09:06:27 -0700103 return SkOpts::hash(&key, sizeof(Key));
joshualitt323c2eb2016-01-20 06:48:47 -0800104 }
105
106 void operator delete(void* p) {
Herb Derbyb12175f2018-05-23 16:38:09 -0400107 ::operator delete(p);
joshualitt323c2eb2016-01-20 06:48:47 -0800108 }
Herb Derbyb12175f2018-05-23 16:38:09 -0400109
joshualitt323c2eb2016-01-20 06:48:47 -0800110 void* operator new(size_t) {
Ben Wagnerb4aab9a2017-08-16 10:53:04 -0400111 SK_ABORT("All blobs are created by placement new.");
joshualitt323c2eb2016-01-20 06:48:47 -0800112 return sk_malloc_throw(0);
113 }
114
115 void* operator new(size_t, void* p) { return p; }
joshualitt323c2eb2016-01-20 06:48:47 -0800116
117 bool hasDistanceField() const { return SkToBool(fTextType & kHasDistanceField_TextType); }
118 bool hasBitmap() const { return SkToBool(fTextType & kHasBitmap_TextType); }
119 void setHasDistanceField() { fTextType |= kHasDistanceField_TextType; }
120 void setHasBitmap() { fTextType |= kHasBitmap_TextType; }
121
joshualittddd22d82016-02-16 06:47:52 -0800122 int runCount() const { return fRunCount; }
123
joshualitt323c2eb2016-01-20 06:48:47 -0800124 void push_back_run(int currRun) {
125 SkASSERT(currRun < fRunCount);
126 if (currRun > 0) {
127 Run::SubRunInfo& newRun = fRuns[currRun].fSubRunInfo.back();
128 Run::SubRunInfo& lastRun = fRuns[currRun - 1].fSubRunInfo.back();
129 newRun.setAsSuccessor(lastRun);
130 }
131 }
132
133 // sets the last subrun of runIndex to use distance field text
Brian Salomon5c6ac642017-12-19 11:09:32 -0500134 void setSubRunHasDistanceFields(int runIndex, bool hasLCD, bool isAntiAlias, bool hasWCoord) {
joshualitt323c2eb2016-01-20 06:48:47 -0800135 Run& run = fRuns[runIndex];
136 Run::SubRunInfo& subRun = run.fSubRunInfo.back();
137 subRun.setUseLCDText(hasLCD);
Jim Van Verth90e89b32017-07-06 16:36:55 -0400138 subRun.setAntiAliased(isAntiAlias);
joshualitt323c2eb2016-01-20 06:48:47 -0800139 subRun.setDrawAsDistanceFields();
Brian Salomon5c6ac642017-12-19 11:09:32 -0500140 subRun.setHasWCoord(hasWCoord);
joshualitt323c2eb2016-01-20 06:48:47 -0800141 }
142
Jim Van Verthb515ae72018-05-23 16:44:55 -0400143 // sets the last subrun of runIndex to use w values
144 void setSubRunHasW(int runIndex, bool hasWCoord) {
145 Run& run = fRuns[runIndex];
146 Run::SubRunInfo& subRun = run.fSubRunInfo.back();
147 subRun.setHasWCoord(hasWCoord);
148 }
149
Jim Van Verth54d9c882018-02-08 16:14:48 -0500150 void setRunPaintFlags(int runIndex, uint16_t paintFlags) {
151 fRuns[runIndex].fPaintFlags = paintFlags & Run::kPaintFlagsMask;
Jim Van Verth89737de2018-02-06 21:30:20 +0000152 }
153
joshualitt323c2eb2016-01-20 06:48:47 -0800154 void setMinAndMaxScale(SkScalar scaledMax, SkScalar scaledMin) {
155 // we init fMaxMinScale and fMinMaxScale in the constructor
156 fMaxMinScale = SkMaxScalar(scaledMax, fMaxMinScale);
157 fMinMaxScale = SkMinScalar(scaledMin, fMinMaxScale);
158 }
159
160 // inits the override descriptor on the current run. All following subruns must use this
161 // descriptor
162 void initOverride(int runIndex) {
163 Run& run = fRuns[runIndex];
164 // Push back a new subrun to fill and set the override descriptor
165 run.push_back();
166 run.fOverrideDescriptor.reset(new SkAutoDescriptor);
167 }
168
Herb Derby526819d2018-03-09 12:51:12 -0500169 SkExclusiveStrikePtr setupCache(int runIndex,
170 const SkSurfaceProps& props,
171 SkScalerContextFlags scalerContextFlags,
172 const SkPaint& skPaint,
173 const SkMatrix* viewMatrix);
joshualitt323c2eb2016-01-20 06:48:47 -0800174
175 // Appends a glyph to the blob. If the glyph is too large, the glyph will be appended
176 // as a path.
177 void appendGlyph(int runIndex,
178 const SkRect& positions,
Brian Osman1be2b7c2018-10-29 16:07:15 -0400179 GrColor4h color,
Herb Derbycf370b12018-09-19 14:42:45 -0400180 const sk_sp<GrTextStrike>& strike,
Herb Derbyae64e492018-08-06 14:58:25 -0400181 GrGlyph* glyph, bool preTransformed);
Jim Van Verth54d9c882018-02-08 16:14:48 -0500182
183 // Appends a glyph to the blob as a path only.
184 void appendPathGlyph(int runIndex, const SkPath& path,
185 SkScalar x, SkScalar y, SkScalar scale, bool preTransformed);
joshualitt323c2eb2016-01-20 06:48:47 -0800186
Jim Van Verthb515ae72018-05-23 16:44:55 -0400187 static size_t GetVertexStride(GrMaskFormat maskFormat, bool hasWCoord) {
joshualitt323c2eb2016-01-20 06:48:47 -0800188 switch (maskFormat) {
189 case kA8_GrMaskFormat:
Jim Van Verthb515ae72018-05-23 16:44:55 -0400190 return hasWCoord ? kGrayTextDFPerspectiveVASize : kGrayTextVASize;
joshualitt323c2eb2016-01-20 06:48:47 -0800191 case kARGB_GrMaskFormat:
Jim Van Verthb515ae72018-05-23 16:44:55 -0400192 return hasWCoord ? kColorTextPerspectiveVASize : kColorTextVASize;
joshualitt323c2eb2016-01-20 06:48:47 -0800193 default:
Jim Van Verthb515ae72018-05-23 16:44:55 -0400194 SkASSERT(!hasWCoord);
joshualitt323c2eb2016-01-20 06:48:47 -0800195 return kLCDTextVASize;
196 }
197 }
198
Herb Derby0edb2142018-10-16 17:04:11 -0400199 bool mustRegenerate(const SkPaint&, bool, const SkMaskFilterBase::BlurRec& blurRec,
joshualitt323c2eb2016-01-20 06:48:47 -0800200 const SkMatrix& viewMatrix, SkScalar x, SkScalar y);
201
Herb Derbyc1b482c2018-08-09 15:02:27 -0400202 void flush(GrTextTarget*, const SkSurfaceProps& props,
Jim Van Verth54d9c882018-02-08 16:14:48 -0500203 const GrDistanceFieldAdjustTable* distanceAdjustTable,
Brian Osman1be2b7c2018-10-29 16:07:15 -0400204 const SkPaint& paint, GrColor4h filteredColor, const GrClip& clip,
Robert Phillipse4643cc2018-08-14 13:01:29 -0400205 const SkMatrix& viewMatrix, SkScalar x, SkScalar y);
joshualitt323c2eb2016-01-20 06:48:47 -0800206
joshualitt8e0ef292016-02-19 14:13:03 -0800207 void computeSubRunBounds(SkRect* outBounds, int runIndex, int subRunIndex,
Jim Van Verth70276912018-06-01 13:46:46 -0400208 const SkMatrix& viewMatrix, SkScalar x, SkScalar y,
209 bool needsGlyphTransform) {
joshualittbc811112016-02-11 12:42:02 -0800210 // We don't yet position distance field text on the cpu, so we have to map the vertex bounds
211 // into device space.
212 // We handle vertex bounds differently for distance field text and bitmap text because
213 // the vertex bounds of bitmap text are in device space. If we are flushing multiple runs
214 // from one blob then we are going to pay the price here of mapping the rect for each run.
215 const Run& run = fRuns[runIndex];
216 const Run::SubRunInfo& subRun = run.fSubRunInfo[subRunIndex];
217 *outBounds = subRun.vertexBounds();
Jim Van Verth70276912018-06-01 13:46:46 -0400218 if (needsGlyphTransform) {
joshualittbc811112016-02-11 12:42:02 -0800219 // Distance field text is positioned with the (X,Y) as part of the glyph position,
220 // and currently the view matrix is applied on the GPU
joshualitt8e0ef292016-02-19 14:13:03 -0800221 outBounds->offset(x - fInitialX, y - fInitialY);
222 viewMatrix.mapRect(outBounds);
joshualittbc811112016-02-11 12:42:02 -0800223 } else {
224 // Bitmap text is fully positioned on the CPU, and offset by an (X,Y) translate in
225 // device space.
226 SkMatrix boundsMatrix = fInitialViewMatrixInverse;
227
228 boundsMatrix.postTranslate(-fInitialX, -fInitialY);
229
joshualitt8e0ef292016-02-19 14:13:03 -0800230 boundsMatrix.postTranslate(x, y);
joshualittbc811112016-02-11 12:42:02 -0800231
joshualitt8e0ef292016-02-19 14:13:03 -0800232 boundsMatrix.postConcat(viewMatrix);
joshualittbc811112016-02-11 12:42:02 -0800233 boundsMatrix.mapRect(outBounds);
234
235 // Due to floating point numerical inaccuracies, we have to round out here
236 outBounds->roundOut(outBounds);
237 }
238 }
239
joshualitt323c2eb2016-01-20 06:48:47 -0800240 // position + local coord
241 static const size_t kColorTextVASize = sizeof(SkPoint) + sizeof(SkIPoint16);
Jim Van Verthb515ae72018-05-23 16:44:55 -0400242 static const size_t kColorTextPerspectiveVASize = sizeof(SkPoint3) + sizeof(SkIPoint16);
joshualitt323c2eb2016-01-20 06:48:47 -0800243 static const size_t kGrayTextVASize = sizeof(SkPoint) + sizeof(GrColor) + sizeof(SkIPoint16);
Brian Salomon5c6ac642017-12-19 11:09:32 -0500244 static const size_t kGrayTextDFPerspectiveVASize =
245 sizeof(SkPoint3) + sizeof(GrColor) + sizeof(SkIPoint16);
joshualitt323c2eb2016-01-20 06:48:47 -0800246 static const size_t kLCDTextVASize = kGrayTextVASize;
Brian Salomon5c6ac642017-12-19 11:09:32 -0500247 static const size_t kMaxVASize = kGrayTextDFPerspectiveVASize;
joshualitt323c2eb2016-01-20 06:48:47 -0800248 static const int kVerticesPerGlyph = 4;
249
Herb Derby86240592018-05-24 16:12:31 -0400250 static void AssertEqual(const GrTextBlob&, const GrTextBlob&);
joshualitt323c2eb2016-01-20 06:48:47 -0800251
252 // The color here is the GrPaint color, and it is used to determine whether we
253 // have to regenerate LCD text blobs.
254 // We use this color vs the SkPaint color because it has the colorfilter applied.
Jim Van Verth58c3cce2017-10-19 15:50:24 -0400255 void initReusableBlob(SkColor luminanceColor, const SkMatrix& viewMatrix,
256 SkScalar x, SkScalar y) {
Jim Van Verthbc2cdd12017-06-08 11:14:35 -0400257 fLuminanceColor = luminanceColor;
joshualitt7481e752016-01-22 06:08:48 -0800258 this->setupViewMatrix(viewMatrix, x, y);
joshualitt323c2eb2016-01-20 06:48:47 -0800259 }
260
joshualitt7481e752016-01-22 06:08:48 -0800261 void initThrowawayBlob(const SkMatrix& viewMatrix, SkScalar x, SkScalar y) {
262 this->setupViewMatrix(viewMatrix, x, y);
joshualitt323c2eb2016-01-20 06:48:47 -0800263 }
264
joshualitt92303772016-02-10 11:55:52 -0800265 const Key& key() const { return fKey; }
266
Herb Derbyb12175f2018-05-23 16:38:09 -0400267 size_t size() const { return fSize; }
268
Herb Derby86240592018-05-24 16:12:31 -0400269 ~GrTextBlob() {
joshualitt92303772016-02-10 11:55:52 -0800270 for (int i = 0; i < fRunCount; i++) {
271 fRuns[i].~Run();
272 }
273 }
274
joshualittbc811112016-02-11 12:42:02 -0800275 ////////////////////////////////////////////////////////////////////////////////////////////////
276 // Internal test methods
Jim Van Verth56c37142017-10-31 14:44:25 -0400277 std::unique_ptr<GrDrawOp> test_makeOp(int glyphCount, uint16_t run, uint16_t subRun,
Brian Salomon44acb5b2017-07-18 19:59:24 -0400278 const SkMatrix& viewMatrix, SkScalar x, SkScalar y,
Brian Osman1be2b7c2018-10-29 16:07:15 -0400279 const SkPaint& paint, GrColor4h filteredColor,
Herb Derbybc6f9c92018-08-08 13:58:45 -0400280 const SkSurfaceProps&, const GrDistanceFieldAdjustTable*,
Herb Derbyc1b482c2018-08-09 15:02:27 -0400281 GrTextTarget*);
joshualittbc811112016-02-11 12:42:02 -0800282
joshualitt323c2eb2016-01-20 06:48:47 -0800283private:
Herb Derby86240592018-05-24 16:12:31 -0400284 GrTextBlob()
joshualitt92303772016-02-10 11:55:52 -0800285 : fMaxMinScale(-SK_ScalarMax)
286 , fMinMaxScale(SK_ScalarMax)
287 , fTextType(0) {}
288
joshualitt323c2eb2016-01-20 06:48:47 -0800289
joshualitt8e0ef292016-02-19 14:13:03 -0800290 // This function will only be called when we are generating a blob from scratch. We record the
joshualitt7481e752016-01-22 06:08:48 -0800291 // initial view matrix and initial offsets(x,y), because we record vertex bounds relative to
292 // these numbers. When blobs are reused with new matrices, we need to return to model space so
293 // we can update the vertex bounds appropriately.
294 void setupViewMatrix(const SkMatrix& viewMatrix, SkScalar x, SkScalar y) {
joshualitt8e0ef292016-02-19 14:13:03 -0800295 fInitialViewMatrix = viewMatrix;
joshualitt7481e752016-01-22 06:08:48 -0800296 if (!viewMatrix.invert(&fInitialViewMatrixInverse)) {
297 fInitialViewMatrixInverse = SkMatrix::I();
joshualitt7481e752016-01-22 06:08:48 -0800298 }
joshualitt8e0ef292016-02-19 14:13:03 -0800299 fInitialX = x;
300 fInitialY = y;
301
302 // make sure all initial subruns have the correct VM and X/Y applied
303 for (int i = 0; i < fRunCount; i++) {
304 fRuns[i].fSubRunInfo[0].init(fInitialViewMatrix, x, y);
305 }
joshualitt7481e752016-01-22 06:08:48 -0800306 }
307
joshualitt374b2f72015-07-21 08:05:03 -0700308 /*
309 * Each Run inside of the blob can have its texture coordinates regenerated if required.
310 * To determine if regeneration is necessary, fAtlasGeneration is used. If there have been
311 * any evictions inside of the atlas, then we will simply regenerate Runs. We could track
312 * this at a more fine grained level, but its not clear if this is worth it, as evictions
313 * should be fairly rare.
314 *
315 * One additional point, each run can contain glyphs with any of the three mask formats.
316 * We call these SubRuns. Because a subrun must be a contiguous range, we have to create
317 * a new subrun each time the mask format changes in a run. In theory, a run can have as
318 * many SubRuns as it has glyphs, ie if a run alternates between color emoji and A8. In
319 * practice, the vast majority of runs have only a single subrun.
320 *
Herb Derby26cbe512018-05-24 14:39:01 -0400321 * Finally, for runs where the entire thing is too large for the GrTextContext to
Jim Van Verthf4c13162018-01-11 16:40:24 -0500322 * handle, we have a bit to mark the run as flushable via rendering as paths or as scaled
323 * glyphs. It would be a bit expensive to figure out ahead of time whether or not a run
joshualitt374b2f72015-07-21 08:05:03 -0700324 * can flush in this manner, so we always allocate vertices for the run, regardless of
325 * whether or not it is too large. The benefit of this strategy is that we can always reuse
326 * a blob allocation regardless of viewmatrix changes. We could store positions for these
Jim Van Verthf4c13162018-01-11 16:40:24 -0500327 * glyphs, however, it's not clear if this is a win because we'd still have to either go to the
joshualitt374b2f72015-07-21 08:05:03 -0700328 * glyph cache to get the path at flush time, or hold onto the path in the cache, which
329 * would greatly increase the memory of these cached items.
330 */
331 struct Run {
Jim Van Verth54d9c882018-02-08 16:14:48 -0500332 Run() : fPaintFlags(0)
333 , fInitialized(false) {
joshualitt374b2f72015-07-21 08:05:03 -0700334 // To ensure we always have one subrun, we push back a fresh run here
335 fSubRunInfo.push_back();
336 }
337 struct SubRunInfo {
338 SubRunInfo()
Brian Salomon2ee084e2016-12-16 18:59:19 -0500339 : fAtlasGeneration(GrDrawOpAtlas::kInvalidAtlasGeneration)
340 , fVertexStartIndex(0)
341 , fVertexEndIndex(0)
342 , fGlyphStartIndex(0)
343 , fGlyphEndIndex(0)
344 , fColor(GrColor_ILLEGAL)
345 , fMaskFormat(kA8_GrMaskFormat)
Jim Van Verth90e89b32017-07-06 16:36:55 -0400346 , fFlags(0) {
Mike Reed274218e2018-01-08 15:05:02 -0500347 fVertexBounds = SkRectPriv::MakeLargestInverted();
joshualitt7481e752016-01-22 06:08:48 -0800348 }
joshualitt7e97b0b2015-07-31 15:18:08 -0700349 SubRunInfo(const SubRunInfo& that)
350 : fBulkUseToken(that.fBulkUseToken)
351 , fStrike(SkSafeRef(that.fStrike.get()))
joshualitt8e0ef292016-02-19 14:13:03 -0800352 , fCurrentViewMatrix(that.fCurrentViewMatrix)
joshualitt7481e752016-01-22 06:08:48 -0800353 , fVertexBounds(that.fVertexBounds)
joshualitt7e97b0b2015-07-31 15:18:08 -0700354 , fAtlasGeneration(that.fAtlasGeneration)
355 , fVertexStartIndex(that.fVertexStartIndex)
356 , fVertexEndIndex(that.fVertexEndIndex)
357 , fGlyphStartIndex(that.fGlyphStartIndex)
358 , fGlyphEndIndex(that.fGlyphEndIndex)
joshualitt8e0ef292016-02-19 14:13:03 -0800359 , fX(that.fX)
360 , fY(that.fY)
joshualittf9e658b2015-12-09 09:26:44 -0800361 , fColor(that.fColor)
joshualitt7e97b0b2015-07-31 15:18:08 -0700362 , fMaskFormat(that.fMaskFormat)
Jim Van Verth90e89b32017-07-06 16:36:55 -0400363 , fFlags(that.fFlags) {
joshualitt7e97b0b2015-07-31 15:18:08 -0700364 }
joshualitt3660d532015-12-07 11:32:50 -0800365
joshualitt18b072d2015-12-07 12:26:12 -0800366 // TODO when this object is more internal, drop the privacy
joshualitt3660d532015-12-07 11:32:50 -0800367 void resetBulkUseToken() { fBulkUseToken.reset(); }
Brian Salomon2ee084e2016-12-16 18:59:19 -0500368 GrDrawOpAtlas::BulkUseTokenUpdater* bulkUseToken() { return &fBulkUseToken; }
Robert Phillipscaf1ebb2018-03-01 14:28:44 -0500369 void setStrike(sk_sp<GrTextStrike> strike) { fStrike = std::move(strike); }
370 GrTextStrike* strike() const { return fStrike.get(); }
371 sk_sp<GrTextStrike> refStrike() const { return fStrike; }
joshualitt3660d532015-12-07 11:32:50 -0800372
373 void setAtlasGeneration(uint64_t atlasGeneration) { fAtlasGeneration = atlasGeneration;}
374 uint64_t atlasGeneration() const { return fAtlasGeneration; }
375
376 size_t byteCount() const { return fVertexEndIndex - fVertexStartIndex; }
joshualitt3660d532015-12-07 11:32:50 -0800377 size_t vertexStartIndex() const { return fVertexStartIndex; }
joshualitt3660d532015-12-07 11:32:50 -0800378 size_t vertexEndIndex() const { return fVertexEndIndex; }
379 void appendVertices(size_t vertexStride) {
380 fVertexEndIndex += vertexStride * kVerticesPerGlyph;
381 }
382
383 uint32_t glyphCount() const { return fGlyphEndIndex - fGlyphStartIndex; }
joshualitt3660d532015-12-07 11:32:50 -0800384 uint32_t glyphStartIndex() const { return fGlyphStartIndex; }
joshualitt3660d532015-12-07 11:32:50 -0800385 uint32_t glyphEndIndex() const { return fGlyphEndIndex; }
386 void glyphAppended() { fGlyphEndIndex++; }
joshualittf9e658b2015-12-09 09:26:44 -0800387 void setColor(GrColor color) { fColor = color; }
388 GrColor color() const { return fColor; }
joshualitt3660d532015-12-07 11:32:50 -0800389 void setMaskFormat(GrMaskFormat format) { fMaskFormat = format; }
390 GrMaskFormat maskFormat() const { return fMaskFormat; }
391
joshualitt18b072d2015-12-07 12:26:12 -0800392 void setAsSuccessor(const SubRunInfo& prev) {
393 fGlyphStartIndex = prev.glyphEndIndex();
394 fGlyphEndIndex = prev.glyphEndIndex();
395
396 fVertexStartIndex = prev.vertexEndIndex();
397 fVertexEndIndex = prev.vertexEndIndex();
joshualitt8e0ef292016-02-19 14:13:03 -0800398
399 // copy over viewmatrix settings
400 this->init(prev.fCurrentViewMatrix, prev.fX, prev.fY);
joshualitt18b072d2015-12-07 12:26:12 -0800401 }
402
joshualitt7481e752016-01-22 06:08:48 -0800403 const SkRect& vertexBounds() const { return fVertexBounds; }
404 void joinGlyphBounds(const SkRect& glyphBounds) {
405 fVertexBounds.joinNonEmptyArg(glyphBounds);
406 }
407
joshualitt8e0ef292016-02-19 14:13:03 -0800408 void init(const SkMatrix& viewMatrix, SkScalar x, SkScalar y) {
409 fCurrentViewMatrix = viewMatrix;
410 fX = x;
411 fY = y;
412 }
413
414 // This function assumes the translation will be applied before it is called again
415 void computeTranslation(const SkMatrix& viewMatrix, SkScalar x, SkScalar y,
Brian Salomon5c6ac642017-12-19 11:09:32 -0500416 SkScalar* transX, SkScalar* transY);
joshualitt8e0ef292016-02-19 14:13:03 -0800417
joshualitt3660d532015-12-07 11:32:50 -0800418 // df properties
Jim Van Verth90e89b32017-07-06 16:36:55 -0400419 void setDrawAsDistanceFields() { fFlags |= kDrawAsSDF_Flag; }
420 bool drawAsDistanceFields() const { return SkToBool(fFlags & kDrawAsSDF_Flag); }
421 void setUseLCDText(bool useLCDText) {
422 fFlags = useLCDText ? fFlags | kUseLCDText_Flag : fFlags & ~kUseLCDText_Flag;
423 }
424 bool hasUseLCDText() const { return SkToBool(fFlags & kUseLCDText_Flag); }
425 void setAntiAliased(bool antiAliased) {
426 fFlags = antiAliased ? fFlags | kAntiAliased_Flag : fFlags & ~kAntiAliased_Flag;
427 }
428 bool isAntiAliased() const { return SkToBool(fFlags & kAntiAliased_Flag); }
Brian Salomon5c6ac642017-12-19 11:09:32 -0500429 void setHasWCoord(bool hasW) {
430 fFlags = hasW ? (fFlags | kHasWCoord_Flag) : fFlags & ~kHasWCoord_Flag;
431 }
432 bool hasWCoord() const { return SkToBool(fFlags & kHasWCoord_Flag); }
Jim Van Verthb515ae72018-05-23 16:44:55 -0400433 void setNeedsTransform(bool needsTransform) {
434 fFlags = needsTransform ? (fFlags | kNeedsTransform_Flag)
435 : fFlags & ~kNeedsTransform_Flag;
Jim Van Verthcf838c72018-03-05 14:40:36 -0500436 }
Jim Van Verthb515ae72018-05-23 16:44:55 -0400437 bool needsTransform() const { return SkToBool(fFlags & kNeedsTransform_Flag); }
joshualitt3660d532015-12-07 11:32:50 -0800438
439 private:
Jim Van Verth90e89b32017-07-06 16:36:55 -0400440 enum Flag {
Jim Van Verthcf838c72018-03-05 14:40:36 -0500441 kDrawAsSDF_Flag = 0x01,
442 kUseLCDText_Flag = 0x02,
443 kAntiAliased_Flag = 0x04,
444 kHasWCoord_Flag = 0x08,
Jim Van Verthb515ae72018-05-23 16:44:55 -0400445 kNeedsTransform_Flag = 0x10
Jim Van Verth90e89b32017-07-06 16:36:55 -0400446 };
447
Brian Salomon2ee084e2016-12-16 18:59:19 -0500448 GrDrawOpAtlas::BulkUseTokenUpdater fBulkUseToken;
Robert Phillipscaf1ebb2018-03-01 14:28:44 -0500449 sk_sp<GrTextStrike> fStrike;
joshualitt8e0ef292016-02-19 14:13:03 -0800450 SkMatrix fCurrentViewMatrix;
joshualitt7481e752016-01-22 06:08:48 -0800451 SkRect fVertexBounds;
joshualitt374b2f72015-07-21 08:05:03 -0700452 uint64_t fAtlasGeneration;
453 size_t fVertexStartIndex;
454 size_t fVertexEndIndex;
455 uint32_t fGlyphStartIndex;
456 uint32_t fGlyphEndIndex;
joshualitt8e0ef292016-02-19 14:13:03 -0800457 SkScalar fX;
458 SkScalar fY;
joshualittf9e658b2015-12-09 09:26:44 -0800459 GrColor fColor;
joshualitt374b2f72015-07-21 08:05:03 -0700460 GrMaskFormat fMaskFormat;
Jim Van Verth90e89b32017-07-06 16:36:55 -0400461 uint32_t fFlags;
Jim Van Verth58c3cce2017-10-19 15:50:24 -0400462 }; // SubRunInfo
joshualitt374b2f72015-07-21 08:05:03 -0700463
464 SubRunInfo& push_back() {
465 // Forward glyph / vertex information to seed the new sub run
joshualitt374b2f72015-07-21 08:05:03 -0700466 SubRunInfo& newSubRun = fSubRunInfo.push_back();
joshualitt18b072d2015-12-07 12:26:12 -0800467 const SubRunInfo& prevSubRun = fSubRunInfo.fromBack(1);
joshualitte43e3bd2015-07-29 11:10:38 -0700468
joshualitt18b072d2015-12-07 12:26:12 -0800469 newSubRun.setAsSuccessor(prevSubRun);
joshualitt374b2f72015-07-21 08:05:03 -0700470 return newSubRun;
471 }
472 static const int kMinSubRuns = 1;
Hal Canary144caf52016-11-07 17:57:18 -0500473 sk_sp<SkTypeface> fTypeface;
joshualitt374b2f72015-07-21 08:05:03 -0700474 SkSTArray<kMinSubRuns, SubRunInfo> fSubRunInfo;
475 SkAutoDescriptor fDescriptor;
bsalomon8b6fa5e2016-05-19 16:23:47 -0700476
477 // Effects from the paint that are used to build a SkScalerContext.
478 sk_sp<SkPathEffect> fPathEffect;
bsalomon8b6fa5e2016-05-19 16:23:47 -0700479 sk_sp<SkMaskFilter> fMaskFilter;
joshualitt3660d532015-12-07 11:32:50 -0800480
481 // Distance field text cannot draw coloremoji, and so has to fall back. However,
482 // though the distance field text and the coloremoji may share the same run, they
483 // will have different descriptors. If fOverrideDescriptor is non-nullptr, then it
484 // will be used in place of the run's descriptor to regen texture coords
Ben Wagner145dbcd2016-11-03 14:40:50 -0400485 std::unique_ptr<SkAutoDescriptor> fOverrideDescriptor; // df properties
Jim Van Verth54d9c882018-02-08 16:14:48 -0500486
487 // Any glyphs that can't be rendered with the base or override descriptor
488 // are rendered as paths
489 struct PathGlyph {
490 PathGlyph(const SkPath& path, SkScalar x, SkScalar y, SkScalar scale, bool preXformed)
491 : fPath(path)
492 , fX(x)
493 , fY(y)
494 , fScale(scale)
495 , fPreTransformed(preXformed) {}
496 SkPath fPath;
497 SkScalar fX;
498 SkScalar fY;
499 SkScalar fScale;
500 bool fPreTransformed;
501 };
502
503 SkTArray<PathGlyph> fPathGlyphs;
504
505 struct {
506 unsigned fPaintFlags : 16; // needed mainly for rendering paths
507 bool fInitialized : 1;
508 };
509 // the only flags we need to set
510 static constexpr auto kPaintFlagsMask = SkPaint::kAntiAlias_Flag;
Jim Van Verth58c3cce2017-10-19 15:50:24 -0400511 }; // Run
joshualitt374b2f72015-07-21 08:05:03 -0700512
Brian Salomonf18b1d82017-10-27 11:30:49 -0400513 inline std::unique_ptr<GrAtlasTextOp> makeOp(
Jim Van Verth56c37142017-10-31 14:44:25 -0400514 const Run::SubRunInfo& info, int glyphCount, uint16_t run, uint16_t subRun,
Brian Salomonf18b1d82017-10-27 11:30:49 -0400515 const SkMatrix& viewMatrix, SkScalar x, SkScalar y, const SkIRect& clipRect,
Brian Osman1be2b7c2018-10-29 16:07:15 -0400516 const SkPaint& paint, GrColor4h filteredColor, const SkSurfaceProps&,
Herb Derbyc1b482c2018-08-09 15:02:27 -0400517 const GrDistanceFieldAdjustTable*, GrTextTarget*);
joshualitt323c2eb2016-01-20 06:48:47 -0800518
joshualitt374b2f72015-07-21 08:05:03 -0700519 struct StrokeInfo {
520 SkScalar fFrameWidth;
521 SkScalar fMiterLimit;
522 SkPaint::Join fJoin;
523 };
524
525 enum TextType {
526 kHasDistanceField_TextType = 0x1,
527 kHasBitmap_TextType = 0x2,
528 };
529
530 // all glyph / vertex offsets are into these pools.
Brian Salomon18923f92017-11-06 16:26:02 -0500531 char* fVertices;
joshualitt374b2f72015-07-21 08:05:03 -0700532 GrGlyph** fGlyphs;
533 Run* fRuns;
Mike Reed80747ef2018-01-23 15:29:32 -0500534 SkMaskFilterBase::BlurRec fBlurRec;
joshualitt374b2f72015-07-21 08:05:03 -0700535 StrokeInfo fStrokeInfo;
joshualitt374b2f72015-07-21 08:05:03 -0700536 Key fKey;
joshualitt8e0ef292016-02-19 14:13:03 -0800537 SkMatrix fInitialViewMatrix;
joshualitt7481e752016-01-22 06:08:48 -0800538 SkMatrix fInitialViewMatrixInverse;
joshualitt2f2ee832016-02-10 08:52:24 -0800539 size_t fSize;
Jim Van Verthbc2cdd12017-06-08 11:14:35 -0400540 SkColor fLuminanceColor;
joshualitt7481e752016-01-22 06:08:48 -0800541 SkScalar fInitialX;
542 SkScalar fInitialY;
joshualitt374b2f72015-07-21 08:05:03 -0700543
544 // We can reuse distance field text, but only if the new viewmatrix would not result in
545 // a mip change. Because there can be multiple runs in a blob, we track the overall
546 // maximum minimum scale, and minimum maximum scale, we can support before we need to regen
547 SkScalar fMaxMinScale;
548 SkScalar fMinMaxScale;
549 int fRunCount;
550 uint8_t fTextType;
joshualitt374b2f72015-07-21 08:05:03 -0700551};
552
Brian Salomon18923f92017-11-06 16:26:02 -0500553/**
554 * Used to produce vertices for a subrun of a blob. The vertices are cached in the blob itself.
555 * This is invoked each time a sub run is drawn. It regenerates the vertex data as required either
556 * because of changes to the atlas or because of different draw parameters (e.g. color change). In
557 * rare cases the draw may have to interrupted and flushed in the middle of the sub run in order to
558 * free up atlas space. Thus, this generator is stateful and should be invoked in a loop until the
559 * entire sub run has been completed.
560 */
Herb Derby86240592018-05-24 16:12:31 -0400561class GrTextBlob::VertexRegenerator {
Brian Salomon18923f92017-11-06 16:26:02 -0500562public:
563 /**
564 * Consecutive VertexRegenerators often use the same SkGlyphCache. If the same instance of
565 * SkAutoGlyphCache is reused then it can save the cost of multiple detach/attach operations of
566 * SkGlyphCache.
567 */
Herb Derby86240592018-05-24 16:12:31 -0400568 VertexRegenerator(GrResourceProvider*, GrTextBlob*, int runIdx, int subRunIdx,
Robert Phillips4bc70112018-03-01 10:24:02 -0500569 const SkMatrix& viewMatrix, SkScalar x, SkScalar y, GrColor color,
Robert Phillipsc4039ea2018-03-01 11:36:45 -0500570 GrDeferredUploadTarget*, GrGlyphCache*, GrAtlasManager*,
Herb Derby7956b592018-03-22 16:10:30 -0400571 SkExclusiveStrikePtr*);
Brian Salomon18923f92017-11-06 16:26:02 -0500572
573 struct Result {
574 /**
575 * Was regenerate() able to draw all the glyphs from the sub run? If not flush all glyph
576 * draws and call regenerate() again.
577 */
578 bool fFinished = true;
579
580 /**
581 * How many glyphs were regenerated. Will be equal to the sub run's glyph count if
582 * fType is kFinished.
583 */
584 int fGlyphsRegenerated = 0;
585
586 /**
587 * Pointer where the caller finds the first regenerated vertex.
588 */
589 const char* fFirstVertex;
590 };
591
Robert Phillipsd2e9f762018-03-07 11:54:37 -0500592 bool regenerate(Result*);
Brian Salomon18923f92017-11-06 16:26:02 -0500593
594private:
595 template <bool regenPos, bool regenCol, bool regenTexCoords, bool regenGlyphs>
Robert Phillipsd2e9f762018-03-07 11:54:37 -0500596 bool doRegen(Result*);
Brian Salomon18923f92017-11-06 16:26:02 -0500597
Robert Phillips4bc70112018-03-01 10:24:02 -0500598 GrResourceProvider* fResourceProvider;
Brian Salomon18923f92017-11-06 16:26:02 -0500599 const SkMatrix& fViewMatrix;
Herb Derby86240592018-05-24 16:12:31 -0400600 GrTextBlob* fBlob;
Brian Salomon18923f92017-11-06 16:26:02 -0500601 GrDeferredUploadTarget* fUploadTarget;
Robert Phillipsc4039ea2018-03-01 11:36:45 -0500602 GrGlyphCache* fGlyphCache;
603 GrAtlasManager* fFullAtlasManager;
Herb Derby8c4cbf42018-03-09 15:28:04 -0500604 SkExclusiveStrikePtr* fLazyCache;
Brian Salomon18923f92017-11-06 16:26:02 -0500605 Run* fRun;
606 Run::SubRunInfo* fSubRun;
Brian Salomon18923f92017-11-06 16:26:02 -0500607 GrColor fColor;
608 SkScalar fTransX;
609 SkScalar fTransY;
610
611 uint32_t fRegenFlags = 0;
612 int fCurrGlyph = 0;
613 bool fBrokenRun = false;
614};
615
Herb Derby86240592018-05-24 16:12:31 -0400616#endif // GrTextBlob_DEFINED