blob: 9e3ff056fd8aa81ff07b23fef7bf1a32b602b5ae [file] [log] [blame]
Cary Clark8032b982017-07-28 11:04:54 -04001# external references that will be documented eventually ...
2#External
3 DirectWrite TrueType Windows Linux Android
4 FreeType FreeType-based Harfbuzz
5 PostScript PostScript_arct
6 OS_X Core_Graphics Core_Text iOS
7 LCD RGB
8 Premultiplied Unpremultiplied
9 Unicode Unicode5 UTF-8 UTF-16 UTF-32 ASCII Unichar
10 HTML_Canvas HTML_Canvas_arcTo
11 API
12 CPU
Cary Clarkbad5ad72017-08-03 17:14:08 -040013 GPU GPU-backed OpenGL Vulkan
Cary Clark8032b982017-07-28 11:04:54 -040014 NULL
15 RFC
16 Bezier Coons
Cary Clarkbad5ad72017-08-03 17:14:08 -040017 SaveLayerFlags # not external; need to add typedef support
Cary Clark8032b982017-07-28 11:04:54 -040018 SkUserConfig.h # not external, but still thinking about how markup refers to this
Cary Clarkbad5ad72017-08-03 17:14:08 -040019 SkXXX.h # ditto
Cary Clark8032b982017-07-28 11:04:54 -040020 Skia # ditto
21 SK_USE_FREETYPE_EMBOLDEN # ditto
22 SK_SUPPORT_LEGACY_PAINT_TEXTDECORATION # ditto
23 SK_BUILD_FOR_ANDROID_FRAMEWORK # ditto
24 Developer_Mode # ditto
25 Draw_Layer # ditto
26 Raster_Engine # ditto
27
28# FreeType related
29FT_LOAD_TARGET_LIGHT
30FT_LOAD_TARGET_NORMAL
31FT_LOAD_TARGET_LCD
32FT_LOAD_TARGET_LCD_V
33FT_LOAD_NO_HINTING
34FT_Load_Glyph
35
36#External ##
37
38#Topic Arc
39#Substitute arcs
40#Topic ##
41
42#Topic BBH_Factory
43#Class SkBBHFactory
44##
45##
46
47#Topic Bitmap
48#Class SkBitmap
49 #Subtopic Row_Bytes
50 ##
51#Class ##
52##
53
54#Topic Blend_Mode
55#EnumClass SkBlendMode
56 #Const kSrc 1
57 ##
58 #Const kSrcOver 3
59 ##
60 #Const kPlus 12
61 ##
62#EnumClass ##
63#Topic ##
64
65#Topic Circle
66#Substitute circles
67#Topic ##
68
69#Topic Clip_Op
70#EnumClass SkClipOp
71 #Const kDifference 0
72 ##
73 #Const kIntersect 1
74 ##
75##
76##
77
78#Topic Color
79 #Typedef SkColor
80 #Typedef ##
81
82 # fixme: defines, not methods, need new markup type
83 #Method int SkColorGetA(color)
84 ##
85 #Method int SkColorGetR(color)
86 ##
87 #Method int SkColorGetG(color)
88 ##
89 #Method int SkColorGetB(color)
90 ##
91 #Method int SkColorSetARGB(a, r, g, b)
92 ##
93
94 #Const SK_ColorBLACK 0xFF000000
95 ##
96 #Const SK_ColorBLUE 0xFF0000FF
97 ##
98 #Const SK_ColorGREEN 0xFF00FF00
99 ##
100 #Const SK_ColorRED 0xFFFF0000
101 ##
102 #Const SK_ColorWHITE 0xFFFFFFFF
103 ##
104 #Subtopic Alpha
105 #Substitute alpha
106 #Subtopic ##
107 #Subtopic RGB
108 #Substitute RGB
109 #Subtopic Red
110 #Substitute red
111 #Subtopic ##
112 #Subtopic Blue
113 #Substitute blue
114 #Subtopic ##
115 #Subtopic Green
116 #Substitute green
117 #Subtopic ##
118 #Subtopic ##
119 #Subtopic ARGB
120 #Substitute ARGB
121 #Subtopic ##
122
123 #Subtopic RBG
124 #Substitute RBG
125 #Subtopic ##
126
127 #Subtopic RGB-565
128 #Substitute RGB-565
129 #Alias Color_RGB-565 # quit changing - to _ !
130 #Subtopic ##
131#Topic ##
132
133#Topic Color_Filter
134#Class SkColorFilter
135#Class ##
136#Topic ##
137
138#Topic Color_Space
139##
140
141#Topic Curve
142#Alias Curves
143##
144
145#Topic Data
146##
147
148#Topic Device
149#Class SkBaseDevice
150##
151#Topic ##
152
153#Topic Document
154#Class SkDocument
155 #Method SkCanvas* beginPage(SkScalar width, SkScalar height,
156 const SkRect* content = NULL)
157 ##
158##
159#Subtopic PDF
160##
161##
162
163#Topic Draw_Filter
164#Class SkDrawFilter
165##
166##
167
168#Topic Draw_Looper
169#Class SkDrawLooper
170#Class ##
171#Topic ##
172
173#Topic Drawable
174#Class SkDrawable
175 #Method void draw(SkCanvas*, const SkMatrix* = NULL)
176 ##
177##
178##
179
180#Topic Dump_Canvas
181#Class SkDumpCanvas
182##
183#Topic ##
184
185#Topic Filter_Quality
186#Enum SkFilterQuality
187 #Const kNone_SkFilterQuality 0
188 ##
189 #Const kLow_SkFilterQuality 1
190 ##
191 #Const kMedium_SkFilterQuality 2
192 ##
193 #Const kHigh_SkFilterQuality 3
194 ##
195#Enum ##
196#Topic ##
197
198#Topic Font
199#Subtopic Advance
200#Subtopic ##
201#Subtopic Engine
202##
203#Topic ##
204
205#Topic Font_Manager
206#Topic ##
207
208#Topic Glyph
209##
210
Cary Clarkbad5ad72017-08-03 17:14:08 -0400211#Topic GPU_Context
212#Substitute GPU context
213##
214
215#Topic GPU_Surface
216#Substitute GPU surface
217##
218
Cary Clark8032b982017-07-28 11:04:54 -0400219#Topic Image
220 #Subtopic Alpha_Type
221 #Enum SkAlphaType
222 #Const kPremul_SkAlphaType 2
223 ##
224 ##
225 #Subtopic ##
226 #Subtopic Color_Type
227 #Enum SkColorType
228 #Const kUnknown_SkColorType 0
229 ##
230 #Const kAlpha_8_SkColorType 1
231 ##
232 #Const kRGB_565_SkColorType 2
233 ##
234 #Const kARGB_4444_SkColorType 3
235 ##
236 #Const kRGBA_8888_SkColorType 4
237 ##
238 #Const kBGRA_8888_SkColorType 5
239 ##
240 #Const kIndex_8_SkColorType 6
241 ##
242 #Const kGray_8_SkColorType 7
243 ##
244 #Const kRGBA_F16_SkColorType 8
245 ##
246 #ToDo this is a lie; need to not require values for consts ##
247 #Const kN32_SkColorType 4
248 ##
249 #Enum ##
250 #Subtopic ##
251 #Subtopic Info
252 #Struct SkImageInfo
253 #Method SkImageInfo()
254 ##
255 ##
256 #Subtopic ##
257 #Class SkImage
258 #Method sk_sp<SkShader> makeShader(SkShader::TileMode, SkShader::TileMode,
259 const SkMatrix* localMatrix = nullptr) const
260 ##
261 ##
262#Topic ##
263
264#Topic Image_Filter
265#Subtopic Scaling
266#Subtopic ##
267#Class SkImageFilter
268#Class ##
269#Topic ##
270
271#Topic Image_Scaling
272##
273
274#Topic IRect
275#Struct SkIRect
276##
277##
278
279#Topic Line
280#Substitute lines
281#Alias Lines
282#Topic ##
283
284#Topic Mask
285#Topic ##
286
287#Topic Mask_Alpha
288#Topic ##
289
290#Topic Mask_Filter
291#Class SkMaskFilter
292#Class ##
293#Topic ##
294
295#Topic Matrix
296#Struct SkMatrix
297#Struct ##
298#Topic ##
299
300#Topic Nine_Patch
301##
302
303#Topic Number_Types
304 #Typedef SkGlyphID
305 #Typedef ##
306 #Typedef SkScalar
307 #Typedef ##
308 #Const SK_ScalarMax
309 to be written
310 ##
311 #Const SK_ScalarInfinity
312 to be written
313 ##
314 #Const SK_ScalarNegativeInfinity
315 to be written
316 ##
317 #Const SK_ScalarNaN
318 to be written
319 ##
320 #Typedef SkUnichar
321 #Typedef ##
322 #Typedef U8CPU
323 #Typedef ##
324#Topic ##
325
326#Topic Oval
327#Substitute ovals
328#Topic ##
329
330#Topic Paint_Defaults
331#Const SkPaintDefaults_Flags 0
332##
333#Const SkPaintDefaults_Hinting 2
334##
335#Const SkPaintDefaults_TextSize 12
336##
337#Const SkPaintDefaults_MiterLimit 4
338##
339#Topic ##
340
341#Topic Patch
342#Substitute patches
343#Topic ##
344
345#Topic Path_Effect
346 #Class SkPathEffect
347 #Class ##
348#Topic ##
349
350#Topic Path_Measure
351 #Class SkPathMeasure
352 #Method void dump() const
353 ##
354 ##
355##
356
357#Topic PathOps
358 #Method bool SK_API Op(const SkPath& one, const SkPath& two, SkPathOp op, SkPath* result)
359 ##
360#Topic ##
361
362#Topic Picture
363#Subtopic Recorder
364 #Class SkPictureRecorder
365 #Method SkCanvas* beginRecording(const SkRect& bounds,
366 SkBBHFactory* bbhFactory = NULL,
367 uint32_t recordFlags = 0)
368 ##
369 ##
370##
371##
372
373#Topic Pixel
374#Subtopic Storage
375##
376##
377
Cary Clarkbad5ad72017-08-03 17:14:08 -0400378#Enum SkPixelGeometry
379##
380
Cary Clark8032b982017-07-28 11:04:54 -0400381#Topic Pixmap
382#Class SkPixmap
383##
384##
385
386#Topic Point
387#Alias Points
388 #Struct SkPoint
389 #Method bool equalsWithinTolerance(const SkPoint& p) const
390 ##
391 #Struct ##
392 #Subtopic Array
393 #Substitute SkPoint arrays
394 #Subtopic ##
395#Topic ##
396
397#Topic Raster_Handle_Allocator
398#Class SkRasterHandleAllocator
399 #Struct Rec
400 ##
401 #Method static std::unique_ptr<SkCanvas> MakeCanvas(std::unique_ptr<SkRasterHandleAllocator>, const SkImageInfo&, const Rec* rec = nullptr)
402 ##
403##
404##
405
Cary Clarkbad5ad72017-08-03 17:14:08 -0400406#Topic Raster_Surface
407##
408
Cary Clark8032b982017-07-28 11:04:54 -0400409#Topic Rasterizer
410#Class SkRasterizer
411#Class ##
412#Subtopic Layer
413#Subtopic ##
414#Topic ##
415
416#Topic Rect
417#Alias Rects
418 #Struct SkRect
419 #Method static constexpr SkRect SK_WARN_UNUSED_RESULT MakeEmpty()
420 ##
421 #Method void dump() const
422 ##
423 #Method void dumpHex() const
424 ##
425 #Struct ##
426#Topic ##
427
428#Topic Reference_Count
429#Substitute SkRefCnt
430#Class sk_sp
431#Class ##
432#Topic ##
433
434#Topic Region
435#Class SkRegion
436##
437#Topic ##
438
439#Topic Round_Rect
440 #Class SkRRect
441 #Method void dump() const
442 ##
443 #Method void dumpHex() const
444 ##
445 ##
446#Topic ##
447
448#Topic RSXform
449#Struct SkRSXform
450##
451##
452
453#Topic Shader
454#Class SkShader
455 #Enum TileMode
456 #Const kClamp_TileMode 0
457 ##
458 ##
459 #Method static sk_sp<SkShader> MakeBitmapShader(const SkBitmap& src, TileMode tmx, TileMode tmy,
460 const SkMatrix* localMatrix = nullptr)
461 ##
462#Class ##
463#Subtopic Gradient
464#Subtopic ##
465#Topic ##
466
467#Topic Sprite
468#Substitute sprites
469#Topic ##
470
471#Topic Stream
472#Class SkFlattenable
473#Class ##
474#Topic ##
475
476#Topic String
477#Class SkString
478#Class ##
479#Topic ##
480
481#Topic Surface
482#Class SkSurface
483 #Method static sk_sp<SkSurface> MakeRasterDirect(const SkImageInfo&, void* pixels, size_t rowBytes,
484 const SkSurfaceProps* = nullptr)
485 ##
486##
487#Subtopic Properties
488 #Class SkSurfaceProps
Cary Clarkbad5ad72017-08-03 17:14:08 -0400489 #Topic Legacy_Font_Host
Cary Clark8032b982017-07-28 11:04:54 -0400490 #Enum InitType
491 #Const kLegacyFontHost_InitType 0
492 ##
493 ##
Cary Clarkbad5ad72017-08-03 17:14:08 -0400494 #Topic ##
Cary Clark8032b982017-07-28 11:04:54 -0400495 ##
496##
Cary Clark8032b982017-07-28 11:04:54 -0400497##
498
499#Topic SVG
500#Subtopic Canvas
501##
502#Subtopic Arc
503##
504##
505
506#Topic Text
507#Topic ##
508
509#Topic Text_Blob
510#Class SkTextBlob
511#Class ##
512#Topic ##
513
514#Topic Typeface
515#Class SkTypeface
516#Class ##
517#Topic ##
518
519#Topic Vector
520#Struct SkVector
521##
522##
523
524#Topic Vertices
525#Substitute vertices
526#Subtopic Colors
527##
528#Subtopic Texs
529##
530#Topic ##
531
532#Topic Read_Buffer
533 #Struct SkReadBuffer
534 #Struct ##
535##
536
537#Topic Write_Buffer
538 #Struct SkWriteBuffer
539 #Struct ##
540#Topic ##