blob: 9a7c488d67636981b6482c25199c9611b0496e9e [file] [log] [blame]
Cary Clark8032b982017-07-28 11:04:54 -04001# external references that will be documented eventually ...
2#External
Cary Clarkce101242017-09-01 15:51:02 -04003 DirectWrite TrueType Windows Linux Android iOS
Cary Clark8032b982017-07-28 11:04:54 -04004 FreeType FreeType-based Harfbuzz
Cary Clarkce101242017-09-01 15:51:02 -04005 Descenders Kerning Unhinted
Cary Clark8032b982017-07-28 11:04:54 -04006 LCD RGB
Cary Clark8032b982017-07-28 11:04:54 -04007 Unicode Unicode5 UTF-8 UTF-16 UTF-32 ASCII Unichar
Cary Clark8032b982017-07-28 11:04:54 -04008 API
9 CPU
Cary Clarkbad5ad72017-08-03 17:14:08 -040010 GPU GPU-backed OpenGL Vulkan
Cary Clark8032b982017-07-28 11:04:54 -040011 RFC
Cary Clark73fa9722017-08-29 17:36:51 -040012 Bezier Coons Cartesian
Cary Clarkce101242017-09-01 15:51:02 -040013 C C++ Destructor Subclasses
Cary Clarkbad5ad72017-08-03 17:14:08 -040014 SaveLayerFlags # not external; need to add typedef support
Cary Clarkce101242017-09-01 15:51:02 -040015 SkUserConfig # not external, but still thinking about how markup refers to this
Cary Clarkbad5ad72017-08-03 17:14:08 -040016 SkXXX.h # ditto
Cary Clark8032b982017-07-28 11:04:54 -040017 Skia # ditto
18 SK_USE_FREETYPE_EMBOLDEN # ditto
19 SK_SUPPORT_LEGACY_PAINT_TEXTDECORATION # ditto
20 SK_BUILD_FOR_ANDROID_FRAMEWORK # ditto
Cary Clarkce101242017-09-01 15:51:02 -040021 SK_IGNORE_TO_STRING # ditto
Cary Clark8032b982017-07-28 11:04:54 -040022
23# FreeType related
24FT_LOAD_TARGET_LIGHT
25FT_LOAD_TARGET_NORMAL
26FT_LOAD_TARGET_LCD
27FT_LOAD_TARGET_LCD_V
28FT_LOAD_NO_HINTING
29FT_Load_Glyph
30
31#External ##
32
Cary Clarkce101242017-09-01 15:51:02 -040033#Topic Alias
34#Alias Aliased
35#Alias Aliasing
36##
37
38#Topic Anti-alias
39#Alias Anti-aliased
40#Alias Anti-aliasing
41##
42
Cary Clark8032b982017-07-28 11:04:54 -040043#Topic Arc
Cary Clarkce101242017-09-01 15:51:02 -040044#Alias Arcs
Cary Clark8032b982017-07-28 11:04:54 -040045#Topic ##
46
47#Topic BBH_Factory
48#Class SkBBHFactory
49##
50##
51
52#Topic Bitmap
53#Class SkBitmap
54 #Subtopic Row_Bytes
55 ##
56#Class ##
57##
58
59#Topic Blend_Mode
60#EnumClass SkBlendMode
61 #Const kSrc 1
62 ##
63 #Const kSrcOver 3
64 ##
65 #Const kPlus 12
66 ##
67#EnumClass ##
68#Topic ##
69
70#Topic Circle
Cary Clarkce101242017-09-01 15:51:02 -040071#Alias Circles
Cary Clark8032b982017-07-28 11:04:54 -040072#Topic ##
73
74#Topic Clip_Op
75#EnumClass SkClipOp
76 #Const kDifference 0
77 ##
78 #Const kIntersect 1
79 ##
80##
81##
82
83#Topic Color
84 #Typedef SkColor
85 #Typedef ##
86
87 # fixme: defines, not methods, need new markup type
88 #Method int SkColorGetA(color)
89 ##
90 #Method int SkColorGetR(color)
91 ##
92 #Method int SkColorGetG(color)
93 ##
94 #Method int SkColorGetB(color)
95 ##
96 #Method int SkColorSetARGB(a, r, g, b)
97 ##
98
99 #Const SK_ColorBLACK 0xFF000000
100 ##
101 #Const SK_ColorBLUE 0xFF0000FF
102 ##
103 #Const SK_ColorGREEN 0xFF00FF00
104 ##
105 #Const SK_ColorRED 0xFFFF0000
106 ##
107 #Const SK_ColorWHITE 0xFFFFFFFF
108 ##
109 #Subtopic Alpha
Cary Clarkce101242017-09-01 15:51:02 -0400110 #Alias Alpha
Cary Clark8032b982017-07-28 11:04:54 -0400111 #Subtopic ##
112 #Subtopic RGB
113 #Substitute RGB
114 #Subtopic Red
Cary Clarkce101242017-09-01 15:51:02 -0400115 #Alias Red
Cary Clark8032b982017-07-28 11:04:54 -0400116 #Subtopic ##
117 #Subtopic Blue
Cary Clarkce101242017-09-01 15:51:02 -0400118 #Alias Blue
Cary Clark8032b982017-07-28 11:04:54 -0400119 #Subtopic ##
120 #Subtopic Green
Cary Clarkce101242017-09-01 15:51:02 -0400121 #Alias Green
Cary Clark8032b982017-07-28 11:04:54 -0400122 #Subtopic ##
123 #Subtopic ##
124 #Subtopic ARGB
125 #Substitute ARGB
126 #Subtopic ##
127
128 #Subtopic RBG
129 #Substitute RBG
130 #Subtopic ##
131
132 #Subtopic RGB-565
133 #Substitute RGB-565
134 #Alias Color_RGB-565 # quit changing - to _ !
135 #Subtopic ##
136#Topic ##
137
138#Topic Color_Filter
139#Class SkColorFilter
140#Class ##
141#Topic ##
142
143#Topic Color_Space
144##
145
Cary Clarkce101242017-09-01 15:51:02 -0400146#Topic Core_Graphics
147#Substitute Core Graphics
148##
149
150#Topic Core_Text
151#Substitute Core Text
152##
153
Cary Clark8032b982017-07-28 11:04:54 -0400154#Topic Curve
155#Alias Curves
156##
157
158#Topic Data
159##
160
161#Topic Device
162#Class SkBaseDevice
163##
164#Topic ##
165
166#Topic Document
167#Class SkDocument
168 #Method SkCanvas* beginPage(SkScalar width, SkScalar height,
169 const SkRect* content = NULL)
170 ##
171##
172#Subtopic PDF
173##
174##
175
176#Topic Draw_Filter
177#Class SkDrawFilter
178##
179##
180
Cary Clarkce101242017-09-01 15:51:02 -0400181#Topic Draw_Layer
182##
183
Cary Clark8032b982017-07-28 11:04:54 -0400184#Topic Draw_Looper
185#Class SkDrawLooper
186#Class ##
187#Topic ##
188
189#Topic Drawable
190#Class SkDrawable
191 #Method void draw(SkCanvas*, const SkMatrix* = NULL)
192 ##
193##
194##
195
196#Topic Dump_Canvas
197#Class SkDumpCanvas
198##
199#Topic ##
200
201#Topic Filter_Quality
202#Enum SkFilterQuality
203 #Const kNone_SkFilterQuality 0
204 ##
205 #Const kLow_SkFilterQuality 1
206 ##
207 #Const kMedium_SkFilterQuality 2
208 ##
209 #Const kHigh_SkFilterQuality 3
210 ##
211#Enum ##
212#Topic ##
213
214#Topic Font
215#Subtopic Advance
216#Subtopic ##
217#Subtopic Engine
218##
219#Topic ##
220
221#Topic Font_Manager
222#Topic ##
223
224#Topic Glyph
Cary Clarkce101242017-09-01 15:51:02 -0400225#Alias Glyphs
Cary Clark8032b982017-07-28 11:04:54 -0400226##
227
Cary Clarkbad5ad72017-08-03 17:14:08 -0400228#Topic GPU_Context
229#Substitute GPU context
230##
231
232#Topic GPU_Surface
233#Substitute GPU surface
234##
235
Cary Clarkce101242017-09-01 15:51:02 -0400236#Topic HTML_Canvas
237 #Substitute HTML Canvas
238 #Subtopic ArcTo
239 #Substitute HTML Canvas arcTo
240 ##
241##
242
Cary Clark8032b982017-07-28 11:04:54 -0400243#Topic Image
244 #Subtopic Alpha_Type
245 #Enum SkAlphaType
246 #Const kPremul_SkAlphaType 2
247 ##
248 ##
249 #Subtopic ##
250 #Subtopic Color_Type
251 #Enum SkColorType
252 #Const kUnknown_SkColorType 0
253 ##
254 #Const kAlpha_8_SkColorType 1
255 ##
256 #Const kRGB_565_SkColorType 2
257 ##
258 #Const kARGB_4444_SkColorType 3
259 ##
260 #Const kRGBA_8888_SkColorType 4
261 ##
262 #Const kBGRA_8888_SkColorType 5
263 ##
264 #Const kIndex_8_SkColorType 6
265 ##
266 #Const kGray_8_SkColorType 7
267 ##
268 #Const kRGBA_F16_SkColorType 8
269 ##
270 #ToDo this is a lie; need to not require values for consts ##
271 #Const kN32_SkColorType 4
272 ##
273 #Enum ##
274 #Subtopic ##
275 #Subtopic Info
276 #Struct SkImageInfo
277 #Method SkImageInfo()
278 ##
279 ##
280 #Subtopic ##
281 #Class SkImage
282 #Method sk_sp<SkShader> makeShader(SkShader::TileMode, SkShader::TileMode,
283 const SkMatrix* localMatrix = nullptr) const
284 ##
285 ##
286#Topic ##
287
288#Topic Image_Filter
289#Subtopic Scaling
290#Subtopic ##
291#Class SkImageFilter
292#Class ##
293#Topic ##
294
295#Topic Image_Scaling
296##
297
298#Topic IRect
299#Struct SkIRect
300##
301##
302
Cary Clarkce101242017-09-01 15:51:02 -0400303#Topic Left_Side_Bearing
304##
305
Cary Clark8032b982017-07-28 11:04:54 -0400306#Topic Line
Cary Clark8032b982017-07-28 11:04:54 -0400307#Alias Lines
308#Topic ##
309
310#Topic Mask
311#Topic ##
312
313#Topic Mask_Alpha
314#Topic ##
315
316#Topic Mask_Filter
317#Class SkMaskFilter
318#Class ##
319#Topic ##
320
321#Topic Matrix
322#Struct SkMatrix
323#Struct ##
324#Topic ##
325
326#Topic Nine_Patch
327##
328
329#Topic Number_Types
330 #Typedef SkGlyphID
331 #Typedef ##
332 #Typedef SkScalar
333 #Typedef ##
334 #Const SK_ScalarMax
335 to be written
336 ##
337 #Const SK_ScalarInfinity
338 to be written
339 ##
340 #Const SK_ScalarNegativeInfinity
341 to be written
342 ##
343 #Const SK_ScalarNaN
344 to be written
345 ##
346 #Typedef SkUnichar
347 #Typedef ##
348 #Typedef U8CPU
349 #Typedef ##
350#Topic ##
351
Cary Clarkce101242017-09-01 15:51:02 -0400352#Topic OS_X
353#Substitute OS X
354##
355
Cary Clark8032b982017-07-28 11:04:54 -0400356#Topic Oval
Cary Clarkce101242017-09-01 15:51:02 -0400357#Alias Ovals
Cary Clark8032b982017-07-28 11:04:54 -0400358#Topic ##
359
360#Topic Paint_Defaults
361#Const SkPaintDefaults_Flags 0
362##
363#Const SkPaintDefaults_Hinting 2
364##
365#Const SkPaintDefaults_TextSize 12
366##
367#Const SkPaintDefaults_MiterLimit 4
368##
369#Topic ##
370
371#Topic Patch
Cary Clarkce101242017-09-01 15:51:02 -0400372#Alias Patches
Cary Clark8032b982017-07-28 11:04:54 -0400373#Topic ##
374
375#Topic Path_Effect
376 #Class SkPathEffect
377 #Class ##
378#Topic ##
379
380#Topic Path_Measure
381 #Class SkPathMeasure
382 #Method void dump() const
383 ##
384 ##
385##
386
387#Topic PathOps
388 #Method bool SK_API Op(const SkPath& one, const SkPath& two, SkPathOp op, SkPath* result)
389 ##
390#Topic ##
391
392#Topic Picture
393#Subtopic Recorder
394 #Class SkPictureRecorder
395 #Method SkCanvas* beginRecording(const SkRect& bounds,
396 SkBBHFactory* bbhFactory = NULL,
397 uint32_t recordFlags = 0)
398 ##
399 ##
400##
401##
402
403#Topic Pixel
404#Subtopic Storage
405##
406##
407
Cary Clarkbad5ad72017-08-03 17:14:08 -0400408#Enum SkPixelGeometry
409##
410
Cary Clark8032b982017-07-28 11:04:54 -0400411#Topic Pixmap
412#Class SkPixmap
413##
414##
415
416#Topic Point
417#Alias Points
418 #Struct SkPoint
419 #Method bool equalsWithinTolerance(const SkPoint& p) const
420 ##
421 #Struct ##
422 #Subtopic Array
423 #Substitute SkPoint arrays
424 #Subtopic ##
425#Topic ##
426
Cary Clarkce101242017-09-01 15:51:02 -0400427#Topic PostScript
428#Substitute PostScript
429#Subtopic Arct
430#Substitute PostScript arct
431##
432##
433
434#Topic Premultiply
435#Alias Premultiplied
436##
437
438#Topic Raster_Engine
439##
440
Cary Clark8032b982017-07-28 11:04:54 -0400441#Topic Raster_Handle_Allocator
442#Class SkRasterHandleAllocator
443 #Struct Rec
444 ##
445 #Method static std::unique_ptr<SkCanvas> MakeCanvas(std::unique_ptr<SkRasterHandleAllocator>, const SkImageInfo&, const Rec* rec = nullptr)
446 ##
447##
448##
449
Cary Clarkbad5ad72017-08-03 17:14:08 -0400450#Topic Raster_Surface
451##
452
Cary Clark8032b982017-07-28 11:04:54 -0400453#Topic Rasterizer
454#Class SkRasterizer
455#Class ##
456#Subtopic Layer
457#Subtopic ##
458#Topic ##
459
460#Topic Rect
461#Alias Rects
462 #Struct SkRect
463 #Method static constexpr SkRect SK_WARN_UNUSED_RESULT MakeEmpty()
464 ##
465 #Method void dump() const
466 ##
467 #Method void dumpHex() const
468 ##
469 #Struct ##
470#Topic ##
471
472#Topic Reference_Count
473#Substitute SkRefCnt
474#Class sk_sp
475#Class ##
476#Topic ##
477
478#Topic Region
479#Class SkRegion
480##
481#Topic ##
482
Cary Clarkce101242017-09-01 15:51:02 -0400483#Topic Right_Side_Bearing
484##
485
Cary Clark8032b982017-07-28 11:04:54 -0400486#Topic Round_Rect
487 #Class SkRRect
488 #Method void dump() const
489 ##
490 #Method void dumpHex() const
491 ##
492 ##
493#Topic ##
494
495#Topic RSXform
496#Struct SkRSXform
497##
498##
499
500#Topic Shader
501#Class SkShader
502 #Enum TileMode
503 #Const kClamp_TileMode 0
504 ##
505 ##
506 #Method static sk_sp<SkShader> MakeBitmapShader(const SkBitmap& src, TileMode tmx, TileMode tmy,
507 const SkMatrix* localMatrix = nullptr)
508 ##
509#Class ##
510#Subtopic Gradient
511#Subtopic ##
512#Topic ##
513
514#Topic Sprite
Cary Clarkce101242017-09-01 15:51:02 -0400515#Alias Sprites
Cary Clark8032b982017-07-28 11:04:54 -0400516#Topic ##
517
518#Topic Stream
519#Class SkFlattenable
520#Class ##
521#Topic ##
522
523#Topic String
524#Class SkString
525#Class ##
526#Topic ##
527
Cary Clarkce101242017-09-01 15:51:02 -0400528#Topic Supersampling
529##
530
Cary Clark8032b982017-07-28 11:04:54 -0400531#Topic Surface
532#Class SkSurface
533 #Method static sk_sp<SkSurface> MakeRasterDirect(const SkImageInfo&, void* pixels, size_t rowBytes,
534 const SkSurfaceProps* = nullptr)
535 ##
536##
537#Subtopic Properties
538 #Class SkSurfaceProps
Cary Clarkbad5ad72017-08-03 17:14:08 -0400539 #Topic Legacy_Font_Host
Cary Clark8032b982017-07-28 11:04:54 -0400540 #Enum InitType
541 #Const kLegacyFontHost_InitType 0
542 ##
543 ##
Cary Clarkbad5ad72017-08-03 17:14:08 -0400544 #Topic ##
Cary Clark8032b982017-07-28 11:04:54 -0400545 ##
546##
Cary Clark8032b982017-07-28 11:04:54 -0400547##
548
549#Topic SVG
550#Subtopic Canvas
551##
552#Subtopic Arc
553##
554##
555
556#Topic Text
557#Topic ##
558
559#Topic Text_Blob
560#Class SkTextBlob
561#Class ##
562#Topic ##
563
564#Topic Typeface
565#Class SkTypeface
566#Class ##
567#Topic ##
568
Cary Clarkce101242017-09-01 15:51:02 -0400569#Topic Unpremultiply
570#Alias Unpremultiplied
571##
572
Cary Clark8032b982017-07-28 11:04:54 -0400573#Topic Vector
574#Struct SkVector
575##
576##
577
578#Topic Vertices
Cary Clark8032b982017-07-28 11:04:54 -0400579#Subtopic Colors
580##
581#Subtopic Texs
582##
583#Topic ##
584
585#Topic Read_Buffer
586 #Struct SkReadBuffer
587 #Struct ##
588##
589
590#Topic Write_Buffer
591 #Struct SkWriteBuffer
592 #Struct ##
593#Topic ##