undocumented.bmh revision 77295347c229fa4353e09d97961546ce3c9391e5
1# external references that will be documented eventually ... 2#External 3 DirectWrite TrueType Windows Linux Android iOS __ANDROID_API__ AHardwareBuffer 4 FreeType FreeType-based Harfbuzz 5 Descenders Kerning Unhinted 6 LCD RGB sRGB YUV 7 YUV_Component_Y YUV_Component_U YUV_Component_V 8 Unicode Unicode5 UTF-8 UTF-16 UTF-32 ASCII Unichar 9 API 10 BMP GIF HEIF ICO JPEG PNG WBMP WebP 11 CPU Little_Endian Big_Endian 12 GPU GPU-backed OpenGL Vulkan I/O MSAA UV_Mapping Multi_Sample_Anti_Aliasing GPU_Share_Group 13 PDF XPS 14 RFC 15 NaN NaNs 16 Bezier_Curve Coons_Patch Cartesian_Coordinate Euclidean_Distance Euclidean_Space Mip_Map 17 C C++ Destructor Subclasses 18 SkUserConfig # not external, but still thinking about how markup refers to this 19 SkXXX.h # ditto 20 SkXXX_Reference # ditto 21 Skia # ditto 22 SK_ABORT # ditto 23 SK_API # ditto 24 SK_DEBUG # ditto 25 SK_RELEASE # ditto 26 SK_USE_FREETYPE_EMBOLDEN # ditto 27 SK_SUPPORT_LEGACY_PAINT_TEXTDECORATION # ditto 28 SK_BUILD_FOR_ANDROID_FRAMEWORK # ditto 29 SK_BUILD_FOR_MAC # ditto 30 SK_BUILD_FOR_IOS # ditto 31 SK_IGNORE_TO_STRING # ditto 32 SK_SUPPORT_GPU # ditto 33 SK_HAS_JPEG_LIBRARY # ditto 34 SK_HAS_PNG_LIBRARY # ditto 35 SK_HAS_WEBP_LIBRARY # ditto 36 37# FreeType related 38FT_LOAD_TARGET_LIGHT 39FT_LOAD_TARGET_NORMAL 40FT_LOAD_TARGET_LCD 41FT_LOAD_TARGET_LCD_V 42FT_LOAD_NO_HINTING 43FT_Load_Glyph 44 45#External ## 46 47#Topic Alias 48#Alias Aliased 49#Alias Aliasing 50## 51 52#Topic Anti-alias 53#Alias Anti-aliased 54#Alias Anti-aliasing 55## 56 57#Topic Arc 58#Alias Arcs 59#Topic ## 60 61#Topic Backend_Semaphore 62#Class GrBackendSemaphore 63#Alias GrBackendSemaphores 64## 65## 66 67#Topic BBH_Factory 68#Class SkBBHFactory 69## 70## 71 72#Topic Blend_Mode 73#EnumClass SkBlendMode 74 #Const kSrc 1 75 ## 76 #Const kSrcOver 3 77 ## 78 #Const kPlus 12 79 ## 80#EnumClass ## 81#Topic ## 82 83#Topic Circle 84#Alias Circles 85#Topic ## 86 87#Topic Clip_Op 88#EnumClass SkClipOp 89 #Const kDifference 0 90 ## 91 #Const kIntersect 1 92 ## 93## 94## 95 96#Topic Color 97 #Typedef uint32_t SkColor 98 #Typedef ## 99 100 #Typedef uint32_t SkPMColor 101 #Typedef ## 102 103 # fixme: defines, not methods, need new markup type 104 #Method int SkColorGetA(color) 105 ## 106 #Method int SkColorGetR(color) 107 ## 108 #Method int SkColorGetG(color) 109 ## 110 #Method int SkColorGetB(color) 111 ## 112 #Method int SkColorSetARGB(a, r, g, b) 113 ## 114 115 #Const SK_ColorBLACK 0xFF000000 116 ## 117 #Const SK_ColorBLUE 0xFF0000FF 118 ## 119 #Const SK_ColorGREEN 0xFF00FF00 120 ## 121 #Const SK_ColorRED 0xFFFF0000 122 ## 123 #Const SK_ColorWHITE 0xFFFFFFFF 124 ## 125 #Subtopic Alpha 126 #Alias Alpha 127 #Subtopic ## 128 #Subtopic RGB 129 #Substitute RGB 130 #Subtopic Red 131 #Alias Red 132 #Subtopic ## 133 #Subtopic Blue 134 #Alias Blue 135 #Subtopic ## 136 #Subtopic Green 137 #Alias Green 138 #Subtopic ## 139 #Subtopic ## 140 #Subtopic ARGB 141 #Substitute ARGB 142 #Subtopic ## 143 144 #Subtopic RBG 145 #Substitute RBG 146 #Subtopic ## 147 148 #Subtopic RGB-565 149 #Substitute RGB-565 150 #Alias Color_RGB-565 # quit changing - to _ ! 151 #Subtopic ## 152#Topic ## 153 154#Topic Color_Filter 155#Class SkColorFilter 156#Method void toString(SkString* str) const 157## 158#Class ## 159#Topic ## 160 161#Topic Color_Space 162#Class SkColorSpace 163 #Method static sk_sp<SkColorSpace> MakeSRGBLinear() 164 ## 165## 166#EnumClass SkTransferFunctionBehavior 167#Const kRespect 0 168## 169#Const kIgnore 1 170## 171#EnumClass ## 172## 173 174#Topic Create_Color_Space_Xform_Canvas 175#Method std::unique_ptr<SkCanvas> SK_API SkCreateColorSpaceXformCanvas(SkCanvas* target, 176 sk_sp<SkColorSpace> targetCS) 177## 178## 179 180#Topic Core_Graphics 181#Substitute Core Graphics 182## 183 184#Topic Core_Text 185#Substitute Core Text 186## 187 188#Topic Curve 189#Alias Curves 190## 191 192#Topic Data 193#Class SkData 194## 195## 196 197#Topic Debugging 198#Method SK_API void SkDebugf(const char format[], ...) 199## 200## 201 202#Topic Deferred_Display_List 203#Class SkDeferredDisplayList 204## 205#Subtopic Recorder 206#Class SkDeferredDisplayListRecorder 207## 208## 209## 210 211#Topic Device 212#Class SkBaseDevice 213## 214#Topic ## 215 216#Topic Document 217#Class SkDocument 218 #Method SkCanvas* beginPage(SkScalar width, SkScalar height, 219 const SkRect* content = NULL) 220 ## 221## 222#Subtopic PDF 223## 224## 225 226#Topic Draw_Filter 227#Class SkDrawFilter 228## 229## 230 231#Topic Draw_Layer 232## 233 234#Topic Draw_Looper 235#Class SkDrawLooper 236#Class ## 237#Topic ## 238 239#Topic Drawable 240#Class SkDrawable 241 #Method void draw(SkCanvas*, const SkMatrix* = NULL) 242 ## 243## 244## 245 246#Topic Dump_Canvas 247#Class SkDumpCanvas 248## 249#Topic ## 250 251#Topic Encoded_Image_Format 252#EnumClass SkEncodedImageFormat 253 #Const kUnknown 0 254 ## 255 #Const kBMP 1 256 ## 257 #Const kGIF 2 258 ## 259 #Const kICO 3 260 ## 261 #Const kJPEG 4 262 ## 263 #Const kPNG 5 264 ## 265 #Const kWBMP 6 266 ## 267 #Const kWEBP 7 268 ## 269 #Const kPKM 8 270 ## 271 #Const kKTX 9 272 ## 273 #Const kASTC 10 274 ## 275 #Const kDNG 11 276 ## 277 #Const kHEIF 12 278 ## 279## 280#Topic ## 281 282#Topic Filter_Quality 283#Enum SkFilterQuality 284 #Const kNone_SkFilterQuality 0 285 ## 286 #Const kLow_SkFilterQuality 1 287 ## 288 #Const kMedium_SkFilterQuality 2 289 ## 290 #Const kHigh_SkFilterQuality 3 291 ## 292#Enum ## 293#Subtopic Nearest_Neighbor 294#Substitute nearest neighbor filter 295## 296#Subtopic Bilerp 297#Substitute bilerp filter 298## 299#Subtopic MipMap 300#Substitute mip-map filter 301## 302#Subtopic BiCubic 303#Substitute bicubic filter 304## 305#Topic ## 306 307#Topic Font 308#Subtopic Advance 309#Subtopic ## 310#Subtopic Engine 311## 312#Topic ## 313 314#Topic Font_Manager 315#Topic ## 316 317#Topic Glyph 318#Alias Glyphs 319## 320 321#Topic GPU_Context 322#Substitute GPU context 323#Subtopic Resource_Cache_Limits 324#Alias Resource_Cache_Limits 325## 326#Class GrContext 327#Method void flush() 328## 329## 330## 331 332#Topic GPU_Surface 333#Substitute GPU surface 334## 335 336#Topic GPU_Texture 337#Substitute GPU texture 338## 339 340#Topic HTML_Canvas 341 #Substitute HTML Canvas 342 #Subtopic ArcTo 343 #Substitute HTML Canvas arcTo 344 ## 345## 346 347#Topic Image_Filter 348#Subtopic Scaling 349#Subtopic ## 350#Class SkImageFilter 351#Method void toString(SkString* str) const 352## 353#Class ## 354#Topic ## 355 356#Topic Image_Scaling 357## 358 359#Topic ISize 360#Struct SkISize 361## 362## 363 364#Topic Left_Side_Bearing 365## 366 367#Topic Line 368#Alias Lines 369#Topic ## 370 371#Topic Malloc_Pixel_Ref 372#Class SkMallocPixelRef 373 #Method static sk_sp<SkPixelRef> MakeZeroed(const SkImageInfo&, size_t rowBytes) 374 ## 375 #Method static sk_sp<SkPixelRef> MakeAllocate(const SkImageInfo&, size_t rowBytes) 376 ## 377## 378## 379 380#Topic Mask 381#Class SkMask 382 #Enum Format 383 #Const kBW_Format 0 384 ## 385 #Const kA8_Format 1 386 ## 387 #Const k3D_Format 2 388 ## 389 #Const kARGB32_Format 3 390 ## 391 k#Const LCD16_Format 4 392 ## 393 ## 394## 395#Topic ## 396 397#Topic Mask_Alpha 398#Topic ## 399 400#Topic Mask_Filter 401#Class SkMaskFilter 402#Method virtual bool filterMask(SkMask* dst, const SkMask& src, const SkMatrix&, 403 SkIPoint* margin) const 404## 405#Method void toString(SkString* str) const 406## 407#Class ## 408#Topic ## 409 410#Topic Math 411 #Method static inline bool sk_64_isS32(int64_t value) 412 ## 413 #Method SkIntToScalar(x) 414 ## 415 #Method SkScalarRoundToInt(x) 416 ## 417 #Method SkScalarFloorToInt(x) 418 ## 419 #Method SkScalarCeilToInt(x) 420 ## 421 #Method SkScalarFloorToScalar(x) 422 ## 423 #Method SkScalarCeilToScalar(x) 424 ## 425 #Method SkScalarIsFinite(x) 426 ## 427 #Method SkScalarIsNaN(x) 428 ## 429 #Method template <typename D, typename S> inline bool SkTFitsIn(S s) 430 ## 431## 432 433#Topic Meta_Data 434#Class SkMetaData 435## 436## 437 438#Topic Mip_Map 439## 440 441#Topic Nine_Patch 442## 443 444#Topic Number_Types 445 #Typedef uint16_t SkGlyphID 446 #Typedef ## 447 #Topic Scalar 448 #Alias Scalar 449 #Typedef float SkScalar 450 #Typedef ## 451 ## 452 #Const SK_MinS32FitsInFloat 453 to be written 454 ## 455 #Const SK_MaxS32FitsInFloat 456 to be written 457 ## 458 #Const SK_ScalarMin 459 to be written 460 ## 461 #Const SK_ScalarMax 462 to be written 463 ## 464 #Const SK_ScalarInfinity 465 to be written 466 ## 467 #Const SK_ScalarNegativeInfinity 468 to be written 469 ## 470 #Const SK_ScalarNaN 471 to be written 472 ## 473 #Const SK_MinS32 474 to be written 475 ## 476 #Const SK_MaxS32 477 to be written 478 ## 479 #Const SK_MaxSizeT 480 to be written 481 ## 482 #Typedef int32_t SkUnichar 483 #Typedef ## 484 #Typedef unsigned U8CPU 485 #Typedef ## 486#Topic ## 487 488#Topic OS_X 489#Substitute OS X 490## 491 492#Topic Oval 493#Alias Ovals 494#Topic ## 495 496#Topic Paint_Defaults 497#Const SkPaintDefaults_Flags 0 498## 499#Const SkPaintDefaults_Hinting 2 500## 501#Const SkPaintDefaults_TextSize 12 502## 503#Const SkPaintDefaults_MiterLimit 4 504## 505#Topic ## 506 507#Topic Patch 508#Alias Patches 509#Topic ## 510 511#Topic Path_Effect 512 #Class SkPathEffect 513 #Method void toString(SkString* str) const 514 ## 515 #Class ## 516#Topic ## 517 518#Topic Path_Measure 519 #Class SkPathMeasure 520 #Method void dump() const 521 ## 522 ## 523## 524 525#Topic PathOps 526 #Method bool SK_API Op(const SkPath& one, const SkPath& two, SkPathOp op, SkPath* result) 527 ## 528#Topic ## 529 530#Topic Picture 531#Class SkPicture 532#Method virtual void playback(SkCanvas*, AbortCallback* = nullptr) const = 0 533## 534## 535#Subtopic Recorder 536 #Class SkPictureRecorder 537 #Method SkCanvas* beginRecording(const SkRect& bounds, 538 SkBBHFactory* bbhFactory = NULL, 539 uint32_t recordFlags = 0) 540 ## 541 ## 542## 543## 544 545#Topic Pixel 546#Subtopic Storage 547## 548## 549 550#Topic Pixel_Ref 551#Class SkPixelRef 552 #Method int width() const 553 ## 554 #Method int height() const 555 ## 556 #Method bool isImmutable() const 557 ## 558 #Method void setImmutable() 559 ## 560## 561## 562 563#Enum SkPixelGeometry 564## 565 566# Topic Point_Array 567# Substitute SkPoint arrays 568# Topic ## 569 570#Topic Point3 571#Struct SkPoint3 572## 573#Topic ## 574 575#Topic PostScript 576#Substitute PostScript 577#Subtopic Arct 578#Substitute PostScript arct 579## 580## 581 582#Topic Premultiply 583#Alias Premultiplied 584## 585 586#Topic Raster_Engine 587## 588 589#Topic Raster_Handle_Allocator 590#Class SkRasterHandleAllocator 591 #Struct Rec 592 ## 593 #Method static std::unique_ptr<SkCanvas> MakeCanvas(std::unique_ptr<SkRasterHandleAllocator>, const SkImageInfo&, const Rec* rec = nullptr) 594 ## 595## 596## 597 598#Topic Raster_Bitmap 599## 600 601#Topic Raster_Surface 602## 603 604#Topic Rasterizer 605#Class SkRasterizer 606#Class ## 607#Subtopic Layer 608#Subtopic ## 609#Topic ## 610 611#Topic Reference_Count 612#Substitute SkRefCnt 613#Class SkRefCnt 614#Class ## 615#Class sk_sp 616#Class ## 617#Topic ## 618 619#Topic Region 620#Class SkRegion 621## 622#Topic ## 623 624#Topic Render_Target 625#Class GrRenderTarget 626## 627## 628 629#Topic Right_Side_Bearing 630## 631 632#Topic Round_Rect 633 #Class SkRRect 634 #Method void dump() const 635 ## 636 #Method void dumpHex() const 637 ## 638 ## 639#Topic ## 640 641#Topic RSXform 642#Struct SkRSXform 643## 644## 645 646#Topic Shader 647#Class SkShader 648 #Enum TileMode 649 #Const kClamp_TileMode 0 650 ## 651 #Const kRepeat_TileMode 1 652 ## 653 #Const kMirror_TileMode 2 654 ## 655 ## 656 #Method static sk_sp<SkShader> MakeBitmapShader(const SkBitmap& src, TileMode tmx, TileMode tmy, 657 const SkMatrix* localMatrix = nullptr) 658 ## 659#Class ## 660#Subtopic Gradient 661#Subtopic ## 662#Topic ## 663 664#Topic Size 665#Struct SkSize 666## 667## 668 669#Topic Sprite 670#Alias Sprites 671#Topic ## 672 673#Topic Stream 674#Class SkStream 675#Class ## 676#Topic ## 677 678#Topic String 679#Class SkString 680#Class ## 681#Topic ## 682 683#Topic Supersampling 684## 685 686#Topic Surface_Characterization 687#Class SkSurfaceCharacterization 688## 689## 690 691#Topic Surface_Properties 692 #Class SkSurfaceProps 693 #Topic Legacy_Font_Host 694 #Enum InitType 695 #Const kLegacyFontHost_InitType 0 696 ## 697 ## 698 #Topic ## 699 ## 700## 701 702#Topic SVG 703#Subtopic Canvas 704## 705#Subtopic Arc 706## 707## 708 709#Topic Text 710#Topic ## 711 712#Topic Text_Blob 713#Class SkTextBlob 714#Class ## 715#Topic ## 716 717#Topic Texture 718#Class GrBackendTexture 719## 720## 721 722#Topic Typeface 723#Class SkTypeface 724#Class ## 725#Topic ## 726 727#Topic Types 728 #Typedef intptr_t GrBackendObject 729 #Typedef ## 730 731 #Enum GrSurfaceOrigin 732 #Const kBottomLeft_GrSurfaceOrigin 0 733 ## 734 #Const kTopLeft_GrSurfaceOrigin 1 735 ## 736 #Enum ## 737 738 #Subtopic Budgeted 739 #EnumClass SkBudgeted 740 #Const kNo 0 741 ## 742 #Const kYes 1 743 ## 744 #EnumClass ## 745 ## 746 747 #EnumClass GrSemaphoresSubmitted 748 #Const kNo 0 749 ## 750 #Const kYes 1 751 ## 752 #EnumClass ## 753#Topic ## 754 755#Topic Unpremultiply 756#Alias Unpremultiplied 757## 758 759#Topic Vertices 760#Subtopic Colors 761## 762#Subtopic Texs 763## 764#Topic ## 765 766#Topic Read_Buffer 767 #Struct SkReadBuffer 768 #Struct ## 769## 770 771#Topic Write_Buffer 772 #Struct SkWriteBuffer 773 #Struct ## 774#Topic ## 775 776