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 /site | |
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 'site')
-rw-r--r-- | site/user/api/SkCanvas_Reference.md | 4 | ||||
-rw-r--r-- | site/user/api/SkPaint_Reference.md | 37 |
2 files changed, 20 insertions, 21 deletions
diff --git a/site/user/api/SkCanvas_Reference.md b/site/user/api/SkCanvas_Reference.md index 98875b8888..32990c663a 100644 --- a/site/user/api/SkCanvas_Reference.md +++ b/site/user/api/SkCanvas_Reference.md @@ -2,6 +2,8 @@ SkCanvas Reference === # <a name="Canvas"></a> Canvas + +# <a name="SkCanvas"></a> Class SkCanvas <a href="#Canvas">Canvas</a> provides an interface for drawing, and how the drawing is clipped and transformed. <a href="#Canvas">Canvas</a> contains a stack of <a href="#Matrix">Matrix</a> and <a href="#Clip">Clip</a> values. @@ -23,8 +25,6 @@ destination. <a href="#Canvas">Canvas</a> can be constructed to draw to <a href="undocumented#Bitmap">Bitmap</a> without first creating <a href="undocumented#Raster_Surface">Raster Surface</a>. This approach may be deprecated in the future. -# <a name="SkCanvas"></a> Class SkCanvas - # <a name="Overview"></a> Overview ## <a name="Subtopics"></a> Subtopics diff --git a/site/user/api/SkPaint_Reference.md b/site/user/api/SkPaint_Reference.md index a9fa76e3d3..a1f2b8bbef 100644 --- a/site/user/api/SkPaint_Reference.md +++ b/site/user/api/SkPaint_Reference.md @@ -2,6 +2,8 @@ SkPaint Reference === # <a name="Paint"></a> Paint + +# <a name="SkPaint"></a> Class SkPaint <a href="#Paint">Paint</a> controls options applied when drawing and measuring. <a href="#Paint">Paint</a> collects all options outside of the <a href="#Clip">Canvas Clip</a> and <a href="#Matrix">Canvas Matrix</a>. @@ -28,8 +30,6 @@ is set in <a href="#Paint">Paint</a>. Multiple colors are drawn either by using multiple paints or with objects like <a href="undocumented#Shader">Shader</a> attached to <a href="#Paint">Paint</a>. -# <a name="SkPaint"></a> Class SkPaint - # <a name="Overview"></a> Overview ## <a name="Subtopics"></a> Subtopics @@ -3947,10 +3947,10 @@ All character encoding are able to represent all of <a href="undocumented#Unicod in the total storage required. <a href="undocumented#UTF_8">UTF-8</a> (<a href="undocumented#RFC">RFC</a> 3629)is made up of 8-bit bytes, -and encodes <a href="undocumented#ASCII">ASCII</a> in one byte, and all valid code points in <a href="undocumented#Unicode">Unicode</a> in multiple bytes. -<a href="undocumented#UTF_16">UTF-16</a> (<a href="undocumented#RFC">RFC</a> 2781)uses one or two 16-bit words, -and encodes <a href="undocumented#Unicode">Unicode</a> ranges 0x0000 to 0xD7FF and 0xE000 to 0xFFFF in one word. -<a href="undocumented#UTF_32">UTF-32</a>describes +and encodes <a href="undocumented#ASCII">ASCII</a> in one byte, and all valid code points in <a href="undocumented#Unicode">Unicode</a> in multiple +bytes.<a href="undocumented#UTF_16">UTF-16</a> (<a href="undocumented#RFC">RFC</a> 2781)uses one or two 16-bit words, +and encodes <a href="undocumented#Unicode">Unicode</a> ranges 0x0000 to 0xD7FF and 0xE000 to 0xFFFF in one +word.<a href="undocumented#UTF_32">UTF-32</a>describes a 32-bit word, which encodes all code points in <a href="undocumented#Unicode">Unicode</a>. <a href="undocumented#Font_Manager">Font Manager</a> uses font data to convert character code points into glyph indices. @@ -4063,6 +4063,14 @@ Y-axis values above the baseline are negative, and below the baseline are positi <div><fiddle-embed name="b5b76e0a15da0c3530071186a9006498"></fiddle-embed></div> # <a name="SkPaint_FontMetrics"></a> Struct SkPaint::FontMetrics +<a href="#SkPaint_FontMetrics">FontMetrics</a> is filled out by <a href="#SkPaint_getFontMetrics">getFontMetrics</a>. <a href="#SkPaint_FontMetrics">FontMetrics</a> contents reflect the values +computed by <a href="undocumented#Font_Manager">Font Manager</a> using <a href="undocumented#Typeface">Typeface</a>. Values are set to zero if they are +not available. + +<a href="#SkPaint_FontMetrics_fUnderlineThickness">fUnderlineThickness</a> and <a href="#SkPaint_FontMetrics_fUnderlinePosition">fUnderlinePosition</a> have a bit set in <a href="#SkPaint_FontMetrics_fFlags">fFlags</a> if their values +are valid, since their value may be zero. +<a href="#SkPaint_FontMetrics_fStrikeoutThickness">fStrikeoutThickness</a> and <a href="#SkPaint_FontMetrics_fStrikeoutPosition">fStrikeoutPosition</a> have a bit set in <a href="#SkPaint_FontMetrics_fFlags">fFlags</a> if their values +are valid, since their value may be zero. <pre style="padding: 1em 1em 1em 1em;width: 44em; background-color: #f0f0f0"> struct <a href="#SkPaint_FontMetrics">FontMetrics</a> { @@ -4096,17 +4104,12 @@ bool <a href="#SkPaint_FontMetrics_hasStrikeoutThickness">hasStrikeoutThickness( bool <a href="#SkPaint_FontMetrics_hasStrikeoutPosition">hasStrikeoutPosition(SkScalar* position)</a> const; };</pre> -<a href="#SkPaint_FontMetrics">FontMetrics</a> is filled out by <a href="#SkPaint_getFontMetrics">getFontMetrics</a>. <a href="#SkPaint_FontMetrics">FontMetrics</a> contents reflect the values -computed by <a href="undocumented#Font_Manager">Font Manager</a> using <a href="undocumented#Typeface">Typeface</a>. Values are set to zero if they are -not available. - -<a href="#SkPaint_FontMetrics_fUnderlineThickness">fUnderlineThickness</a> and <a href="#SkPaint_FontMetrics_fUnderlinePosition">fUnderlinePosition</a> have a bit set in <a href="#SkPaint_FontMetrics_fFlags">fFlags</a> if their values -are valid, since their value may be zero. -<a href="#SkPaint_FontMetrics_fStrikeoutThickness">fStrikeoutThickness</a> and <a href="#SkPaint_FontMetrics_fStrikeoutPosition">fStrikeoutPosition</a> have a bit set in <a href="#SkPaint_FontMetrics_fFlags">fFlags</a> if their values -are valid, since their value may be zero. - ## <a name="SkPaint_FontMetrics_FontMetricsFlags"></a> Enum SkPaint::FontMetrics::FontMetricsFlags +<a href="#SkPaint_FontMetrics_FontMetricsFlags">FontMetricsFlags</a> are set in <a href="#SkPaint_FontMetrics_fFlags">fFlags</a> 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. + <pre style="padding: 1em 1em 1em 1em;width: 44em; background-color: #f0f0f0"> enum <a href="#SkPaint_FontMetrics_FontMetricsFlags">FontMetricsFlags</a> { <a href="#SkPaint_FontMetrics_kUnderlineThicknessIsValid_Flag">kUnderlineThicknessIsValid Flag</a> = 1 << 0, @@ -4115,10 +4118,6 @@ enum <a href="#SkPaint_FontMetrics_FontMetricsFlags">FontMetricsFlags</a> { <a href="#SkPaint_FontMetrics_kStrikeoutPositionIsValid_Flag">kStrikeoutPositionIsValid Flag</a> = 1 << 3, };</pre> -<a href="#SkPaint_FontMetrics_FontMetricsFlags">FontMetricsFlags</a> are set in <a href="#SkPaint_FontMetrics_fFlags">fFlags</a> 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. - ### Constants <table> |