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