document SkColor.h

SkColor.h uses #define liberally, and has many global symbols,
two things bookmaker hasn't seen in other includes.

Revised .h -> .bmh converter to work with SkColor.h as well
as updating how .bmh indices are built.

Generated SkColor_Reference.bmh for globals, and
SkColor4f_Reference.bmh for class.

Other than the existing comments, this doesn't update the
documentation or add new examples.

Docs-Preview: https://skia.org/?cl=118985
TBR=caryclark@google.com
Bug: skia:6898
Change-Id: I5978257ee0e51319823efbe8dfc467a08c99ffe0
Reviewed-on: https://skia-review.googlesource.com/118985
Commit-Queue: Cary Clark <caryclark@skia.org>
Reviewed-by: Cary Clark <caryclark@skia.org>

1 files changed, 288 insertions, 8 deletions

diff --git a/site/user/api/catalog.htm b/site/user/api/catalog.htm
index a731ed91c7..e81a37df5e 100644
--- a/site/user/api/catalog.htm
+++ b/site/user/api/catalog.htm
@@ -3739,6 +3739,118 @@
     "file": "SkPath_Reference",
     "name": "Path_2"
 },
+    "SK_AlphaOPAQUE": {
+    "code": "void draw(SkCanvas* canvas) {\n    // incomplete\n}",
+    "width": 256,
+    "height": 256,
+    "hash": "882e8e0103048009a25cfc20400492f7",
+    "file": "SkColor_Reference",
+    "name": "SK_AlphaOPAQUE"
+},
+    "SK_AlphaTRANSPARENT": {
+    "code": "void draw(SkCanvas* canvas) {\n    // incomplete\n}",
+    "width": 256,
+    "height": 256,
+    "hash": "882e8e0103048009a25cfc20400492f7",
+    "file": "SkColor_Reference",
+    "name": "SK_AlphaTRANSPARENT"
+},
+    "SK_ColorBLACK": {
+    "code": "void draw(SkCanvas* canvas) {\n    // incomplete\n}",
+    "width": 256,
+    "height": 256,
+    "hash": "882e8e0103048009a25cfc20400492f7",
+    "file": "SkColor_Reference",
+    "name": "SK_ColorBLACK"
+},
+    "SK_ColorBLUE": {
+    "code": "void draw(SkCanvas* canvas) {\n    // incomplete\n}",
+    "width": 256,
+    "height": 256,
+    "hash": "882e8e0103048009a25cfc20400492f7",
+    "file": "SkColor_Reference",
+    "name": "SK_ColorBLUE"
+},
+    "SK_ColorCYAN": {
+    "code": "void draw(SkCanvas* canvas) {\n    // incomplete\n}",
+    "width": 256,
+    "height": 256,
+    "hash": "882e8e0103048009a25cfc20400492f7",
+    "file": "SkColor_Reference",
+    "name": "SK_ColorCYAN"
+},
+    "SK_ColorDKGRAY": {
+    "code": "void draw(SkCanvas* canvas) {\n    // incomplete\n}",
+    "width": 256,
+    "height": 256,
+    "hash": "882e8e0103048009a25cfc20400492f7",
+    "file": "SkColor_Reference",
+    "name": "SK_ColorDKGRAY"
+},
+    "SK_ColorGRAY": {
+    "code": "void draw(SkCanvas* canvas) {\n    // incomplete\n}",
+    "width": 256,
+    "height": 256,
+    "hash": "882e8e0103048009a25cfc20400492f7",
+    "file": "SkColor_Reference",
+    "name": "SK_ColorGRAY"
+},
+    "SK_ColorGREEN": {
+    "code": "void draw(SkCanvas* canvas) {\n    // incomplete\n}",
+    "width": 256,
+    "height": 256,
+    "hash": "882e8e0103048009a25cfc20400492f7",
+    "file": "SkColor_Reference",
+    "name": "SK_ColorGREEN"
+},
+    "SK_ColorLTGRAY": {
+    "code": "void draw(SkCanvas* canvas) {\n    // incomplete\n}",
+    "width": 256,
+    "height": 256,
+    "hash": "882e8e0103048009a25cfc20400492f7",
+    "file": "SkColor_Reference",
+    "name": "SK_ColorLTGRAY"
+},
+    "SK_ColorMAGENTA": {
+    "code": "void draw(SkCanvas* canvas) {\n    // incomplete\n}",
+    "width": 256,
+    "height": 256,
+    "hash": "882e8e0103048009a25cfc20400492f7",
+    "file": "SkColor_Reference",
+    "name": "SK_ColorMAGENTA"
+},
+    "SK_ColorRED": {
+    "code": "void draw(SkCanvas* canvas) {\n    // incomplete\n}",
+    "width": 256,
+    "height": 256,
+    "hash": "882e8e0103048009a25cfc20400492f7",
+    "file": "SkColor_Reference",
+    "name": "SK_ColorRED"
+},
+    "SK_ColorTRANSPARENT": {
+    "code": "void draw(SkCanvas* canvas) {\n    // incomplete\n}",
+    "width": 256,
+    "height": 256,
+    "hash": "882e8e0103048009a25cfc20400492f7",
+    "file": "SkColor_Reference",
+    "name": "SK_ColorTRANSPARENT"
+},
+    "SK_ColorWHITE": {
+    "code": "void draw(SkCanvas* canvas) {\n    // incomplete\n}",
+    "width": 256,
+    "height": 256,
+    "hash": "882e8e0103048009a25cfc20400492f7",
+    "file": "SkColor_Reference",
+    "name": "SK_ColorWHITE"
+},
+    "SK_ColorYELLOW": {
+    "code": "void draw(SkCanvas* canvas) {\n    // incomplete\n}",
+    "width": 256,
+    "height": 256,
+    "hash": "882e8e0103048009a25cfc20400492f7",
+    "file": "SkColor_Reference",
+    "name": "SK_ColorYELLOW"
+},
     "SkAutoCanvasRestore_SkCanvas_star": {
     "code": "void draw(SkCanvas* canvas) {\n    SkPaint p;\n    p.setAntiAlias(true);\n    p.setTextSize(64);\n    for (SkScalar sx : { -1, 1 } ) {\n        for (SkScalar sy : { -1, 1 } ) {\n            SkAutoCanvasRestore autoRestore(canvas, true);\n            SkMatrix m = SkMatrix::MakeAll(sx, 1, 96,    0, sy, 64,   0, 0, 1);\n            canvas->concat(m);\n            canvas->drawString(\"R\", 0, 0, p);\n        }\n    }\n}",
     "width": 256,
@@ -4827,6 +4939,142 @@
     "file": "SkCanvas_Reference",
     "name": "SkCanvas::writePixels_2"
 },
+    "SkColor4f_FromColor": {
+    "code": "void draw(SkCanvas* canvas) {\n    // incomplete\n}",
+    "width": 256,
+    "height": 256,
+    "hash": "882e8e0103048009a25cfc20400492f7",
+    "file": "SkColor4f_Reference",
+    "name": "SkColor4f::FromColor"
+},
+    "SkColor4f_Pin": {
+    "code": "void draw(SkCanvas* canvas) {\n    // incomplete\n}",
+    "width": 256,
+    "height": 256,
+    "hash": "882e8e0103048009a25cfc20400492f7",
+    "file": "SkColor4f_Reference",
+    "name": "SkColor4f::Pin"
+},
+    "SkColor4f_equal1_operator": {
+    "code": "void draw(SkCanvas* canvas) {\n    // incomplete\n}",
+    "width": 256,
+    "height": 256,
+    "hash": "882e8e0103048009a25cfc20400492f7",
+    "file": "SkColor4f_Reference",
+    "name": "SkColor4f::operator==(const SkColor4f& other)_const"
+},
+    "SkColor4f_notequal1_operator": {
+    "code": "void draw(SkCanvas* canvas) {\n    // incomplete\n}",
+    "width": 256,
+    "height": 256,
+    "hash": "882e8e0103048009a25cfc20400492f7",
+    "file": "SkColor4f_Reference",
+    "name": "SkColor4f::operator!=(const SkColor4f& other)_const"
+},
+    "SkColor4f_pin": {
+    "code": "void draw(SkCanvas* canvas) {\n    // incomplete\n}",
+    "width": 256,
+    "height": 256,
+    "hash": "882e8e0103048009a25cfc20400492f7",
+    "file": "SkColor4f_Reference",
+    "name": "SkColor4f::pin()"
+},
+    "SkColor4f_premul": {
+    "code": "void draw(SkCanvas* canvas) {\n    // incomplete\n}",
+    "width": 256,
+    "height": 256,
+    "hash": "882e8e0103048009a25cfc20400492f7",
+    "file": "SkColor4f_Reference",
+    "name": "SkColor4f::premul()"
+},
+    "SkColor4f_toSkColor": {
+    "code": "void draw(SkCanvas* canvas) {\n    // incomplete\n}",
+    "width": 256,
+    "height": 256,
+    "hash": "882e8e0103048009a25cfc20400492f7",
+    "file": "SkColor4f_Reference",
+    "name": "SkColor4f::toSkColor"
+},
+    "SkColor4f_vec": {
+    "code": "void draw(SkCanvas* canvas) {\n    // incomplete\n}",
+    "width": 256,
+    "height": 256,
+    "hash": "882e8e0103048009a25cfc20400492f7",
+    "file": "SkColor4f_Reference",
+    "name": "SkColor4f::vec()"
+},
+    "SkColor4f_vec_2": {
+    "code": "void draw(SkCanvas* canvas) {\n    // incomplete\n}",
+    "width": 256,
+    "height": 256,
+    "hash": "882e8e0103048009a25cfc20400492f7",
+    "file": "SkColor4f_Reference",
+    "name": "SkColor4f::vec_2"
+},
+    "SkColorGetA": {
+    "code": "void draw(SkCanvas* canvas) {\n    // incomplete\n}",
+    "width": 256,
+    "height": 256,
+    "hash": "882e8e0103048009a25cfc20400492f7",
+    "file": "SkColor_Reference",
+    "name": "SkColorGetA"
+},
+    "SkColorGetB": {
+    "code": "void draw(SkCanvas* canvas) {\n    // incomplete\n}",
+    "width": 256,
+    "height": 256,
+    "hash": "882e8e0103048009a25cfc20400492f7",
+    "file": "SkColor_Reference",
+    "name": "SkColorGetB"
+},
+    "SkColorGetG": {
+    "code": "void draw(SkCanvas* canvas) {\n    // incomplete\n}",
+    "width": 256,
+    "height": 256,
+    "hash": "882e8e0103048009a25cfc20400492f7",
+    "file": "SkColor_Reference",
+    "name": "SkColorGetG"
+},
+    "SkColorGetR": {
+    "code": "void draw(SkCanvas* canvas) {\n    // incomplete\n}",
+    "width": 256,
+    "height": 256,
+    "hash": "882e8e0103048009a25cfc20400492f7",
+    "file": "SkColor_Reference",
+    "name": "SkColorGetR"
+},
+    "SkColorSetA": {
+    "code": "void draw(SkCanvas* canvas) {\n    // incomplete\n}",
+    "width": 256,
+    "height": 256,
+    "hash": "882e8e0103048009a25cfc20400492f7",
+    "file": "SkColor_Reference",
+    "name": "SkColorSetA"
+},
+    "SkColorSetARGB": {
+    "code": "void draw(SkCanvas* canvas) {\n    // incomplete\n}",
+    "width": 256,
+    "height": 256,
+    "hash": "882e8e0103048009a25cfc20400492f7",
+    "file": "SkColor_Reference",
+    "name": "SkColorSetARGB"
+},
+    "SkColorSetRGB": {
+    "code": "void draw(SkCanvas* canvas) {\n    // incomplete\n}",
+    "width": 256,
+    "height": 256,
+    "hash": "882e8e0103048009a25cfc20400492f7",
+    "file": "SkColor_Reference",
+    "name": "SkColorSetRGB"
+},
+    "SkColorToHSV": {
+    "code": "void draw(SkCanvas* canvas) {\n    // incomplete\n}",
+    "width": 256,
+    "height": 256,
+    "hash": "882e8e0103048009a25cfc20400492f7",
+    "file": "SkColor_Reference",
+    "name": "SkColorToHSV"
+},
     "SkColorTypeBytesPerPixel": {
     "code": "void draw(SkCanvas* canvas) {\n    const char* colors[] = { \"Unknown\", \"Alpha_8\", \"RGB_565\", \"ARGB_4444\", \"RGBA_8888\", \"RGB_888x\",\n                             \"BGRA_8888\", \"RGBA_1010102\", \"RGB_101010x\", \"Gray_8\", \"RGBA_F16\" };\n    SkPaint paint;\n    paint.setTypeface(SkTypeface::MakeFromName(\"monospace\", SkFontStyle()));\n    paint.setAntiAlias(true);\n    paint.setTextSize(10);\n    int y = 15;\n    canvas->drawString(\"    colorType  bytes\", 10, y, paint);\n    for (SkColorType colorType : {\n    kUnknown_SkColorType, kAlpha_8_SkColorType, kRGB_565_SkColorType,\n    kARGB_4444_SkColorType, kRGBA_8888_SkColorType, kRGB_888x_SkColorType,\n    kBGRA_8888_SkColorType, kRGBA_1010102_SkColorType, kRGB_101010x_SkColorType,\n    kGray_8_SkColorType, kRGBA_F16_SkColorType\n                                 } ) {\n        int result = SkColorTypeBytesPerPixel(colorType);\n        SkString string;\n        string.printf(\"%13s %4d\", colors[(int) colorType], result);\n        canvas->drawString(string, 10, y += 14, paint);\n    }\n}",
     "width": 256,
@@ -4851,6 +5099,22 @@
     "file": "SkImageInfo_Reference",
     "name": "SkColorTypeValidateAlphaType"
 },
+    "SkHSVToColor": {
+    "code": "void draw(SkCanvas* canvas) {\n    // incomplete\n}",
+    "width": 256,
+    "height": 256,
+    "hash": "882e8e0103048009a25cfc20400492f7",
+    "file": "SkColor_Reference",
+    "name": "SkHSVToColor"
+},
+    "SkHSVToColor_2": {
+    "code": "void draw(SkCanvas* canvas) {\n    // incomplete\n}",
+    "width": 256,
+    "height": 256,
+    "hash": "882e8e0103048009a25cfc20400492f7",
+    "file": "SkColor_Reference",
+    "name": "SkHSVToColor_2"
+},
     "SkIPoint_add_operator": {
     "code": "void draw(SkCanvas* canvas) {\n    auto draw_lines = [=](const SkIPoint pts[], size_t count, SkPaint& paint) -> void {\n        for (size_t i = 0; i < count - 1; ++i) {\n            SkPoint p0, p1;\n            p0.iset(pts[i]);\n            p1.iset(pts[i + 1]);\n            canvas->drawLine(p0, p1, paint);\n        }\n    };\n    SkIPoint points[] = { { 3, 1 }, { 4, 2 }, { 5, 1 }, { 7, 3 } };\n    SkPaint paint;\n    paint.setAntiAlias(true);\n    paint.setStyle(SkPaint::kStroke_Style);\n    canvas->scale(30, 15);\n    draw_lines(points, SK_ARRAY_COUNT(points), paint);\n    SkIPoint mod = {4, 1};\n    for (auto& point : points) {\n        point = point + mod;\n        mod.fX -= 1;\n        mod.fY += 1;\n    }\n    paint.setColor(SK_ColorRED);\n    draw_lines(points, SK_ARRAY_COUNT(points), paint);\n}",
     "width": 256,
@@ -6979,6 +7243,30 @@
     "file": "SkPoint_Reference",
     "name": "SkPoint::operator-=(const SkVector& v)"
 },
+    "SkPreMultiplyARGB": {
+    "code": "void draw(SkCanvas* canvas) {\n    // incomplete\n}",
+    "width": 256,
+    "height": 256,
+    "hash": "882e8e0103048009a25cfc20400492f7",
+    "file": "SkColor_Reference",
+    "name": "SkPreMultiplyARGB"
+},
+    "SkPreMultiplyColor": {
+    "code": "void draw(SkCanvas* canvas) {\n    // incomplete\n}",
+    "width": 256,
+    "height": 256,
+    "hash": "882e8e0103048009a25cfc20400492f7",
+    "file": "SkColor_Reference",
+    "name": "SkPreMultiplyColor"
+},
+    "SkRGBToHSV": {
+    "code": "void draw(SkCanvas* canvas) {\n    // incomplete\n}",
+    "width": 256,
+    "height": 256,
+    "hash": "882e8e0103048009a25cfc20400492f7",
+    "file": "SkColor_Reference",
+    "name": "SkRGBToHSV"
+},
     "SkSurface_BackendHandleAccess": {
     "code": "void draw(SkCanvas* canvas) {\n    SkPaint paint;\n    paint.setTextSize(32);\n    GrContext* context = canvas->getGrContext();\n    if (!context) {\n         canvas->drawString(\"GPU only!\", 20, 40, paint);\n         return;\n    }\n    sk_sp<SkSurface> gpuSurface = SkSurface::MakeRenderTarget(\n            context, SkBudgeted::kYes, SkImageInfo::MakeN32Premul(10, 10));\n    int y = 20;\n    SkString str;\n    paint.setTextSize(16);\n    for (auto access : { SkSurface::kFlushRead_BackendHandleAccess, \n                         SkSurface::kFlushWrite_BackendHandleAccess,\n                         SkSurface::kDiscardWrite_BackendHandleAccess } ) {\n        sk_sp<SkImage> image(gpuSurface->makeImageSnapshot());\n        str.printf(\"uniqueID=%d\", image->uniqueID());\n        canvas->drawString(str, 20, y += 20, paint);\n        GrBackendObject backendObject = gpuSurface->getTextureHandle(access);\n        str.printf(\"backendObject %c= 0\", backendObject != 0 ? '!' : '=');\n        canvas->drawString(str, 20, y += 20, paint);\n    }\n    sk_sp<SkImage> image(gpuSurface->makeImageSnapshot());\n    str.printf(\"final image uniqueID=%d\", image->uniqueID());\n    canvas->drawString(str, 20, y += 20, paint);\n}",
     "width": 256,
@@ -7059,14 +7347,6 @@
     "file": "SkSurface_Reference",
     "name": "SkSurface::getCanvas"
 },
-    "SkSurface_getRenderTargetHandle": {
-    "code": "void draw(SkCanvas* canvas) {\n    SkPaint paint;\n    paint.setTextSize(32);\n    GrContext* context = canvas->getGrContext();\n    if (!context) {\n         canvas->drawString(\"GPU only!\", 20, 40, paint);\n         return;\n    }\n    sk_sp<SkSurface> gpuSurface = SkSurface::MakeRenderTarget(\n            context, SkBudgeted::kYes, SkImageInfo::MakeN32Premul(10, 10));\n    GrBackendObject backendObject;\n    if (gpuSurface->getRenderTargetHandle(&backendObject, \n            SkSurface::kFlushRead_BackendHandleAccess)) {\n        SkString str;\n        str.printf(\"backendObject=%ld\", backendObject);\n        paint.setTextSize(16);\n        canvas->drawString(str, 20, 40, paint);\n    }\n}",
-    "width": 256,
-    "height": 64,
-    "hash": "dbc6c0e01a177ba03c87c00c32a43148",
-    "file": "SkSurface_Reference",
-    "name": "SkSurface::getRenderTargetHandle"
-},
     "SkSurface_getTextureHandle": {
     "code": "void draw(SkCanvas* canvas) {\n    SkPaint paint;\n    paint.setTextSize(32);\n    GrContext* context = canvas->getGrContext();\n    if (!context) {\n         canvas->drawString(\"GPU only!\", 20, 40, paint);\n         return;\n    }\n    sk_sp<SkSurface> gpuSurface = SkSurface::MakeRenderTarget(\n            context, SkBudgeted::kYes, SkImageInfo::MakeN32Premul(10, 10));\n    GrBackendObject backendObject = gpuSurface->getTextureHandle(\n            SkSurface::kFlushRead_BackendHandleAccess);\n    if (backendObject) {\n        SkString str;\n        str.printf(\"backendObject=%08lx\", backendObject);\n        paint.setTextSize(16);\n        canvas->drawString(str, 20, 40, paint);\n    }\n}",
     "width": 256,