undocumented.bmh revision d0530ba8f406ef287ce89a995ce7be4b32ab6e85
1# external references that will be documented eventually ... 2#External 3 DirectWrite TrueType Windows Linux Android iOS 4 FreeType FreeType-based Harfbuzz 5 Descenders Kerning Unhinted 6 LCD RGB 7 Unicode Unicode5 UTF-8 UTF-16 UTF-32 ASCII Unichar 8 API 9 CPU 10 GPU GPU-backed OpenGL Vulkan 11 RFC 12 Bezier Coons Cartesian 13 C C++ Destructor Subclasses 14 SaveLayerFlags # not external; need to add typedef support 15 SkUserConfig # not external, but still thinking about how markup refers to this 16 SkXXX.h # ditto 17 SkXXX_Reference # ditto 18 Skia # ditto 19 SK_DEBUG # ditto 20 SK_RELEASE # ditto 21 SK_USE_FREETYPE_EMBOLDEN # ditto 22 SK_SUPPORT_LEGACY_PAINT_TEXTDECORATION # ditto 23 SK_BUILD_FOR_ANDROID_FRAMEWORK # ditto 24 SK_IGNORE_TO_STRING # 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 Alias 37#Alias Aliased 38#Alias Aliasing 39## 40 41#Topic Anti-alias 42#Alias Anti-aliased 43#Alias Anti-aliasing 44## 45 46#Topic Arc 47#Alias Arcs 48#Topic ## 49 50#Topic BBH_Factory 51#Class SkBBHFactory 52## 53## 54 55#Topic Bitmap 56#Class SkBitmap 57 #Subtopic Row_Bytes 58 ## 59 #Method void erase(SkColor c, const SkIRect& area) const 60 ## 61 #Method bool installPixels(const SkImageInfo& info, void* pixels, size_t rowBytes) 62 ## 63 #Method bool readPixels(const SkImageInfo& dstInfo, void* dstPixels, size_t dstRowBytes, 64 int srcX, int srcY, SkTransferFunctionBehavior behavior) const 65 ## 66#Class ## 67## 68 69#Topic Blend_Mode 70#EnumClass SkBlendMode 71 #Const kSrc 1 72 ## 73 #Const kSrcOver 3 74 ## 75 #Const kPlus 12 76 ## 77#EnumClass ## 78#Topic ## 79 80#Topic Circle 81#Alias Circles 82#Topic ## 83 84#Topic Clip_Op 85#EnumClass SkClipOp 86 #Const kDifference 0 87 ## 88 #Const kIntersect 1 89 ## 90## 91## 92 93#Topic Color 94 #Typedef SkColor 95 #Typedef ## 96 97 # fixme: defines, not methods, need new markup type 98 #Method int SkColorGetA(color) 99 ## 100 #Method int SkColorGetR(color) 101 ## 102 #Method int SkColorGetG(color) 103 ## 104 #Method int SkColorGetB(color) 105 ## 106 #Method int SkColorSetARGB(a, r, g, b) 107 ## 108 109 #Const SK_ColorBLACK 0xFF000000 110 ## 111 #Const SK_ColorBLUE 0xFF0000FF 112 ## 113 #Const SK_ColorGREEN 0xFF00FF00 114 ## 115 #Const SK_ColorRED 0xFFFF0000 116 ## 117 #Const SK_ColorWHITE 0xFFFFFFFF 118 ## 119 #Subtopic Alpha 120 #Alias Alpha 121 #Subtopic ## 122 #Subtopic RGB 123 #Substitute RGB 124 #Subtopic Red 125 #Alias Red 126 #Subtopic ## 127 #Subtopic Blue 128 #Alias Blue 129 #Subtopic ## 130 #Subtopic Green 131 #Alias Green 132 #Subtopic ## 133 #Subtopic ## 134 #Subtopic ARGB 135 #Substitute ARGB 136 #Subtopic ## 137 138 #Subtopic RBG 139 #Substitute RBG 140 #Subtopic ## 141 142 #Subtopic RGB-565 143 #Substitute RGB-565 144 #Alias Color_RGB-565 # quit changing - to _ ! 145 #Subtopic ## 146#Topic ## 147 148#Topic Color_Filter 149#Class SkColorFilter 150#Class ## 151#Topic ## 152 153#Topic Color_Space 154#Class SkColorSpace 155 #Method static sk_sp<SkColorSpace> MakeSRGBLinear() 156 ## 157## 158#EnumClass SkTransferFunctionBehavior 159#Const kRespect 0 160## 161#Const kIgnore 1 162## 163#EnumClass ## 164## 165 166#Topic Core_Graphics 167#Substitute Core Graphics 168## 169 170#Topic Core_Text 171#Substitute Core Text 172## 173 174#Topic Curve 175#Alias Curves 176## 177 178#Topic Data 179## 180 181#Topic Device 182#Class SkBaseDevice 183## 184#Topic ## 185 186#Topic Document 187#Class SkDocument 188 #Method SkCanvas* beginPage(SkScalar width, SkScalar height, 189 const SkRect* content = NULL) 190 ## 191## 192#Subtopic PDF 193## 194## 195 196#Topic Draw_Filter 197#Class SkDrawFilter 198## 199## 200 201#Topic Draw_Layer 202## 203 204#Topic Draw_Looper 205#Class SkDrawLooper 206#Class ## 207#Topic ## 208 209#Topic Drawable 210#Class SkDrawable 211 #Method void draw(SkCanvas*, const SkMatrix* = NULL) 212 ## 213## 214## 215 216#Topic Dump_Canvas 217#Class SkDumpCanvas 218## 219#Topic ## 220 221#Topic Filter_Quality 222#Enum SkFilterQuality 223 #Const kNone_SkFilterQuality 0 224 ## 225 #Const kLow_SkFilterQuality 1 226 ## 227 #Const kMedium_SkFilterQuality 2 228 ## 229 #Const kHigh_SkFilterQuality 3 230 ## 231#Enum ## 232#Subtopic Nearest_Neighbor 233#Substitute nearest neighbor filter 234## 235#Subtopic Bilerp 236#Substitute bilerp filter 237## 238#Subtopic MipMap 239#Substitute mip-map filter 240## 241#Subtopic BiCubic 242#Substitute bicubic filter 243## 244#Topic ## 245 246#Topic Font 247#Subtopic Advance 248#Subtopic ## 249#Subtopic Engine 250## 251#Topic ## 252 253#Topic Font_Manager 254#Topic ## 255 256#Topic Glyph 257#Alias Glyphs 258## 259 260#Topic GPU_Context 261#Substitute GPU context 262## 263 264#Topic GPU_Surface 265#Substitute GPU surface 266## 267 268#Topic HTML_Canvas 269 #Substitute HTML Canvas 270 #Subtopic ArcTo 271 #Substitute HTML Canvas arcTo 272 ## 273## 274 275#Topic Image 276 #Subtopic Alpha_Type 277 #Alias Alpha_Type 278 #Enum SkAlphaType 279 #Const kUnknown_SkAlphaType 0 280 ## 281 #Const kOpaque_SkAlphaType 1 282 ## 283 #Const kPremul_SkAlphaType 2 284 ## 285 #Const kUnpremul_SkAlphaType 3 286 ## 287 ## 288 #Subtopic ## 289 #Subtopic Color_Type 290 #Alias Color_Type 291 #Alias Color_Types 292 #Enum SkColorType 293 #Const kUnknown_SkColorType 0 294 ## 295 #Const kAlpha_8_SkColorType 1 296 ## 297 #Const kRGB_565_SkColorType 2 298 ## 299 #Const kARGB_4444_SkColorType 3 300 ## 301 #Const kRGBA_8888_SkColorType 4 302 ## 303 #Const kBGRA_8888_SkColorType 5 304 ## 305 #Const kIndex_8_SkColorType 6 306 ## 307 #Const kGray_8_SkColorType 7 308 ## 309 #Const kRGBA_F16_SkColorType 8 310 ## 311 #ToDo this is a lie; need to not require values for consts ## 312 #Const kN32_SkColorType 4 313 ## 314 #Enum ## 315 #Subtopic ## 316 #Subtopic Info 317 #Struct SkImageInfo 318 #Method SkImageInfo() 319 ## 320 #Method SkImageInfo makeColorSpace(sk_sp<SkColorSpace> cs) const 321 ## 322 #Method size_t minRowBytes() const 323 ## 324 #Method bool isOpaque() const 325 ## 326 #Method int bytesPerPixel() const 327 ## 328 ## 329 #Subtopic ## 330 #Class SkImage 331 #Method sk_sp<SkShader> makeShader(SkShader::TileMode, SkShader::TileMode, 332 const SkMatrix* localMatrix = nullptr) const 333 ## 334 #Method static sk_sp<SkImage> MakeRasterCopy(const SkPixmap&) 335 ## 336 #Method bool readPixels(const SkPixmap& dst, int srcX, int srcY, 337 CachingHint = kAllow_CachingHint) const 338 ## 339 #Method bool scalePixels(const SkPixmap& dst, SkFilterQuality, CachingHint = kAllow_CachingHint) const 340 ## 341 ## 342#Topic ## 343 344#Topic Image_Filter 345#Subtopic Scaling 346#Subtopic ## 347#Class SkImageFilter 348#Class ## 349#Topic ## 350 351#Topic Image_Scaling 352## 353 354#Topic IRect 355#Struct SkIRect 356 #Method bool intersect(const SkIRect& r) 357 ## 358## 359## 360 361#Topic Left_Side_Bearing 362## 363 364#Topic Line 365#Alias Lines 366#Topic ## 367 368#Topic Mask 369#Class SkMask 370 #Enum Format 371 #Const kBW_Format 0 372 ## 373 #Const kA8_Format 1 374 ## 375 #Const k3D_Format 2 376 ## 377 #Const kARGB32_Format 3 378 ## 379 k#Const LCD16_Format 4 380 ## 381 ## 382## 383#Topic ## 384 385#Topic Mask_Alpha 386#Topic ## 387 388#Topic Mask_Filter 389#Class SkMaskFilter 390#Class ## 391#Topic ## 392 393#Topic Math 394 #Method static inline bool sk_64_isS32(int64_t value) 395 ## 396## 397 398#Topic Matrix 399#Struct SkMatrix 400#Struct ## 401#Topic ## 402 403#Topic Nine_Patch 404## 405 406#Topic Number_Types 407 #Typedef SkGlyphID 408 #Typedef ## 409 #Typedef SkScalar 410 #Typedef ## 411 #Const SK_ScalarMax 412 to be written 413 ## 414 #Const SK_ScalarInfinity 415 to be written 416 ## 417 #Const SK_ScalarNegativeInfinity 418 to be written 419 ## 420 #Const SK_ScalarNaN 421 to be written 422 ## 423 #Typedef SkUnichar 424 #Typedef ## 425 #Typedef U8CPU 426 #Typedef ## 427#Topic ## 428 429#Topic OS_X 430#Substitute OS X 431## 432 433#Topic Oval 434#Alias Ovals 435#Topic ## 436 437#Topic Paint_Defaults 438#Const SkPaintDefaults_Flags 0 439## 440#Const SkPaintDefaults_Hinting 2 441## 442#Const SkPaintDefaults_TextSize 12 443## 444#Const SkPaintDefaults_MiterLimit 4 445## 446#Topic ## 447 448#Topic Patch 449#Alias Patches 450#Topic ## 451 452#Topic Path_Effect 453 #Class SkPathEffect 454 #Class ## 455#Topic ## 456 457#Topic Path_Measure 458 #Class SkPathMeasure 459 #Method void dump() const 460 ## 461 ## 462## 463 464#Topic PathOps 465 #Method bool SK_API Op(const SkPath& one, const SkPath& two, SkPathOp op, SkPath* result) 466 ## 467#Topic ## 468 469#Topic Picture 470#Subtopic Recorder 471 #Class SkPictureRecorder 472 #Method SkCanvas* beginRecording(const SkRect& bounds, 473 SkBBHFactory* bbhFactory = NULL, 474 uint32_t recordFlags = 0) 475 ## 476 ## 477## 478## 479 480#Topic Pixel 481#Subtopic Storage 482## 483## 484 485#Topic PixelRef 486#Class SkPixelRef 487## 488## 489 490#Enum SkPixelGeometry 491## 492 493#Topic Point 494#Alias Points 495 #Struct SkPoint 496 #Method bool equalsWithinTolerance(const SkPoint& p) const 497 ## 498 #Struct ## 499 #Subtopic Array 500 #Substitute SkPoint arrays 501 #Subtopic ## 502#Topic ## 503 504#Topic PostScript 505#Substitute PostScript 506#Subtopic Arct 507#Substitute PostScript arct 508## 509## 510 511#Topic Premultiply 512#Alias Premultiplied 513## 514 515#Topic Raster_Engine 516## 517 518#Topic Raster_Handle_Allocator 519#Class SkRasterHandleAllocator 520 #Struct Rec 521 ## 522 #Method static std::unique_ptr<SkCanvas> MakeCanvas(std::unique_ptr<SkRasterHandleAllocator>, const SkImageInfo&, const Rec* rec = nullptr) 523 ## 524## 525## 526 527#Topic Raster_Surface 528## 529 530#Topic Rasterizer 531#Class SkRasterizer 532#Class ## 533#Subtopic Layer 534#Subtopic ## 535#Topic ## 536 537#Topic Rect 538#Alias Rects 539 #Struct SkRect 540 #Method static constexpr SkRect SK_WARN_UNUSED_RESULT MakeEmpty() 541 ## 542 #Method void dump() const 543 ## 544 #Method void dumpHex() const 545 ## 546 #Struct ## 547#Topic ## 548 549#Topic Reference_Count 550#Substitute SkRefCnt 551#Class sk_sp 552#Class ## 553#Topic ## 554 555#Topic Region 556#Class SkRegion 557## 558#Topic ## 559 560#Topic Right_Side_Bearing 561## 562 563#Topic Round_Rect 564 #Class SkRRect 565 #Method void dump() const 566 ## 567 #Method void dumpHex() const 568 ## 569 ## 570#Topic ## 571 572#Topic RSXform 573#Struct SkRSXform 574## 575## 576 577#Topic Shader 578#Class SkShader 579 #Enum TileMode 580 #Const kClamp_TileMode 0 581 ## 582 ## 583 #Method static sk_sp<SkShader> MakeBitmapShader(const SkBitmap& src, TileMode tmx, TileMode tmy, 584 const SkMatrix* localMatrix = nullptr) 585 ## 586#Class ## 587#Subtopic Gradient 588#Subtopic ## 589#Topic ## 590 591#Topic Sprite 592#Alias Sprites 593#Topic ## 594 595#Topic Stream 596#Class SkFlattenable 597#Class ## 598#Topic ## 599 600#Topic String 601#Class SkString 602#Class ## 603#Topic ## 604 605#Topic Supersampling 606## 607 608#Topic Surface 609#Class SkSurface 610 #Method static sk_sp<SkSurface> MakeRasterDirect(const SkImageInfo&, void* pixels, size_t rowBytes, 611 const SkSurfaceProps* = nullptr) 612 ## 613 #Method bool readPixels(const SkPixmap& dst, int srcX, int srcY); 614 ## 615## 616#Subtopic Properties 617 #Class SkSurfaceProps 618 #Topic Legacy_Font_Host 619 #Enum InitType 620 #Const kLegacyFontHost_InitType 0 621 ## 622 ## 623 #Topic ## 624 ## 625## 626## 627 628#Topic SVG 629#Subtopic Canvas 630## 631#Subtopic Arc 632## 633## 634 635#Topic Text 636#Topic ## 637 638#Topic Text_Blob 639#Class SkTextBlob 640#Class ## 641#Topic ## 642 643#Topic Typeface 644#Class SkTypeface 645#Class ## 646#Topic ## 647 648#Topic Unpremultiply 649#Alias Unpremultiplied 650## 651 652#Topic Vector 653#Struct SkVector 654## 655## 656 657#Topic Vertices 658#Subtopic Colors 659## 660#Subtopic Texs 661## 662#Topic ## 663 664#Topic Read_Buffer 665 #Struct SkReadBuffer 666 #Struct ## 667## 668 669#Topic Write_Buffer 670 #Struct SkWriteBuffer 671 #Struct ## 672#Topic ## 673