blob: d66bcf87af272d9e9db49214151560e7820fbd24 [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 Clarkbc5697d2017-10-04 14:31:33 -040011 PDF XPS
Cary Clark8032b982017-07-28 11:04:54 -040012 RFC
Cary Clarkbc5697d2017-10-04 14:31:33 -040013 NaN NaNs
Cary Clark73fa9722017-08-29 17:36:51 -040014 Bezier Coons Cartesian
Cary Clarkce101242017-09-01 15:51:02 -040015 C C++ Destructor Subclasses
Cary Clarkbad5ad72017-08-03 17:14:08 -040016 SaveLayerFlags # not external; need to add typedef support
Cary Clarkce101242017-09-01 15:51:02 -040017 SkUserConfig # not external, but still thinking about how markup refers to this
Cary Clarkbad5ad72017-08-03 17:14:08 -040018 SkXXX.h # ditto
Cary Clarkd0530ba2017-09-14 11:25:39 -040019 SkXXX_Reference # ditto
Cary Clark8032b982017-07-28 11:04:54 -040020 Skia # ditto
Cary Clarkbc5697d2017-10-04 14:31:33 -040021 SK_ABORT # ditto
22 SK_API # ditto
Cary Clarkd0530ba2017-09-14 11:25:39 -040023 SK_DEBUG # ditto
24 SK_RELEASE # ditto
Cary Clark8032b982017-07-28 11:04:54 -040025 SK_USE_FREETYPE_EMBOLDEN # ditto
26 SK_SUPPORT_LEGACY_PAINT_TEXTDECORATION # ditto
27 SK_BUILD_FOR_ANDROID_FRAMEWORK # ditto
Cary Clarkce101242017-09-01 15:51:02 -040028 SK_IGNORE_TO_STRING # ditto
Cary Clark8032b982017-07-28 11:04:54 -040029
30# FreeType related
31FT_LOAD_TARGET_LIGHT
32FT_LOAD_TARGET_NORMAL
33FT_LOAD_TARGET_LCD
34FT_LOAD_TARGET_LCD_V
35FT_LOAD_NO_HINTING
36FT_Load_Glyph
37
38#External ##
39
Cary Clarkce101242017-09-01 15:51:02 -040040#Topic Alias
41#Alias Aliased
42#Alias Aliasing
43##
44
45#Topic Anti-alias
46#Alias Anti-aliased
47#Alias Anti-aliasing
48##
49
Cary Clark8032b982017-07-28 11:04:54 -040050#Topic Arc
Cary Clarkce101242017-09-01 15:51:02 -040051#Alias Arcs
Cary Clark8032b982017-07-28 11:04:54 -040052#Topic ##
53
54#Topic BBH_Factory
55#Class SkBBHFactory
56##
57##
58
Cary Clark8032b982017-07-28 11:04:54 -040059#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
Cary Clarkd0530ba2017-09-14 11:25:39 -0400144#Class SkColorSpace
145 #Method static sk_sp<SkColorSpace> MakeSRGBLinear()
146 ##
147##
148#EnumClass SkTransferFunctionBehavior
149#Const kRespect 0
150##
151#Const kIgnore 1
152##
153#EnumClass ##
Cary Clark8032b982017-07-28 11:04:54 -0400154##
155
Cary Clarkce101242017-09-01 15:51:02 -0400156#Topic Core_Graphics
157#Substitute Core Graphics
158##
159
160#Topic Core_Text
161#Substitute Core Text
162##
163
Cary Clark8032b982017-07-28 11:04:54 -0400164#Topic Curve
165#Alias Curves
166##
167
168#Topic Data
169##
170
171#Topic Device
172#Class SkBaseDevice
173##
174#Topic ##
175
176#Topic Document
177#Class SkDocument
178 #Method SkCanvas* beginPage(SkScalar width, SkScalar height,
179 const SkRect* content = NULL)
180 ##
181##
182#Subtopic PDF
183##
184##
185
186#Topic Draw_Filter
187#Class SkDrawFilter
188##
189##
190
Cary Clarkce101242017-09-01 15:51:02 -0400191#Topic Draw_Layer
192##
193
Cary Clark8032b982017-07-28 11:04:54 -0400194#Topic Draw_Looper
195#Class SkDrawLooper
196#Class ##
197#Topic ##
198
199#Topic Drawable
200#Class SkDrawable
201 #Method void draw(SkCanvas*, const SkMatrix* = NULL)
202 ##
203##
204##
205
206#Topic Dump_Canvas
207#Class SkDumpCanvas
208##
209#Topic ##
210
211#Topic Filter_Quality
212#Enum SkFilterQuality
213 #Const kNone_SkFilterQuality 0
214 ##
215 #Const kLow_SkFilterQuality 1
216 ##
217 #Const kMedium_SkFilterQuality 2
218 ##
219 #Const kHigh_SkFilterQuality 3
220 ##
221#Enum ##
Cary Clarkd0530ba2017-09-14 11:25:39 -0400222#Subtopic Nearest_Neighbor
223#Substitute nearest neighbor filter
224##
225#Subtopic Bilerp
226#Substitute bilerp filter
227##
228#Subtopic MipMap
229#Substitute mip-map filter
230##
231#Subtopic BiCubic
232#Substitute bicubic filter
233##
Cary Clark8032b982017-07-28 11:04:54 -0400234#Topic ##
235
236#Topic Font
237#Subtopic Advance
238#Subtopic ##
239#Subtopic Engine
240##
241#Topic ##
242
243#Topic Font_Manager
244#Topic ##
245
246#Topic Glyph
Cary Clarkce101242017-09-01 15:51:02 -0400247#Alias Glyphs
Cary Clark8032b982017-07-28 11:04:54 -0400248##
249
Cary Clarkbad5ad72017-08-03 17:14:08 -0400250#Topic GPU_Context
251#Substitute GPU context
252##
253
254#Topic GPU_Surface
255#Substitute GPU surface
256##
257
Cary Clarkce101242017-09-01 15:51:02 -0400258#Topic HTML_Canvas
259 #Substitute HTML Canvas
260 #Subtopic ArcTo
261 #Substitute HTML Canvas arcTo
262 ##
263##
264
Cary Clark8032b982017-07-28 11:04:54 -0400265#Topic Image
266 #Subtopic Alpha_Type
Cary Clarkd0530ba2017-09-14 11:25:39 -0400267 #Alias Alpha_Type
Cary Clark8032b982017-07-28 11:04:54 -0400268 #Enum SkAlphaType
Cary Clarkd0530ba2017-09-14 11:25:39 -0400269 #Const kUnknown_SkAlphaType 0
270 ##
271 #Const kOpaque_SkAlphaType 1
272 ##
Cary Clark8032b982017-07-28 11:04:54 -0400273 #Const kPremul_SkAlphaType 2
274 ##
Cary Clarkd0530ba2017-09-14 11:25:39 -0400275 #Const kUnpremul_SkAlphaType 3
276 ##
Cary Clark8032b982017-07-28 11:04:54 -0400277 ##
278 #Subtopic ##
Cary Clarkd0530ba2017-09-14 11:25:39 -0400279 #Subtopic Color_Type
280 #Alias Color_Type
281 #Alias Color_Types
Cary Clark8032b982017-07-28 11:04:54 -0400282 #Enum SkColorType
283 #Const kUnknown_SkColorType 0
284 ##
285 #Const kAlpha_8_SkColorType 1
286 ##
287 #Const kRGB_565_SkColorType 2
288 ##
289 #Const kARGB_4444_SkColorType 3
290 ##
291 #Const kRGBA_8888_SkColorType 4
292 ##
293 #Const kBGRA_8888_SkColorType 5
294 ##
295 #Const kIndex_8_SkColorType 6
296 ##
297 #Const kGray_8_SkColorType 7
298 ##
299 #Const kRGBA_F16_SkColorType 8
300 ##
301 #ToDo this is a lie; need to not require values for consts ##
302 #Const kN32_SkColorType 4
303 ##
304 #Enum ##
305 #Subtopic ##
306 #Subtopic Info
307 #Struct SkImageInfo
308 #Method SkImageInfo()
309 ##
Cary Clarkd0530ba2017-09-14 11:25:39 -0400310 #Method SkImageInfo makeColorSpace(sk_sp<SkColorSpace> cs) const
311 ##
312 #Method size_t minRowBytes() const
313 ##
314 #Method bool isOpaque() const
315 ##
316 #Method int bytesPerPixel() const
317 ##
Cary Clarkbc5697d2017-10-04 14:31:33 -0400318 #Method int height() const
319 ##
320 #Method int width() const
321 ##
322 #Method SkColorType colorType() const
323 ##
324 #Method SkAlphaType alphaType() const
325 ##
326 #Method SkColorSpace* colorSpace() const
327 ##
328 #Method bool isOpaque() const
329 ##
330 #Method size_t minRowBytes() const
331 ##
332 #Method size_t computeByteSize(size_t rowBytes) const
333 ##
Cary Clark8032b982017-07-28 11:04:54 -0400334 ##
335 #Subtopic ##
336 #Class SkImage
337 #Method sk_sp<SkShader> makeShader(SkShader::TileMode, SkShader::TileMode,
338 const SkMatrix* localMatrix = nullptr) const
339 ##
Cary Clarkd0530ba2017-09-14 11:25:39 -0400340 #Method static sk_sp<SkImage> MakeRasterCopy(const SkPixmap&)
341 ##
342 #Method bool readPixels(const SkPixmap& dst, int srcX, int srcY,
343 CachingHint = kAllow_CachingHint) const
344 ##
345 #Method bool scalePixels(const SkPixmap& dst, SkFilterQuality, CachingHint = kAllow_CachingHint) const
346 ##
Cary Clark8032b982017-07-28 11:04:54 -0400347 ##
348#Topic ##
349
350#Topic Image_Filter
351#Subtopic Scaling
352#Subtopic ##
353#Class SkImageFilter
354#Class ##
355#Topic ##
356
357#Topic Image_Scaling
358##
359
Cary Clarkce101242017-09-01 15:51:02 -0400360#Topic Left_Side_Bearing
361##
362
Cary Clark8032b982017-07-28 11:04:54 -0400363#Topic Line
Cary Clark8032b982017-07-28 11:04:54 -0400364#Alias Lines
365#Topic ##
366
Cary Clarkbc5697d2017-10-04 14:31:33 -0400367#Topic Malloc_Pixel_Ref
368#Class SkMallocPixelRef
369 #Method static sk_sp<SkPixelRef> MakeZeroed(const SkImageInfo&, size_t rowBytes)
370 ##
371 #Method static sk_sp<SkPixelRef> MakeAllocate(const SkImageInfo&, size_t rowBytes)
372 ##
373##
374##
375
Cary Clark8032b982017-07-28 11:04:54 -0400376#Topic Mask
Cary Clarkd0530ba2017-09-14 11:25:39 -0400377#Class SkMask
378 #Enum Format
379 #Const kBW_Format 0
380 ##
381 #Const kA8_Format 1
382 ##
383 #Const k3D_Format 2
384 ##
385 #Const kARGB32_Format 3
386 ##
387 k#Const LCD16_Format 4
388 ##
389 ##
390##
Cary Clark8032b982017-07-28 11:04:54 -0400391#Topic ##
392
393#Topic Mask_Alpha
394#Topic ##
395
396#Topic Mask_Filter
397#Class SkMaskFilter
Cary Clarkbc5697d2017-10-04 14:31:33 -0400398#Method virtual bool filterMask(SkMask* dst, const SkMask& src, const SkMatrix&,
399 SkIPoint* margin) const
400##
Cary Clark8032b982017-07-28 11:04:54 -0400401#Class ##
402#Topic ##
403
Cary Clarkd0530ba2017-09-14 11:25:39 -0400404#Topic Math
405 #Method static inline bool sk_64_isS32(int64_t value)
406 ##
Cary Clarkbc5697d2017-10-04 14:31:33 -0400407 #Method SkIntToScalar(x)
408 ##
409 #Method SkScalarRoundToInt(x)
410 ##
411 #Method SkScalarFloorToInt(x)
412 ##
413 #Method SkScalarCeilToInt(x)
414 ##
415 #Method SkScalarFloorToScalar(x)
416 ##
417 #Method SkScalarCeilToScalar(x)
418 ##
Cary Clarkd0530ba2017-09-14 11:25:39 -0400419##
420
Cary Clarkbc5697d2017-10-04 14:31:33 -0400421#Topic Mip_Map
422##
Cary Clark8032b982017-07-28 11:04:54 -0400423
424#Topic Nine_Patch
425##
426
427#Topic Number_Types
428 #Typedef SkGlyphID
429 #Typedef ##
430 #Typedef SkScalar
431 #Typedef ##
432 #Const SK_ScalarMax
433 to be written
434 ##
435 #Const SK_ScalarInfinity
436 to be written
437 ##
438 #Const SK_ScalarNegativeInfinity
439 to be written
440 ##
441 #Const SK_ScalarNaN
442 to be written
443 ##
444 #Typedef SkUnichar
445 #Typedef ##
446 #Typedef U8CPU
447 #Typedef ##
448#Topic ##
449
Cary Clarkce101242017-09-01 15:51:02 -0400450#Topic OS_X
451#Substitute OS X
452##
453
Cary Clark8032b982017-07-28 11:04:54 -0400454#Topic Oval
Cary Clarkce101242017-09-01 15:51:02 -0400455#Alias Ovals
Cary Clark8032b982017-07-28 11:04:54 -0400456#Topic ##
457
458#Topic Paint_Defaults
459#Const SkPaintDefaults_Flags 0
460##
461#Const SkPaintDefaults_Hinting 2
462##
463#Const SkPaintDefaults_TextSize 12
464##
465#Const SkPaintDefaults_MiterLimit 4
466##
467#Topic ##
468
469#Topic Patch
Cary Clarkce101242017-09-01 15:51:02 -0400470#Alias Patches
Cary Clark8032b982017-07-28 11:04:54 -0400471#Topic ##
472
473#Topic Path_Effect
474 #Class SkPathEffect
475 #Class ##
476#Topic ##
477
478#Topic Path_Measure
479 #Class SkPathMeasure
480 #Method void dump() const
481 ##
482 ##
483##
484
485#Topic PathOps
486 #Method bool SK_API Op(const SkPath& one, const SkPath& two, SkPathOp op, SkPath* result)
487 ##
488#Topic ##
489
490#Topic Picture
491#Subtopic Recorder
492 #Class SkPictureRecorder
493 #Method SkCanvas* beginRecording(const SkRect& bounds,
494 SkBBHFactory* bbhFactory = NULL,
495 uint32_t recordFlags = 0)
496 ##
497 ##
498##
499##
500
501#Topic Pixel
502#Subtopic Storage
503##
504##
505
Cary Clarkbc5697d2017-10-04 14:31:33 -0400506#Topic Pixel_Ref
Cary Clarkd0530ba2017-09-14 11:25:39 -0400507#Class SkPixelRef
Cary Clarkbc5697d2017-10-04 14:31:33 -0400508 #Method int width() const
509 ##
510 #Method int height() const
511 ##
512 #Method bool isImmutable() const
513 ##
514 #Method void setImmutable()
515 ##
Cary Clarkd0530ba2017-09-14 11:25:39 -0400516##
Cary Clarkbad5ad72017-08-03 17:14:08 -0400517##
518
Cary Clarkd0530ba2017-09-14 11:25:39 -0400519#Enum SkPixelGeometry
Cary Clark8032b982017-07-28 11:04:54 -0400520##
521
522#Topic Point
523#Alias Points
524 #Struct SkPoint
525 #Method bool equalsWithinTolerance(const SkPoint& p) const
526 ##
527 #Struct ##
528 #Subtopic Array
529 #Substitute SkPoint arrays
530 #Subtopic ##
531#Topic ##
532
Cary Clarkce101242017-09-01 15:51:02 -0400533#Topic PostScript
534#Substitute PostScript
535#Subtopic Arct
536#Substitute PostScript arct
537##
538##
539
540#Topic Premultiply
541#Alias Premultiplied
542##
543
544#Topic Raster_Engine
545##
546
Cary Clark8032b982017-07-28 11:04:54 -0400547#Topic Raster_Handle_Allocator
548#Class SkRasterHandleAllocator
549 #Struct Rec
550 ##
551 #Method static std::unique_ptr<SkCanvas> MakeCanvas(std::unique_ptr<SkRasterHandleAllocator>, const SkImageInfo&, const Rec* rec = nullptr)
552 ##
553##
554##
555
Cary Clarkbad5ad72017-08-03 17:14:08 -0400556#Topic Raster_Surface
557##
558
Cary Clark8032b982017-07-28 11:04:54 -0400559#Topic Rasterizer
560#Class SkRasterizer
561#Class ##
562#Subtopic Layer
563#Subtopic ##
564#Topic ##
565
Cary Clark8032b982017-07-28 11:04:54 -0400566#Topic Reference_Count
567#Substitute SkRefCnt
Cary Clarkbc5697d2017-10-04 14:31:33 -0400568#Class SkRefCnt
569#Class ##
Cary Clark8032b982017-07-28 11:04:54 -0400570#Class sk_sp
571#Class ##
572#Topic ##
573
574#Topic Region
575#Class SkRegion
576##
577#Topic ##
578
Cary Clarkce101242017-09-01 15:51:02 -0400579#Topic Right_Side_Bearing
580##
581
Cary Clark8032b982017-07-28 11:04:54 -0400582#Topic Round_Rect
583 #Class SkRRect
584 #Method void dump() const
585 ##
586 #Method void dumpHex() const
587 ##
588 ##
589#Topic ##
590
591#Topic RSXform
592#Struct SkRSXform
593##
594##
595
596#Topic Shader
597#Class SkShader
598 #Enum TileMode
599 #Const kClamp_TileMode 0
600 ##
601 ##
602 #Method static sk_sp<SkShader> MakeBitmapShader(const SkBitmap& src, TileMode tmx, TileMode tmy,
603 const SkMatrix* localMatrix = nullptr)
604 ##
605#Class ##
606#Subtopic Gradient
607#Subtopic ##
608#Topic ##
609
Cary Clarkbc5697d2017-10-04 14:31:33 -0400610#Topic Size
611#Alias ISize
612##
613
Cary Clark8032b982017-07-28 11:04:54 -0400614#Topic Sprite
Cary Clarkce101242017-09-01 15:51:02 -0400615#Alias Sprites
Cary Clark8032b982017-07-28 11:04:54 -0400616#Topic ##
617
618#Topic Stream
619#Class SkFlattenable
620#Class ##
621#Topic ##
622
623#Topic String
624#Class SkString
625#Class ##
626#Topic ##
627
Cary Clarkce101242017-09-01 15:51:02 -0400628#Topic Supersampling
629##
630
Cary Clark8032b982017-07-28 11:04:54 -0400631#Topic Surface
632#Class SkSurface
633 #Method static sk_sp<SkSurface> MakeRasterDirect(const SkImageInfo&, void* pixels, size_t rowBytes,
634 const SkSurfaceProps* = nullptr)
635 ##
Cary Clarkd0530ba2017-09-14 11:25:39 -0400636 #Method bool readPixels(const SkPixmap& dst, int srcX, int srcY);
637 ##
Cary Clark8032b982017-07-28 11:04:54 -0400638##
639#Subtopic Properties
640 #Class SkSurfaceProps
Cary Clarkbad5ad72017-08-03 17:14:08 -0400641 #Topic Legacy_Font_Host
Cary Clark8032b982017-07-28 11:04:54 -0400642 #Enum InitType
643 #Const kLegacyFontHost_InitType 0
644 ##
645 ##
Cary Clarkbad5ad72017-08-03 17:14:08 -0400646 #Topic ##
Cary Clark8032b982017-07-28 11:04:54 -0400647 ##
648##
Cary Clark8032b982017-07-28 11:04:54 -0400649##
650
651#Topic SVG
652#Subtopic Canvas
653##
654#Subtopic Arc
655##
656##
657
658#Topic Text
659#Topic ##
660
661#Topic Text_Blob
662#Class SkTextBlob
663#Class ##
664#Topic ##
665
666#Topic Typeface
667#Class SkTypeface
668#Class ##
669#Topic ##
670
Cary Clarkce101242017-09-01 15:51:02 -0400671#Topic Unpremultiply
672#Alias Unpremultiplied
673##
674
Cary Clark8032b982017-07-28 11:04:54 -0400675#Topic Vector
676#Struct SkVector
677##
678##
679
680#Topic Vertices
Cary Clark8032b982017-07-28 11:04:54 -0400681#Subtopic Colors
682##
683#Subtopic Texs
684##
685#Topic ##
686
687#Topic Read_Buffer
688 #Struct SkReadBuffer
689 #Struct ##
690##
691
692#Topic Write_Buffer
693 #Struct SkWriteBuffer
694 #Struct ##
695#Topic ##