diff options
author | Cary Clark <caryclark@skia.org> | 2017-09-15 02:56:12 -0400 |
---|---|---|
committer | Skia Commit-Bot <skia-commit-bot@chromium.org> | 2017-09-15 14:03:53 +0000 |
commit | e4aa37128f246b137b73d45488fdeb894b002736 (patch) | |
tree | 3b8dd1f4b963e104bad73f838b4a6257df3374a5 /docs | |
parent | 053d7a43e5f9b799ce32cbaee22aaf97ac65c925 (diff) |
missing description for FontMetricFlags
rearrange class descriptions to make them
appear consistently inside the #Class
declaration in the .bmh files.
Look for the descriptions there and
regenerate the .md files.
Docs-Preview: https://skia.org/?cl=46523
TBR=caryclark@google.com
Bug: skia: 6898
Change-Id: I00a176428725ef27667d3f23d76d6b7ff0cfced1
Reviewed-on: https://skia-review.googlesource.com/46523
Commit-Queue: Cary Clark <caryclark@google.com>
Reviewed-by: Cary Clark <caryclark@skia.org>
Diffstat (limited to 'docs')
-rw-r--r-- | docs/SkCanvas_Reference.bmh | 4 | ||||
-rw-r--r-- | docs/SkPaint_Reference.bmh | 39 | ||||
-rw-r--r-- | docs/SkPixmap_Reference.bmh | 3 |
3 files changed, 24 insertions, 22 deletions
diff --git a/docs/SkCanvas_Reference.bmh b/docs/SkCanvas_Reference.bmh index ae351421a5..0c86011c78 100644 --- a/docs/SkCanvas_Reference.bmh +++ b/docs/SkCanvas_Reference.bmh @@ -1,6 +1,8 @@ #Topic Canvas #Alias Canvas_Reference +#Class SkCanvas + Canvas provides an interface for drawing, and how the drawing is clipped and transformed. Canvas contains a stack of Matrix and Clip values. @@ -22,8 +24,6 @@ destination. Canvas can be constructed to draw to Bitmap without first creating Raster_Surface. This approach may be deprecated in the future. -#Class SkCanvas - #Topic Overview #Subtopic Subtopics diff --git a/docs/SkPaint_Reference.bmh b/docs/SkPaint_Reference.bmh index 0b80bf7e07..6dc3109e84 100644 --- a/docs/SkPaint_Reference.bmh +++ b/docs/SkPaint_Reference.bmh @@ -1,6 +1,8 @@ #Topic Paint #Alias Paint_Reference +#Class SkPaint + Paint controls options applied when drawing and measuring. Paint collects all options outside of the Canvas_Clip and Canvas_Matrix. @@ -27,8 +29,6 @@ Paint describes a single color, a single font, a single image quality, and so on Multiple colors are drawn either by using multiple paints or with objects like Shader attached to Paint. -#Class SkPaint - #Topic Overview #Subtopic Subtopics @@ -4000,10 +4000,10 @@ All character encoding are able to represent all of Unicode, differing only in the total storage required. #A UTF-8 (RFC 3629) # https://tools.ietf.org/html/rfc3629 ## is made up of 8-bit bytes, -and encodes ASCII in one byte, and all valid code points in Unicode in multiple bytes. -#A UTF-16 (RFC 2781) # https://tools.ietf.org/html/rfc2781 ## uses one or two 16-bit words, -and encodes Unicode ranges 0x0000 to 0xD7FF and 0xE000 to 0xFFFF in one word. -#A UTF-32 # http://www.unicode.org/versions/Unicode5.0.0/ch03.pdf ## describes +and encodes ASCII in one byte, and all valid code points in Unicode in multiple +bytes. #A UTF-16 (RFC 2781) # https://tools.ietf.org/html/rfc2781 ## uses one or two 16-bit words, +and encodes Unicode ranges 0x0000 to 0xD7FF and 0xE000 to 0xFFFF in one +word. #A UTF-32 # http://www.unicode.org/versions/Unicode5.0.0/ch03.pdf ## describes a 32-bit word, which encodes all code points in Unicode. Font_Manager uses font data to convert character code points into glyph indices. @@ -4159,6 +4159,16 @@ void draw(SkCanvas* canvas) { #Struct FontMetrics + FontMetrics is filled out by getFontMetrics. FontMetrics contents reflect the values + computed by Font_Manager using Typeface. Values are set to zero if they are + not available. + + fUnderlineThickness and fUnderlinePosition have a bit set in fFlags if their values + are valid, since their value may be zero. + + fStrikeoutThickness and fStrikeoutPosition have a bit set in fFlags if their values + are valid, since their value may be zero. + #Code struct FontMetrics { enum FontMetricsFlags { @@ -4192,17 +4202,12 @@ void draw(SkCanvas* canvas) { }; ## - FontMetrics is filled out by getFontMetrics. FontMetrics contents reflect the values - computed by Font_Manager using Typeface. Values are set to zero if they are - not available. + #Enum FontMetricsFlags - fUnderlineThickness and fUnderlinePosition have a bit set in fFlags if their values - are valid, since their value may be zero. - - fStrikeoutThickness and fStrikeoutPosition have a bit set in fFlags if their values - are valid, since their value may be zero. + FontMetricsFlags are set in fFlags when underline and strikeout metrics are valid; + the underline or strikeout metric may be valid and zero. + Fonts with embedded bitmaps may not have valid underline or strikeout metrics. - #Enum FontMetricsFlags #Code enum FontMetricsFlags { kUnderlineThicknessIsValid_Flag = 1 << 0, @@ -4212,10 +4217,6 @@ void draw(SkCanvas* canvas) { }; ## - FontMetricsFlags are set in fFlags when underline and strikeout metrics are valid; - the underline or strikeout metric may be valid and zero. - Fonts with embedded bitmaps may not have valid underline or strikeout metrics. - #Const kUnderlineThicknessIsValid_Flag 0x0001 Set if fUnderlineThickness is valid. ## diff --git a/docs/SkPixmap_Reference.bmh b/docs/SkPixmap_Reference.bmh index 83f350252c..409090b2bd 100644 --- a/docs/SkPixmap_Reference.bmh +++ b/docs/SkPixmap_Reference.bmh @@ -1,5 +1,6 @@ #Topic Pixmap - +#Alias Pixmap_Reference + #Class SkPixmap Pixmap provides a utility to pair SkImageInfo with pixels and row bytes. |