2017-07-28 19:18:29 +00:00
SkPaint Reference
===
# <a name="Paint"></a> Paint
2017-09-15 06:56:12 +00:00
# <a name="SkPaint"></a> Class SkPaint
2017-08-25 15:51:49 +00:00
< 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 > .
2017-07-28 19:18:29 +00:00
2018-01-04 21:11:51 +00:00
Various options apply to text, strokes and fills, and images.
2017-07-28 19:18:29 +00:00
Some options may not be implemented on all platforms; in these cases, setting
2017-08-04 16:48:24 +00:00
the option has no effect. Some options are conveniences that duplicate < a href = "SkCanvas_Reference#Canvas" > Canvas< / a >
2017-07-28 19:18:29 +00:00
functionality; for instance, text size is identical to matrix scale.
2017-08-25 15:51:49 +00:00
< a href = "#Paint" > Paint< / a > options are rarely exclusive; each option modifies a stage of the drawing
pipeline and multiple pipeline stages may be affected by a single < a href = "#Paint" > Paint< / a > .
2017-07-28 19:18:29 +00:00
2018-01-04 21:11:51 +00:00
< a href = "#Paint" > Paint< / a > collects effects and filters that describe single-pass and multiple-pass
2017-07-28 19:18:29 +00:00
algorithms that alter the drawing geometry, color, and transparency. For instance,
2018-01-04 21:11:51 +00:00
< a href = "#Paint" > Paint< / a > does not directly implement dashing or blur, but contains the objects that do so.
2017-07-28 19:18:29 +00:00
2017-08-25 15:51:49 +00:00
The objects contained by < a href = "#Paint" > Paint< / a > are opaque, and cannot be edited outside of the < a href = "#Paint" > Paint< / a >
2017-07-28 19:18:29 +00:00
to affect it. The implementation is free to defer computations associated with the
2018-01-04 21:11:51 +00:00
< a href = "#Paint" > Paint< / a > , or ignore them altogether. For instance, some GPU implementations draw all
< a href = "SkPath_Reference#Path" > Path< / a > geometries with Anti-aliasing, regardless of how < a href = "#SkPaint_kAntiAlias_Flag" > SkPaint::kAntiAlias Flag< / a >
2017-08-25 15:51:49 +00:00
is set in < a href = "#Paint" > Paint< / a > .
2017-07-28 19:18:29 +00:00
2017-08-25 15:51:49 +00:00
< a href = "#Paint" > Paint< / a > describes a single color, a single font, a single image quality, and so on.
2017-07-28 19:18:29 +00:00
Multiple colors are drawn either by using multiple paints or with objects like
2017-08-25 15:51:49 +00:00
< a href = "undocumented#Shader" > Shader< / a > attached to < a href = "#Paint" > Paint< / a > .
2017-07-28 19:18:29 +00:00
# <a name="Overview"></a> Overview
## <a name="Subtopics"></a> Subtopics
2018-01-22 12:55:48 +00:00
| name | description |
2017-07-28 19:18:29 +00:00
| --- | --- |
2018-01-22 12:55:48 +00:00
| < a href = "#Overview_Classes_and_Structs" > Classes and Structs< / a > | embedded struct and class members |
| < a href = "#Overview_Constants" > Constants< / a > | enum and enum class, const values |
| < a href = "#Overview_Constructors" > Constructors< / a > | list of functions that construct < a href = "SkPath_Reference#SkPath" > SkPath< / a > |
| < a href = "#Overview_Member_Functions" > Member Functions< / a > | list of static functions and member methods |
| < a href = "#Overview_Operators" > Operators< / a > | operator overloading methods |
| < a href = "#Overview_Related_Functions" > Related Functions< / a > | similar methods grouped together |
## <a name="Related_Functions"></a> Related Functions
| name | description |
| --- | --- |
| Anti-alias | approximating coverage with transparency |
| < a href = "#Automatic_Hinting" > Automatic Hinting< / a > | always adjust glyph paths |
| < a href = "#Blend_Mode_Methods" > Blend Mode Methods< / a > | get and set < a href = "undocumented#Blend_Mode" > Blend Mode< / a > |
| < a href = "#Color_Filter_Methods" > Color Filter Methods< / a > | get and set < a href = "undocumented#Color_Filter" > Color Filter< / a > |
| < a href = "#Color_Methods" > Color Methods< / a > | get and set < a href = "undocumented#Color" > Color< / a > |
| Destructor | paint termination |
| < a href = "#Device_Text" > Device Text< / a > | increase precision of glyph position |
| < a href = "#Dither" > Dither< / a > | distributing color error |
| < a href = "#Draw_Looper_Methods" > Draw Looper Methods< / a > | get and set < a href = "undocumented#Draw_Looper" > Draw Looper< / a > |
| < a href = "#Fake_Bold" > Fake Bold< / a > | approximate font styles |
| < a href = "#Fast_Bounds" > Fast Bounds< / a > | approximate area required by < a href = "#Paint" > Paint< / a > |
| < a href = "#Fill_Path" > Fill Path< / a > | make < a href = "SkPath_Reference#Path" > Path< / a > from < a href = "undocumented#Path_Effect" > Path Effect< / a > , stroking |
| < a href = "#Filter_Quality_Methods" > Filter Quality Methods< / a > | get and set < a href = "undocumented#Filter_Quality" > Filter Quality< / a > |
| < a href = "#SkPaint_Flags" > Flags< / a > | attributes represented by single bits |
| < a href = "SkPaint_Reference#Font_Embedded_Bitmaps" > Font Embedded Bitmaps< / a > | custom sized bitmap < a href = "#Glyph" > Glyphs< / a > |
| < a href = "#Font_Metrics" > Font Metrics< / a > | common glyph dimensions |
| < a href = "SkPaint_Reference#Full_Hinting_Spacing" > Full Hinting Spacing< / a > | glyph spacing affected by hinting |
| < a href = "#SkPaint_Hinting" > Hinting< / a > | glyph outline adjustment |
| < a href = "#Image_Filter_Methods" > Image Filter Methods< / a > | get and set < a href = "undocumented#Image_Filter" > Image Filter< / a > |
| < a href = "#Initializers" > Initializers< / a > | constructors and initialization |
| < a href = "#Management" > Management< / a > | paint copying, moving, comparing |
| < a href = "#Mask_Filter_Methods" > Mask Filter Methods< / a > | get and set < a href = "undocumented#Mask_Filter" > Mask Filter< / a > |
| < a href = "#Measure_Text" > Measure Text< / a > | width, height, bounds of text |
| < a href = "#Miter_Limit" > Miter Limit< / a > | maximum length of stroked corners |
| < a href = "#Path_Effect_Methods" > Path Effect Methods< / a > | get and set < a href = "undocumented#Path_Effect" > Path Effect< / a > |
| < a href = "#Shader_Methods" > Shader Methods< / a > | get and set < a href = "undocumented#Shader" > Shader< / a > |
| < a href = "#Stroke_Cap" > Stroke Cap< / a > | decorations at ends of open strokes |
| < a href = "#Stroke_Join" > Stroke Join< / a > | decoration at corners of strokes |
| < a href = "#Stroke_Width" > Stroke Width< / a > | thickness perpendicular to geometry |
| < a href = "#SkPaint_Style" > Style< / a > | geometry filling, stroking |
| < a href = "#Text_Align" > Text Align< / a > | text placement relative to position |
| < a href = "#Text_Encoding" > Text Encoding< / a > | text encoded as characters or < a href = "#Glyph" > Glyphs< / a > |
| < a href = "#Text_Intercepts" > Text Intercepts< / a > | advanced underline, strike through |
| < a href = "#Text_Path" > Text Path< / a > | geometry of < a href = "#Glyph" > Glyphs< / a > |
| < a href = "#Text_Scale_X" > Text Scale X< / a > | text horizontal scale |
| < a href = "#Text_Size" > Text Size< / a > | overall height in points |
| < a href = "#Text_Skew_X" > Text Skew X< / a > | text horizontal slant |
| < a href = "#Typeface_Methods" > Typeface Methods< / a > | get and set < a href = "undocumented#Typeface" > Typeface< / a > |
| < a href = "#Vertical_Text" > Vertical Text< / a > | orient text from top to bottom |
2017-07-28 19:18:29 +00:00
## <a name="Constants"></a> Constants
2018-01-22 12:55:48 +00:00
| name | description |
2017-07-28 19:18:29 +00:00
| --- | --- |
2018-01-22 12:55:48 +00:00
| < a href = "#SkPaint_Align" > Align< / a > | glyph locations relative to text position |
| < a href = "#SkPaint_Cap" > Cap< / a > | start and end geometry on stroked shapes |
| < a href = "#SkPaint_Flags" > Flags< / a > | values described by bits and masks |
| < a href = "#SkPaint_FontMetrics_FontMetricsFlags" > FontMetrics::FontMetricsFlags< / a > | valid < a href = "#Font_Metrics" > Font Metrics< / a > |
| < a href = "#SkPaint_Hinting" > Hinting< / a > | level of glyph outline adjustment |
| < a href = "#SkPaint_Join" > Join< / a > | corner geometry on stroked shapes |
| < a href = "#SkPaint_Style" > Style< / a > | stroke, fill, or both |
| < a href = "#SkPaint_TextEncoding" > TextEncoding< / a > | character or glyph encoded size |
## <a name="Classes_and_Structs"></a> Classes and Structs
| name | description |
2017-07-28 19:18:29 +00:00
| --- | --- |
2018-01-22 12:55:48 +00:00
| < a href = "#SkPaint_FontMetrics" > FontMetrics< / a > | typeface values |
2017-07-28 19:18:29 +00:00
## <a name="Constructors"></a> Constructors
2018-01-22 12:55:48 +00:00
| name | description |
2017-07-28 19:18:29 +00:00
| --- | --- |
2018-01-22 12:55:48 +00:00
| < a href = "#SkPaint_empty_constructor" > SkPaint()< / a > | constructs with default values |
| < a href = "#SkPaint_move_SkPaint" > SkPaint(SkPaint& & paint)< / a > | moves paint without copying it |
| < a href = "#SkPaint_copy_const_SkPaint" > SkPaint(const SkPaint& paint)< / a > | makes a shallow copy |
| | decreases < a href = "undocumented#Reference_Count" > Reference Count< / a > of owned objects |
2017-07-28 19:18:29 +00:00
## <a name="Operators"></a> Operators
2018-01-22 12:55:48 +00:00
| name | description |
2017-07-28 19:18:29 +00:00
| --- | --- |
2018-01-22 12:55:48 +00:00
| < a href = "#SkPaint_notequal_operator" > operator!=(const SkPaint& a, const SkPaint& b)< / a > | compares paints for inequality |
| < a href = "#SkPaint_move_operator" > operator=(SkPaint& & paint)< / a > | moves paint without copying it |
| < a href = "#SkPaint_copy_operator" > operator=(const SkPaint& paint)< / a > | makes a shallow copy |
| < a href = "#SkPaint_equal_operator" > operator==(const SkPaint& a, const SkPaint& b)< / a > | compares paints for equality |
2017-07-28 19:18:29 +00:00
## <a name="Member_Functions"></a> Member Functions
2018-01-22 12:55:48 +00:00
| name | description |
2017-07-28 19:18:29 +00:00
| --- | --- |
2018-01-22 12:55:48 +00:00
| < a href = "#SkPaint_breakText" > breakText< / a > | returns text that fits in a width |
| < a href = "#SkPaint_canComputeFastBounds" > canComputeFastBounds< / a > | returns true if settings allow for fast bounds computation |
| < a href = "#SkPaint_computeFastBounds" > computeFastBounds< / a > | returns fill bounds for quick reject tests |
| < a href = "#SkPaint_computeFastStrokeBounds" > computeFastStrokeBounds< / a > | returns stroke bounds for quick reject tests |
| < a href = "#SkPaint_containsText" > containsText< / a > | returns if all text corresponds to < a href = "#Glyph" > Glyphs< / a > |
| < a href = "#SkPaint_countText" > countText< / a > | returns number of < a href = "#Glyph" > Glyphs< / a > in text |
| < a href = "#SkPaint_doComputeFastBounds" > doComputeFastBounds< / a > | returns bounds for quick reject tests |
| < a href = "#SkPaint_flatten" > flatten< / a > | serializes into a buffer |
| < a href = "#SkPaint_getAlpha" > getAlpha< / a > | returns < a href = "#Alpha" > Color Alpha< / a > , color opacity |
| < a href = "#SkPaint_getBlendMode" > getBlendMode< / a > | returns < a href = "undocumented#Blend_Mode" > Blend Mode< / a > , how colors combine with < a href = "undocumented#Device" > Device< / a > |
| < a href = "#SkPaint_getColor" > getColor< / a > | returns < a href = "#Alpha" > Color Alpha< / a > and < a href = "#RGB" > Color RGB< / a > , one drawing color |
| < a href = "#SkPaint_getColorFilter" > getColorFilter< / a > | returns < a href = "undocumented#Color_Filter" > Color Filter< / a > , how colors are altered |
| < a href = "#SkPaint_getDrawLooper" > getDrawLooper< / a > | returns < a href = "undocumented#Draw_Looper" > Draw Looper< / a > , multiple layers |
| < a href = "#SkPaint_getFillPath" > getFillPath< / a > | returns fill path equivalent to stroke |
| < a href = "#SkPaint_getFilterQuality" > getFilterQuality< / a > | returns < a href = "undocumented#Filter_Quality" > Filter Quality< / a > , image filtering level |
| < a href = "#SkPaint_getFlags" > getFlags< / a > | returns < a href = "#SkPaint_Flags" > Flags< / a > stored in a bit field |
| < a href = "#SkPaint_getFontBounds" > getFontBounds< / a > | returns union all glyph bounds |
| < a href = "#SkPaint_getFontMetrics" > getFontMetrics< / a > | returns < a href = "undocumented#Typeface" > Typeface< / a > metrics scaled by text size |
| < a href = "#SkPaint_getFontSpacing" > getFontSpacing< / a > | returns recommended spacing between lines |
| < a href = "#SkPaint_getHash" > getHash< / a > | returns a shallow hash for equality checks |
| < a href = "#SkPaint_getHinting" > getHinting< / a > | returns < a href = "#SkPaint_Hinting" > Hinting< / a > , glyph outline adjustment level |
| < a href = "#SkPaint_getImageFilter" > getImageFilter< / a > | returns < a href = "undocumented#Image_Filter" > Image Filter< / a > , alter pixels; blur |
| < a href = "#SkPaint_getMaskFilter" > getMaskFilter< / a > | returns < a href = "undocumented#Mask_Filter" > Mask Filter< / a > , alterations to < a href = "undocumented#Mask_Alpha" > Mask Alpha< / a > |
| < a href = "#SkPaint_getPathEffect" > getPathEffect< / a > | returns < a href = "undocumented#Path_Effect" > Path Effect< / a > , modifications to path geometry; dashing |
| < a href = "#SkPaint_getPosTextHIntercepts" > getPosTextHIntercepts< / a > | returns where lines intersect horizontally positioned text; underlines |
| < a href = "#SkPaint_getPosTextIntercepts" > getPosTextIntercepts< / a > | returns where lines intersect positioned text; underlines |
| < a href = "#SkPaint_getPosTextPath" > getPosTextPath< / a > | returns < a href = "SkPath_Reference#Path" > Path< / a > equivalent to positioned text |
| < a href = "#SkPaint_getShader" > getShader< / a > | returns < a href = "undocumented#Shader" > Shader< / a > , multiple drawing colors; gradients |
| < a href = "#SkPaint_getStrokeCap" > getStrokeCap< / a > | returns < a href = "#SkPaint_Cap" > Cap< / a > , the area drawn at path ends |
| < a href = "#SkPaint_getStrokeJoin" > getStrokeJoin< / a > | returns < a href = "#SkPaint_Join" > Join< / a > , geometry on path corners |
| < a href = "#SkPaint_getStrokeMiter" > getStrokeMiter< / a > | returns < a href = "#Miter_Limit" > Miter Limit< / a > , angles with sharp corners |
| < a href = "#SkPaint_getStrokeWidth" > getStrokeWidth< / a > | returns thickness of the stroke |
| < a href = "#SkPaint_getStyle" > getStyle< / a > | returns < a href = "#SkPaint_Style" > Style< / a > : stroke, fill, or both |
| < a href = "#SkPaint_getTextAlign" > getTextAlign< / a > | returns < a href = "#SkPaint_Align" > Align< / a > : left, center, or right |
| < a href = "#SkPaint_getTextBlobIntercepts" > getTextBlobIntercepts< / a > | returns where lines intersect < a href = "undocumented#Text_Blob" > Text Blob< / a > ; underlines |
| < a href = "#SkPaint_getTextEncoding" > getTextEncoding< / a > | returns character or glyph encoded size |
| < a href = "#SkPaint_getTextIntercepts" > getTextIntercepts< / a > | returns where lines intersect text; underlines |
| < a href = "#SkPaint_getTextPath" > getTextPath< / a > | returns < a href = "SkPath_Reference#Path" > Path< / a > equivalent to text |
| < a href = "#SkPaint_getTextScaleX" > getTextScaleX< / a > | returns the text horizontal scale; condensed text |
| < a href = "#SkPaint_getTextSize" > getTextSize< / a > | returns text size in points |
| < a href = "#SkPaint_getTextSkewX" > getTextSkewX< / a > | returns the text horizontal skew; oblique text |
| < a href = "#SkPaint_getTextWidths" > getTextWidths< / a > | returns advance and bounds for each glyph in text |
| < a href = "#SkPaint_getTypeface" > getTypeface< / a > | returns < a href = "undocumented#Typeface" > Typeface< / a > , font description |
| < a href = "#SkPaint_glyphsToUnichars" > glyphsToUnichars< / a > | converts < a href = "#Glyph" > Glyphs< / a > into text |
| < a href = "#SkPaint_isAntiAlias" > isAntiAlias< / a > | returns true if Anti-alias is set |
| < a href = "#SkPaint_isAutohinted" > isAutohinted< / a > | returns true if < a href = "#Glyph" > Glyphs< / a > are always hinted |
| < a href = "#SkPaint_isDevKernText" > isDevKernText< / a > | returns true if < a href = "SkPaint_Reference#Full_Hinting_Spacing" > Full Hinting Spacing< / a > is set |
| < a href = "#SkPaint_isDither" > isDither< / a > | returns true if < a href = "#Dither" > Dither< / a > is set |
| < a href = "#SkPaint_isEmbeddedBitmapText" > isEmbeddedBitmapText< / a > | returns true if < a href = "SkPaint_Reference#Font_Embedded_Bitmaps" > Font Embedded Bitmaps< / a > is set |
| < a href = "#SkPaint_isFakeBoldText" > isFakeBoldText< / a > | returns true if < a href = "#Fake_Bold" > Fake Bold< / a > is set |
| < a href = "#SkPaint_isLCDRenderText" > isLCDRenderText< / a > | returns true if < a href = "SkPaint_Reference#LCD_Text" > LCD Text< / a > is set |
| < a href = "#SkPaint_isSrcOver" > isSrcOver< / a > | returns true if < a href = "undocumented#Blend_Mode" > Blend Mode< / a > is < a href = "#SkBlendMode_kSrcOver" > SkBlendMode::kSrcOver< / a > |
| < a href = "#SkPaint_isSubpixelText" > isSubpixelText< / a > | returns true if < a href = "SkPaint_Reference#Subpixel_Text" > Subpixel Text< / a > is set |
| < a href = "#SkPaint_isVerticalText" > isVerticalText< / a > | returns true if < a href = "#Vertical_Text" > Vertical Text< / a > is set |
| < a href = "#SkPaint_measureText" > measureText< / a > | returns advance width and bounds of text |
| < a href = "#SkPaint_nothingToDraw" > nothingToDraw< / a > | returns true if < a href = "#Paint" > Paint< / a > prevents all drawing |
| < a href = "#SkPaint_refColorFilter" > refColorFilter< / a > | references < a href = "undocumented#Color_Filter" > Color Filter< / a > , how colors are altered |
| < a href = "#SkPaint_refDrawLooper" > refDrawLooper< / a > | references < a href = "undocumented#Draw_Looper" > Draw Looper< / a > , multiple layers |
| < a href = "#SkPaint_refImageFilter" > refImageFilter< / a > | references < a href = "undocumented#Image_Filter" > Image Filter< / a > , alter pixels; blur |
| < a href = "#SkPaint_refMaskFilter" > refMaskFilter< / a > | references < a href = "undocumented#Mask_Filter" > Mask Filter< / a > , alterations to < a href = "undocumented#Mask_Alpha" > Mask Alpha< / a > |
| < a href = "#SkPaint_refPathEffect" > refPathEffect< / a > | references < a href = "undocumented#Path_Effect" > Path Effect< / a > , modifications to path geometry; dashing |
| < a href = "#SkPaint_refShader" > refShader< / a > | references < a href = "undocumented#Shader" > Shader< / a > , multiple drawing colors; gradients |
| < a href = "#SkPaint_refTypeface" > refTypeface< / a > | references < a href = "undocumented#Typeface" > Typeface< / a > , font description |
| < a href = "#SkPaint_reset" > reset< / a > | sets to default values |
| < a href = "#SkPaint_setARGB" > setARGB< / a > | sets color by component |
| < a href = "#SkPaint_setAlpha" > setAlpha< / a > | sets < a href = "#Alpha" > Color Alpha< / a > , color opacity |
| < a href = "#SkPaint_setAntiAlias" > setAntiAlias< / a > | sets or clears Anti-alias |
| < a href = "#SkPaint_setAutohinted" > setAutohinted< / a > | sets < a href = "#Glyph" > Glyphs< / a > to always be hinted |
| < a href = "#SkPaint_setBlendMode" > setBlendMode< / a > | sets < a href = "undocumented#Blend_Mode" > Blend Mode< / a > , how colors combine with destination |
| < a href = "#SkPaint_setColor" > setColor< / a > | sets < a href = "#Alpha" > Color Alpha< / a > and < a href = "#RGB" > Color RGB< / a > , one drawing color |
| < a href = "#SkPaint_setColorFilter" > setColorFilter< / a > | sets < a href = "undocumented#Color_Filter" > Color Filter< / a > , alters color |
| < a href = "#SkPaint_setDevKernText" > setDevKernText< / a > | sets or clears < a href = "SkPaint_Reference#Full_Hinting_Spacing" > Full Hinting Spacing< / a > |
| < a href = "#SkPaint_setDither" > setDither< / a > | sets or clears < a href = "#Dither" > Dither< / a > |
| < a href = "#SkPaint_setDrawLooper" > setDrawLooper< / a > | sets < a href = "undocumented#Draw_Looper" > Draw Looper< / a > , multiple layers |
| < a href = "#SkPaint_setEmbeddedBitmapText" > setEmbeddedBitmapText< / a > | sets or clears < a href = "SkPaint_Reference#Font_Embedded_Bitmaps" > Font Embedded Bitmaps< / a > |
| < a href = "#SkPaint_setFakeBoldText" > setFakeBoldText< / a > | sets or clears < a href = "#Fake_Bold" > Fake Bold< / a > |
| < a href = "#SkPaint_setFilterQuality" > setFilterQuality< / a > | sets < a href = "undocumented#Filter_Quality" > Filter Quality< / a > , the image filtering level |
| < a href = "#SkPaint_setFlags" > setFlags< / a > | sets multiple < a href = "#SkPaint_Flags" > Flags< / a > in a bit field |
| < a href = "#SkPaint_setHinting" > setHinting< / a > | sets < a href = "#SkPaint_Hinting" > Hinting< / a > , glyph outline adjustment level |
| < a href = "#SkPaint_setImageFilter" > setImageFilter< / a > | sets < a href = "undocumented#Image_Filter" > Image Filter< / a > , alter pixels; blur |
| < a href = "#SkPaint_setLCDRenderText" > setLCDRenderText< / a > | sets or clears < a href = "SkPaint_Reference#LCD_Text" > LCD Text< / a > |
| < a href = "#SkPaint_setMaskFilter" > setMaskFilter< / a > | sets < a href = "undocumented#Mask_Filter" > Mask Filter< / a > , alterations to < a href = "undocumented#Mask_Alpha" > Mask Alpha< / a > |
| < a href = "#SkPaint_setPathEffect" > setPathEffect< / a > | sets < a href = "undocumented#Path_Effect" > Path Effect< / a > , modifications to path geometry; dashing |
| < a href = "#SkPaint_setShader" > setShader< / a > | sets < a href = "undocumented#Shader" > Shader< / a > , multiple drawing colors; gradients |
| < a href = "#SkPaint_setStrokeCap" > setStrokeCap< / a > | sets < a href = "#SkPaint_Cap" > Cap< / a > , the area drawn at path ends |
| < a href = "#SkPaint_setStrokeJoin" > setStrokeJoin< / a > | sets < a href = "#SkPaint_Join" > Join< / a > , geometry on path corners |
| < a href = "#SkPaint_setStrokeMiter" > setStrokeMiter< / a > | sets < a href = "#Miter_Limit" > Miter Limit< / a > , angles with sharp corners |
| < a href = "#SkPaint_setStrokeWidth" > setStrokeWidth< / a > | sets thickness of the stroke |
| < a href = "#SkPaint_setStyle" > setStyle< / a > | sets < a href = "#SkPaint_Style" > Style< / a > : stroke, fill, or both |
| < a href = "#SkPaint_setSubpixelText" > setSubpixelText< / a > | sets or clears < a href = "SkPaint_Reference#Subpixel_Text" > Subpixel Text< / a > |
| < a href = "#SkPaint_setTextAlign" > setTextAlign< / a > | sets < a href = "#SkPaint_Align" > Align< / a > : left, center, or right |
| < a href = "#SkPaint_setTextEncoding" > setTextEncoding< / a > | sets character or glyph encoded size |
| < a href = "#SkPaint_setTextScaleX" > setTextScaleX< / a > | sets the text horizontal scale; condensed text |
| < a href = "#SkPaint_setTextSize" > setTextSize< / a > | sets text size in points |
| < a href = "#SkPaint_setTextSkewX" > setTextSkewX< / a > | sets the text horizontal skew; oblique text |
| < a href = "#SkPaint_setTypeface" > setTypeface< / a > | sets < a href = "undocumented#Typeface" > Typeface< / a > , font description |
| < a href = "#SkPaint_setVerticalText" > setVerticalText< / a > | sets or clears < a href = "#Vertical_Text" > Vertical Text< / a > |
| < a href = "#SkPaint_textToGlyphs" > textToGlyphs< / a > | converts text into glyph indices |
| < a href = "#SkPaint_toString" > toString< / a > | converts < a href = "#Paint" > Paint< / a > to machine readable form |
| < a href = "#SkPaint_unflatten" > unflatten< / a > | populates from a serialized stream |
2017-07-28 19:18:29 +00:00
# <a name="Initializers"></a> Initializers
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_empty_constructor" > < / a >
2017-07-28 19:18:29 +00:00
## SkPaint
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-07-28 19:18:29 +00:00
SkPaint()
< / pre >
2017-08-25 15:51:49 +00:00
Constructs < a href = "#Paint" > Paint< / a > with default values.
2017-07-28 19:18:29 +00:00
| attribute | default value |
| --- | --- |
2017-11-27 15:44:06 +00:00
| Anti-alias | false |
2017-08-25 15:51:49 +00:00
| < a href = "undocumented#Blend_Mode" > Blend Mode< / a > | < a href = "#SkBlendMode_kSrcOver" > SkBlendMode::kSrcOver< / a > |
2017-08-04 16:48:24 +00:00
| < a href = "undocumented#Color" > Color< / a > | < a href = "undocumented#SK_ColorBLACK" > SK ColorBLACK< / a > |
2017-08-25 15:51:49 +00:00
| < a href = "#Alpha" > Color Alpha< / a > | 255 |
2017-08-04 16:48:24 +00:00
| < a href = "undocumented#Color_Filter" > Color Filter< / a > | nullptr |
2017-08-25 15:51:49 +00:00
| < a href = "#Dither" > Dither< / a > | false |
2017-08-04 16:48:24 +00:00
| < a href = "undocumented#Draw_Looper" > Draw Looper< / a > | nullptr |
2017-08-25 15:51:49 +00:00
| < a href = "#Fake_Bold" > Fake Bold< / a > | false |
2017-08-04 16:48:24 +00:00
| < a href = "undocumented#Filter_Quality" > Filter Quality< / a > | < a href = "undocumented#SkFilterQuality" > kNone SkFilterQuality< / a > |
| < a href = "SkPaint_Reference#Font_Embedded_Bitmaps" > Font Embedded Bitmaps< / a > | false |
2017-08-25 15:51:49 +00:00
| < a href = "#Automatic_Hinting" > Automatic Hinting< / a > | false |
2017-08-04 16:48:24 +00:00
| < a href = "SkPaint_Reference#Full_Hinting_Spacing" > Full Hinting Spacing< / a > | false |
2017-08-25 15:51:49 +00:00
| < a href = "#SkPaint_Hinting" > Hinting< / a > | < a href = "#SkPaint_kNormal_Hinting" > kNormal Hinting< / a > |
2017-08-04 16:48:24 +00:00
| < a href = "undocumented#Image_Filter" > Image Filter< / a > | nullptr |
| < a href = "SkPaint_Reference#LCD_Text" > LCD Text< / a > | false |
| < a href = "SkPaint_Reference#Linear_Text" > Linear Text< / a > | false |
2017-08-25 15:51:49 +00:00
| < a href = "#Miter_Limit" > Miter Limit< / a > | 4 |
2017-08-04 16:48:24 +00:00
| < a href = "undocumented#Mask_Filter" > Mask Filter< / a > | nullptr |
| < a href = "undocumented#Path_Effect" > Path Effect< / a > | nullptr |
| < a href = "undocumented#Shader" > Shader< / a > | nullptr |
2017-08-25 15:51:49 +00:00
| < a href = "#SkPaint_Style" > Style< / a > | < a href = "#SkPaint_kFill_Style" > kFill Style< / a > |
| < a href = "#Text_Align" > Text Align< / a > | < a href = "#SkPaint_kLeft_Align" > kLeft Align< / a > |
| < a href = "#Text_Encoding" > Text Encoding< / a > | < a href = "#SkPaint_kUTF8_TextEncoding" > kUTF8 TextEncoding< / a > |
| < a href = "#Text_Scale_X" > Text Scale X< / a > | 1 |
| < a href = "#Text_Size" > Text Size< / a > | 12 |
| < a href = "#Text_Skew_X" > Text Skew X< / a > | 0 |
2017-08-04 16:48:24 +00:00
| < a href = "undocumented#Typeface" > Typeface< / a > | nullptr |
2017-08-25 15:51:49 +00:00
| < a href = "#Stroke_Cap" > Stroke Cap< / a > | < a href = "#SkPaint_kButt_Cap" > kButt Cap< / a > |
| < a href = "#Stroke_Join" > Stroke Join< / a > | < a href = "#SkPaint_kMiter_Join" > kMiter Join< / a > |
| < a href = "#Stroke_Width" > Stroke Width< / a > | 0 |
2017-08-04 16:48:24 +00:00
| < a href = "SkPaint_Reference#Subpixel_Text" > Subpixel Text< / a > | false |
2017-08-25 15:51:49 +00:00
| < a href = "#Vertical_Text" > Vertical Text< / a > | false |
2017-07-28 19:18:29 +00:00
The flags, text size, hinting, and miter limit may be overridden at compile time by defining
2018-01-04 21:11:51 +00:00
paint default values. The overrides may be included in "SkUserConfig.h" or predefined by the
2017-07-28 19:18:29 +00:00
build system.
### Return Value
2017-08-25 15:51:49 +00:00
default initialized < a href = "#Paint" > Paint< / a >
2017-07-28 19:18:29 +00:00
### Example
< div > < fiddle-embed name = "c4b2186d85c142a481298f7144295ffd" > < / fiddle-embed > < / div >
---
2017-08-29 21:36:51 +00:00
< a name = "SkPaint_copy_const_SkPaint" > < / a >
2017-07-28 19:18:29 +00:00
## SkPaint
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-07-28 19:18:29 +00:00
SkPaint(const SkPaint& paint)
< / pre >
2017-08-25 15:51:49 +00:00
Makes a shallow copy of < a href = "#Paint" > Paint< / a > . < a href = "undocumented#Typeface" > Typeface< / a > , < a href = "undocumented#Path_Effect" > Path Effect< / a > , < a href = "undocumented#Shader" > Shader< / a > ,
2018-01-22 05:50:26 +00:00
< a href = "undocumented#Mask_Filter" > Mask Filter< / a > , < a href = "undocumented#Color_Filter" > Color Filter< / a > , < a href = "undocumented#Draw_Looper" > Draw Looper< / a > , and < a href = "undocumented#Image_Filter" > Image Filter< / a > are shared
2017-08-29 21:36:51 +00:00
between the original < a href = "#SkPaint_copy_const_SkPaint_paint" > paint< / a > and the copy. Objects containing < a href = "undocumented#Reference_Count" > Reference Count< / a > increment
2017-08-03 21:14:08 +00:00
their references by one.
2017-07-28 19:18:29 +00:00
2018-01-22 05:50:26 +00:00
The referenced objects < a href = "undocumented#Path_Effect" > Path Effect< / a > , < a href = "undocumented#Shader" > Shader< / a > , < a href = "undocumented#Mask_Filter" > Mask Filter< / a > , < a href = "undocumented#Color_Filter" > Color Filter< / a > ,
2017-08-04 16:48:24 +00:00
< a href = "undocumented#Draw_Looper" > Draw Looper< / a > , and < a href = "undocumented#Image_Filter" > Image Filter< / a > cannot be modified after they are created.
2017-08-25 15:51:49 +00:00
This prevents objects with < a href = "undocumented#Reference_Count" > Reference Count< / a > from being modified once < a href = "#Paint" > Paint< / a > refers to them.
2017-07-28 19:18:29 +00:00
### Parameters
2017-08-29 21:36:51 +00:00
< table > < tr > < td > < a name = "SkPaint_copy_const_SkPaint_paint" > < code > < strong > paint < / strong > < / code > < / a > < / td > < td >
2017-07-28 19:18:29 +00:00
original to copy< / td >
< / tr >
< / table >
### Return Value
2017-08-29 21:36:51 +00:00
shallow copy of < a href = "#SkPaint_copy_const_SkPaint_paint" > paint< / a >
2017-07-28 19:18:29 +00:00
### Example
< div > < fiddle-embed name = "b99971ad0ef243d617925289d963b62d" >
#### Example Output
~~~~
SK_ColorRED == paint1.getColor()
SK_ColorBLUE == paint2.getColor()
~~~~
< / fiddle-embed > < / div >
---
2017-08-29 21:36:51 +00:00
< a name = "SkPaint_move_SkPaint" > < / a >
2017-07-28 19:18:29 +00:00
## SkPaint
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-07-28 19:18:29 +00:00
SkPaint(SkPaint& & paint)
< / pre >
2017-09-14 15:25:39 +00:00
Implements a move constructor to avoid increasing the reference counts
2017-08-29 21:36:51 +00:00
of objects referenced by the < a href = "#SkPaint_move_SkPaint_paint" > paint< / a > .
2017-07-28 19:18:29 +00:00
2017-08-29 21:36:51 +00:00
After the call, < a href = "#SkPaint_move_SkPaint_paint" > paint< / a > is undefined, and can be safely destructed.
2017-07-28 19:18:29 +00:00
### Parameters
2017-08-29 21:36:51 +00:00
< table > < tr > < td > < a name = "SkPaint_move_SkPaint_paint" > < code > < strong > paint < / strong > < / code > < / a > < / td > < td >
2017-07-28 19:18:29 +00:00
original to move< / td >
< / tr >
< / table >
### Return Value
2017-08-29 21:36:51 +00:00
content of < a href = "#SkPaint_move_SkPaint_paint" > paint< / a >
2017-07-28 19:18:29 +00:00
### Example
< div > < fiddle-embed name = "8ed1488a503cd5282b86a51614aa90b1" >
#### Example Output
~~~~
path effect unique: true
~~~~
< / fiddle-embed > < / div >
---
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_reset" > < / a >
2017-07-28 19:18:29 +00:00
## reset
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-07-28 19:18:29 +00:00
void reset()
< / pre >
2017-10-04 18:31:33 +00:00
Sets all < a href = "#Paint" > Paint< / a > contents to their initial values. This is equivalent to replacing
< a href = "#Paint" > Paint< / a > with the result of < a href = "#SkPaint_empty_constructor" > SkPaint()< / a > .
2017-07-28 19:18:29 +00:00
### Example
< div > < fiddle-embed name = "ef269937ade7e7353635121d9a64f9f7" >
#### Example Output
~~~~
paint1 == paint2
~~~~
< / fiddle-embed > < / div >
---
# <a name="Destructor"></a> Destructor
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_destructor" > < / a >
2017-07-28 19:18:29 +00:00
## ~SkPaint
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-07-28 19:18:29 +00:00
~SkPaint()
< / pre >
2017-08-25 15:51:49 +00:00
Decreases < a href = "#Paint" > Paint< / a > < a href = "undocumented#Reference_Count" > Reference Count< / a > of owned objects: < a href = "undocumented#Typeface" > Typeface< / a > , < a href = "undocumented#Path_Effect" > Path Effect< / a > , < a href = "undocumented#Shader" > Shader< / a > ,
2018-01-22 05:50:26 +00:00
< a href = "undocumented#Mask_Filter" > Mask Filter< / a > , < a href = "undocumented#Color_Filter" > Color Filter< / a > , < a href = "undocumented#Draw_Looper" > Draw Looper< / a > , and < a href = "undocumented#Image_Filter" > Image Filter< / a > . If the
2017-08-04 16:48:24 +00:00
objects containing < a href = "undocumented#Reference_Count" > Reference Count< / a > go to zero, they are deleted.
2017-07-28 19:18:29 +00:00
---
# <a name="Management"></a> Management
2017-11-27 15:44:06 +00:00
< a name = "SkPaint_copy_operator" > < / a >
2017-07-28 19:18:29 +00:00
## operator=
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-07-28 19:18:29 +00:00
SkPaint& operator=(const SkPaint& paint)
< / pre >
2017-08-25 15:51:49 +00:00
Makes a shallow copy of < a href = "#Paint" > Paint< / a > . < a href = "undocumented#Typeface" > Typeface< / a > , < a href = "undocumented#Path_Effect" > Path Effect< / a > , < a href = "undocumented#Shader" > Shader< / a > ,
2018-01-22 05:50:26 +00:00
< a href = "undocumented#Mask_Filter" > Mask Filter< / a > , < a href = "undocumented#Color_Filter" > Color Filter< / a > , < a href = "undocumented#Draw_Looper" > Draw Looper< / a > , and < a href = "undocumented#Image_Filter" > Image Filter< / a > are shared
2017-11-27 15:44:06 +00:00
between the original < a href = "#SkPaint_copy_operator_paint" > paint< / a > and the copy. Objects containing < a href = "undocumented#Reference_Count" > Reference Count< / a > in the
2017-07-28 19:18:29 +00:00
prior destination are decreased by one, and the referenced objects are deleted if the
2017-11-27 15:44:06 +00:00
resulting count is zero. Objects containing < a href = "undocumented#Reference_Count" > Reference Count< / a > in the parameter < a href = "#SkPaint_copy_operator_paint" > paint< / a >
are increased by one. < a href = "#SkPaint_copy_operator_paint" > paint< / a > is unmodified.
2017-07-28 19:18:29 +00:00
### Parameters
2017-11-27 15:44:06 +00:00
< table > < tr > < td > < a name = "SkPaint_copy_operator_paint" > < code > < strong > paint < / strong > < / code > < / a > < / td > < td >
2017-07-28 19:18:29 +00:00
original to copy< / td >
< / tr >
< / table >
### Return Value
2017-11-27 15:44:06 +00:00
content of < a href = "#SkPaint_copy_operator_paint" > paint< / a >
2017-07-28 19:18:29 +00:00
### Example
< div > < fiddle-embed name = "b476a9088f80dece176ed577807d3992" >
#### Example Output
~~~~
SK_ColorRED == paint1.getColor()
SK_ColorRED == paint2.getColor()
~~~~
< / fiddle-embed > < / div >
---
2017-11-27 15:44:06 +00:00
< a name = "SkPaint_move_operator" > < / a >
2017-07-28 19:18:29 +00:00
## operator=
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-07-28 19:18:29 +00:00
SkPaint& operator=(SkPaint& & paint)
< / pre >
2017-11-27 15:44:06 +00:00
Moves the < a href = "#SkPaint_move_operator_paint" > paint< / a > to avoid increasing the reference counts
of objects referenced by the < a href = "#SkPaint_move_operator_paint" > paint< / a > parameter. Objects containing < a href = "undocumented#Reference_Count" > Reference Count< / a > in the
2017-08-03 21:14:08 +00:00
prior destination are decreased by one; those objects are deleted if the resulting count
is zero.
2017-07-28 19:18:29 +00:00
2017-11-27 15:44:06 +00:00
After the call, < a href = "#SkPaint_move_operator_paint" > paint< / a > is undefined, and can be safely destructed.
2017-07-28 19:18:29 +00:00
### Parameters
2017-11-27 15:44:06 +00:00
< table > < tr > < td > < a name = "SkPaint_move_operator_paint" > < code > < strong > paint < / strong > < / code > < / a > < / td > < td >
2017-07-28 19:18:29 +00:00
original to move< / td >
< / tr >
< / table >
### Return Value
2017-11-27 15:44:06 +00:00
content of < a href = "#SkPaint_move_operator_paint" > paint< / a >
2017-07-28 19:18:29 +00:00
### Example
< div > < fiddle-embed name = "9fb7459b097d713f5f1fe5675afe14f5" >
#### Example Output
~~~~
SK_ColorRED == paint2.getColor()
~~~~
< / fiddle-embed > < / div >
---
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_equal_operator" > < / a >
2017-07-28 19:18:29 +00:00
## operator==
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-07-28 19:18:29 +00:00
bool operator==(const SkPaint& a, const SkPaint& b)
< / pre >
2017-08-25 15:51:49 +00:00
Compares < a href = "#SkPaint_equal_operator_a" > a< / a > and < a href = "#SkPaint_equal_operator_b" > b< / a > , and returns true if < a href = "#SkPaint_equal_operator_a" > a< / a > and < a href = "#SkPaint_equal_operator_b" > b< / a > are equivalent. May return false
2018-01-22 05:50:26 +00:00
if < a href = "undocumented#Typeface" > Typeface< / a > , < a href = "undocumented#Path_Effect" > Path Effect< / a > , < a href = "undocumented#Shader" > Shader< / a > , < a href = "undocumented#Mask_Filter" > Mask Filter< / a > , < a href = "undocumented#Color_Filter" > Color Filter< / a > ,
2017-08-04 16:48:24 +00:00
< a href = "undocumented#Draw_Looper" > Draw Looper< / a > , or < a href = "undocumented#Image_Filter" > Image Filter< / a > have identical contents but different pointers.
2017-07-28 19:18:29 +00:00
### Parameters
2017-08-25 15:51:49 +00:00
< table > < tr > < td > < a name = "SkPaint_equal_operator_a" > < code > < strong > a < / strong > < / code > < / a > < / td > < td >
< a href = "#Paint" > Paint< / a > to compare< / td >
< / tr > < tr > < td > < a name = "SkPaint_equal_operator_b" > < code > < strong > b < / strong > < / code > < / a > < / td > < td >
< a href = "#Paint" > Paint< / a > to compare< / td >
2017-07-28 19:18:29 +00:00
< / tr >
< / table >
### Return Value
2017-08-25 15:51:49 +00:00
true if < a href = "#Paint" > Paint< / a > pair are equivalent
2017-07-28 19:18:29 +00:00
### Example
< div > < fiddle-embed name = "7481a948e34672720337a631830586dd" >
#### Example Output
~~~~
paint1 == paint2
paint1 != paint2
~~~~
< / fiddle-embed > < / div >
---
2017-11-27 15:44:06 +00:00
< a name = "SkPaint_notequal_operator" > < / a >
2017-07-28 19:18:29 +00:00
## operator!=
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-07-28 19:18:29 +00:00
bool operator!=(const SkPaint& a, const SkPaint& b)
< / pre >
2017-11-27 15:44:06 +00:00
Compares < a href = "#SkPaint_notequal_operator_a" > a< / a > and < a href = "#SkPaint_notequal_operator_b" > b< / a > , and returns true if < a href = "#SkPaint_notequal_operator_a" > a< / a > and < a href = "#SkPaint_notequal_operator_b" > b< / a > are not equivalent. May return true
2018-01-22 05:50:26 +00:00
if < a href = "undocumented#Typeface" > Typeface< / a > , < a href = "undocumented#Path_Effect" > Path Effect< / a > , < a href = "undocumented#Shader" > Shader< / a > , < a href = "undocumented#Mask_Filter" > Mask Filter< / a > , < a href = "undocumented#Color_Filter" > Color Filter< / a > ,
2017-08-04 16:48:24 +00:00
< a href = "undocumented#Draw_Looper" > Draw Looper< / a > , or < a href = "undocumented#Image_Filter" > Image Filter< / a > have identical contents but different pointers.
2017-07-28 19:18:29 +00:00
### Parameters
2017-11-27 15:44:06 +00:00
< table > < tr > < td > < a name = "SkPaint_notequal_operator_a" > < code > < strong > a < / strong > < / code > < / a > < / td > < td >
2017-08-25 15:51:49 +00:00
< a href = "#Paint" > Paint< / a > to compare< / td >
2017-11-27 15:44:06 +00:00
< / tr > < tr > < td > < a name = "SkPaint_notequal_operator_b" > < code > < strong > b < / strong > < / code > < / a > < / td > < td >
2017-08-25 15:51:49 +00:00
< a href = "#Paint" > Paint< / a > to compare< / td >
2017-07-28 19:18:29 +00:00
< / tr >
< / table >
### Return Value
2017-08-25 15:51:49 +00:00
true if < a href = "#Paint" > Paint< / a > pair are not equivalent
2017-07-28 19:18:29 +00:00
### Example
< div > < fiddle-embed name = "b6c8484b1187f555b435ad5369833be4" >
#### Example Output
~~~~
paint1 == paint2
paint1 == paint2
~~~~
< / fiddle-embed > < / div >
---
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_getHash" > < / a >
2017-07-28 19:18:29 +00:00
## getHash
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-07-28 19:18:29 +00:00
uint32_t getHash() const
< / pre >
2017-08-25 15:51:49 +00:00
Returns a hash generated from < a href = "#Paint" > Paint< / a > values and pointers.
2017-07-28 19:18:29 +00:00
Identical hashes guarantee that the paints are
equivalent, but differing hashes do not guarantee that the paints have differing
contents.
2017-08-25 15:51:49 +00:00
If < a href = "#SkPaint_equal_operator" > operator==(const SkPaint& a, const SkPaint& b)< / a > returns true for two paints,
2017-07-28 19:18:29 +00:00
their hashes are also equal.
The hash returned is platform and implementation specific.
### Return Value
a shallow hash
### Example
< div > < fiddle-embed name = "7f7e1b701361912b344f90ae6b530393" >
#### Example Output
~~~~
paint1 == paint2
paint1.getHash() == paint2.getHash()
~~~~
< / fiddle-embed > < / div >
---
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_flatten" > < / a >
2017-07-28 19:18:29 +00:00
## flatten
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-07-28 19:18:29 +00:00
void flatten(SkWriteBuffer& buffer) const
< / pre >
2017-08-25 15:51:49 +00:00
Serializes < a href = "#Paint" > Paint< / a > into a < a href = "#SkPaint_flatten_buffer" > buffer< / a > . A companion < a href = "#SkPaint_unflatten" > unflatten< / a > call
2017-07-28 19:18:29 +00:00
can reconstitute the paint at a later time.
### Parameters
2017-08-25 15:51:49 +00:00
< table > < tr > < td > < a name = "SkPaint_flatten_buffer" > < code > < strong > buffer < / strong > < / code > < / a > < / td > < td >
< a href = "undocumented#Write_Buffer" > Write Buffer< / a > receiving the flattened < a href = "#Paint" > Paint< / a > data< / td >
2017-07-28 19:18:29 +00:00
< / tr >
< / table >
---
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_unflatten" > < / a >
2017-07-28 19:18:29 +00:00
## unflatten
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2018-01-19 05:52:02 +00:00
bool unflatten(SkReadBuffer& buffer)
2017-07-28 19:18:29 +00:00
< / pre >
2017-08-25 15:51:49 +00:00
Populates < a href = "#Paint" > Paint< / a > , typically from a serialized stream, created by calling
< a href = "#SkPaint_flatten" > flatten< / a > at an earlier time.
2017-07-28 19:18:29 +00:00
2017-08-25 15:51:49 +00:00
< a href = "undocumented#SkReadBuffer" > SkReadBuffer< / a > class is not public, so < a href = "#SkPaint_unflatten" > unflatten< / a > cannot be meaningfully called
2017-07-28 19:18:29 +00:00
by the client.
### Parameters
2017-08-25 15:51:49 +00:00
< table > < tr > < td > < a name = "SkPaint_unflatten_buffer" > < code > < strong > buffer < / strong > < / code > < / a > < / td > < td >
2017-09-01 19:51:02 +00:00
serialized data describing < a href = "#Paint" > Paint< / a > content< / td >
2017-07-28 19:18:29 +00:00
< / tr >
< / table >
2018-01-19 05:52:02 +00:00
### Return Value
2018-01-22 12:55:48 +00:00
false if the < a href = "#SkPaint_unflatten_buffer" > buffer< / a > contains invalid data
2017-11-02 21:49:34 +00:00
### See Also
< a href = "undocumented#SkReadBuffer" > SkReadBuffer< / a >
2017-07-28 19:18:29 +00:00
---
# <a name="Hinting"></a> Hinting
2017-08-25 15:51:49 +00:00
## <a name="SkPaint_Hinting"></a> Enum SkPaint::Hinting
2017-07-28 19:18:29 +00:00
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-08-25 15:51:49 +00:00
enum < a href = "#Hinting" > Hinting< / a > {
< a href = "#SkPaint_kNo_Hinting" > kNo Hinting< / a > = 0,
< a href = "#SkPaint_kSlight_Hinting" > kSlight Hinting< / a > = 1,
< a href = "#SkPaint_kNormal_Hinting" > kNormal Hinting< / a > = 2,
< a href = "#SkPaint_kFull_Hinting" > kFull Hinting< / a > = 3,
2017-07-28 19:18:29 +00:00
};< / pre >
2017-08-25 15:51:49 +00:00
< a href = "#Hinting" > Hinting< / a > adjusts the glyph outlines so that the shape provides a uniform
look at a given point size on font engines that support it. < a href = "#Hinting" > Hinting< / a > may have a
2017-07-28 19:18:29 +00:00
muted effect or no effect at all depending on the platform.
2018-01-04 21:11:51 +00:00
The four levels roughly control corresponding features on platforms that use FreeType
2017-08-25 15:51:49 +00:00
as the < a href = "#Engine" > Font Engine< / a > .
2017-07-28 19:18:29 +00:00
### Constants
< table >
< tr >
2017-08-25 15:51:49 +00:00
< td > < a name = "SkPaint_kNo_Hinting" > < code > < strong > SkPaint::kNo_Hinting < / strong > < / code > < / a > < / td > < td > 0< / td > < td > Leaves glyph outlines unchanged from their native representation.
2018-01-04 21:11:51 +00:00
With FreeType, this is equivalent to the FT_LOAD_NO_HINTING
bit-field constant supplied to FT_Load_Glyph, which indicates that the vector
2017-07-28 19:18:29 +00:00
outline being loaded should not be fitted to the pixel grid but simply scaled
to 26.6 fractional pixels.< / td >
< / tr >
< tr >
2017-08-25 15:51:49 +00:00
< td > < a name = "SkPaint_kSlight_Hinting" > < code > < strong > SkPaint::kSlight_Hinting < / strong > < / code > < / a > < / td > < td > 1< / td > < td > Modifies glyph outlines minimally to improve constrast.
2018-01-04 21:11:51 +00:00
With FreeType, this is equivalent in spirit to the
FT_LOAD_TARGET_LIGHT value supplied to FT_Load_Glyph. It chooses a
2017-07-28 19:18:29 +00:00
lighter hinting algorithm for non-monochrome modes.
2017-09-01 19:51:02 +00:00
Generated < a href = "#Glyph" > Glyphs< / a > may be fuzzy but better resemble their original shape.< / td >
2017-07-28 19:18:29 +00:00
< / tr >
< tr >
2017-08-25 15:51:49 +00:00
< td > < a name = "SkPaint_kNormal_Hinting" > < code > < strong > SkPaint::kNormal_Hinting < / strong > < / code > < / a > < / td > < td > 2< / td > < td > Modifies glyph outlines to improve constrast. This is the default.
2018-01-04 21:11:51 +00:00
With FreeType, this supplies FT_LOAD_TARGET_NORMAL to FT_Load_Glyph,
choosing the default hinting algorithm, which is optimized for standard
2017-07-28 19:18:29 +00:00
gray-level rendering.< / td >
< / tr >
< tr >
2018-01-04 21:11:51 +00:00
< td > < a name = "SkPaint_kFull_Hinting" > < code > < strong > SkPaint::kFull_Hinting < / strong > < / code > < / a > < / td > < td > 3< / td > < td > Modifies glyph outlines for maxiumum constrast. With FreeType, this selects
FT_LOAD_TARGET_LCD or FT_LOAD_TARGET_LCD_V if < a href = "#SkPaint_kLCDRenderText_Flag" > kLCDRenderText Flag< / a > is set.
FT_LOAD_TARGET_LCD is a variant of FT_LOAD_TARGET_NORMAL optimized for
horizontally decimated LCD displays; FT_LOAD_TARGET_LCD_V is a
variant of FT_LOAD_TARGET_NORMAL optimized for vertically decimated LCD displays.< / td >
2017-07-28 19:18:29 +00:00
< / tr >
< / table >
2018-01-04 21:11:51 +00:00
On Windows with DirectWrite, < a href = "#Hinting" > Hinting< / a > has no effect.
2017-07-28 19:18:29 +00:00
2017-08-25 15:51:49 +00:00
< a href = "#Hinting" > Hinting< / a > defaults to < a href = "#SkPaint_kNormal_Hinting" > kNormal Hinting< / a > .
2017-08-04 16:48:24 +00:00
Set < a href = "undocumented#SkPaintDefaults_Hinting" > SkPaintDefaults Hinting< / a > at compile time to change the default setting.
2017-07-28 19:18:29 +00:00
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_getHinting" > < / a >
2017-07-28 19:18:29 +00:00
## getHinting
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-07-28 19:18:29 +00:00
Hinting getHinting() const
< / pre >
Returns level of glyph outline adjustment.
### Return Value
2017-08-25 15:51:49 +00:00
one of: < a href = "#SkPaint_kNo_Hinting" > kNo Hinting< / a > , < a href = "#SkPaint_kSlight_Hinting" > kSlight Hinting< / a > , < a href = "#SkPaint_kNormal_Hinting" > kNormal Hinting< / a > , < a href = "#SkPaint_kFull_Hinting" > kFull Hinting< / a >
2017-07-28 19:18:29 +00:00
### Example
< div > < fiddle-embed name = "329e2e5a5919ac431e1c58878a5b99e0" >
#### Example Output
~~~~
SkPaint::kNormal_Hinting == paint.getHinting()
~~~~
< / fiddle-embed > < / div >
---
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_setHinting" > < / a >
2017-07-28 19:18:29 +00:00
## setHinting
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-07-28 19:18:29 +00:00
void setHinting(Hinting hintingLevel)
< / pre >
Sets level of glyph outline adjustment.
2017-08-25 15:51:49 +00:00
Does not check for valid values of < a href = "#SkPaint_setHinting_hintingLevel" > hintingLevel< / a > .
2017-07-28 19:18:29 +00:00
2017-08-25 15:51:49 +00:00
| < a href = "#Hinting" > Hinting< / a > | value | effect on generated glyph outlines |
2017-07-28 19:18:29 +00:00
| --- | --- | --- |
2017-08-25 15:51:49 +00:00
| < a href = "#SkPaint_kNo_Hinting" > kNo Hinting< / a > | 0 | leaves glyph outlines unchanged from their native representation |
2017-09-01 19:51:02 +00:00
| < a href = "#SkPaint_kSlight_Hinting" > kSlight Hinting< / a > | 1 | modifies glyph outlines minimally to improve contrast |
| < a href = "#SkPaint_kNormal_Hinting" > kNormal Hinting< / a > | 2 | modifies glyph outlines to improve contrast |
| < a href = "#SkPaint_kFull_Hinting" > kFull Hinting< / a > | 3 | modifies glyph outlines for maximum contrast |
2017-07-28 19:18:29 +00:00
### Parameters
2017-08-25 15:51:49 +00:00
< table > < tr > < td > < a name = "SkPaint_setHinting_hintingLevel" > < code > < strong > hintingLevel < / strong > < / code > < / a > < / td > < td >
one of: < a href = "#SkPaint_kNo_Hinting" > kNo Hinting< / a > , < a href = "#SkPaint_kSlight_Hinting" > kSlight Hinting< / a > , < a href = "#SkPaint_kNormal_Hinting" > kNormal Hinting< / a > , < a href = "#SkPaint_kFull_Hinting" > kFull Hinting< / a > < / td >
2017-07-28 19:18:29 +00:00
< / tr >
< / table >
### Example
< div > < fiddle-embed name = "78153fbd3f1000cb33b97bbe831ed34e" >
#### Example Output
~~~~
paint1 == paint2
~~~~
< / fiddle-embed > < / div >
---
# <a name="Flags"></a> Flags
2017-08-25 15:51:49 +00:00
## <a name="SkPaint_Flags"></a> Enum SkPaint::Flags
2017-07-28 19:18:29 +00:00
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-08-25 15:51:49 +00:00
enum < a href = "#Flags" > Flags< / a > {
< a href = "#SkPaint_kAntiAlias_Flag" > kAntiAlias Flag< / a > = 0x01,
< a href = "#SkPaint_kDither_Flag" > kDither Flag< / a > = 0x04,
< a href = "#SkPaint_kFakeBoldText_Flag" > kFakeBoldText Flag< / a > = 0x20,
< a href = "#SkPaint_kLinearText_Flag" > kLinearText Flag< / a > = 0x40,
< a href = "#SkPaint_kSubpixelText_Flag" > kSubpixelText Flag< / a > = 0x80,
< a href = "#SkPaint_kDevKernText_Flag" > kDevKernText Flag< / a > = 0x100,
< a href = "#SkPaint_kLCDRenderText_Flag" > kLCDRenderText Flag< / a > = 0x200,
< a href = "#SkPaint_kEmbeddedBitmapText_Flag" > kEmbeddedBitmapText Flag< / a > = 0x400,
< a href = "#SkPaint_kAutoHinting_Flag" > kAutoHinting Flag< / a > = 0x800,
< a href = "#SkPaint_kVerticalText_Flag" > kVerticalText Flag< / a > = 0x1000,
< a href = "#SkPaint_kGenA8FromLCD_Flag" > kGenA8FromLCD Flag< / a > = 0x2000,
< a href = "#SkPaint_kAllFlags" > kAllFlags< / a > = 0xFFFF,
2017-07-28 19:18:29 +00:00
};
< / pre >
2017-08-25 15:51:49 +00:00
The bit values stored in < a href = "#Flags" > Flags< / a > .
The default value for < a href = "#Flags" > Flags< / a > , normally zero, can be changed at compile time
2017-08-04 16:48:24 +00:00
with a custom definition of < a href = "undocumented#SkPaintDefaults_Flags" > SkPaintDefaults Flags< / a > .
2017-08-25 15:51:49 +00:00
All flags can be read and written explicitly; < a href = "#Flags" > Flags< / a > allows manipulating
2017-07-28 19:18:29 +00:00
multiple settings at once.
### Constants
< table >
< tr >
2017-11-27 15:44:06 +00:00
< td > < a name = "SkPaint_kAntiAlias_Flag" > < code > < strong > SkPaint::kAntiAlias_Flag < / strong > < / code > < / a > < / td > < td > 0x0001 < / td > < td > mask for setting Anti-alias< / td >
2017-07-28 19:18:29 +00:00
< / tr >
< tr >
2017-08-25 15:51:49 +00:00
< td > < a name = "SkPaint_kDither_Flag" > < code > < strong > SkPaint::kDither_Flag < / strong > < / code > < / a > < / td > < td > 0x0004< / td > < td > mask for setting < a href = "#Dither" > Dither< / a > < / td >
2017-07-28 19:18:29 +00:00
< / tr >
< tr >
2017-08-25 15:51:49 +00:00
< td > < a name = "SkPaint_kFakeBoldText_Flag" > < code > < strong > SkPaint::kFakeBoldText_Flag < / strong > < / code > < / a > < / td > < td > 0x0020< / td > < td > mask for setting < a href = "#Fake_Bold" > Fake Bold< / a > < / td >
2017-07-28 19:18:29 +00:00
< / tr >
< tr >
2017-08-25 15:51:49 +00:00
< td > < a name = "SkPaint_kLinearText_Flag" > < code > < strong > SkPaint::kLinearText_Flag < / strong > < / code > < / a > < / td > < td > 0x0040< / td > < td > mask for setting < a href = "SkPaint_Reference#Linear_Text" > Linear Text< / a > < / td >
2017-07-28 19:18:29 +00:00
< / tr >
< tr >
2017-08-25 15:51:49 +00:00
< td > < a name = "SkPaint_kSubpixelText_Flag" > < code > < strong > SkPaint::kSubpixelText_Flag < / strong > < / code > < / a > < / td > < td > 0x0080< / td > < td > mask for setting < a href = "SkPaint_Reference#Subpixel_Text" > Subpixel Text< / a > < / td >
2017-07-28 19:18:29 +00:00
< / tr >
< tr >
2017-08-25 15:51:49 +00:00
< td > < a name = "SkPaint_kDevKernText_Flag" > < code > < strong > SkPaint::kDevKernText_Flag < / strong > < / code > < / a > < / td > < td > 0x0100< / td > < td > mask for setting < a href = "SkPaint_Reference#Full_Hinting_Spacing" > Full Hinting Spacing< / a > < / td >
2017-07-28 19:18:29 +00:00
< / tr >
< tr >
2017-08-25 15:51:49 +00:00
< td > < a name = "SkPaint_kLCDRenderText_Flag" > < code > < strong > SkPaint::kLCDRenderText_Flag < / strong > < / code > < / a > < / td > < td > 0x0200< / td > < td > mask for setting < a href = "SkPaint_Reference#LCD_Text" > LCD Text< / a > < / td >
2017-07-28 19:18:29 +00:00
< / tr >
< tr >
2017-08-25 15:51:49 +00:00
< td > < a name = "SkPaint_kEmbeddedBitmapText_Flag" > < code > < strong > SkPaint::kEmbeddedBitmapText_Flag < / strong > < / code > < / a > < / td > < td > 0x0400< / td > < td > mask for setting < a href = "SkPaint_Reference#Font_Embedded_Bitmaps" > Font Embedded Bitmaps< / a > < / td >
2017-07-28 19:18:29 +00:00
< / tr >
< tr >
2017-08-25 15:51:49 +00:00
< td > < a name = "SkPaint_kAutoHinting_Flag" > < code > < strong > SkPaint::kAutoHinting_Flag < / strong > < / code > < / a > < / td > < td > 0x0800< / td > < td > mask for setting < a href = "#Automatic_Hinting" > Automatic Hinting< / a > < / td >
2017-07-28 19:18:29 +00:00
< / tr >
< tr >
2017-08-25 15:51:49 +00:00
< td > < a name = "SkPaint_kVerticalText_Flag" > < code > < strong > SkPaint::kVerticalText_Flag < / strong > < / code > < / a > < / td > < td > 0x1000< / td > < td > mask for setting < a href = "#Vertical_Text" > Vertical Text< / a > < / td >
2017-07-28 19:18:29 +00:00
< / tr >
< tr >
2017-08-25 15:51:49 +00:00
< td > < a name = "SkPaint_kGenA8FromLCD_Flag" > < code > < strong > SkPaint::kGenA8FromLCD_Flag < / strong > < / code > < / a > < / td > < td > 0x2000< / td > < td > not intended for public use< / td >
2017-07-28 19:18:29 +00:00
< / tr >
< tr >
2017-08-25 15:51:49 +00:00
< td > < a name = "SkPaint_kAllFlags" > < code > < strong > SkPaint::kAllFlags < / strong > < / code > < / a > < / td > < td > 0xFFFF< / td > < td > mask of all < a href = "#Flags" > Flags< / a > , including private flags and flags reserved for future use< / td >
2017-07-28 19:18:29 +00:00
< / tr >
2017-08-25 15:51:49 +00:00
< a href = "#Flags" > Flags< / a > default to all flags clear, disabling the associated feature.
2017-07-28 19:18:29 +00:00
< / table >
2017-08-25 15:51:49 +00:00
## <a name="SkPaint_ReserveFlags"></a> Enum SkPaint::ReserveFlags
2017-07-28 19:18:29 +00:00
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-08-25 15:51:49 +00:00
enum < a href = "#SkPaint_ReserveFlags" > ReserveFlags< / a > {
< a href = "#SkPaint_kUnderlineText_ReserveFlag" > kUnderlineText ReserveFlag< / a > = 0x08,
< a href = "#SkPaint_kStrikeThruText_ReserveFlag" > kStrikeThruText ReserveFlag< / a > = 0x10,
2017-07-28 19:18:29 +00:00
};< / pre >
### Constants
< table >
< tr >
2017-08-25 15:51:49 +00:00
< td > < a name = "SkPaint_kUnderlineText_ReserveFlag" > < code > < strong > SkPaint::kUnderlineText_ReserveFlag < / strong > < / code > < / a > < / td > < td > 0x0008< / td > < td > mask for underline text< / td >
2017-07-28 19:18:29 +00:00
< / tr >
< tr >
2017-08-25 15:51:49 +00:00
< td > < a name = "SkPaint_kStrikeThruText_ReserveFlag" > < code > < strong > SkPaint::kStrikeThruText_ReserveFlag < / strong > < / code > < / a > < / td > < td > 0x0010< / td > < td > mask for strike-thru text< / td >
2017-07-28 19:18:29 +00:00
< / tr >
< / table >
2017-11-02 21:49:34 +00:00
### See Also
< a href = "#Flags" > Flags< / a > < a href = "#SkPaint_getFlags" > getFlags< / a >
2017-07-28 19:18:29 +00:00
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_getFlags" > < / a >
2017-07-28 19:18:29 +00:00
## getFlags
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-07-28 19:18:29 +00:00
uint32_t getFlags() const
< / pre >
2017-08-25 15:51:49 +00:00
Returns paint settings described by < a href = "#Flags" > Flags< / a > . Each setting uses one
bit, and can be tested with < a href = "#Flags" > Flags< / a > members.
2017-07-28 19:18:29 +00:00
### Return Value
2017-08-25 15:51:49 +00:00
zero, one, or more bits described by < a href = "#Flags" > Flags< / a >
2017-07-28 19:18:29 +00:00
### Example
< div > < fiddle-embed name = "8a3f8c309533388b01aa66e1267f322d" >
#### Example Output
~~~~
(SkPaint::kAntiAlias_Flag & paint.getFlags()) != 0
~~~~
< / fiddle-embed > < / div >
---
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_setFlags" > < / a >
2017-07-28 19:18:29 +00:00
## setFlags
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-07-28 19:18:29 +00:00
void setFlags(uint32_t flags)
< / pre >
2017-08-25 15:51:49 +00:00
Replaces < a href = "#Flags" > Flags< / a > with < a href = "#SkPaint_setFlags_flags" > flags< / a > , the union of the < a href = "#Flags" > Flags< / a > members.
All < a href = "#Flags" > Flags< / a > members may be cleared, or one or more may be set.
2017-07-28 19:18:29 +00:00
### Parameters
2017-08-25 15:51:49 +00:00
< table > < tr > < td > < a name = "SkPaint_setFlags_flags" > < code > < strong > flags < / strong > < / code > < / a > < / td > < td >
union of < a href = "#Flags" > Flags< / a > for < a href = "#Paint" > Paint< / a > < / td >
2017-07-28 19:18:29 +00:00
< / tr >
< / table >
### Example
< div > < fiddle-embed name = "54baed3f6bc4b9c31ba664e27767fdc7" >
#### Example Output
~~~~
paint.isAntiAlias()
paint.isDither()
~~~~
< / fiddle-embed > < / div >
---
# <a name="Anti-alias"></a> Anti-alias
2017-11-27 15:44:06 +00:00
Anti-alias drawing approximates partial pixel coverage with transparency.
2017-08-25 15:51:49 +00:00
If < a href = "#SkPaint_kAntiAlias_Flag" > kAntiAlias Flag< / a > is clear, pixel centers contained by the shape edge are drawn opaque.
If < a href = "#SkPaint_kAntiAlias_Flag" > kAntiAlias Flag< / a > is set, pixels are drawn with < a href = "#Alpha" > Color Alpha< / a > equal to their coverage.
2017-07-28 19:18:29 +00:00
2018-01-04 21:11:51 +00:00
The rule for < a href = "#Alias" > Aliased< / a > pixels is inconsistent across platforms. A shape edge
2017-07-28 19:18:29 +00:00
passing through the pixel center may, but is not required to, draw the pixel.
2017-09-01 19:51:02 +00:00
< a href = "undocumented#Raster_Engine" > Raster Engine< / a > draws < a href = "#Alias" > Aliased< / a > pixels whose centers are on or to the right of the start of an
2017-08-04 16:48:24 +00:00
active < a href = "SkPath_Reference#Path" > Path< / a > edge, and whose center is to the left of the end of the active < a href = "SkPath_Reference#Path" > Path< / a > edge.
2017-07-28 19:18:29 +00:00
2018-01-04 21:11:51 +00:00
A platform may only support Anti-aliased drawing. Some GPU-backed platforms use
2017-11-27 15:44:06 +00:00
< a href = "undocumented#Supersampling" > Supersampling< / a > to Anti-alias all drawing, and have no mechanism to selectively
2017-09-01 19:51:02 +00:00
< a href = "undocumented#Alias" > Alias< / a > .
2017-07-28 19:18:29 +00:00
2017-11-27 15:44:06 +00:00
The amount of coverage computed for Anti-aliased pixels also varies across platforms.
2017-07-28 19:18:29 +00:00
2017-11-27 15:44:06 +00:00
Anti-alias is disabled by default.
Anti-alias can be enabled by default by setting < a href = "undocumented#SkPaintDefaults_Flags" > SkPaintDefaults Flags< / a > to < a href = "#SkPaint_kAntiAlias_Flag" > kAntiAlias Flag< / a >
2017-07-28 19:18:29 +00:00
at compile time.
### Example
< div > < fiddle-embed name = "a6575a49467ce8d28bb01cc7638fa04d" > < div > A red line is drawn with transparency on the edges to make it look smoother.
A blue line draws only where the pixel centers are contained.
2017-10-04 18:31:33 +00:00
The lines are drawn into < a href = "SkBitmap_Reference#Bitmap" > Bitmap< / a > , then drawn magnified to make the
2017-09-01 19:51:02 +00:00
< a href = "#Alias" > Aliasing< / a > easier to see.< / div > < / fiddle-embed > < / div >
2017-07-28 19:18:29 +00:00
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_isAntiAlias" > < / a >
2017-07-28 19:18:29 +00:00
## isAntiAlias
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-07-28 19:18:29 +00:00
bool isAntiAlias() const
< / pre >
2017-08-04 16:48:24 +00:00
If true, pixels on the active edges of < a href = "SkPath_Reference#Path" > Path< / a > may be drawn with partial transparency.
2017-07-28 19:18:29 +00:00
2017-08-25 15:51:49 +00:00
Equivalent to < a href = "#SkPaint_getFlags" > getFlags< / a > masked with < a href = "#SkPaint_kAntiAlias_Flag" > kAntiAlias Flag< / a > .
2017-07-28 19:18:29 +00:00
### Return Value
2017-08-25 15:51:49 +00:00
< a href = "#SkPaint_kAntiAlias_Flag" > kAntiAlias Flag< / a > state
2017-07-28 19:18:29 +00:00
### Example
< div > < fiddle-embed name = "d7d5f4f7da7acd5104a652f490c6f7b8" >
#### Example Output
~~~~
paint.isAntiAlias() == !!(paint.getFlags() & SkPaint::kAntiAlias_Flag)
paint.isAntiAlias() == !!(paint.getFlags() & SkPaint::kAntiAlias_Flag)
~~~~
< / fiddle-embed > < / div >
---
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_setAntiAlias" > < / a >
2017-07-28 19:18:29 +00:00
## setAntiAlias
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-07-28 19:18:29 +00:00
void setAntiAlias(bool aa)
< / pre >
2017-08-04 16:48:24 +00:00
Requests, but does not require, that < a href = "SkPath_Reference#Path" > Path< / a > edge pixels draw opaque or with
2017-07-28 19:18:29 +00:00
partial transparency.
2017-08-25 15:51:49 +00:00
Sets < a href = "#SkPaint_kAntiAlias_Flag" > kAntiAlias Flag< / a > if < a href = "#SkPaint_setAntiAlias_aa" > aa< / a > is true.
Clears < a href = "#SkPaint_kAntiAlias_Flag" > kAntiAlias Flag< / a > if < a href = "#SkPaint_setAntiAlias_aa" > aa< / a > is false.
2017-07-28 19:18:29 +00:00
### Parameters
2017-08-25 15:51:49 +00:00
< table > < tr > < td > < a name = "SkPaint_setAntiAlias_aa" > < code > < strong > aa < / strong > < / code > < / a > < / td > < td >
setting for < a href = "#SkPaint_kAntiAlias_Flag" > kAntiAlias Flag< / a > < / td >
2017-07-28 19:18:29 +00:00
< / tr >
< / table >
### Example
< div > < fiddle-embed name = "c2ff148374d01cbef845b223e725905c" >
#### Example Output
~~~~
paint1 == paint2
~~~~
< / fiddle-embed > < / div >
---
# <a name="Dither"></a> Dither
2018-01-04 21:11:51 +00:00
< a href = "#Dither" > Dither< / a > increases fidelity by adjusting the color of adjacent pixels.
2017-07-28 19:18:29 +00:00
This can help to smooth color transitions and reducing banding in gradients.
2017-08-04 16:48:24 +00:00
Dithering lessens visible banding from < a href = "undocumented#SkColorType" > kRGB 565 SkColorType< / a >
2018-01-04 21:11:51 +00:00
and < a href = "undocumented#SkColorType" > kRGBA 8888 SkColorType< / a > gradients,
2017-11-27 15:44:06 +00:00
and improves rendering into a < a href = "undocumented#SkColorType" > kRGB 565 SkColorType< / a > < a href = "SkSurface_Reference#Surface" > Surface< / a > .
2017-07-28 19:18:29 +00:00
Dithering is always enabled for linear gradients drawing into
2017-11-27 15:44:06 +00:00
< a href = "undocumented#SkColorType" > kRGB 565 SkColorType< / a > < a href = "SkSurface_Reference#Surface" > Surface< / a > and < a href = "undocumented#SkColorType" > kRGBA 8888 SkColorType< / a > < a href = "SkSurface_Reference#Surface" > Surface< / a > .
< a href = "#Dither" > Dither< / a > cannot be enabled for < a href = "undocumented#SkColorType" > kAlpha 8 SkColorType< / a > < a href = "SkSurface_Reference#Surface" > Surface< / a > and
< a href = "undocumented#SkColorType" > kRGBA F16 SkColorType< / a > < a href = "SkSurface_Reference#Surface" > Surface< / a > .
2017-07-28 19:18:29 +00:00
2017-08-25 15:51:49 +00:00
< a href = "#Dither" > Dither< / a > is disabled by default.
< a href = "#Dither" > Dither< / a > can be enabled by default by setting < a href = "undocumented#SkPaintDefaults_Flags" > SkPaintDefaults Flags< / a > to < a href = "#SkPaint_kDither_Flag" > kDither Flag< / a >
2017-07-28 19:18:29 +00:00
at compile time.
2017-08-25 15:51:49 +00:00
Some platform implementations may ignore dithering. Setto ignore < a href = "#Dither" > Dither< / a > on < a href = "undocumented#GPU_Surface" > GPU Surface< / a > .
2017-07-28 19:18:29 +00:00
### Example
< div > < fiddle-embed name = "8b26507690b71462f44642b911890bbf" > < div > Dithering in the bottom half more closely approximates the requested color by
alternating nearby colors from pixel to pixel.< / div > < / fiddle-embed > < / div >
### Example
< div > < fiddle-embed name = "76d4d4a7931a48495e4d5f54e073be53" > < div > Dithering introduces subtle adjustments to color to smooth gradients.
2017-08-25 15:51:49 +00:00
Drawing the gradient repeatedly with < a href = "#SkBlendMode_kPlus" > SkBlendMode::kPlus< / a > exaggerates the
2017-07-28 19:18:29 +00:00
dither, making it easier to see.< / div > < / fiddle-embed > < / div >
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_isDither" > < / a >
2017-07-28 19:18:29 +00:00
## isDither
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-07-28 19:18:29 +00:00
bool isDither() const
< / pre >
If true, color error may be distributed to smooth color transition.
2017-08-25 15:51:49 +00:00
Equivalent to < a href = "#SkPaint_getFlags" > getFlags< / a > masked with < a href = "#SkPaint_kDither_Flag" > kDither Flag< / a > .
2017-07-28 19:18:29 +00:00
### Return Value
2017-08-25 15:51:49 +00:00
< a href = "#SkPaint_kDither_Flag" > kDither Flag< / a > state
2017-07-28 19:18:29 +00:00
### Example
< div > < fiddle-embed name = "f4ce93f6c5e7335436a985377fd980c0" >
#### Example Output
~~~~
paint.isDither() == !!(paint.getFlags() & SkPaint::kDither_Flag)
paint.isDither() == !!(paint.getFlags() & SkPaint::kDither_Flag)
~~~~
< / fiddle-embed > < / div >
---
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_setDither" > < / a >
2017-07-28 19:18:29 +00:00
## setDither
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-07-28 19:18:29 +00:00
void setDither(bool dither)
< / pre >
Requests, but does not require, to distribute color error.
2017-08-25 15:51:49 +00:00
Sets < a href = "#SkPaint_kDither_Flag" > kDither Flag< / a > if < a href = "#SkPaint_setDither_dither" > dither< / a > is true.
Clears < a href = "#SkPaint_kDither_Flag" > kDither Flag< / a > if < a href = "#SkPaint_setDither_dither" > dither< / a > is false.
2017-07-28 19:18:29 +00:00
### Parameters
2017-08-25 15:51:49 +00:00
< table > < tr > < td > < a name = "SkPaint_setDither_dither" > < code > < strong > dither < / strong > < / code > < / a > < / td > < td >
setting for < a href = "#SkPaint_kDither_Flag" > kDither Flag< / a > < / td >
2017-07-28 19:18:29 +00:00
< / tr >
< / table >
### Example
< div > < fiddle-embed name = "69b7162e8324d9239dd02dd9ada2bdff" >
#### Example Output
~~~~
paint1 == paint2
~~~~
< / fiddle-embed > < / div >
### See Also
2017-08-04 16:48:24 +00:00
< a href = "undocumented#SkColorType" > kRGB 565 SkColorType< / a >
2017-07-28 19:18:29 +00:00
---
### See Also
2017-11-27 15:44:06 +00:00
Gradient < a href = "#RGB" > Color RGB< / a > -565
2017-07-28 19:18:29 +00:00
# <a name="Device_Text"></a> Device Text
2017-08-04 16:48:24 +00:00
< a href = "SkPaint_Reference#LCD_Text" > LCD Text< / a > and < a href = "SkPaint_Reference#Subpixel_Text" > Subpixel Text< / a > increase the precision of glyph position.
2017-07-28 19:18:29 +00:00
2018-01-04 21:11:51 +00:00
When set, < a href = "#SkPaint_Flags" > Flags< / a > < a href = "#SkPaint_kLCDRenderText_Flag" > kLCDRenderText Flag< / a > takes advantage of the organization of < a href = "#RGB" > Color RGB< / a > stripes that
2017-07-28 19:18:29 +00:00
create a color, and relies
2017-09-01 19:51:02 +00:00
on the small size of the stripe and visual perception to make the color fringing imperceptible.
2017-08-04 16:48:24 +00:00
< a href = "SkPaint_Reference#LCD_Text" > LCD Text< / a > can be enabled on devices that orient stripes horizontally or vertically, and that order
2017-08-25 15:51:49 +00:00
the color components as < a href = "#RGB" > Color RGB< / a > or < a href = "#RBG" > Color RBG< / a > .
2017-07-28 19:18:29 +00:00
2018-01-04 21:11:51 +00:00
< a href = "#SkPaint_Flags" > Flags< / a > < a href = "#SkPaint_kSubpixelText_Flag" > kSubpixelText Flag< / a > uses the pixel transparency to represent a fractional offset.
2017-07-28 19:18:29 +00:00
As the opaqueness
of the color increases, the edge of the glyph appears to move towards the outside of the pixel.
Either or both techniques can be enabled.
2017-08-25 15:51:49 +00:00
< a href = "#SkPaint_kLCDRenderText_Flag" > kLCDRenderText Flag< / a > and < a href = "#SkPaint_kSubpixelText_Flag" > kSubpixelText Flag< / a > are clear by default.
2018-01-04 21:11:51 +00:00
< a href = "SkPaint_Reference#LCD_Text" > LCD Text< / a > or < a href = "SkPaint_Reference#Subpixel_Text" > Subpixel Text< / a > can be enabled by default by setting < a href = "undocumented#SkPaintDefaults_Flags" > SkPaintDefaults Flags< / a > to
2017-08-25 15:51:49 +00:00
< a href = "#SkPaint_kLCDRenderText_Flag" > kLCDRenderText Flag< / a > or < a href = "#SkPaint_kSubpixelText_Flag" > kSubpixelText Flag< / a > (or both) at compile time.
2017-07-28 19:18:29 +00:00
### Example
2017-08-04 16:48:24 +00:00
< div > < fiddle-embed name = "4606ae1be792d6bc46d496432f050ee9" > < div > Four commas are drawn normally and with combinations of < a href = "SkPaint_Reference#LCD_Text" > LCD Text< / a > and < a href = "SkPaint_Reference#Subpixel_Text" > Subpixel Text< / a > .
2017-09-01 19:51:02 +00:00
When < a href = "SkPaint_Reference#Subpixel_Text" > Subpixel Text< / a > is disabled, the comma < a href = "#Glyph" > Glyphs< / a > are identical, but not evenly spaced.
When < a href = "SkPaint_Reference#Subpixel_Text" > Subpixel Text< / a > is enabled, the comma < a href = "#Glyph" > Glyphs< / a > are unique, but appear evenly spaced.< / div > < / fiddle-embed > < / div >
2017-07-28 19:18:29 +00:00
## <a name="Linear_Text"></a> Linear Text
2017-08-04 16:48:24 +00:00
< a href = "SkPaint_Reference#Linear_Text" > Linear Text< / a > selects whether text is rendered as a < a href = "undocumented#Glyph" > Glyph< / a > or as a < a href = "SkPath_Reference#Path" > Path< / a > .
2017-08-25 15:51:49 +00:00
If < a href = "#SkPaint_kLinearText_Flag" > kLinearText Flag< / a > is set, it has the same effect as setting < a href = "#SkPaint_Hinting" > Hinting< / a > to < a href = "#SkPaint_kNormal_Hinting" > kNormal Hinting< / a > .
2017-09-14 15:25:39 +00:00
If < a href = "#SkPaint_kLinearText_Flag" > kLinearText Flag< / a > is clear, it is the same as setting < a href = "#SkPaint_Hinting" > Hinting< / a > to < a href = "#SkPaint_kNo_Hinting" > kNo Hinting< / a > .
2017-07-28 19:18:29 +00:00
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_isLinearText" > < / a >
2017-07-28 19:18:29 +00:00
## isLinearText
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-07-28 19:18:29 +00:00
bool isLinearText() const
< / pre >
2017-08-04 16:48:24 +00:00
If true, text is converted to < a href = "SkPath_Reference#Path" > Path< / a > before drawing and measuring.
2017-07-28 19:18:29 +00:00
2017-08-25 15:51:49 +00:00
Equivalent to < a href = "#SkPaint_getFlags" > getFlags< / a > masked with < a href = "#SkPaint_kLinearText_Flag" > kLinearText Flag< / a > .
2017-07-28 19:18:29 +00:00
### Return Value
2017-08-25 15:51:49 +00:00
< a href = "#SkPaint_kLinearText_Flag" > kLinearText Flag< / a > state
2017-07-28 19:18:29 +00:00
### Example
< div > < fiddle-embed name = "2890ad644f980637837e6fcb386fb462" > < / fiddle-embed > < / div >
### See Also
2017-08-25 15:51:49 +00:00
< a href = "#SkPaint_setLinearText" > setLinearText< / a > < a href = "#SkPaint_Hinting" > Hinting< / a >
2017-07-28 19:18:29 +00:00
---
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_setLinearText" > < / a >
2017-07-28 19:18:29 +00:00
## setLinearText
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-07-28 19:18:29 +00:00
void setLinearText(bool linearText)
< / pre >
2017-08-04 16:48:24 +00:00
If true, text is converted to < a href = "SkPath_Reference#Path" > Path< / a > before drawing and measuring.
2017-08-25 15:51:49 +00:00
By default, < a href = "#SkPaint_kLinearText_Flag" > kLinearText Flag< / a > is clear.
2017-07-28 19:18:29 +00:00
2017-08-25 15:51:49 +00:00
Sets < a href = "#SkPaint_kLinearText_Flag" > kLinearText Flag< / a > if < a href = "#SkPaint_setLinearText_linearText" > linearText< / a > is true.
Clears < a href = "#SkPaint_kLinearText_Flag" > kLinearText Flag< / a > if < a href = "#SkPaint_setLinearText_linearText" > linearText< / a > is false.
2017-07-28 19:18:29 +00:00
### Parameters
2017-08-25 15:51:49 +00:00
< table > < tr > < td > < a name = "SkPaint_setLinearText_linearText" > < code > < strong > linearText < / strong > < / code > < / a > < / td > < td >
setting for < a href = "#SkPaint_kLinearText_Flag" > kLinearText Flag< / a > < / td >
2017-07-28 19:18:29 +00:00
< / tr >
< / table >
### Example
< div > < fiddle-embed name = "c93bb912f3bddfb4d96d3ad70ada552b" > < / fiddle-embed > < / div >
### See Also
2017-08-25 15:51:49 +00:00
< a href = "#SkPaint_isLinearText" > isLinearText< / a > < a href = "#SkPaint_Hinting" > Hinting< / a >
2017-07-28 19:18:29 +00:00
---
## <a name="Subpixel_Text"></a> Subpixel Text
2018-01-04 21:11:51 +00:00
< a href = "#SkPaint_Flags" > Flags< / a > < a href = "#SkPaint_kSubpixelText_Flag" > kSubpixelText Flag< / a > uses the pixel transparency to represent a fractional offset.
2017-07-28 19:18:29 +00:00
As the opaqueness
of the color increases, the edge of the glyph appears to move towards the outside of the pixel.
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_isSubpixelText" > < / a >
2017-07-28 19:18:29 +00:00
## isSubpixelText
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-07-28 19:18:29 +00:00
bool isSubpixelText() const
< / pre >
2017-09-01 19:51:02 +00:00
If true, < a href = "#Glyph" > Glyphs< / a > at different sub-pixel positions may differ on pixel edge coverage.
2017-07-28 19:18:29 +00:00
2017-08-25 15:51:49 +00:00
Equivalent to < a href = "#SkPaint_getFlags" > getFlags< / a > masked with < a href = "#SkPaint_kSubpixelText_Flag" > kSubpixelText Flag< / a > .
2017-07-28 19:18:29 +00:00
### Return Value
2017-08-25 15:51:49 +00:00
< a href = "#SkPaint_kSubpixelText_Flag" > kSubpixelText Flag< / a > state
2017-07-28 19:18:29 +00:00
### Example
< div > < fiddle-embed name = "abe9afc0932e2199324ae6cbb396e67c" >
#### Example Output
~~~~
paint.isSubpixelText() == !!(paint.getFlags() & SkPaint::kSubpixelText_Flag)
paint.isSubpixelText() == !!(paint.getFlags() & SkPaint::kSubpixelText_Flag)
~~~~
< / fiddle-embed > < / div >
---
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_setSubpixelText" > < / a >
2017-07-28 19:18:29 +00:00
## setSubpixelText
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-07-28 19:18:29 +00:00
void setSubpixelText(bool subpixelText)
< / pre >
2017-09-01 19:51:02 +00:00
Requests, but does not require, that < a href = "#Glyph" > Glyphs< / a > respect sub-pixel positioning.
2017-07-28 19:18:29 +00:00
2017-08-25 15:51:49 +00:00
Sets < a href = "#SkPaint_kSubpixelText_Flag" > kSubpixelText Flag< / a > if < a href = "#SkPaint_setSubpixelText_subpixelText" > subpixelText< / a > is true.
Clears < a href = "#SkPaint_kSubpixelText_Flag" > kSubpixelText Flag< / a > if < a href = "#SkPaint_setSubpixelText_subpixelText" > subpixelText< / a > is false.
2017-07-28 19:18:29 +00:00
### Parameters
2017-08-25 15:51:49 +00:00
< table > < tr > < td > < a name = "SkPaint_setSubpixelText_subpixelText" > < code > < strong > subpixelText < / strong > < / code > < / a > < / td > < td >
setting for < a href = "#SkPaint_kSubpixelText_Flag" > kSubpixelText Flag< / a > < / td >
2017-07-28 19:18:29 +00:00
< / tr >
< / table >
### Example
< div > < fiddle-embed name = "a77bbc1a4e3be9a8ab0f842f877c5ee4" >
#### Example Output
~~~~
paint1 == paint2
~~~~
< / fiddle-embed > < / div >
---
## <a name="LCD_Text"></a> LCD Text
2018-01-04 21:11:51 +00:00
When set, < a href = "#SkPaint_Flags" > Flags< / a > < a href = "#SkPaint_kLCDRenderText_Flag" > kLCDRenderText Flag< / a > takes advantage of the organization of < a href = "#RGB" > Color RGB< / a > stripes that
2017-07-28 19:18:29 +00:00
create a color, and relies
2017-09-01 19:51:02 +00:00
on the small size of the stripe and visual perception to make the color fringing imperceptible.
2017-08-04 16:48:24 +00:00
< a href = "SkPaint_Reference#LCD_Text" > LCD Text< / a > can be enabled on devices that orient stripes horizontally or vertically, and that order
2017-08-25 15:51:49 +00:00
the color components as < a href = "#RGB" > Color RGB< / a > or < a href = "#RBG" > Color RBG< / a > .
2017-07-28 19:18:29 +00:00
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_isLCDRenderText" > < / a >
2017-07-28 19:18:29 +00:00
## isLCDRenderText
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-07-28 19:18:29 +00:00
bool isLCDRenderText() const
< / pre >
2018-01-04 21:11:51 +00:00
If true, < a href = "#Glyph" > Glyphs< / a > may use LCD striping to improve glyph edges.
2017-07-28 19:18:29 +00:00
2017-08-25 15:51:49 +00:00
Returns true if < a href = "#SkPaint_Flags" > Flags< / a > < a href = "#SkPaint_kLCDRenderText_Flag" > kLCDRenderText Flag< / a > is set.
2017-07-28 19:18:29 +00:00
### Return Value
2017-08-25 15:51:49 +00:00
< a href = "#SkPaint_kLCDRenderText_Flag" > kLCDRenderText Flag< / a > state
2017-07-28 19:18:29 +00:00
### Example
< div > < fiddle-embed name = "68e1fd95dd2fd06a333899d2bd2396b9" >
#### Example Output
~~~~
paint.isLCDRenderText() == !!(paint.getFlags() & SkPaint::kLCDRenderText_Flag)
paint.isLCDRenderText() == !!(paint.getFlags() & SkPaint::kLCDRenderText_Flag)
~~~~
< / fiddle-embed > < / div >
---
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_setLCDRenderText" > < / a >
2017-07-28 19:18:29 +00:00
## setLCDRenderText
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-07-28 19:18:29 +00:00
void setLCDRenderText(bool lcdText)
< / pre >
2018-01-04 21:11:51 +00:00
Requests, but does not require, that < a href = "#Glyph" > Glyphs< / a > use LCD striping for glyph edges.
2017-07-28 19:18:29 +00:00
2017-08-25 15:51:49 +00:00
Sets < a href = "#SkPaint_kLCDRenderText_Flag" > kLCDRenderText Flag< / a > if < a href = "#SkPaint_setLCDRenderText_lcdText" > lcdText< / a > is true.
Clears < a href = "#SkPaint_kLCDRenderText_Flag" > kLCDRenderText Flag< / a > if < a href = "#SkPaint_setLCDRenderText_lcdText" > lcdText< / a > is false.
2017-07-28 19:18:29 +00:00
### Parameters
2017-08-25 15:51:49 +00:00
< table > < tr > < td > < a name = "SkPaint_setLCDRenderText_lcdText" > < code > < strong > lcdText < / strong > < / code > < / a > < / td > < td >
setting for < a href = "#SkPaint_kLCDRenderText_Flag" > kLCDRenderText Flag< / a > < / td >
2017-07-28 19:18:29 +00:00
< / tr >
< / table >
### Example
< div > < fiddle-embed name = "50dedf8450159571a3edaf4f0050defe" >
#### Example Output
~~~~
paint1 == paint2
~~~~
< / fiddle-embed > < / div >
---
# <a name="Font_Embedded_Bitmaps"></a> Font Embedded Bitmaps
2017-09-01 19:51:02 +00:00
< a href = "SkPaint_Reference#Font_Embedded_Bitmaps" > Font Embedded Bitmaps< / a > allows selecting custom sized bitmap < a href = "#Glyph" > Glyphs< / a > .
2017-08-25 15:51:49 +00:00
< a href = "#SkPaint_Flags" > Flags< / a > < a href = "#SkPaint_kEmbeddedBitmapText_Flag" > kEmbeddedBitmapText Flag< / a > when set chooses an embedded bitmap glyph over an outline contained
2018-01-04 21:11:51 +00:00
in a font if the platform supports this option.
2017-07-28 19:18:29 +00:00
2018-01-04 21:11:51 +00:00
FreeType selects the bitmap glyph if available when < a href = "#SkPaint_kEmbeddedBitmapText_Flag" > kEmbeddedBitmapText Flag< / a > is set, and selects
2017-08-25 15:51:49 +00:00
the outline glyph if < a href = "#SkPaint_kEmbeddedBitmapText_Flag" > kEmbeddedBitmapText Flag< / a > is clear.
2018-01-04 21:11:51 +00:00
Windows may select the bitmap glyph but is not required to do so.
< a href = "undocumented#OS_X" > OS X< / a > and iOS do not support this option.
2017-07-28 19:18:29 +00:00
2017-08-04 16:48:24 +00:00
< a href = "SkPaint_Reference#Font_Embedded_Bitmaps" > Font Embedded Bitmaps< / a > is disabled by default.
< a href = "SkPaint_Reference#Font_Embedded_Bitmaps" > Font Embedded Bitmaps< / a > can be enabled by default by setting < a href = "undocumented#SkPaintDefaults_Flags" > SkPaintDefaults Flags< / a > to
2017-08-25 15:51:49 +00:00
< a href = "#SkPaint_kEmbeddedBitmapText_Flag" > kEmbeddedBitmapText Flag< / a > at compile time.
2017-07-28 19:18:29 +00:00
### Example
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em; font-size: 13px width: 62.5em; background-color: #f0f0f0 " >
void draw(SkCanvas* canvas) {< div > The "hintgasp" TrueType font in the Skia resources/fonts directory
includes an embedded bitmap Glyph at odd font sizes. This example works
on platforms that use FreeType as their Font_Engine.
Windows may, but is not required to, return a bitmap glyph if
kEmbeddedBitmapText_Flag is set.< / div > SkBitmap bitmap;
bitmap.allocN32Pixels(30, 15);
bitmap.eraseColor(0);
SkCanvas offscreen(bitmap);
SkPaint paint;
paint.setAntiAlias(true);
paint.setTextSize(13);
2017-12-08 19:25:14 +00:00
paint.setTypeface(MakeResourceAsTypeface("fonts/hintgasp.ttf"));
2017-11-27 15:44:06 +00:00
for (bool embedded : { false, true}) {
paint.setEmbeddedBitmapText(embedded);
offscreen.drawString("A", embedded ? 5 : 15, 15, paint);
}
canvas->drawBitmap(bitmap, 0, 0);
canvas->scale(10, 10);
canvas->drawBitmap(bitmap, -2, 1);
}
< / pre >
2017-07-28 19:18:29 +00:00
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_isEmbeddedBitmapText" > < / a >
2017-07-28 19:18:29 +00:00
## isEmbeddedBitmapText
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-07-28 19:18:29 +00:00
bool isEmbeddedBitmapText() const
< / pre >
2017-09-01 19:51:02 +00:00
If true, < a href = "#Engine" > Font Engine< / a > may return < a href = "#Glyph" > Glyphs< / a > from font bitmaps instead of from outlines.
2017-07-28 19:18:29 +00:00
2017-08-25 15:51:49 +00:00
Equivalent to < a href = "#SkPaint_getFlags" > getFlags< / a > masked with < a href = "#SkPaint_kEmbeddedBitmapText_Flag" > kEmbeddedBitmapText Flag< / a > .
2017-07-28 19:18:29 +00:00
### Return Value
2017-08-25 15:51:49 +00:00
< a href = "#SkPaint_kEmbeddedBitmapText_Flag" > kEmbeddedBitmapText Flag< / a > state
2017-07-28 19:18:29 +00:00
### Example
< div > < fiddle-embed name = "eba10b27b790e87183ae451b3fc5c4b1" >
#### Example Output
~~~~
paint.isEmbeddedBitmapText() == !!(paint.getFlags() & SkPaint::kEmbeddedBitmapText_Flag)
paint.isEmbeddedBitmapText() == !!(paint.getFlags() & SkPaint::kEmbeddedBitmapText_Flag)
~~~~
< / fiddle-embed > < / div >
---
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_setEmbeddedBitmapText" > < / a >
2017-07-28 19:18:29 +00:00
## setEmbeddedBitmapText
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-07-28 19:18:29 +00:00
void setEmbeddedBitmapText(bool useEmbeddedBitmapText)
< / pre >
Requests, but does not require, to use bitmaps in fonts instead of outlines.
2017-08-25 15:51:49 +00:00
Sets < a href = "#SkPaint_kEmbeddedBitmapText_Flag" > kEmbeddedBitmapText Flag< / a > if < a href = "#SkPaint_setEmbeddedBitmapText_useEmbeddedBitmapText" > useEmbeddedBitmapText< / a > is true.
Clears < a href = "#SkPaint_kEmbeddedBitmapText_Flag" > kEmbeddedBitmapText Flag< / a > if < a href = "#SkPaint_setEmbeddedBitmapText_useEmbeddedBitmapText" > useEmbeddedBitmapText< / a > is false.
2017-07-28 19:18:29 +00:00
### Parameters
2017-08-25 15:51:49 +00:00
< table > < tr > < td > < a name = "SkPaint_setEmbeddedBitmapText_useEmbeddedBitmapText" > < code > < strong > useEmbeddedBitmapText < / strong > < / code > < / a > < / td > < td >
setting for < a href = "#SkPaint_kEmbeddedBitmapText_Flag" > kEmbeddedBitmapText Flag< / a > < / td >
2017-07-28 19:18:29 +00:00
< / tr >
< / table >
### Example
< div > < fiddle-embed name = "246dffdd93a484ba4ad7ecf71198a5d4" >
#### Example Output
~~~~
paint1 == paint2
~~~~
< / fiddle-embed > < / div >
---
# <a name="Automatic_Hinting"></a> Automatic Hinting
2017-08-25 15:51:49 +00:00
If < a href = "#SkPaint_Hinting" > Hinting< / a > is set to < a href = "#SkPaint_kNormal_Hinting" > kNormal Hinting< / a > or < a href = "#SkPaint_kFull_Hinting" > kFull Hinting< / a > , < a href = "#Automatic_Hinting" > Automatic Hinting< / a >
2017-09-01 19:51:02 +00:00
instructs the < a href = "undocumented#Font_Manager" > Font Manager< / a > to always hint < a href = "#Glyph" > Glyphs< / a > .
2017-08-25 15:51:49 +00:00
< a href = "#Automatic_Hinting" > Automatic Hinting< / a > has no effect if < a href = "#SkPaint_Hinting" > Hinting< / a > is set to < a href = "#SkPaint_kNo_Hinting" > kNo Hinting< / a > or
< a href = "#SkPaint_kSlight_Hinting" > kSlight Hinting< / a > .
2017-07-28 19:18:29 +00:00
2018-01-04 21:11:51 +00:00
< a href = "#Automatic_Hinting" > Automatic Hinting< / a > only affects platforms that use FreeType as the < a href = "undocumented#Font_Manager" > Font Manager< / a > .
2017-07-28 19:18:29 +00:00
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_isAutohinted" > < / a >
2017-07-28 19:18:29 +00:00
## isAutohinted
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-07-28 19:18:29 +00:00
bool isAutohinted() const
< / pre >
2017-08-25 15:51:49 +00:00
If true, and if < a href = "#SkPaint_Hinting" > Hinting< / a > is set to < a href = "#SkPaint_kNormal_Hinting" > kNormal Hinting< / a > or < a href = "#SkPaint_kFull_Hinting" > kFull Hinting< / a > , and if
2018-01-04 21:11:51 +00:00
platform uses FreeType as the < a href = "undocumented#Font_Manager" > Font Manager< / a > , instruct the < a href = "undocumented#Font_Manager" > Font Manager< / a > to always hint
2017-09-01 19:51:02 +00:00
< a href = "#Glyph" > Glyphs< / a > .
2017-07-28 19:18:29 +00:00
2017-08-25 15:51:49 +00:00
Equivalent to < a href = "#SkPaint_getFlags" > getFlags< / a > masked with < a href = "#SkPaint_kAutoHinting_Flag" > kAutoHinting Flag< / a > .
2017-07-28 19:18:29 +00:00
### Return Value
2017-08-25 15:51:49 +00:00
< a href = "#SkPaint_kAutoHinting_Flag" > kAutoHinting Flag< / a > state
2017-07-28 19:18:29 +00:00
### Example
< div > < fiddle-embed name = "aa4781afbe3b90e7ef56a287e5b9ce1e" >
#### Example Output
~~~~
paint.isAutohinted() == !!(paint.getFlags() & SkPaint::kAutoHinting_Flag)
paint.isAutohinted() == !!(paint.getFlags() & SkPaint::kAutoHinting_Flag)
~~~~
< / fiddle-embed > < / div >
### See Also
2017-08-25 15:51:49 +00:00
< a href = "#SkPaint_setAutohinted" > setAutohinted< / a > < a href = "#SkPaint_Hinting" > Hinting< / a >
2017-07-28 19:18:29 +00:00
---
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_setAutohinted" > < / a >
2017-07-28 19:18:29 +00:00
## setAutohinted
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-07-28 19:18:29 +00:00
void setAutohinted(bool useAutohinter)
< / pre >
2017-08-25 15:51:49 +00:00
If < a href = "#SkPaint_Hinting" > Hinting< / a > is set to < a href = "#SkPaint_kNormal_Hinting" > kNormal Hinting< / a > or < a href = "#SkPaint_kFull_Hinting" > kFull Hinting< / a > and < a href = "#SkPaint_setAutohinted_useAutohinter" > useAutohinter< / a > is set,
2017-09-01 19:51:02 +00:00
instruct the < a href = "undocumented#Font_Manager" > Font Manager< / a > to always hint < a href = "#Glyph" > Glyphs< / a > .
2017-08-25 15:51:49 +00:00
< a href = "#Automatic_Hinting" > Automatic Hinting< / a > has no effect if < a href = "#SkPaint_Hinting" > Hinting< / a > is set to < a href = "#SkPaint_kNo_Hinting" > kNo Hinting< / a > or
< a href = "#SkPaint_kSlight_Hinting" > kSlight Hinting< / a > .
2017-07-28 19:18:29 +00:00
2018-01-04 21:11:51 +00:00
Only affects platforms that use FreeType as the < a href = "undocumented#Font_Manager" > Font Manager< / a > .
2017-07-28 19:18:29 +00:00
2017-08-25 15:51:49 +00:00
Sets < a href = "#SkPaint_kAutoHinting_Flag" > kAutoHinting Flag< / a > if < a href = "#SkPaint_setAutohinted_useAutohinter" > useAutohinter< / a > is true.
Clears < a href = "#SkPaint_kAutoHinting_Flag" > kAutoHinting Flag< / a > if < a href = "#SkPaint_setAutohinted_useAutohinter" > useAutohinter< / a > is false.
2017-07-28 19:18:29 +00:00
### Parameters
2017-08-25 15:51:49 +00:00
< table > < tr > < td > < a name = "SkPaint_setAutohinted_useAutohinter" > < code > < strong > useAutohinter < / strong > < / code > < / a > < / td > < td >
setting for < a href = "#SkPaint_kAutoHinting_Flag" > kAutoHinting Flag< / a > < / td >
2017-07-28 19:18:29 +00:00
< / tr >
< / table >
### Example
< div > < fiddle-embed name = "4e185306d7de9390fe8445eed0139309" > < / fiddle-embed > < / div >
### See Also
2017-08-25 15:51:49 +00:00
< a href = "#SkPaint_isAutohinted" > isAutohinted< / a > < a href = "#SkPaint_Hinting" > Hinting< / a >
2017-07-28 19:18:29 +00:00
---
# <a name="Vertical_Text"></a> Vertical Text
2017-08-04 16:48:24 +00:00
< a href = "undocumented#Text" > Text< / a > may be drawn by positioning each glyph, or by positioning the first glyph and
2017-09-01 19:51:02 +00:00
using < a href = "#Advance" > Font Advance< / a > to position subsequent < a href = "#Glyph" > Glyphs< / a > . By default, each successive glyph
is positioned to the right of the preceding glyph. < a href = "#Vertical_Text" > Vertical Text< / a > sets successive
< a href = "#Glyph" > Glyphs< / a > to position below the preceding glyph.
2017-07-28 19:18:29 +00:00
2018-01-04 21:11:51 +00:00
Skia can translate text character codes as a series of < a href = "#Glyph" > Glyphs< / a > , but does not implement
font substitution,
textual substitution, line layout, or contextual spacing like Kerning pairs. Use
a text shaping engine like < a href = "http://harfbuzz.org/" > HarfBuzz< / a > to translate text runs
2017-07-28 19:18:29 +00:00
into glyph series.
2017-08-25 15:51:49 +00:00
< a href = "#Vertical_Text" > Vertical Text< / a > is clear if text is drawn left to right or set if drawn from top to bottom.
2017-07-28 19:18:29 +00:00
2017-08-25 15:51:49 +00:00
< a href = "#SkPaint_Flags" > Flags< / a > < a href = "#SkPaint_kVerticalText_Flag" > kVerticalText Flag< / a > if clear draws text left to right.
< a href = "#SkPaint_Flags" > Flags< / a > < a href = "#SkPaint_kVerticalText_Flag" > kVerticalText Flag< / a > if set draws text top to bottom.
2017-07-28 19:18:29 +00:00
2017-08-25 15:51:49 +00:00
< a href = "#Vertical_Text" > Vertical Text< / a > is clear by default.
< a href = "#Vertical_Text" > Vertical Text< / a > can be set by default by setting < a href = "undocumented#SkPaintDefaults_Flags" > SkPaintDefaults Flags< / a > to
< a href = "#SkPaint_kVerticalText_Flag" > kVerticalText Flag< / a > at compile time.
2017-07-28 19:18:29 +00:00
### Example
< div > < fiddle-embed name = "8df5800819311b71373d9abb669b49b8" > < / fiddle-embed > < / div >
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_isVerticalText" > < / a >
2017-07-28 19:18:29 +00:00
## isVerticalText
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-07-28 19:18:29 +00:00
bool isVerticalText() const
< / pre >
2017-09-01 19:51:02 +00:00
If true, < a href = "#Glyph" > Glyphs< / a > are drawn top to bottom instead of left to right.
2017-07-28 19:18:29 +00:00
2017-08-25 15:51:49 +00:00
Equivalent to < a href = "#SkPaint_getFlags" > getFlags< / a > masked with < a href = "#SkPaint_kVerticalText_Flag" > kVerticalText Flag< / a > .
2017-07-28 19:18:29 +00:00
### Return Value
2017-08-25 15:51:49 +00:00
< a href = "#SkPaint_kVerticalText_Flag" > kVerticalText Flag< / a > state
2017-07-28 19:18:29 +00:00
### Example
< div > < fiddle-embed name = "4a269b16e644d473870ffa873396f139" >
#### Example Output
~~~~
paint.isVerticalText() == !!(paint.getFlags() & SkPaint::kVerticalText_Flag)
paint.isVerticalText() == !!(paint.getFlags() & SkPaint::kVerticalText_Flag)
~~~~
< / fiddle-embed > < / div >
---
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_setVerticalText" > < / a >
2017-07-28 19:18:29 +00:00
## setVerticalText
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-07-28 19:18:29 +00:00
void setVerticalText(bool verticalText)
< / pre >
If true, text advance positions the next glyph below the previous glyph instead of to the
right of previous glyph.
2017-08-25 15:51:49 +00:00
Sets < a href = "#SkPaint_kVerticalText_Flag" > kVerticalText Flag< / a > if vertical is true.
Clears < a href = "#SkPaint_kVerticalText_Flag" > kVerticalText Flag< / a > if vertical is false.
2017-07-28 19:18:29 +00:00
### Parameters
2017-08-25 15:51:49 +00:00
< table > < tr > < td > < a name = "SkPaint_setVerticalText_verticalText" > < code > < strong > verticalText < / strong > < / code > < / a > < / td > < td >
setting for < a href = "#SkPaint_kVerticalText_Flag" > kVerticalText Flag< / a > < / td >
2017-07-28 19:18:29 +00:00
< / tr >
< / table >
### Example
< div > < fiddle-embed name = "6fbd7e9e1a346cb8d7f537786009c736" >
#### Example Output
~~~~
paint1 == paint2
~~~~
< / fiddle-embed > < / div >
---
# <a name="Fake_Bold"></a> Fake Bold
2017-08-25 15:51:49 +00:00
< a href = "#Fake_Bold" > Fake Bold< / a > approximates the bold font style accompanying a normal font when a bold font face
2018-01-04 21:11:51 +00:00
is not available. Skia does not provide font substitution; it is up to the client to find the
2017-10-04 18:31:33 +00:00
bold font face using the platform < a href = "undocumented#Font_Manager" > Font Manager< / a > .
2017-07-28 19:18:29 +00:00
2018-01-04 21:11:51 +00:00
Use < a href = "#Text_Skew_X" > Text Skew X< / a > to approximate an italic font style when the italic font face
2017-07-28 19:18:29 +00:00
is not available.
2018-01-04 21:11:51 +00:00
A FreeType based port may define SK_USE_FREETYPE_EMBOLDEN at compile time to direct
2017-09-01 19:51:02 +00:00
the font engine to create the bold < a href = "#Glyph" > Glyphs< / a > . Otherwise, the extra bold is computed
2018-01-04 21:11:51 +00:00
by increasing the stroke width and setting the < a href = "#SkPaint_Style" > Style< / a > to < a href = "#SkPaint_kStrokeAndFill_Style" > kStrokeAndFill Style< / a > as needed.
2017-07-28 19:18:29 +00:00
2017-08-25 15:51:49 +00:00
< a href = "#Fake_Bold" > Fake Bold< / a > is disabled by default.
2017-07-28 19:18:29 +00:00
### Example
< div > < fiddle-embed name = "e811f4829a2daaaeaad3795504a7e02a" > < / fiddle-embed > < / div >
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_isFakeBoldText" > < / a >
2017-07-28 19:18:29 +00:00
## isFakeBoldText
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-07-28 19:18:29 +00:00
bool isFakeBoldText() const
< / pre >
If true, approximate bold by increasing the stroke width when creating glyph bitmaps
from outlines.
2017-08-25 15:51:49 +00:00
Equivalent to < a href = "#SkPaint_getFlags" > getFlags< / a > masked with < a href = "#SkPaint_kFakeBoldText_Flag" > kFakeBoldText Flag< / a > .
2017-07-28 19:18:29 +00:00
### Return Value
2017-08-25 15:51:49 +00:00
< a href = "#SkPaint_kFakeBoldText_Flag" > kFakeBoldText Flag< / a > state
2017-07-28 19:18:29 +00:00
### Example
< div > < fiddle-embed name = "f54d1f85b16073b80b9eef2e1a1d151d" >
#### Example Output
~~~~
paint.isFakeBoldText() == !!(paint.getFlags() & SkPaint::kFakeBoldText_Flag)
paint.isFakeBoldText() == !!(paint.getFlags() & SkPaint::kFakeBoldText_Flag)
~~~~
< / fiddle-embed > < / div >
---
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_setFakeBoldText" > < / a >
2017-07-28 19:18:29 +00:00
## setFakeBoldText
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-07-28 19:18:29 +00:00
void setFakeBoldText(bool fakeBoldText)
< / pre >
2017-09-01 19:51:02 +00:00
Use increased stroke width when creating glyph bitmaps to approximate a bold typeface.
2017-07-28 19:18:29 +00:00
2017-08-25 15:51:49 +00:00
Sets < a href = "#SkPaint_kFakeBoldText_Flag" > kFakeBoldText Flag< / a > if < a href = "#SkPaint_setFakeBoldText_fakeBoldText" > fakeBoldText< / a > is true.
Clears < a href = "#SkPaint_kFakeBoldText_Flag" > kFakeBoldText Flag< / a > if < a href = "#SkPaint_setFakeBoldText_fakeBoldText" > fakeBoldText< / a > is false.
2017-07-28 19:18:29 +00:00
### Parameters
2017-08-25 15:51:49 +00:00
< table > < tr > < td > < a name = "SkPaint_setFakeBoldText_fakeBoldText" > < code > < strong > fakeBoldText < / strong > < / code > < / a > < / td > < td >
setting for < a href = "#SkPaint_kFakeBoldText_Flag" > kFakeBoldText Flag< / a > < / td >
2017-07-28 19:18:29 +00:00
< / tr >
< / table >
### Example
< div > < fiddle-embed name = "594d47858eb11028cb626515a520910a" >
#### Example Output
~~~~
paint1 == paint2
~~~~
< / fiddle-embed > < / div >
---
# <a name="Full_Hinting_Spacing"></a> Full Hinting Spacing
2017-09-01 19:51:02 +00:00
if < a href = "#SkPaint_Hinting" > Hinting< / a > is set to < a href = "#SkPaint_kFull_Hinting" > kFull Hinting< / a > , < a href = "SkPaint_Reference#Full_Hinting_Spacing" > Full Hinting Spacing< / a > adjusts the character
2018-01-04 21:11:51 +00:00
spacing by the difference of the hinted and Unhinted < a href = "undocumented#Left_Side_Bearing" > Left Side Bearing< / a > and
2017-09-01 19:51:02 +00:00
< a href = "undocumented#Right_Side_Bearing" > Right Side Bearing< / a > . < a href = "SkPaint_Reference#Full_Hinting_Spacing" > Full Hinting Spacing< / a > only applies to platforms that use
2018-01-04 21:11:51 +00:00
FreeType as their < a href = "#Engine" > Font Engine< / a > .
2017-07-28 19:18:29 +00:00
2018-01-04 21:11:51 +00:00
< a href = "SkPaint_Reference#Full_Hinting_Spacing" > Full Hinting Spacing< / a > is not related to text Kerning, where the space between
a specific pair of characters is adjusted using data in the font Kerning tables.
2017-07-28 19:18:29 +00:00
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_isDevKernText" > < / a >
2017-07-28 19:18:29 +00:00
## isDevKernText
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-07-28 19:18:29 +00:00
bool isDevKernText() const
< / pre >
Returns if character spacing may be adjusted by the hinting difference.
2017-08-25 15:51:49 +00:00
Equivalent to < a href = "#SkPaint_getFlags" > getFlags< / a > masked with < a href = "#SkPaint_kDevKernText_Flag" > kDevKernText Flag< / a > .
2017-07-28 19:18:29 +00:00
### Return Value
2017-08-25 15:51:49 +00:00
< a href = "#SkPaint_kDevKernText_Flag" > kDevKernText Flag< / a > state
2017-07-28 19:18:29 +00:00
### Example
< div > < fiddle-embed name = "4f69a84b2505b12809c30b0cc09c5157" > < / fiddle-embed > < / div >
---
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_setDevKernText" > < / a >
2017-07-28 19:18:29 +00:00
## setDevKernText
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-07-28 19:18:29 +00:00
void setDevKernText(bool devKernText)
< / pre >
Requests, but does not require, to use hinting to adjust glyph spacing.
2017-08-25 15:51:49 +00:00
Sets < a href = "#SkPaint_kDevKernText_Flag" > kDevKernText Flag< / a > if < a href = "#SkPaint_setDevKernText_devKernText" > devKernText< / a > is true.
Clears < a href = "#SkPaint_kDevKernText_Flag" > kDevKernText Flag< / a > if < a href = "#SkPaint_setDevKernText_devKernText" > devKernText< / a > is false.
2017-07-28 19:18:29 +00:00
### Parameters
2017-08-25 15:51:49 +00:00
< table > < tr > < td > < a name = "SkPaint_setDevKernText_devKernText" > < code > < strong > devKernText < / strong > < / code > < / a > < / td > < td >
setting for < a href = "#SkPaint_setDevKernText_devKernText" > devKernText< / a > < / td >
2017-07-28 19:18:29 +00:00
< / tr >
< / table >
### Example
< div > < fiddle-embed name = "2b718a059072908bf68942503f264797" >
#### Example Output
~~~~
paint1 == paint2
~~~~
< / fiddle-embed > < / div >
---
# <a name="Filter_Quality_Methods"></a> Filter Quality Methods
2017-08-04 16:48:24 +00:00
< a href = "undocumented#Filter_Quality" > Filter Quality< / a > trades speed for image filtering when the image is scaled.
A lower < a href = "undocumented#Filter_Quality" > Filter Quality< / a > draws faster, but has less fidelity.
A higher < a href = "undocumented#Filter_Quality" > Filter Quality< / a > draws slower, but looks better.
2017-09-01 19:51:02 +00:00
If the image is drawn without scaling, the < a href = "undocumented#Filter_Quality" > Filter Quality< / a > choice will not result
in a noticeable difference.
2017-07-28 19:18:29 +00:00
2017-08-25 15:51:49 +00:00
< a href = "undocumented#Filter_Quality" > Filter Quality< / a > is used in < a href = "#Paint" > Paint< / a > passed as a parameter to
2017-07-28 19:18:29 +00:00
< table > < tr >
2017-08-25 15:51:49 +00:00
< td > < a href = "#SkCanvas_drawBitmap" > SkCanvas::drawBitmap< / a > < / td > < / tr > < tr >
< td > < a href = "#SkCanvas_drawBitmapRect" > SkCanvas::drawBitmapRect< / a > < / td > < / tr > < tr >
< td > < a href = "#SkCanvas_drawImage" > SkCanvas::drawImage< / a > < / td > < / tr > < tr >
< td > < a href = "#SkCanvas_drawImageRect" > SkCanvas::drawImageRect< / a > < / td > < / tr >
2017-07-28 19:18:29 +00:00
< / table >
2017-11-27 15:44:06 +00:00
and when < a href = "#Paint" > Paint< / a > has a < a href = "undocumented#Shader" > Shader< / a > specialization that uses < a href = "SkImage_Reference#Image" > Image< / a > or < a href = "SkBitmap_Reference#Bitmap" > Bitmap< / a > .
2017-07-28 19:18:29 +00:00
2017-08-04 16:48:24 +00:00
< a href = "undocumented#Filter_Quality" > Filter Quality< / a > is < a href = "undocumented#SkFilterQuality" > kNone SkFilterQuality< / a > by default.
2017-07-28 19:18:29 +00:00
### Example
< div > < fiddle-embed name = "ee77f83f7291e07ae0d89f1380c7d67c" > < / fiddle-embed > < / div >
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_getFilterQuality" > < / a >
2017-07-28 19:18:29 +00:00
## getFilterQuality
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-07-28 19:18:29 +00:00
SkFilterQuality getFilterQuality() const
< / pre >
2017-08-04 16:48:24 +00:00
Returns < a href = "undocumented#Filter_Quality" > Filter Quality< / a > , the image filtering level. A lower setting
2017-07-28 19:18:29 +00:00
draws faster; a higher setting looks better when the image is scaled.
### Return Value
2018-01-04 21:11:51 +00:00
one of: < a href = "undocumented#SkFilterQuality" > kNone SkFilterQuality< / a > , < a href = "undocumented#SkFilterQuality" > kLow SkFilterQuality< / a > ,
2017-08-04 16:48:24 +00:00
< a href = "undocumented#SkFilterQuality" > kMedium SkFilterQuality< / a > , < a href = "undocumented#SkFilterQuality" > kHigh SkFilterQuality< / a >
2017-07-28 19:18:29 +00:00
### Example
< div > < fiddle-embed name = "d4ca1f23809b6835c4ba46ea98a86900" >
#### Example Output
~~~~
kNone_SkFilterQuality == paint.getFilterQuality()
~~~~
< / fiddle-embed > < / div >
---
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_setFilterQuality" > < / a >
2017-07-28 19:18:29 +00:00
## setFilterQuality
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-07-28 19:18:29 +00:00
void setFilterQuality(SkFilterQuality quality)
< / pre >
2017-08-04 16:48:24 +00:00
Sets < a href = "undocumented#Filter_Quality" > Filter Quality< / a > , the image filtering level. A lower setting
2017-07-28 19:18:29 +00:00
draws faster; a higher setting looks better when the image is scaled.
2018-01-04 21:11:51 +00:00
Does not check to see if < a href = "#SkPaint_setFilterQuality_quality" > quality< / a > is valid.
2017-07-28 19:18:29 +00:00
### Parameters
2017-08-25 15:51:49 +00:00
< table > < tr > < td > < a name = "SkPaint_setFilterQuality_quality" > < code > < strong > quality < / strong > < / code > < / a > < / td > < td >
2018-01-04 21:11:51 +00:00
one of: < a href = "undocumented#SkFilterQuality" > kNone SkFilterQuality< / a > , < a href = "undocumented#SkFilterQuality" > kLow SkFilterQuality< / a > ,
2017-08-04 16:48:24 +00:00
< a href = "undocumented#SkFilterQuality" > kMedium SkFilterQuality< / a > , < a href = "undocumented#SkFilterQuality" > kHigh SkFilterQuality< / a > < / td >
2017-07-28 19:18:29 +00:00
< / tr >
< / table >
### Example
< div > < fiddle-embed name = "e4288fabf24ee60b645e8bb6ea0afadf" >
#### Example Output
~~~~
kHigh_SkFilterQuality == paint.getFilterQuality()
~~~~
< / fiddle-embed > < / div >
### See Also
2017-08-04 16:48:24 +00:00
< a href = "undocumented#SkFilterQuality" > SkFilterQuality< / a > < a href = "undocumented#Image_Scaling" > Image Scaling< / a >
2017-07-28 19:18:29 +00:00
---
# <a name="Color_Methods"></a> Color Methods
2017-08-25 15:51:49 +00:00
< a href = "undocumented#Color" > Color< / a > specifies the < a href = "#RGB_Red" > Color RGB Red< / a > , < a href = "#RGB_Blue" > Color RGB Blue< / a > , < a href = "#RGB_Green" > Color RGB Green< / a > , and < a href = "#Alpha" > Color Alpha< / a > values used to draw a filled
2017-07-28 19:18:29 +00:00
or stroked shape in a
32-bit value. Each component occupies 8-bits, ranging from zero: no contribution;
to 255: full intensity. All values in any combination are valid.
2017-09-01 19:51:02 +00:00
< a href = "undocumented#Color" > Color< / a > is not < a href = "#Premultiply" > Premultiplied< / a > ;
2017-08-25 15:51:49 +00:00
< a href = "#Alpha" > Color Alpha< / a > sets the transparency independent of < a href = "#RGB" > Color RGB< / a > : < a href = "#RGB_Red" > Color RGB Red< / a > , < a href = "#RGB_Blue" > Color RGB Blue< / a > , and < a href = "#RGB_Green" > Color RGB Green< / a > .
2017-07-28 19:18:29 +00:00
2017-08-25 15:51:49 +00:00
The bit positions of < a href = "#Alpha" > Color Alpha< / a > and < a href = "#RGB" > Color RGB< / a > are independent of the bit positions
2017-07-28 19:18:29 +00:00
on the output device, which may have more or fewer bits, and may have a different arrangement.
2017-08-25 15:51:49 +00:00
| bit positions | < a href = "#Alpha" > Color Alpha< / a > | < a href = "#RGB_Red" > Color RGB Red< / a > | < a href = "#RGB_Blue" > Color RGB Blue< / a > | < a href = "#RGB_Green" > Color RGB Green< / a > |
2017-07-28 19:18:29 +00:00
| --- | --- | --- | --- | --- |
| | 31 - 24 | 23 - 16 | 15 - 8 | 7 - 0 |
### Example
< div > < fiddle-embed name = "214b559d75c65a7bef6ef4be1f860053" > < / fiddle-embed > < / div >
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_getColor" > < / a >
2017-07-28 19:18:29 +00:00
## getColor
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-07-28 19:18:29 +00:00
SkColor getColor() const
< / pre >
2017-09-01 19:51:02 +00:00
Retrieves < a href = "#Alpha" > Alpha< / a > and < a href = "#RGB" > Color RGB< / a > , < a href = "#Unpremultiply" > Unpremultiplied< / a > , packed into 32 bits.
2017-08-04 16:48:24 +00:00
Use helpers < a href = "undocumented#SkColorGetA" > SkColorGetA< / a > , < a href = "undocumented#SkColorGetR" > SkColorGetR< / a > , < a href = "undocumented#SkColorGetG" > SkColorGetG< / a > , and < a href = "undocumented#SkColorGetB" > SkColorGetB< / a > to extract
2017-07-28 19:18:29 +00:00
a color component.
### Return Value
2017-09-01 19:51:02 +00:00
< a href = "#Unpremultiply" > Unpremultiplied< / a > < a href = "#ARGB" > Color ARGB< / a >
2017-07-28 19:18:29 +00:00
### Example
< div > < fiddle-embed name = "72d41f890203109a41f589a7403acae9" >
#### Example Output
~~~~
Yellow is 100% red, 100% green, and 0% blue.
~~~~
< / fiddle-embed > < / div >
### See Also
2017-08-04 16:48:24 +00:00
< a href = "undocumented#SkColor" > SkColor< / a >
2017-07-28 19:18:29 +00:00
---
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_setColor" > < / a >
2017-07-28 19:18:29 +00:00
## setColor
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-07-28 19:18:29 +00:00
void setColor(SkColor color)
< / pre >
2017-09-01 19:51:02 +00:00
Sets < a href = "#Alpha" > Alpha< / a > and < a href = "#RGB" > Color RGB< / a > used when stroking and filling. The < a href = "#SkPaint_setColor_color" > color< / a > is a 32-bit value,
2018-01-04 21:11:51 +00:00
< a href = "#Unpremultiply" > Unpremultiplied< / a > , packing 8-bit components for < a href = "#Alpha" > Alpha< / a > , < a href = "#Red" > Red< / a > , < a href = "#Blue" > Blue< / a > , and < a href = "#Green" > Green< / a > .
2017-07-28 19:18:29 +00:00
### Parameters
2017-08-25 15:51:49 +00:00
< table > < tr > < td > < a name = "SkPaint_setColor_color" > < code > < strong > color < / strong > < / code > < / a > < / td > < td >
2017-09-01 19:51:02 +00:00
< a href = "#Unpremultiply" > Unpremultiplied< / a > < a href = "#ARGB" > Color ARGB< / a > < / td >
2017-07-28 19:18:29 +00:00
< / tr >
< / table >
### Example
< div > < fiddle-embed name = "6e70f18300bd676a3c056ceb6b62f8df" >
#### Example Output
~~~~
green1 == green2
~~~~
< / fiddle-embed > < / div >
### See Also
2017-08-25 15:51:49 +00:00
< a href = "undocumented#SkColor" > SkColor< / a > < a href = "#SkPaint_setARGB" > setARGB< / a > < a href = "undocumented#SkColorSetARGB" > SkColorSetARGB< / a >
2017-07-28 19:18:29 +00:00
---
## <a name="Alpha_Methods"></a> Alpha Methods
2017-08-25 15:51:49 +00:00
< a href = "#Alpha" > Color Alpha< / a > sets the transparency independent of < a href = "#RGB" > Color RGB< / a > : < a href = "#RGB_Red" > Color RGB Red< / a > , < a href = "#RGB_Blue" > Color RGB Blue< / a > , and < a href = "#RGB_Green" > Color RGB Green< / a > .
2017-07-28 19:18:29 +00:00
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_getAlpha" > < / a >
2017-07-28 19:18:29 +00:00
## getAlpha
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-07-28 19:18:29 +00:00
uint8_t getAlpha() const
< / pre >
2017-09-01 19:51:02 +00:00
Retrieves < a href = "#Alpha" > Alpha< / a > from the < a href = "undocumented#Color" > Color< / a > used when stroking and filling.
2017-07-28 19:18:29 +00:00
### Return Value
2017-09-01 19:51:02 +00:00
< a href = "#Alpha" > Alpha< / a > ranging from zero, fully transparent, to 255, fully opaque
2017-07-28 19:18:29 +00:00
### Example
< div > < fiddle-embed name = "9a85bb62fe3d877b18fb7f952c4fa7f7" >
#### Example Output
~~~~
255 == paint.getAlpha()
~~~~
< / fiddle-embed > < / div >
---
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_setAlpha" > < / a >
2017-07-28 19:18:29 +00:00
## setAlpha
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-07-28 19:18:29 +00:00
void setAlpha(U8CPU a)
< / pre >
2018-01-04 21:11:51 +00:00
Replaces < a href = "#Alpha" > Alpha< / a > , leaving < a href = "#RGB" > Color RGB< / a >
2017-07-28 19:18:29 +00:00
unchanged. An out of range value triggers an assert in the debug
2017-08-25 15:51:49 +00:00
build. < a href = "#SkPaint_setAlpha_a" > a< / a > is < a href = "#SkPaint_setAlpha_a" > a< / a > value from zero to 255.
< a href = "#SkPaint_setAlpha_a" > a< / a > set to zero makes < a href = "undocumented#Color" > Color< / a > fully transparent; < a href = "#SkPaint_setAlpha_a" > a< / a > set to 255 makes < a href = "undocumented#Color" > Color< / a >
2017-07-28 19:18:29 +00:00
fully opaque.
### Parameters
2017-08-25 15:51:49 +00:00
< table > < tr > < td > < a name = "SkPaint_setAlpha_a" > < code > < strong > a < / strong > < / code > < / a > < / td > < td >
2017-09-01 19:51:02 +00:00
< a href = "#Alpha" > Alpha< / a > component of < a href = "undocumented#Color" > Color< / a > < / td >
2017-07-28 19:18:29 +00:00
< / tr >
< / table >
### Example
< div > < fiddle-embed name = "6ddc0360512dfb9947e75c17e6a8103d" >
#### Example Output
~~~~
0x44112233 == paint.getColor()
~~~~
< / fiddle-embed > < / div >
---
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_setARGB" > < / a >
2017-07-28 19:18:29 +00:00
## setARGB
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-07-28 19:18:29 +00:00
void setARGB(U8CPU a, U8CPU r, U8CPU g, U8CPU b)
< / pre >
2017-08-04 16:48:24 +00:00
Sets < a href = "undocumented#Color" > Color< / a > used when drawing solid fills. The color components range from 0 to 255.
2017-09-01 19:51:02 +00:00
The color is < a href = "#Unpremultiply" > Unpremultiplied< / a > ; < a href = "#Alpha" > Alpha< / a > sets the transparency independent of < a href = "#RGB" > Color RGB< / a > .
2017-07-28 19:18:29 +00:00
### Parameters
2017-08-25 15:51:49 +00:00
< table > < tr > < td > < a name = "SkPaint_setARGB_a" > < code > < strong > a < / strong > < / code > < / a > < / td > < td >
amount of < a href = "#Alpha" > Color Alpha< / a > , from fully transparent (0) to fully opaque (255)< / td >
< / tr > < tr > < td > < a name = "SkPaint_setARGB_r" > < code > < strong > r < / strong > < / code > < / a > < / td > < td >
amount of < a href = "#RGB_Red" > Color RGB Red< / a > , from no red (0) to full red (255)< / td >
< / tr > < tr > < td > < a name = "SkPaint_setARGB_g" > < code > < strong > g < / strong > < / code > < / a > < / td > < td >
amount of < a href = "#RGB_Green" > Color RGB Green< / a > , from no green (0) to full green (255)< / td >
< / tr > < tr > < td > < a name = "SkPaint_setARGB_b" > < code > < strong > b < / strong > < / code > < / a > < / td > < td >
amount of < a href = "#RGB_Blue" > Color RGB Blue< / a > , from no blue (0) to full blue (255)< / td >
2017-07-28 19:18:29 +00:00
< / tr >
< / table >
### Example
< div > < fiddle-embed name = "cb62e4755789ed32f7120dc55984959d" >
#### Example Output
~~~~
transRed1 == transRed2
~~~~
< / fiddle-embed > < / div >
### See Also
2017-08-25 15:51:49 +00:00
< a href = "#SkPaint_setColor" > setColor< / a > < a href = "undocumented#SkColorSetARGB" > SkColorSetARGB< / a >
2017-07-28 19:18:29 +00:00
---
# <a name="Style"></a> Style
2017-08-25 15:51:49 +00:00
< a href = "#Style" > Style< / a > specifies if the geometry is filled, stroked, or both filled and stroked.
Some shapes ignore < a href = "#Style" > Style< / a > and are always drawn filled or stroked.
2017-07-28 19:18:29 +00:00
2017-08-25 15:51:49 +00:00
Set < a href = "#Style" > Style< / a > to < a href = "#SkPaint_kFill_Style" > kFill Style< / a > to fill the shape.
2017-07-28 19:18:29 +00:00
The fill covers the area inside the geometry for most shapes.
2017-08-25 15:51:49 +00:00
Set < a href = "#Style" > Style< / a > to < a href = "#SkPaint_kStroke_Style" > kStroke Style< / a > to stroke the shape.
2017-07-28 19:18:29 +00:00
## <a name="Fill"></a> Fill
### See Also
2017-08-25 15:51:49 +00:00
< a href = "#Fill_Type" > Path Fill Type< / a >
2017-07-28 19:18:29 +00:00
## <a name="Stroke"></a> Stroke
2017-10-04 18:31:33 +00:00
The stroke covers the area described by following the shape edge with a pen or brush of
2017-08-25 15:51:49 +00:00
< a href = "#Stroke_Width" > Stroke Width< / a > . The area covered where the shape starts and stops is described by < a href = "#Stroke_Cap" > Stroke Cap< / a > .
The area covered where the shape turns a corner is described by < a href = "#Stroke_Join" > Stroke Join< / a > .
2017-10-04 18:31:33 +00:00
The stroke is centered on the shape; it extends equally on either side of the shape edge.
2017-07-28 19:18:29 +00:00
2017-08-25 15:51:49 +00:00
As < a href = "#Stroke_Width" > Stroke Width< / a > gets smaller, the drawn path frame is thinner. < a href = "#Stroke_Width" > Stroke Width< / a > less than one
may have gaps, and if < a href = "#SkPaint_kAntiAlias_Flag" > kAntiAlias Flag< / a > is set, < a href = "#Alpha" > Color Alpha< / a > will increase to visually decrease coverage.
2017-07-28 19:18:29 +00:00
## <a name="Hairline"></a> Hairline
2017-08-25 15:51:49 +00:00
< a href = "#Stroke_Width" > Stroke Width< / a > of zero has a special meaning and switches drawing to use < a href = "#Hairline" > Hairline< / a > .
2018-01-04 21:11:51 +00:00
< a href = "#Hairline" > Hairline< / a > draws the thinnest continuous frame. If < a href = "#SkPaint_kAntiAlias_Flag" > kAntiAlias Flag< / a > is clear, adjacent pixels
flow horizontally, vertically,or diagonally.
2017-07-28 19:18:29 +00:00
2017-08-25 15:51:49 +00:00
< a href = "SkPath_Reference#Path" > Path< / a > drawing with < a href = "#Hairline" > Hairline< / a > may hit the same pixel more than once. For instance, < a href = "SkPath_Reference#Path" > Path< / a > containing
two lines in one < a href = "#Contour" > Path Contour< / a > will draw the corner point once, but may both lines may draw the adjacent
pixel. If < a href = "#SkPaint_kAntiAlias_Flag" > kAntiAlias Flag< / a > is set, transparency is applied twice, resulting in a darker pixel. Some
2018-01-04 21:11:51 +00:00
GPU-backed implementations apply transparency at a later drawing stage, avoiding double hit pixels
2017-07-28 19:18:29 +00:00
while stroking.
2017-08-25 15:51:49 +00:00
## <a name="SkPaint_Style"></a> Enum SkPaint::Style
2017-07-28 19:18:29 +00:00
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-08-25 15:51:49 +00:00
enum < a href = "#SkPaint_Style" > Style< / a > {
< a href = "#SkPaint_kFill_Style" > kFill Style< / a > ,
< a href = "#SkPaint_kStroke_Style" > kStroke Style< / a > ,
< a href = "#SkPaint_kStrokeAndFill_Style" > kStrokeAndFill Style< / a > ,
2017-07-28 19:18:29 +00:00
};< / pre >
2017-08-25 15:51:49 +00:00
Set < a href = "#SkPaint_Style" > Style< / a > to fill, stroke, or both fill and stroke geometry.
2017-07-28 19:18:29 +00:00
The stroke and fill
share all paint attributes; for instance, they are drawn with the same color.
2017-08-25 15:51:49 +00:00
Use < a href = "#SkPaint_kStrokeAndFill_Style" > kStrokeAndFill Style< / a > to avoid hitting the same pixels twice with a stroke draw and
2017-07-28 19:18:29 +00:00
a fill draw.
### Constants
< table >
< tr >
2017-08-25 15:51:49 +00:00
< td > < a name = "SkPaint_kFill_Style" > < code > < strong > SkPaint::kFill_Style < / strong > < / code > < / a > < / td > < td > 0< / td > < td > Set to fill geometry.
2018-01-04 21:11:51 +00:00
Applies to < a href = "SkRect_Reference#Rect" > Rect< / a > , < a href = "undocumented#Region" > Region< / a > , < a href = "undocumented#Round_Rect" > Round Rect< / a > , < a href = "#Circle" > Circles< / a > , < a href = "#Oval" > Ovals< / a > , < a href = "SkPath_Reference#Path" > Path< / a > , and < a href = "undocumented#Text" > Text< / a > .
2017-11-27 15:44:06 +00:00
< a href = "SkBitmap_Reference#Bitmap" > Bitmap< / a > , < a href = "SkImage_Reference#Image" > Image< / a > , < a href = "#Patch" > Patches< / a > , < a href = "undocumented#Region" > Region< / a > , < a href = "#Sprite" > Sprites< / a > , and < a href = "undocumented#Vertices" > Vertices< / a > are painted as if
2017-08-25 15:51:49 +00:00
< a href = "#SkPaint_kFill_Style" > kFill Style< / a > is set, and ignore the set < a href = "#SkPaint_Style" > Style< / a > .
The < a href = "#Fill_Type" > Path Fill Type< / a > specifies additional rules to fill the area outside the path edge,
2017-07-28 19:18:29 +00:00
and to create an unfilled hole inside the shape.
2017-08-25 15:51:49 +00:00
< a href = "#SkPaint_Style" > Style< / a > is set to < a href = "#SkPaint_kFill_Style" > kFill Style< / a > by default.< / td >
2017-07-28 19:18:29 +00:00
< / tr >
< tr >
2017-08-25 15:51:49 +00:00
< td > < a name = "SkPaint_kStroke_Style" > < code > < strong > SkPaint::kStroke_Style < / strong > < / code > < / a > < / td > < td > 1< / td > < td > Set to stroke geometry.
2018-01-04 21:11:51 +00:00
Applies to < a href = "SkRect_Reference#Rect" > Rect< / a > , < a href = "undocumented#Region" > Region< / a > , < a href = "undocumented#Round_Rect" > Round Rect< / a > , < a href = "#Arc" > Arcs< / a > , < a href = "#Circle" > Circles< / a > , < a href = "#Oval" > Ovals< / a > , < a href = "SkPath_Reference#Path" > Path< / a > , and < a href = "undocumented#Text" > Text< / a > .
2017-09-01 19:51:02 +00:00
< a href = "#Arc" > Arcs< / a > , < a href = "#Line" > Lines< / a > , and < a href = "#Point" > Points< / a > , are always drawn as if < a href = "#SkPaint_kStroke_Style" > kStroke Style< / a > is set,
2017-08-25 15:51:49 +00:00
and ignore the set < a href = "#SkPaint_Style" > Style< / a > .
The stroke construction is unaffected by the < a href = "#Fill_Type" > Path Fill Type< / a > .< / td >
2017-07-28 19:18:29 +00:00
< / tr >
< tr >
2017-08-25 15:51:49 +00:00
< td > < a name = "SkPaint_kStrokeAndFill_Style" > < code > < strong > SkPaint::kStrokeAndFill_Style < / strong > < / code > < / a > < / td > < td > 2< / td > < td > Set to stroke and fill geometry.
2017-10-04 18:31:33 +00:00
Applies to < a href = "SkRect_Reference#Rect" > Rect< / a > , < a href = "undocumented#Region" > Region< / a > , < a href = "undocumented#Round_Rect" > Round Rect< / a > , < a href = "#Circle" > Circles< / a > , < a href = "#Oval" > Ovals< / a > , < a href = "SkPath_Reference#Path" > Path< / a > , and < a href = "undocumented#Text" > Text< / a > .
2017-08-25 15:51:49 +00:00
< a href = "SkPath_Reference#Path" > Path< / a > is treated as if it is set to < a href = "#SkPath_kWinding_FillType" > SkPath::kWinding FillType< / a > ,
and the set < a href = "#Fill_Type" > Path Fill Type< / a > is ignored.< / td >
2017-07-28 19:18:29 +00:00
< / tr >
< / table >
2017-08-25 15:51:49 +00:00
## <a name="SkPaint__anonymous"></a> Enum SkPaint::_anonymous
2017-07-28 19:18:29 +00:00
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-07-28 19:18:29 +00:00
enum {
2017-08-25 15:51:49 +00:00
< a href = "#SkPaint_kStyleCount" > kStyleCount< / a > = < a href = "#SkPaint_kStrokeAndFill_Style" > kStrokeAndFill Style< / a > + 1,
2017-07-28 19:18:29 +00:00
};< / pre >
### Constants
< table >
< tr >
2017-08-25 15:51:49 +00:00
< td > < a name = "SkPaint_kStyleCount" > < code > < strong > SkPaint::kStyleCount < / strong > < / code > < / a > < / td > < td > 3< / td > < td > The number of different < a href = "#SkPaint_Style" > Style< / a > values defined.
May be used to verify that < a href = "#SkPaint_Style" > Style< / a > is a legal value.< / td >
2017-07-28 19:18:29 +00:00
< / tr >
< / table >
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_getStyle" > < / a >
2017-07-28 19:18:29 +00:00
## getStyle
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-07-28 19:18:29 +00:00
Style getStyle() const
< / pre >
Whether the geometry is filled, stroked, or filled and stroked.
### Return Value
2017-08-25 15:51:49 +00:00
one of:< a href = "#SkPaint_kFill_Style" > kFill Style< / a > , < a href = "#SkPaint_kStroke_Style" > kStroke Style< / a > , < a href = "#SkPaint_kStrokeAndFill_Style" > kStrokeAndFill Style< / a >
2017-07-28 19:18:29 +00:00
### Example
< div > < fiddle-embed name = "1c5e18c3c0102d2dac86a78ba8c8ce01" >
#### Example Output
~~~~
SkPaint::kFill_Style == paint.getStyle()
~~~~
< / fiddle-embed > < / div >
### See Also
2017-08-25 15:51:49 +00:00
< a href = "#SkPaint_Style" > Style< / a > < a href = "#SkPaint_setStyle" > setStyle< / a >
2017-07-28 19:18:29 +00:00
---
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_setStyle" > < / a >
2017-07-28 19:18:29 +00:00
## setStyle
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-07-28 19:18:29 +00:00
void setStyle(Style style)
< / pre >
Sets whether the geometry is filled, stroked, or filled and stroked.
2017-08-25 15:51:49 +00:00
Has no effect if < a href = "#SkPaint_setStyle_style" > style< / a > is not a legal < a href = "#SkPaint_Style" > Style< / a > value.
2017-07-28 19:18:29 +00:00
### Parameters
2017-08-25 15:51:49 +00:00
< table > < tr > < td > < a name = "SkPaint_setStyle_style" > < code > < strong > style < / strong > < / code > < / a > < / td > < td >
one of: < a href = "#SkPaint_kFill_Style" > kFill Style< / a > , < a href = "#SkPaint_kStroke_Style" > kStroke Style< / a > , < a href = "#SkPaint_kStrokeAndFill_Style" > kStrokeAndFill Style< / a > < / td >
2017-07-28 19:18:29 +00:00
< / tr >
< / table >
### Example
< div > < fiddle-embed name = "c7bb6248e4735b8d1a32d02fba40d344" > < / fiddle-embed > < / div >
### See Also
2017-08-25 15:51:49 +00:00
< a href = "#SkPaint_Style" > Style< / a > < a href = "#SkPaint_getStyle" > getStyle< / a >
2017-07-28 19:18:29 +00:00
---
### See Also
2017-08-25 15:51:49 +00:00
< a href = "#Fill_Type" > Path Fill Type< / a > < a href = "undocumented#Path_Effect" > Path Effect< / a > < a href = "#Style_Fill" > Style Fill< / a > < a href = "#Style_Stroke" > Style Stroke< / a >
2017-07-28 19:18:29 +00:00
# <a name="Stroke_Width"></a> Stroke Width
2017-08-25 15:51:49 +00:00
< a href = "#Stroke_Width" > Stroke Width< / a > sets the width for stroking. The width is the thickness
2018-01-04 21:11:51 +00:00
of the stroke perpendicular to the path direction when the paint style is
2017-08-25 15:51:49 +00:00
set to < a href = "#SkPaint_kStroke_Style" > kStroke Style< / a > or < a href = "#SkPaint_kStrokeAndFill_Style" > kStrokeAndFill Style< / a > .
2017-07-28 19:18:29 +00:00
When width is greater than zero, the stroke encompasses as many pixels partially
or fully as needed. When the width equals zero, the paint enables hairlines;
2018-01-04 21:11:51 +00:00
the stroke is always one pixel wide.
2017-07-28 19:18:29 +00:00
2017-10-04 18:31:33 +00:00
The stroke dimensions are scaled by the canvas matrix, but < a href = "#Hairline" > Hairline< / a > stroke
2017-07-28 19:18:29 +00:00
remains one pixel wide regardless of scaling.
The default width for the paint is zero.
### Example
2018-01-04 21:11:51 +00:00
< div > < fiddle-embed name = "01e3e08a3022a351628ff54e84887756" gpu = "true" > < div > The pixels hit to represent thin lines vary with the angle of the
2017-10-04 18:31:33 +00:00
line and the platform implementation.< / div > < / fiddle-embed > < / div >
2017-07-28 19:18:29 +00:00
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_getStrokeWidth" > < / a >
2017-07-28 19:18:29 +00:00
## getStrokeWidth
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-07-28 19:18:29 +00:00
SkScalar getStrokeWidth() const
< / pre >
2017-08-25 15:51:49 +00:00
Returns the thickness of the pen used by < a href = "#Paint" > Paint< / a > to
2017-07-28 19:18:29 +00:00
outline the shape.
### Return Value
2017-08-25 15:51:49 +00:00
zero for < a href = "#Hairline" > Hairline< / a > , greater than zero for pen thickness
2017-07-28 19:18:29 +00:00
### Example
< div > < fiddle-embed name = "99aa73f64df8bbf06e656cd891a81b9e" >
#### Example Output
~~~~
0 == paint.getStrokeWidth()
~~~~
< / fiddle-embed > < / div >
---
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_setStrokeWidth" > < / a >
2017-07-28 19:18:29 +00:00
## setStrokeWidth
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-07-28 19:18:29 +00:00
void setStrokeWidth(SkScalar width)
< / pre >
Sets the thickness of the pen used by the paint to
2018-01-04 21:11:51 +00:00
outline the shape.
Has no effect if < a href = "#SkPaint_setStrokeWidth_width" > width< / a > is less than zero.
2017-07-28 19:18:29 +00:00
### Parameters
2017-08-25 15:51:49 +00:00
< table > < tr > < td > < a name = "SkPaint_setStrokeWidth_width" > < code > < strong > width < / strong > < / code > < / a > < / td > < td >
zero thickness for < a href = "#Hairline" > Hairline< / a > ; greater than zero for pen thickness< / td >
2017-07-28 19:18:29 +00:00
< / tr >
< / table >
### Example
< div > < fiddle-embed name = "0c4446c0870b5c7b5a2efe77ff92afb8" >
#### Example Output
~~~~
5 == paint.getStrokeWidth()
~~~~
< / fiddle-embed > < / div >
---
# <a name="Miter_Limit"></a> Miter Limit
2017-08-25 15:51:49 +00:00
< a href = "#Miter_Limit" > Miter Limit< / a > specifies the maximum miter length,
2017-07-28 19:18:29 +00:00
relative to the stroke width.
2017-08-25 15:51:49 +00:00
< a href = "#Miter_Limit" > Miter Limit< / a > is used when the < a href = "#Stroke_Join" > Stroke Join< / a >
is set to < a href = "#SkPaint_kMiter_Join" > kMiter Join< / a > , and the < a href = "#SkPaint_Style" > Style< / a > is either < a href = "#SkPaint_kStroke_Style" > kStroke Style< / a >
or < a href = "#SkPaint_kStrokeAndFill_Style" > kStrokeAndFill Style< / a > .
2017-07-28 19:18:29 +00:00
2017-08-25 15:51:49 +00:00
If the miter at a corner exceeds this limit, < a href = "#SkPaint_kMiter_Join" > kMiter Join< / a >
is replaced with < a href = "#SkPaint_kBevel_Join" > kBevel Join< / a > .
2017-07-28 19:18:29 +00:00
2017-08-25 15:51:49 +00:00
< a href = "#Miter_Limit" > Miter Limit< / a > can be computed from the corner angle:
2017-07-28 19:18:29 +00:00
2017-08-25 15:51:49 +00:00
miter limit = 1 / sin ( angle / 2 )< a href = "#Miter_Limit" > Miter Limit< / a > default value is 4.
2017-08-04 16:48:24 +00:00
The default may be changed at compile time by setting < a href = "undocumented#SkPaintDefaults_MiterLimit" > SkPaintDefaults MiterLimit< / a >
2018-01-04 21:11:51 +00:00
in "SkUserConfig.h" or as a define supplied by the build environment.
2017-07-28 19:18:29 +00:00
Here are some miter limits and the angles that triggers them.
| miter limit | angle in degrees |
| --- | --- |
| 10 | 11.48 |
| 9 | 12.76 |
| 8 | 14.36 |
| 7 | 16.43 |
| 6 | 19.19 |
| 5 | 23.07 |
| 4 | 28.96 |
| 3 | 38.94 |
| 2 | 60 |
| 1 | 180 |
### Example
< div > < fiddle-embed name = "5de2de0f00354e59074a9bb1a42d5a63" > < div > This example draws a stroked corner and the miter length beneath.
When the miter limit is decreased slightly, the miter join is replaced
by a bevel join.< / div > < / fiddle-embed > < / div >
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_getStrokeMiter" > < / a >
2017-07-28 19:18:29 +00:00
## getStrokeMiter
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-07-28 19:18:29 +00:00
SkScalar getStrokeMiter() const
< / pre >
The limit at which a sharp corner is drawn beveled.
### Return Value
2017-08-25 15:51:49 +00:00
zero and greater < a href = "#Miter_Limit" > Miter Limit< / a >
2017-07-28 19:18:29 +00:00
### Example
< div > < fiddle-embed name = "50da74a43b725f07a914df588c867d36" >
#### Example Output
~~~~
default miter limit == 4
~~~~
< / fiddle-embed > < / div >
### See Also
2017-08-25 15:51:49 +00:00
< a href = "#Miter_Limit" > Miter Limit< / a > < a href = "#SkPaint_setStrokeMiter" > setStrokeMiter< / a > < a href = "#SkPaint_Join" > Join< / a >
2017-07-28 19:18:29 +00:00
---
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_setStrokeMiter" > < / a >
2017-07-28 19:18:29 +00:00
## setStrokeMiter
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-07-28 19:18:29 +00:00
void setStrokeMiter(SkScalar miter)
< / pre >
The limit at which a sharp corner is drawn beveled.
Valid values are zero and greater.
2017-08-25 15:51:49 +00:00
Has no effect if < a href = "#SkPaint_setStrokeMiter_miter" > miter< / a > is less than zero.
2017-07-28 19:18:29 +00:00
### Parameters
2017-08-25 15:51:49 +00:00
< table > < tr > < td > < a name = "SkPaint_setStrokeMiter_miter" > < code > < strong > miter < / strong > < / code > < / a > < / td > < td >
zero and greater < a href = "#Miter_Limit" > Miter Limit< / a > < / td >
2017-07-28 19:18:29 +00:00
< / tr >
< / table >
### Example
< div > < fiddle-embed name = "700b284dbc97785c6a9c9636088713ad" >
#### Example Output
~~~~
default miter limit == 8
~~~~
< / fiddle-embed > < / div >
### See Also
2017-08-25 15:51:49 +00:00
< a href = "#Miter_Limit" > Miter Limit< / a > < a href = "#SkPaint_getStrokeMiter" > getStrokeMiter< / a > < a href = "#SkPaint_Join" > Join< / a >
2017-07-28 19:18:29 +00:00
---
# <a name="Stroke_Cap"></a> Stroke Cap
2017-08-25 15:51:49 +00:00
## <a name="SkPaint_Cap"></a> Enum SkPaint::Cap
2017-07-28 19:18:29 +00:00
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-08-25 15:51:49 +00:00
enum < a href = "#SkPaint_Cap" > Cap< / a > {
< a href = "#SkPaint_kButt_Cap" > kButt Cap< / a > ,
< a href = "#SkPaint_kRound_Cap" > kRound Cap< / a > ,
< a href = "#SkPaint_kSquare_Cap" > kSquare Cap< / a > ,
2017-07-28 19:18:29 +00:00
2017-08-25 15:51:49 +00:00
< a href = "#SkPaint_kLast_Cap" > kLast Cap< / a > = < a href = "#SkPaint_kSquare_Cap" > kSquare Cap< / a > ,
< a href = "#SkPaint_kDefault_Cap" > kDefault Cap< / a > = < a href = "#SkPaint_kButt_Cap" > kButt Cap< / a > ,
2017-07-28 19:18:29 +00:00
};
2017-09-21 16:31:06 +00:00
2017-08-25 15:51:49 +00:00
static constexpr int < a href = "#SkPaint_kCapCount" > kCapCount< / a > = < a href = "#SkPaint_kLast_Cap" > kLast Cap< / a > + 1;< / pre >
2017-07-28 19:18:29 +00:00
2017-08-25 15:51:49 +00:00
< a href = "#Stroke_Cap" > Stroke Cap< / a > draws at the beginning and end of an open < a href = "#Contour" > Path Contour< / a > .
2017-07-28 19:18:29 +00:00
### Constants
< table >
< tr >
2017-08-25 15:51:49 +00:00
< td > < a name = "SkPaint_kButt_Cap" > < code > < strong > SkPaint::kButt_Cap < / strong > < / code > < / a > < / td > < td > 0< / td > < td > Does not extend the stroke past the beginning or the end.< / td >
2017-07-28 19:18:29 +00:00
< / tr >
< tr >
2017-08-25 15:51:49 +00:00
< td > < a name = "SkPaint_kRound_Cap" > < code > < strong > SkPaint::kRound_Cap < / strong > < / code > < / a > < / td > < td > 1< / td > < td > Adds a circle with a diameter equal to < a href = "#Stroke_Width" > Stroke Width< / a > at the beginning
2017-07-28 19:18:29 +00:00
and end.< / td >
< / tr >
< tr >
2017-08-25 15:51:49 +00:00
< td > < a name = "SkPaint_kSquare_Cap" > < code > < strong > SkPaint::kSquare_Cap < / strong > < / code > < / a > < / td > < td > 2< / td > < td > Adds a square with sides equal to < a href = "#Stroke_Width" > Stroke Width< / a > at the beginning
2017-07-28 19:18:29 +00:00
and end. The square sides are parallel to the initial and final direction
of the stroke.< / td >
< / tr >
< tr >
2017-08-25 15:51:49 +00:00
< td > < a name = "SkPaint_kLast_Cap" > < code > < strong > SkPaint::kLast_Cap < / strong > < / code > < / a > < / td > < td > 2< / td > < td > Equivalent to the largest value for < a href = "#Stroke_Cap" > Stroke Cap< / a > .< / td >
2017-07-28 19:18:29 +00:00
< / tr >
< tr >
2017-08-25 15:51:49 +00:00
< td > < a name = "SkPaint_kDefault_Cap" > < code > < strong > SkPaint::kDefault_Cap < / strong > < / code > < / a > < / td > < td > 0< / td > < td > Equivalent to < a href = "#SkPaint_kButt_Cap" > kButt Cap< / a > .
< a href = "#Stroke_Cap" > Stroke Cap< / a > is set to < a href = "#SkPaint_kButt_Cap" > kButt Cap< / a > by default.< / td >
2017-07-28 19:18:29 +00:00
< / tr >
< tr >
2017-08-25 15:51:49 +00:00
< td > < a name = "SkPaint_kCapCount" > < code > < strong > SkPaint::kCapCount < / strong > < / code > < / a > < / td > < td > 3< / td > < td > The number of different < a href = "#Stroke_Cap" > Stroke Cap< / a > values defined.
May be used to verify that < a href = "#Stroke_Cap" > Stroke Cap< / a > is a legal value.< / td >
2017-07-28 19:18:29 +00:00
< / tr >
2018-01-04 21:11:51 +00:00
Stroke describes the area covered by a pen of < a href = "#Stroke_Width" > Stroke Width< / a > as it
2017-10-04 18:31:33 +00:00
follows the < a href = "#Contour" > Path Contour< / a > , moving parallel to the contour direction.
2017-07-28 19:18:29 +00:00
2017-08-25 15:51:49 +00:00
If the < a href = "#Contour" > Path Contour< / a > is not terminated by < a href = "#SkPath_kClose_Verb" > SkPath::kClose Verb< / a > , the contour has a
2017-07-28 19:18:29 +00:00
visible beginning and end.
2017-08-25 15:51:49 +00:00
< a href = "#Contour" > Path Contour< / a > may start and end at the same point; defining < a href = "SkPath_Reference#Zero_Length" > Zero Length Contour< / a > .
2017-07-28 19:18:29 +00:00
2017-08-25 15:51:49 +00:00
< a href = "#SkPaint_kButt_Cap" > kButt Cap< / a > and < a href = "SkPath_Reference#Zero_Length" > Zero Length Contour< / a > is not drawn.
2018-01-04 21:11:51 +00:00
< a href = "#SkPaint_kRound_Cap" > kRound Cap< / a > and < a href = "SkPath_Reference#Zero_Length" > Zero Length Contour< / a > draws a circle of diameter < a href = "#Stroke_Width" > Stroke Width< / a >
2017-07-28 19:18:29 +00:00
at the contour point.
2017-08-25 15:51:49 +00:00
< a href = "#SkPaint_kSquare_Cap" > kSquare Cap< / a > and < a href = "SkPath_Reference#Zero_Length" > Zero Length Contour< / a > draws an upright square with a side of
< a href = "#Stroke_Width" > Stroke Width< / a > at the contour point.
2017-07-28 19:18:29 +00:00
2017-08-25 15:51:49 +00:00
< a href = "#Stroke_Cap" > Stroke Cap< / a > is < a href = "#SkPaint_kButt_Cap" > kButt Cap< / a > by default.
2017-07-28 19:18:29 +00:00
< / table >
### Example
2017-11-02 21:49:34 +00:00
< div > < fiddle-embed name = "2bffb6384cc20077e632e7d01da045ca" > < / fiddle-embed > < / div >
2017-07-28 19:18:29 +00:00
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_getStrokeCap" > < / a >
2017-07-28 19:18:29 +00:00
## getStrokeCap
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-07-28 19:18:29 +00:00
Cap getStrokeCap() const
< / pre >
The geometry drawn at the beginning and end of strokes.
### Return Value
2017-08-25 15:51:49 +00:00
one of: < a href = "#SkPaint_kButt_Cap" > kButt Cap< / a > , < a href = "#SkPaint_kRound_Cap" > kRound Cap< / a > , < a href = "#SkPaint_kSquare_Cap" > kSquare Cap< / a >
2017-07-28 19:18:29 +00:00
### Example
< div > < fiddle-embed name = "aabf9baee8e026fae36fca30e955512b" >
#### Example Output
~~~~
kButt_Cap == default stroke cap
~~~~
< / fiddle-embed > < / div >
### See Also
2017-08-25 15:51:49 +00:00
< a href = "#Stroke_Cap" > Stroke Cap< / a > < a href = "#SkPaint_setStrokeCap" > setStrokeCap< / a >
2017-07-28 19:18:29 +00:00
---
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_setStrokeCap" > < / a >
2017-07-28 19:18:29 +00:00
## setStrokeCap
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-07-28 19:18:29 +00:00
void setStrokeCap(Cap cap)
< / pre >
The geometry drawn at the beginning and end of strokes.
### Parameters
2017-08-25 15:51:49 +00:00
< table > < tr > < td > < a name = "SkPaint_setStrokeCap_cap" > < code > < strong > cap < / strong > < / code > < / a > < / td > < td >
one of: < a href = "#SkPaint_kButt_Cap" > kButt Cap< / a > , < a href = "#SkPaint_kRound_Cap" > kRound Cap< / a > , < a href = "#SkPaint_kSquare_Cap" > kSquare Cap< / a > ;
has no effect if < a href = "#SkPaint_setStrokeCap_cap" > cap< / a > is not valid< / td >
2017-07-28 19:18:29 +00:00
< / tr >
< / table >
### Example
< div > < fiddle-embed name = "de83fbd848a4625345b4b87a6e55d98a" >
#### Example Output
~~~~
kRound_Cap == paint.getStrokeCap()
~~~~
< / fiddle-embed > < / div >
### See Also
2017-08-25 15:51:49 +00:00
< a href = "#Stroke_Cap" > Stroke Cap< / a > < a href = "#SkPaint_getStrokeCap" > getStrokeCap< / a >
2017-07-28 19:18:29 +00:00
---
# <a name="Stroke_Join"></a> Stroke Join
2017-08-25 15:51:49 +00:00
< a href = "#Stroke_Join" > Stroke Join< / a > draws at the sharp corners of an open or closed < a href = "#Contour" > Path Contour< / a > .
2017-07-28 19:18:29 +00:00
2018-01-04 21:11:51 +00:00
Stroke describes the area covered by a pen of < a href = "#Stroke_Width" > Stroke Width< / a > as it
2017-10-04 18:31:33 +00:00
follows the < a href = "#Contour" > Path Contour< / a > , moving parallel to the contour direction.
2017-07-28 19:18:29 +00:00
If the contour direction changes abruptly, because the tangent direction leading
to the end of a curve within the contour does not match the tangent direction of
2017-08-25 15:51:49 +00:00
the following curve, the pair of curves meet at < a href = "#Stroke_Join" > Stroke Join< / a > .
2017-07-28 19:18:29 +00:00
### Example
2017-11-02 21:49:34 +00:00
< div > < fiddle-embed name = "917c44b504d3f9308571fd3835d90a0d" > < / fiddle-embed > < / div >
2017-07-28 19:18:29 +00:00
2017-08-25 15:51:49 +00:00
## <a name="SkPaint_Join"></a> Enum SkPaint::Join
2017-07-28 19:18:29 +00:00
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-08-25 15:51:49 +00:00
enum < a href = "#SkPaint_Join" > Join< / a > {
< a href = "#SkPaint_kMiter_Join" > kMiter Join< / a > ,
< a href = "#SkPaint_kRound_Join" > kRound Join< / a > ,
< a href = "#SkPaint_kBevel_Join" > kBevel Join< / a > ,
2017-07-28 19:18:29 +00:00
2017-08-25 15:51:49 +00:00
< a href = "#SkPaint_kLast_Join" > kLast Join< / a > = < a href = "#SkPaint_kBevel_Join" > kBevel Join< / a > ,
< a href = "#SkPaint_kDefault_Join" > kDefault Join< / a > = < a href = "#SkPaint_kMiter_Join" > kMiter Join< / a > ,
2017-07-28 19:18:29 +00:00
};
2017-09-21 16:31:06 +00:00
2017-08-25 15:51:49 +00:00
static constexpr int < a href = "#SkPaint_kJoinCount" > kJoinCount< / a > = < a href = "#SkPaint_kLast_Join" > kLast Join< / a > + 1;< / pre >
2017-07-28 19:18:29 +00:00
2017-08-25 15:51:49 +00:00
< a href = "#SkPaint_Join" > Join< / a > specifies how corners are drawn when a shape is stroked. < a href = "#SkPaint_Join" > Join< / a >
2017-07-28 19:18:29 +00:00
affects the four corners of a stroked rectangle, and the connected segments in a
stroked path.
Choose miter join to draw sharp corners. Choose round join to draw a circle with a
radius equal to the stroke width on top of the corner. Choose bevel join to minimally
connect the thick strokes.
2018-01-04 21:11:51 +00:00
The fill path constructed to describe the stroked path respects the join setting but may
2017-07-28 19:18:29 +00:00
not contain the actual join. For instance, a fill path constructed with round joins does
not necessarily include circles at each connected segment.
### Constants
< table >
< tr >
2017-08-25 15:51:49 +00:00
< td > < a name = "SkPaint_kMiter_Join" > < code > < strong > SkPaint::kMiter_Join < / strong > < / code > < / a > < / td > < td > 0< / td > < td > Extends the outside corner to the extent allowed by < a href = "#Miter_Limit" > Miter Limit< / a > .
If the extension exceeds < a href = "#Miter_Limit" > Miter Limit< / a > , < a href = "#SkPaint_kBevel_Join" > kBevel Join< / a > is used instead.< / td >
2017-07-28 19:18:29 +00:00
< / tr >
< tr >
2017-08-25 15:51:49 +00:00
< td > < a name = "SkPaint_kRound_Join" > < code > < strong > SkPaint::kRound_Join < / strong > < / code > < / a > < / td > < td > 1< / td > < td > Adds a circle with a diameter of < a href = "#Stroke_Width" > Stroke Width< / a > at the sharp corner.< / td >
2017-07-28 19:18:29 +00:00
< / tr >
< tr >
2017-08-25 15:51:49 +00:00
< td > < a name = "SkPaint_kBevel_Join" > < code > < strong > SkPaint::kBevel_Join < / strong > < / code > < / a > < / td > < td > 2< / td > < td > Connects the outside edges of the sharp corner.< / td >
2017-07-28 19:18:29 +00:00
< / tr >
< tr >
2017-08-25 15:51:49 +00:00
< td > < a name = "SkPaint_kLast_Join" > < code > < strong > SkPaint::kLast_Join < / strong > < / code > < / a > < / td > < td > 2< / td > < td > Equivalent to the largest value for < a href = "#Stroke_Join" > Stroke Join< / a > .< / td >
2017-07-28 19:18:29 +00:00
< / tr >
< tr >
2017-08-25 15:51:49 +00:00
< td > < a name = "SkPaint_kDefault_Join" > < code > < strong > SkPaint::kDefault_Join < / strong > < / code > < / a > < / td > < td > 1< / td > < td > Equivalent to < a href = "#SkPaint_kMiter_Join" > kMiter Join< / a > .
< a href = "#Stroke_Join" > Stroke Join< / a > is set to < a href = "#SkPaint_kMiter_Join" > kMiter Join< / a > by default.< / td >
2017-07-28 19:18:29 +00:00
< / tr >
< tr >
2017-08-25 15:51:49 +00:00
< td > < a name = "SkPaint_kJoinCount" > < code > < strong > SkPaint::kJoinCount < / strong > < / code > < / a > < / td > < td > 3< / td > < td > The number of different < a href = "#Stroke_Join" > Stroke Join< / a > values defined.
May be used to verify that < a href = "#Stroke_Join" > Stroke Join< / a > is a legal value.< / td >
2017-07-28 19:18:29 +00:00
< / tr >
< / table >
### Example
< div > < fiddle-embed name = "3b1aebacc21c1836a52876b9b0b3905e" > < / fiddle-embed > < / div >
### See Also
2017-08-25 15:51:49 +00:00
< a href = "#SkPaint_setStrokeJoin" > setStrokeJoin< / a > < a href = "#SkPaint_getStrokeJoin" > getStrokeJoin< / a > < a href = "#SkPaint_setStrokeMiter" > setStrokeMiter< / a > < a href = "#SkPaint_getStrokeMiter" > getStrokeMiter< / a >
2017-07-28 19:18:29 +00:00
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_getStrokeJoin" > < / a >
2017-07-28 19:18:29 +00:00
## getStrokeJoin
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-07-28 19:18:29 +00:00
Join getStrokeJoin() const
< / pre >
2017-12-15 16:21:51 +00:00
The geometry drawn at the corners of strokes.
2017-07-28 19:18:29 +00:00
### Return Value
2017-08-25 15:51:49 +00:00
one of: < a href = "#SkPaint_kMiter_Join" > kMiter Join< / a > , < a href = "#SkPaint_kRound_Join" > kRound Join< / a > , < a href = "#SkPaint_kBevel_Join" > kBevel Join< / a >
2017-07-28 19:18:29 +00:00
### Example
< div > < fiddle-embed name = "31bf751d0a8ddf176b871810820d8199" >
#### Example Output
~~~~
kMiter_Join == default stroke join
~~~~
< / fiddle-embed > < / div >
### See Also
2017-08-25 15:51:49 +00:00
< a href = "#Stroke_Join" > Stroke Join< / a > < a href = "#SkPaint_setStrokeJoin" > setStrokeJoin< / a >
2017-07-28 19:18:29 +00:00
---
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_setStrokeJoin" > < / a >
2017-07-28 19:18:29 +00:00
## setStrokeJoin
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-07-28 19:18:29 +00:00
void setStrokeJoin(Join join)
< / pre >
2017-12-15 16:21:51 +00:00
The geometry drawn at the corners of strokes.
2017-07-28 19:18:29 +00:00
### Parameters
2017-08-25 15:51:49 +00:00
< table > < tr > < td > < a name = "SkPaint_setStrokeJoin_join" > < code > < strong > join < / strong > < / code > < / a > < / td > < td >
one of: < a href = "#SkPaint_kMiter_Join" > kMiter Join< / a > , < a href = "#SkPaint_kRound_Join" > kRound Join< / a > , < a href = "#SkPaint_kBevel_Join" > kBevel Join< / a > ;
2017-08-03 21:14:08 +00:00
otherwise, has no effect< / td >
2017-07-28 19:18:29 +00:00
< / tr >
< / table >
### Example
< div > < fiddle-embed name = "48d963ad4286eddf680f9c511eb6da91" >
#### Example Output
~~~~
kMiter_Join == paint.getStrokeJoin()
~~~~
< / fiddle-embed > < / div >
### See Also
2017-08-25 15:51:49 +00:00
< a href = "#Stroke_Join" > Stroke Join< / a > < a href = "#SkPaint_getStrokeJoin" > getStrokeJoin< / a >
2017-07-28 19:18:29 +00:00
---
### See Also
2017-08-25 15:51:49 +00:00
< a href = "#Miter_Limit" > Miter Limit< / a >
2017-07-28 19:18:29 +00:00
# <a name="Fill_Path"></a> Fill Path
2017-08-25 15:51:49 +00:00
< a href = "#Fill_Path" > Fill Path< / a > creates a < a href = "SkPath_Reference#Path" > Path< / a > by applying the < a href = "undocumented#Path_Effect" > Path Effect< / a > , followed by the < a href = "#Style_Stroke" > Style Stroke< / a > .
2017-07-28 19:18:29 +00:00
2017-08-25 15:51:49 +00:00
If < a href = "#Paint" > Paint< / a > contains < a href = "undocumented#Path_Effect" > Path Effect< / a > , < a href = "undocumented#Path_Effect" > Path Effect< / a > operates on the source < a href = "SkPath_Reference#Path" > Path< / a > ; the result
2017-08-04 16:48:24 +00:00
replaces the destination < a href = "SkPath_Reference#Path" > Path< / a > . Otherwise, the source < a href = "SkPath_Reference#Path" > Path< / a > is replaces the
destination < a href = "SkPath_Reference#Path" > Path< / a > .
2017-07-28 19:18:29 +00:00
2017-08-04 16:48:24 +00:00
Fill < a href = "SkPath_Reference#Path" > Path< / a > can request the < a href = "undocumented#Path_Effect" > Path Effect< / a > to restrict to a culling rectangle, but
the < a href = "undocumented#Path_Effect" > Path Effect< / a > is not required to do so.
2017-07-28 19:18:29 +00:00
2018-01-04 21:11:51 +00:00
If < a href = "#SkPaint_Style" > Style< / a > is < a href = "#SkPaint_kStroke_Style" > kStroke Style< / a > or < a href = "#SkPaint_kStrokeAndFill_Style" > kStrokeAndFill Style< / a > ,
2017-08-25 15:51:49 +00:00
and < a href = "#Stroke_Width" > Stroke Width< / a > is greater than zero, the < a href = "#Stroke_Width" > Stroke Width< / a > , < a href = "#Stroke_Cap" > Stroke Cap< / a > , < a href = "#Stroke_Join" > Stroke Join< / a > ,
and < a href = "#Miter_Limit" > Miter Limit< / a > operate on the destination < a href = "SkPath_Reference#Path" > Path< / a > , replacing it.
2017-07-28 19:18:29 +00:00
2018-01-04 21:11:51 +00:00
Fill < a href = "SkPath_Reference#Path" > Path< / a > can specify the precision used by < a href = "#Stroke_Width" > Stroke Width< / a > to approximate the stroke geometry.
2017-07-28 19:18:29 +00:00
2017-08-25 15:51:49 +00:00
If the < a href = "#SkPaint_Style" > Style< / a > is < a href = "#SkPaint_kStroke_Style" > kStroke Style< / a > and the < a href = "#Stroke_Width" > Stroke Width< / a > is zero, < a href = "#SkPaint_getFillPath" > getFillPath< / a >
returns false since < a href = "#Hairline" > Hairline< / a > has no filled equivalent.
2017-07-28 19:18:29 +00:00
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_getFillPath" > < / a >
2017-07-28 19:18:29 +00:00
## getFillPath
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
bool getFillPath(const SkPath& src, SkPath* dst, const SkRect* cullRect, SkScalar resScale = 1) const
2017-07-28 19:18:29 +00:00
< / pre >
The filled equivalent of the stroked path.
### Parameters
2017-08-25 15:51:49 +00:00
< table > < tr > < td > < a name = "SkPaint_getFillPath_src" > < code > < strong > src < / strong > < / code > < / a > < / td > < td >
2017-08-04 16:48:24 +00:00
< a href = "SkPath_Reference#Path" > Path< / a > read to create a filled version< / td >
2017-08-25 15:51:49 +00:00
< / tr > < tr > < td > < a name = "SkPaint_getFillPath_dst" > < code > < strong > dst < / strong > < / code > < / a > < / td > < td >
resulting < a href = "SkPath_Reference#Path" > Path< / a > ; may be the same as < a href = "#SkPaint_getFillPath_src" > src< / a > , but may not be nullptr< / td >
< / tr > < tr > < td > < a name = "SkPaint_getFillPath_cullRect" > < code > < strong > cullRect < / strong > < / code > < / a > < / td > < td >
2017-08-04 16:48:24 +00:00
optional limit passed to < a href = "undocumented#Path_Effect" > Path Effect< / a > < / td >
2017-08-25 15:51:49 +00:00
< / tr > < tr > < td > < a name = "SkPaint_getFillPath_resScale" > < code > < strong > resScale < / strong > < / code > < / a > < / td > < td >
2017-07-28 19:18:29 +00:00
if > 1, increase precision, else if (0 < res < 1 ) reduce precision
to favor speed and size< / td >
< / tr >
< / table >
### Return Value
2017-08-25 15:51:49 +00:00
true if the path represents < a href = "#Style_Fill" > Style Fill< / a > , or false if it represents < a href = "#Hairline" > Hairline< / a >
2017-07-28 19:18:29 +00:00
### Example
2017-09-01 19:51:02 +00:00
< div > < fiddle-embed name = "cedd6233848198e1fca4d1e14816baaf" > < div > A very small < a href = "#Quad" > Quad< / a > stroke is turned into a filled path with increasing levels of precision.
2018-01-04 21:11:51 +00:00
At the lowest precision, the < a href = "#Quad" > Quad< / a > stroke is approximated by a rectangle.
2017-07-28 19:18:29 +00:00
At the highest precision, the filled path has high fidelity compared to the original stroke.< / div > < / fiddle-embed > < / div >
---
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-07-28 19:18:29 +00:00
bool getFillPath(const SkPath& src, SkPath* dst) const
< / pre >
The filled equivalent of the stroked path.
2017-08-25 15:51:49 +00:00
Replaces < a href = "#SkPaint_getFillPath_2_dst" > dst< / a > with the < a href = "#SkPaint_getFillPath_2_src" > src< / a > path modified by < a href = "undocumented#Path_Effect" > Path Effect< / a > and < a href = "#Style_Stroke" > Style Stroke< / a > .
< a href = "undocumented#Path_Effect" > Path Effect< / a > , if any, is not culled. < a href = "#Stroke_Width" > Stroke Width< / a > is created with default precision.
2017-07-28 19:18:29 +00:00
### Parameters
2017-08-25 15:51:49 +00:00
< table > < tr > < td > < a name = "SkPaint_getFillPath_2_src" > < code > < strong > src < / strong > < / code > < / a > < / td > < td >
2017-08-04 16:48:24 +00:00
< a href = "SkPath_Reference#Path" > Path< / a > read to create a filled version< / td >
2017-08-25 15:51:49 +00:00
< / tr > < tr > < td > < a name = "SkPaint_getFillPath_2_dst" > < code > < strong > dst < / strong > < / code > < / a > < / td > < td >
resulting < a href = "SkPath_Reference#Path" > Path< / a > < a href = "#SkPaint_getFillPath_2_dst" > dst< / a > may be the same as < a href = "#SkPaint_getFillPath_2_src" > src< / a > , but may not be nullptr< / td >
2017-07-28 19:18:29 +00:00
< / tr >
< / table >
### Return Value
2017-08-25 15:51:49 +00:00
true if the path represents < a href = "#Style_Fill" > Style Fill< / a > , or false if it represents < a href = "#Hairline" > Hairline< / a >
2017-07-28 19:18:29 +00:00
### Example
< div > < fiddle-embed name = "e6d8ca0cc17e0b475bd54dd995825468" > < / fiddle-embed > < / div >
---
### See Also
2017-08-25 15:51:49 +00:00
< a href = "#Style_Stroke" > Style Stroke< / a > < a href = "#Stroke_Width" > Stroke Width< / a > < a href = "undocumented#Path_Effect" > Path Effect< / a >
2017-07-28 19:18:29 +00:00
# <a name="Shader_Methods"></a> Shader Methods
2017-08-04 16:48:24 +00:00
< a href = "undocumented#Shader" > Shader< / a > defines the colors used when drawing a shape.
< a href = "undocumented#Shader" > Shader< / a > may be an image, a gradient, or a computed fill.
2018-01-04 21:11:51 +00:00
If < a href = "#Paint" > Paint< / a > has no < a href = "undocumented#Shader" > Shader< / a > , then < a href = "undocumented#Color" > Color< / a > fills the shape.
2017-07-28 19:18:29 +00:00
2017-08-25 15:51:49 +00:00
< a href = "undocumented#Shader" > Shader< / a > is modulated by < a href = "#Alpha" > Color Alpha< / a > component of < a href = "undocumented#Color" > Color< / a > .
If < a href = "undocumented#Shader" > Shader< / a > object defines only < a href = "#Alpha" > Color Alpha< / a > , then < a href = "undocumented#Color" > Color< / a > modulated by < a href = "#Alpha" > Color Alpha< / a > describes
2017-07-28 19:18:29 +00:00
the fill.
2017-08-25 15:51:49 +00:00
The drawn transparency can be modified without altering < a href = "undocumented#Shader" > Shader< / a > , by changing < a href = "#Alpha" > Color Alpha< / a > .
2017-07-28 19:18:29 +00:00
### Example
< div > < fiddle-embed name = "c015dc2010c15e1c00b4f7330232b0f7" > < / fiddle-embed > < / div >
2017-08-25 15:51:49 +00:00
If < a href = "undocumented#Shader" > Shader< / a > generates only < a href = "#Alpha" > Color Alpha< / a > then all components of < a href = "undocumented#Color" > Color< / a > modulate the output.
2017-07-28 19:18:29 +00:00
### Example
< div > < fiddle-embed name = "9673be7720ba3adcdae42ddc1565b588" > < / fiddle-embed > < / div >
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_getShader" > < / a >
2017-07-28 19:18:29 +00:00
## getShader
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-07-28 19:18:29 +00:00
SkShader* getShader() const
< / pre >
Optional colors used when filling a path, such as a gradient.
2017-08-04 16:48:24 +00:00
Does not alter < a href = "undocumented#Shader" > Shader< / a > < a href = "undocumented#Reference_Count" > Reference Count< / a > .
2017-07-28 19:18:29 +00:00
### Return Value
2017-08-04 16:48:24 +00:00
< a href = "undocumented#Shader" > Shader< / a > if previously set, nullptr otherwise
2017-07-28 19:18:29 +00:00
### Example
< div > < fiddle-embed name = "09f15b9fd88882850da2d235eb86292f" >
#### Example Output
~~~~
nullptr == shader
nullptr != shader
~~~~
< / fiddle-embed > < / div >
---
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_refShader" > < / a >
2017-07-28 19:18:29 +00:00
## refShader
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-10-04 18:31:33 +00:00
sk_sp< SkShader> refShader() const
2017-07-28 19:18:29 +00:00
< / pre >
Optional colors used when filling a path, such as a gradient.
2017-08-04 16:48:24 +00:00
Increases < a href = "undocumented#Shader" > Shader< / a > < a href = "undocumented#Reference_Count" > Reference Count< / a > by one.
2017-07-28 19:18:29 +00:00
### Return Value
2017-08-04 16:48:24 +00:00
< a href = "undocumented#Shader" > Shader< / a > if previously set, nullptr otherwise
2017-07-28 19:18:29 +00:00
### Example
< div > < fiddle-embed name = "53da0295972a418cbc9607bbb17feaa8" >
#### Example Output
~~~~
shader unique: true
shader unique: false
~~~~
< / fiddle-embed > < / div >
---
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_setShader" > < / a >
2017-07-28 19:18:29 +00:00
## setShader
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-10-04 18:31:33 +00:00
void setShader(sk_sp< SkShader> shader)
2017-07-28 19:18:29 +00:00
< / pre >
Optional colors used when filling a path, such as a gradient.
2017-09-14 15:25:39 +00:00
Sets < a href = "undocumented#Shader" > Shader< / a > to < a href = "#SkPaint_setShader_shader" > shader< / a > , decreasing < a href = "undocumented#Reference_Count" > Reference Count< / a > of the previous < a href = "undocumented#Shader" > Shader< / a > .
2017-09-21 16:31:06 +00:00
Increments < a href = "#SkPaint_setShader_shader" > shader< / a > < a href = "undocumented#Reference_Count" > Reference Count< / a > by one.
2017-07-28 19:18:29 +00:00
### Parameters
2017-08-25 15:51:49 +00:00
< table > < tr > < td > < a name = "SkPaint_setShader_shader" > < code > < strong > shader < / strong > < / code > < / a > < / td > < td >
2017-08-04 16:48:24 +00:00
how geometry is filled with color; if nullptr, < a href = "undocumented#Color" > Color< / a > is used instead< / td >
2017-07-28 19:18:29 +00:00
< / tr >
< / table >
### Example
< div > < fiddle-embed name = "77e64d5bae9b1ba037fd99252bb4aa58" > < / fiddle-embed > < / div >
---
# <a name="Color_Filter_Methods"></a> Color Filter Methods
2017-08-04 16:48:24 +00:00
< a href = "undocumented#Color_Filter" > Color Filter< / a > alters the color used when drawing a shape.
< a href = "undocumented#Color_Filter" > Color Filter< / a > may apply < a href = "undocumented#Blend_Mode" > Blend Mode< / a > , transform the color through a matrix, or composite multiple filters.
2017-08-25 15:51:49 +00:00
If < a href = "#Paint" > Paint< / a > has no < a href = "undocumented#Color_Filter" > Color Filter< / a > , the color is unaltered.
2017-07-28 19:18:29 +00:00
2017-08-25 15:51:49 +00:00
The drawn transparency can be modified without altering < a href = "undocumented#Color_Filter" > Color Filter< / a > , by changing < a href = "#Alpha" > Color Alpha< / a > .
2017-07-28 19:18:29 +00:00
### Example
< div > < fiddle-embed name = "5abde56ca2f89a18b8e231abd1b57c56" > < / fiddle-embed > < / div >
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_getColorFilter" > < / a >
2017-07-28 19:18:29 +00:00
## getColorFilter
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-07-28 19:18:29 +00:00
SkColorFilter* getColorFilter() const
< / pre >
2017-08-04 16:48:24 +00:00
Returns < a href = "undocumented#Color_Filter" > Color Filter< / a > if set, or nullptr.
Does not alter < a href = "undocumented#Color_Filter" > Color Filter< / a > < a href = "undocumented#Reference_Count" > Reference Count< / a > .
2017-07-28 19:18:29 +00:00
### Return Value
2017-08-04 16:48:24 +00:00
< a href = "undocumented#Color_Filter" > Color Filter< / a > if previously set, nullptr otherwise
2017-07-28 19:18:29 +00:00
### Example
< div > < fiddle-embed name = "093bdc627d6b59002670fd290931f6c9" >
#### Example Output
~~~~
nullptr == color filter
nullptr != color filter
~~~~
< / fiddle-embed > < / div >
---
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_refColorFilter" > < / a >
2017-07-28 19:18:29 +00:00
## refColorFilter
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-10-04 18:31:33 +00:00
sk_sp< SkColorFilter> refColorFilter() const
2017-07-28 19:18:29 +00:00
< / pre >
2017-08-04 16:48:24 +00:00
Returns < a href = "undocumented#Color_Filter" > Color Filter< / a > if set, or nullptr.
Increases < a href = "undocumented#Color_Filter" > Color Filter< / a > < a href = "undocumented#Reference_Count" > Reference Count< / a > by one.
2017-07-28 19:18:29 +00:00
### Return Value
2017-08-04 16:48:24 +00:00
< a href = "undocumented#Color_Filter" > Color Filter< / a > if set, or nullptr
2017-07-28 19:18:29 +00:00
### Example
< div > < fiddle-embed name = "b588c95fa4c86ddbc4b0546762f08297" >
#### Example Output
~~~~
color filter unique: true
color filter unique: false
~~~~
< / fiddle-embed > < / div >
---
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_setColorFilter" > < / a >
2017-07-28 19:18:29 +00:00
## setColorFilter
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-10-04 18:31:33 +00:00
void setColorFilter(sk_sp< SkColorFilter> colorFilter)
2017-07-28 19:18:29 +00:00
< / pre >
2017-09-21 16:31:06 +00:00
Sets < a href = "undocumented#Color_Filter" > Color Filter< / a > to filter, decreasing < a href = "undocumented#Reference_Count" > Reference Count< / a > of the previous
< a href = "undocumented#Color_Filter" > Color Filter< / a > . Pass nullptr to clear < a href = "undocumented#Color_Filter" > Color Filter< / a > .
Increments filter < a href = "undocumented#Reference_Count" > Reference Count< / a > by one.
2017-07-28 19:18:29 +00:00
### Parameters
2017-08-25 15:51:49 +00:00
< table > < tr > < td > < a name = "SkPaint_setColorFilter_colorFilter" > < code > < strong > colorFilter < / strong > < / code > < / a > < / td > < td >
2017-08-04 16:48:24 +00:00
< a href = "undocumented#Color_Filter" > Color Filter< / a > to apply to subsequent draw< / td >
2017-07-28 19:18:29 +00:00
< / tr >
< / table >
### Example
< div > < fiddle-embed name = "c7b786dc9b3501cd0eaba47494b6fa31" > < / fiddle-embed > < / div >
---
# <a name="Blend_Mode_Methods"></a> Blend Mode Methods
2017-08-04 16:48:24 +00:00
< a href = "undocumented#Blend_Mode" > Blend Mode< / a > describes how < a href = "undocumented#Color" > Color< / a > combines with the destination color.
2017-08-25 15:51:49 +00:00
The default setting, < a href = "#SkBlendMode_kSrcOver" > SkBlendMode::kSrcOver< / a > , draws the source color
2017-07-28 19:18:29 +00:00
over the destination color.
### Example
< div > < fiddle-embed name = "73092d4d06faecea3c204d852a4dd8a8" > < / fiddle-embed > < / div >
### See Also
2017-08-04 16:48:24 +00:00
< a href = "undocumented#Blend_Mode" > Blend Mode< / a >
2017-07-28 19:18:29 +00:00
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_getBlendMode" > < / a >
2017-07-28 19:18:29 +00:00
## getBlendMode
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-07-28 19:18:29 +00:00
SkBlendMode getBlendMode() const
< / pre >
2017-08-04 16:48:24 +00:00
Returns < a href = "undocumented#Blend_Mode" > Blend Mode< / a > .
2017-08-25 15:51:49 +00:00
By default, returns < a href = "#SkBlendMode_kSrcOver" > SkBlendMode::kSrcOver< / a > .
2017-07-28 19:18:29 +00:00
### Return Value
mode used to combine source color with destination color
### Example
< div > < fiddle-embed name = "4ec1864b8203d52c0810e8605092f45c" >
#### Example Output
~~~~
kSrcOver == getBlendMode
kSrcOver != getBlendMode
~~~~
< / fiddle-embed > < / div >
---
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_isSrcOver" > < / a >
2017-07-28 19:18:29 +00:00
## isSrcOver
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-07-28 19:18:29 +00:00
bool isSrcOver() const
< / pre >
2017-08-25 15:51:49 +00:00
Returns true if < a href = "undocumented#Blend_Mode" > Blend Mode< / a > is < a href = "#SkBlendMode_kSrcOver" > SkBlendMode::kSrcOver< / a > , the default.
2017-07-28 19:18:29 +00:00
### Return Value
2017-08-25 15:51:49 +00:00
true if < a href = "undocumented#Blend_Mode" > Blend Mode< / a > is < a href = "#SkBlendMode_kSrcOver" > SkBlendMode::kSrcOver< / a >
2017-07-28 19:18:29 +00:00
### Example
< div > < fiddle-embed name = "257c9473db7a2b3a0fb2b9e2431e59a6" >
#### Example Output
~~~~
isSrcOver == true
isSrcOver != true
~~~~
< / fiddle-embed > < / div >
---
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_setBlendMode" > < / a >
2017-07-28 19:18:29 +00:00
## setBlendMode
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-07-28 19:18:29 +00:00
void setBlendMode(SkBlendMode mode)
< / pre >
2018-01-04 21:11:51 +00:00
Sets < a href = "undocumented#Blend_Mode" > Blend Mode< / a > to < a href = "#SkPaint_setBlendMode_mode" > mode< / a > .
2017-07-28 19:18:29 +00:00
Does not check for valid input.
### Parameters
2017-08-25 15:51:49 +00:00
< table > < tr > < td > < a name = "SkPaint_setBlendMode_mode" > < code > < strong > mode < / strong > < / code > < / a > < / td > < td >
2017-08-04 16:48:24 +00:00
< a href = "undocumented#SkBlendMode" > SkBlendMode< / a > used to combine source color and destination< / td >
2017-07-28 19:18:29 +00:00
< / tr >
< / table >
### Example
< div > < fiddle-embed name = "257c9473db7a2b3a0fb2b9e2431e59a6" >
#### Example Output
~~~~
isSrcOver == true
isSrcOver != true
~~~~
< / fiddle-embed > < / div >
---
# <a name="Path_Effect_Methods"></a> Path Effect Methods
2017-08-04 16:48:24 +00:00
< a href = "undocumented#Path_Effect" > Path Effect< / a > modifies the path geometry before drawing it.
< a href = "undocumented#Path_Effect" > Path Effect< / a > may implement dashing, custom fill effects and custom stroke effects.
2017-08-25 15:51:49 +00:00
If < a href = "#Paint" > Paint< / a > has no < a href = "undocumented#Path_Effect" > Path Effect< / a > , the path geometry is unaltered when filled or stroked.
2017-07-28 19:18:29 +00:00
### Example
< div > < fiddle-embed name = "8cf5684b187d60f09e11c4a48993ea39" > < / fiddle-embed > < / div >
### See Also
2017-08-04 16:48:24 +00:00
< a href = "undocumented#Path_Effect" > Path Effect< / a >
2017-07-28 19:18:29 +00:00
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_getPathEffect" > < / a >
2017-07-28 19:18:29 +00:00
## getPathEffect
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-07-28 19:18:29 +00:00
SkPathEffect* getPathEffect() const
< / pre >
2017-08-04 16:48:24 +00:00
Returns < a href = "undocumented#Path_Effect" > Path Effect< / a > if set, or nullptr.
Does not alter < a href = "undocumented#Path_Effect" > Path Effect< / a > < a href = "undocumented#Reference_Count" > Reference Count< / a > .
2017-07-28 19:18:29 +00:00
### Return Value
2017-08-04 16:48:24 +00:00
< a href = "undocumented#Path_Effect" > Path Effect< / a > if previously set, nullptr otherwise
2017-07-28 19:18:29 +00:00
### Example
< div > < fiddle-embed name = "211a1b14bfa6c4332082c8eab4fbc5fd" >
#### Example Output
~~~~
nullptr == path effect
nullptr != path effect
~~~~
< / fiddle-embed > < / div >
---
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_refPathEffect" > < / a >
2017-07-28 19:18:29 +00:00
## refPathEffect
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-10-04 18:31:33 +00:00
sk_sp< SkPathEffect> refPathEffect() const
2017-07-28 19:18:29 +00:00
< / pre >
2017-08-04 16:48:24 +00:00
Returns < a href = "undocumented#Path_Effect" > Path Effect< / a > if set, or nullptr.
Increases < a href = "undocumented#Path_Effect" > Path Effect< / a > < a href = "undocumented#Reference_Count" > Reference Count< / a > by one.
2017-07-28 19:18:29 +00:00
### Return Value
2017-08-04 16:48:24 +00:00
< a href = "undocumented#Path_Effect" > Path Effect< / a > if previously set, nullptr otherwise
2017-07-28 19:18:29 +00:00
### Example
2017-11-27 15:44:06 +00:00
< div > < fiddle-embed name = "f56039b94c702c2704c8c5100e623aca" >
2017-07-28 19:18:29 +00:00
#### Example Output
~~~~
path effect unique: true
path effect unique: false
~~~~
< / fiddle-embed > < / div >
---
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_setPathEffect" > < / a >
2017-07-28 19:18:29 +00:00
## setPathEffect
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-10-04 18:31:33 +00:00
void setPathEffect(sk_sp< SkPathEffect> pathEffect)
2017-07-28 19:18:29 +00:00
< / pre >
2017-09-21 16:31:06 +00:00
Sets < a href = "undocumented#Path_Effect" > Path Effect< / a > to < a href = "#SkPaint_setPathEffect_pathEffect" > pathEffect< / a > , decreasing < a href = "undocumented#Reference_Count" > Reference Count< / a > of the previous
< a href = "undocumented#Path_Effect" > Path Effect< / a > . Pass nullptr to leave the path geometry unaltered.
Increments < a href = "#SkPaint_setPathEffect_pathEffect" > pathEffect< / a > < a href = "undocumented#Reference_Count" > Reference Count< / a > by one.
2017-07-28 19:18:29 +00:00
### Parameters
2017-08-25 15:51:49 +00:00
< table > < tr > < td > < a name = "SkPaint_setPathEffect_pathEffect" > < code > < strong > pathEffect < / strong > < / code > < / a > < / td > < td >
2017-08-04 16:48:24 +00:00
replace < a href = "SkPath_Reference#Path" > Path< / a > with a modification when drawn< / td >
2017-07-28 19:18:29 +00:00
< / tr >
< / table >
### Example
< div > < fiddle-embed name = "52dd55074ca0b7d520d04e750ca2a0d7" > < / fiddle-embed > < / div >
---
# <a name="Mask_Filter_Methods"></a> Mask Filter Methods
2017-09-01 19:51:02 +00:00
< a href = "undocumented#Mask_Filter" > Mask Filter< / a > uses coverage of the shape drawn to create < a href = "undocumented#Mask_Alpha" > Mask Alpha< / a > .
2018-01-22 05:50:26 +00:00
< a href = "undocumented#Mask_Filter" > Mask Filter< / a > takes a < a href = "undocumented#Mask" > Mask< / a > , and returns a < a href = "undocumented#Mask" > Mask< / a > .
2017-09-21 16:31:06 +00:00
< a href = "undocumented#Mask_Filter" > Mask Filter< / a > may change the geometry and transparency of the shape, such as
creating a blur effect. Set < a href = "undocumented#Mask_Filter" > Mask Filter< / a > to nullptr to prevent < a href = "undocumented#Mask_Filter" > Mask Filter< / a > from
modifying the draw.
2017-07-28 19:18:29 +00:00
### Example
< div > < fiddle-embed name = "320b04ea1e1291d49f1e61994a0410fe" > < / fiddle-embed > < / div >
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_getMaskFilter" > < / a >
2017-07-28 19:18:29 +00:00
## getMaskFilter
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-07-28 19:18:29 +00:00
SkMaskFilter* getMaskFilter() const
< / pre >
2017-08-04 16:48:24 +00:00
Returns < a href = "undocumented#Mask_Filter" > Mask Filter< / a > if set, or nullptr.
Does not alter < a href = "undocumented#Mask_Filter" > Mask Filter< / a > < a href = "undocumented#Reference_Count" > Reference Count< / a > .
2017-07-28 19:18:29 +00:00
### Return Value
2017-08-04 16:48:24 +00:00
< a href = "undocumented#Mask_Filter" > Mask Filter< / a > if previously set, nullptr otherwise
2017-07-28 19:18:29 +00:00
### Example
< div > < fiddle-embed name = "8cd53ece8fc83e4560599ace094b0f16" >
#### Example Output
~~~~
nullptr == mask filter
nullptr != mask filter
~~~~
< / fiddle-embed > < / div >
---
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_refMaskFilter" > < / a >
2017-07-28 19:18:29 +00:00
## refMaskFilter
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-10-04 18:31:33 +00:00
sk_sp< SkMaskFilter> refMaskFilter() const
2017-07-28 19:18:29 +00:00
< / pre >
2017-08-04 16:48:24 +00:00
Returns < a href = "undocumented#Mask_Filter" > Mask Filter< / a > if set, or nullptr.
2017-09-21 16:31:06 +00:00
2017-08-04 16:48:24 +00:00
Increases < a href = "undocumented#Mask_Filter" > Mask Filter< / a > < a href = "undocumented#Reference_Count" > Reference Count< / a > by one.
2017-07-28 19:18:29 +00:00
### Return Value
2017-08-04 16:48:24 +00:00
< a href = "undocumented#Mask_Filter" > Mask Filter< / a > if previously set, nullptr otherwise
2017-07-28 19:18:29 +00:00
### Example
< div > < fiddle-embed name = "35a397dce5d44658ee4e9e9dfb9fee22" >
#### Example Output
~~~~
mask filter unique: true
mask filter unique: false
~~~~
< / fiddle-embed > < / div >
---
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_setMaskFilter" > < / a >
2017-07-28 19:18:29 +00:00
## setMaskFilter
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-10-04 18:31:33 +00:00
void setMaskFilter(sk_sp< SkMaskFilter> maskFilter)
2017-07-28 19:18:29 +00:00
< / pre >
2017-09-21 16:31:06 +00:00
Sets < a href = "undocumented#Mask_Filter" > Mask Filter< / a > to < a href = "#SkPaint_setMaskFilter_maskFilter" > maskFilter< / a > , decreasing < a href = "undocumented#Reference_Count" > Reference Count< / a > of the previous
< a href = "undocumented#Mask_Filter" > Mask Filter< / a > . Pass nullptr to clear < a href = "undocumented#Mask_Filter" > Mask Filter< / a > and leave < a href = "undocumented#Mask_Filter" > Mask Filter< / a > effect on
< a href = "undocumented#Mask_Alpha" > Mask Alpha< / a > unaltered.
Increments < a href = "#SkPaint_setMaskFilter_maskFilter" > maskFilter< / a > < a href = "undocumented#Reference_Count" > Reference Count< / a > by one.
2017-07-28 19:18:29 +00:00
### Parameters
2017-08-25 15:51:49 +00:00
< table > < tr > < td > < a name = "SkPaint_setMaskFilter_maskFilter" > < code > < strong > maskFilter < / strong > < / code > < / a > < / td > < td >
2017-07-28 19:18:29 +00:00
modifies clipping mask generated from drawn geometry< / td >
< / tr >
< / table >
### Example
< div > < fiddle-embed name = "62c5a826692f85c3de3bab65e9e97aa9" > < / fiddle-embed > < / div >
---
# <a name="Typeface_Methods"></a> Typeface Methods
2017-08-04 16:48:24 +00:00
< a href = "undocumented#Typeface" > Typeface< / a > identifies the font used when drawing and measuring text.
< a href = "undocumented#Typeface" > Typeface< / a > may be specified by name, from a file, or from a data stream.
The default < a href = "undocumented#Typeface" > Typeface< / a > defers to the platform-specific default font
2017-07-28 19:18:29 +00:00
implementation.
### Example
2017-11-08 20:37:22 +00:00
< div > < fiddle-embed name = "1a7a5062725139760962582f599f1b97" > < / fiddle-embed > < / div >
2017-07-28 19:18:29 +00:00
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_getTypeface" > < / a >
2017-07-28 19:18:29 +00:00
## getTypeface
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-07-28 19:18:29 +00:00
SkTypeface* getTypeface() const
< / pre >
2017-08-04 16:48:24 +00:00
Returns < a href = "undocumented#Typeface" > Typeface< / a > if set, or nullptr.
2017-09-21 16:31:06 +00:00
Increments < a href = "undocumented#Typeface" > Typeface< / a > < a href = "undocumented#Reference_Count" > Reference Count< / a > by one.
2017-07-28 19:18:29 +00:00
### Return Value
2017-08-04 16:48:24 +00:00
< a href = "undocumented#Typeface" > Typeface< / a > if previously set, nullptr otherwise
2017-07-28 19:18:29 +00:00
### Example
2018-01-05 19:21:59 +00:00
< div > < fiddle-embed name = "5ce718e5a184baaac80e7098d7dad67b" >
2017-07-28 19:18:29 +00:00
#### Example Output
~~~~
nullptr == typeface
nullptr != typeface
~~~~
< / fiddle-embed > < / div >
---
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_refTypeface" > < / a >
2017-07-28 19:18:29 +00:00
## refTypeface
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-10-04 18:31:33 +00:00
sk_sp< SkTypeface> refTypeface() const
2017-07-28 19:18:29 +00:00
< / pre >
2017-08-04 16:48:24 +00:00
Increases < a href = "undocumented#Typeface" > Typeface< / a > < a href = "undocumented#Reference_Count" > Reference Count< / a > by one.
2017-07-28 19:18:29 +00:00
### Return Value
2017-08-04 16:48:24 +00:00
< a href = "undocumented#Typeface" > Typeface< / a > if previously set, nullptr otherwise
2017-07-28 19:18:29 +00:00
### Example
2018-01-05 19:21:59 +00:00
< div > < fiddle-embed name = "4bf8ed109c4b46d8a05c8b7763c1982c" >
2017-07-28 19:18:29 +00:00
#### Example Output
~~~~
typeface1 != typeface2
typeface1 == typeface2
~~~~
< / fiddle-embed > < / div >
---
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_setTypeface" > < / a >
2017-07-28 19:18:29 +00:00
## setTypeface
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-10-04 18:31:33 +00:00
void setTypeface(sk_sp< SkTypeface> typeface)
2017-07-28 19:18:29 +00:00
< / pre >
2018-01-04 21:11:51 +00:00
Sets < a href = "undocumented#Typeface" > Typeface< / a > to < a href = "#SkPaint_setTypeface_typeface" > typeface< / a > , decreasing < a href = "undocumented#Reference_Count" > Reference Count< / a > of the previous < a href = "undocumented#Typeface" > Typeface< / a > .
2017-09-21 16:31:06 +00:00
Pass nullptr to clear < a href = "undocumented#Typeface" > Typeface< / a > and use the default < a href = "#SkPaint_setTypeface_typeface" > typeface< / a > . Increments
< a href = "#SkPaint_setTypeface_typeface" > typeface< / a > < a href = "undocumented#Reference_Count" > Reference Count< / a > by one.
2017-07-28 19:18:29 +00:00
### Parameters
2017-08-25 15:51:49 +00:00
< table > < tr > < td > < a name = "SkPaint_setTypeface_typeface" > < code > < strong > typeface < / strong > < / code > < / a > < / td > < td >
2017-07-28 19:18:29 +00:00
font and style used to draw text< / td >
< / tr >
< / table >
### Example
2018-01-05 19:21:59 +00:00
< div > < fiddle-embed name = "0e6fbb7773cd925b274552f4cd1abef2" > < / fiddle-embed > < / div >
2017-07-28 19:18:29 +00:00
---
# <a name="Image_Filter_Methods"></a> Image Filter Methods
2017-08-25 15:51:49 +00:00
< a href = "undocumented#Image_Filter" > Image Filter< / a > operates on the pixel representation of the shape, as modified by < a href = "#Paint" > Paint< / a >
with < a href = "undocumented#Blend_Mode" > Blend Mode< / a > set to < a href = "#SkBlendMode_kSrcOver" > SkBlendMode::kSrcOver< / a > . < a href = "undocumented#Image_Filter" > Image Filter< / a > creates a new bitmap,
2017-08-04 16:48:24 +00:00
which is drawn to the device using the set < a href = "undocumented#Blend_Mode" > Blend Mode< / a > .
2017-09-21 16:31:06 +00:00
2017-08-04 16:48:24 +00:00
< a href = "undocumented#Image_Filter" > Image Filter< / a > is higher level than < a href = "undocumented#Mask_Filter" > Mask Filter< / a > ; for instance, an < a href = "undocumented#Image_Filter" > Image Filter< / a >
2017-09-01 19:51:02 +00:00
can operate on all channels of < a href = "undocumented#Color" > Color< / a > , while < a href = "undocumented#Mask_Filter" > Mask Filter< / a > generates < a href = "#Alpha" > Alpha< / a > only.
2017-08-04 16:48:24 +00:00
< a href = "undocumented#Image_Filter" > Image Filter< / a > operates independently of and can be used in combination with
2018-01-22 05:50:26 +00:00
< a href = "undocumented#Mask_Filter" > Mask Filter< / a > .
2017-07-28 19:18:29 +00:00
### Example
2017-11-27 15:44:06 +00:00
< div > < fiddle-embed name = "0b2eec148d6397d6231e1fa0b3d1496d" > < / fiddle-embed > < / div >
2017-07-28 19:18:29 +00:00
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_getImageFilter" > < / a >
2017-07-28 19:18:29 +00:00
## getImageFilter
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-07-28 19:18:29 +00:00
SkImageFilter* getImageFilter() const
< / pre >
2017-08-04 16:48:24 +00:00
Returns < a href = "undocumented#Image_Filter" > Image Filter< / a > if set, or nullptr.
Does not alter < a href = "undocumented#Image_Filter" > Image Filter< / a > < a href = "undocumented#Reference_Count" > Reference Count< / a > .
2017-07-28 19:18:29 +00:00
### Return Value
2017-08-04 16:48:24 +00:00
< a href = "undocumented#Image_Filter" > Image Filter< / a > if previously set, nullptr otherwise
2017-07-28 19:18:29 +00:00
### Example
2017-11-27 15:44:06 +00:00
< div > < fiddle-embed name = "7b8118ff57fcb84e6bc82380d155b62e" >
2017-07-28 19:18:29 +00:00
#### Example Output
~~~~
nullptr == image filter
nullptr != image filter
~~~~
< / fiddle-embed > < / div >
---
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_refImageFilter" > < / a >
2017-07-28 19:18:29 +00:00
## refImageFilter
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-10-04 18:31:33 +00:00
sk_sp< SkImageFilter> refImageFilter() const
2017-07-28 19:18:29 +00:00
< / pre >
2017-08-04 16:48:24 +00:00
Returns < a href = "undocumented#Image_Filter" > Image Filter< / a > if set, or nullptr.
Increases < a href = "undocumented#Image_Filter" > Image Filter< / a > < a href = "undocumented#Reference_Count" > Reference Count< / a > by one.
2017-07-28 19:18:29 +00:00
### Return Value
2017-08-04 16:48:24 +00:00
< a href = "undocumented#Image_Filter" > Image Filter< / a > if previously set, nullptr otherwise
2017-07-28 19:18:29 +00:00
### Example
< div > < fiddle-embed name = "13f09088b569251547107d14ae989dc1" >
#### Example Output
~~~~
image filter unique: true
image filter unique: false
~~~~
< / fiddle-embed > < / div >
---
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_setImageFilter" > < / a >
2017-07-28 19:18:29 +00:00
## setImageFilter
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-10-04 18:31:33 +00:00
void setImageFilter(sk_sp< SkImageFilter> imageFilter)
2017-07-28 19:18:29 +00:00
< / pre >
2017-09-21 16:31:06 +00:00
Sets < a href = "undocumented#Image_Filter" > Image Filter< / a > to < a href = "#SkPaint_setImageFilter_imageFilter" > imageFilter< / a > , decreasing < a href = "undocumented#Reference_Count" > Reference Count< / a > of the previous
< a href = "undocumented#Image_Filter" > Image Filter< / a > . Pass nullptr to clear < a href = "undocumented#Image_Filter" > Image Filter< / a > , and remove < a href = "undocumented#Image_Filter" > Image Filter< / a > effect
2017-07-28 19:18:29 +00:00
on drawing.
2017-09-21 16:31:06 +00:00
Increments < a href = "#SkPaint_setImageFilter_imageFilter" > imageFilter< / a > < a href = "undocumented#Reference_Count" > Reference Count< / a > by one.
2017-07-28 19:18:29 +00:00
### Parameters
2017-08-25 15:51:49 +00:00
< table > < tr > < td > < a name = "SkPaint_setImageFilter_imageFilter" > < code > < strong > imageFilter < / strong > < / code > < / a > < / td > < td >
2017-11-27 15:44:06 +00:00
how < a href = "SkImage_Reference#Image" > Image< / a > is sampled when transformed< / td >
2017-07-28 19:18:29 +00:00
< / tr >
< / table >
### Example
< div > < fiddle-embed name = "6679d6e4ec632715ee03e68391bd7f9a" > < / fiddle-embed > < / div >
---
# <a name="Draw_Looper_Methods"></a> Draw Looper Methods
2017-08-04 16:48:24 +00:00
< a href = "undocumented#Draw_Looper" > Draw Looper< / a > sets a modifier that communicates state from one < a href = "undocumented#Draw_Layer" > Draw Layer< / a >
2017-07-28 19:18:29 +00:00
to another to construct the draw.
2017-09-21 16:31:06 +00:00
2017-08-04 16:48:24 +00:00
< a href = "undocumented#Draw_Looper" > Draw Looper< / a > draws one or more times, modifying the canvas and paint each time.
< a href = "undocumented#Draw_Looper" > Draw Looper< / a > may be used to draw multiple colors or create a colored shadow.
2018-01-04 21:11:51 +00:00
Set < a href = "undocumented#Draw_Looper" > Draw Looper< / a > to nullptr to prevent < a href = "undocumented#Draw_Looper" > Draw Looper< / a > from modifying the draw.
2017-07-28 19:18:29 +00:00
### Example
< div > < fiddle-embed name = "84ec12a36e50df5ac565cc7a75ffbe9f" > < / fiddle-embed > < / div >
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_getDrawLooper" > < / a >
2017-07-28 19:18:29 +00:00
## getDrawLooper
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-07-28 19:18:29 +00:00
SkDrawLooper* getDrawLooper() const
< / pre >
2017-08-04 16:48:24 +00:00
Returns < a href = "undocumented#Draw_Looper" > Draw Looper< / a > if set, or nullptr.
Does not alter < a href = "undocumented#Draw_Looper" > Draw Looper< / a > < a href = "undocumented#Reference_Count" > Reference Count< / a > .
2017-07-28 19:18:29 +00:00
### Return Value
2017-08-04 16:48:24 +00:00
< a href = "undocumented#Draw_Looper" > Draw Looper< / a > if previously set, nullptr otherwise
2017-07-28 19:18:29 +00:00
### Example
< div > < fiddle-embed name = "af4c5acc7a91e7f23c2af48018903ad4" >
#### Example Output
~~~~
nullptr == draw looper
nullptr != draw looper
~~~~
< / fiddle-embed > < / div >
---
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_refDrawLooper" > < / a >
2017-07-28 19:18:29 +00:00
## refDrawLooper
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-10-04 18:31:33 +00:00
sk_sp< SkDrawLooper> refDrawLooper() const
2017-07-28 19:18:29 +00:00
< / pre >
2017-08-04 16:48:24 +00:00
Returns < a href = "undocumented#Draw_Looper" > Draw Looper< / a > if set, or nullptr.
Increases < a href = "undocumented#Draw_Looper" > Draw Looper< / a > < a href = "undocumented#Reference_Count" > Reference Count< / a > by one.
2017-07-28 19:18:29 +00:00
### Return Value
2017-08-04 16:48:24 +00:00
< a href = "undocumented#Draw_Looper" > Draw Looper< / a > if previously set, nullptr otherwise
2017-07-28 19:18:29 +00:00
### Example
< div > < fiddle-embed name = "2a3782c33f04ed17a725d0e449c6f7c3" >
#### Example Output
~~~~
draw looper unique: true
draw looper unique: false
~~~~
< / fiddle-embed > < / div >
---
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_getLooper" > < / a >
2017-07-28 19:18:29 +00:00
## getLooper
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-07-28 19:18:29 +00:00
SkDrawLooper* getLooper() const
< / pre >
Deprecated.
(see bug.skia.org/6259)
### Return Value
2017-08-04 16:48:24 +00:00
< a href = "undocumented#Draw_Looper" > Draw Looper< / a > if previously set, nullptr otherwise
2017-07-28 19:18:29 +00:00
---
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_setDrawLooper" > < / a >
2017-07-28 19:18:29 +00:00
## setDrawLooper
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-10-04 18:31:33 +00:00
void setDrawLooper(sk_sp< SkDrawLooper> drawLooper)
2017-07-28 19:18:29 +00:00
< / pre >
2017-09-21 16:31:06 +00:00
Sets < a href = "undocumented#Draw_Looper" > Draw Looper< / a > to < a href = "#SkPaint_setDrawLooper_drawLooper" > drawLooper< / a > , decreasing < a href = "undocumented#Reference_Count" > Reference Count< / a > of the previous
< a href = "#SkPaint_setDrawLooper_drawLooper" > drawLooper< / a > . Pass nullptr to clear < a href = "undocumented#Draw_Looper" > Draw Looper< / a > and leave < a href = "undocumented#Draw_Looper" > Draw Looper< / a > effect on
drawing unaltered.
Increments < a href = "#SkPaint_setDrawLooper_drawLooper" > drawLooper< / a > < a href = "undocumented#Reference_Count" > Reference Count< / a > by one.
2017-07-28 19:18:29 +00:00
### Parameters
2017-08-25 15:51:49 +00:00
< table > < tr > < td > < a name = "SkPaint_setDrawLooper_drawLooper" > < code > < strong > drawLooper < / strong > < / code > < / a > < / td > < td >
2017-08-30 12:58:10 +00:00
iterates through drawing one or more time, altering < a href = "#Paint" > Paint< / a > < / td >
2017-07-28 19:18:29 +00:00
< / tr >
< / table >
### Example
< div > < fiddle-embed name = "bf10f838b330f0a3a3266d42ea68a638" > < / fiddle-embed > < / div >
---
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_setLooper" > < / a >
2017-07-28 19:18:29 +00:00
## setLooper
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-10-04 18:31:33 +00:00
void setLooper(sk_sp< SkDrawLooper> drawLooper)
2017-07-28 19:18:29 +00:00
< / pre >
Deprecated.
(see bug.skia.org/6259)
### Parameters
2017-08-25 15:51:49 +00:00
< table > < tr > < td > < a name = "SkPaint_setLooper_drawLooper" > < code > < strong > drawLooper < / strong > < / code > < / a > < / td > < td >
sets < a href = "undocumented#Draw_Looper" > Draw Looper< / a > to < a href = "#SkPaint_setLooper_drawLooper" > drawLooper< / a > < / td >
2017-07-28 19:18:29 +00:00
< / tr >
---
< / table >
# <a name="Text_Align"></a> Text Align
2017-08-25 15:51:49 +00:00
## <a name="SkPaint_Align"></a> Enum SkPaint::Align
2017-07-28 19:18:29 +00:00
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-08-25 15:51:49 +00:00
enum < a href = "#SkPaint_Align" > Align< / a > {
< a href = "#SkPaint_kLeft_Align" > kLeft Align< / a > ,
< a href = "#SkPaint_kCenter_Align" > kCenter Align< / a > ,
< a href = "#SkPaint_kRight_Align" > kRight Align< / a > ,
2017-07-28 19:18:29 +00:00
};< / pre >
2017-08-25 15:51:49 +00:00
< a href = "#SkPaint_Align" > Align< / a > adjusts the text relative to the text position.
2017-09-01 19:51:02 +00:00
< a href = "#SkPaint_Align" > Align< / a > affects < a href = "#Glyph" > Glyphs< / a > drawn with: < a href = "#SkCanvas_drawText" > SkCanvas::drawText< / a > , < a href = "#SkCanvas_drawPosText" > SkCanvas::drawPosText< / a > ,
2018-01-04 21:11:51 +00:00
< a href = "#SkCanvas_drawPosTextH" > SkCanvas::drawPosTextH< / a > , < a href = "#SkCanvas_drawTextOnPath" > SkCanvas::drawTextOnPath< / a > ,
2017-08-25 15:51:49 +00:00
< a href = "#SkCanvas_drawTextOnPathHV" > SkCanvas::drawTextOnPathHV< / a > , < a href = "#SkCanvas_drawTextRSXform" > SkCanvas::drawTextRSXform< / a > , < a href = "#SkCanvas_drawTextBlob" > SkCanvas::drawTextBlob< / a > ,
2018-01-04 21:11:51 +00:00
and < a href = "#SkCanvas_drawString" > SkCanvas::drawString< / a > ;
2017-09-01 19:51:02 +00:00
as well as calls that place text < a href = "#Glyph" > Glyphs< / a > like < a href = "#SkPaint_getTextWidths" > getTextWidths< / a > and < a href = "#SkPaint_getTextPath" > getTextPath< / a > .
2017-07-28 19:18:29 +00:00
The text position is set by the font for both horizontal and vertical text.
Typically, for horizontal text, the position is to the left side of the glyph on the
base line; and for vertical text, the position is the horizontal center of the glyph
at the caps height.
2018-01-04 21:11:51 +00:00
< a href = "#SkPaint_Align" > Align< / a > adjusts the glyph position to center it or move it to abut the position
2017-07-28 19:18:29 +00:00
using the metrics returned by the font.
2017-08-25 15:51:49 +00:00
< a href = "#SkPaint_Align" > Align< / a > defaults to < a href = "#SkPaint_kLeft_Align" > kLeft Align< / a > .
2017-07-28 19:18:29 +00:00
### Constants
< table >
< tr >
2017-08-25 15:51:49 +00:00
< td > < a name = "SkPaint_kLeft_Align" > < code > < strong > SkPaint::kLeft_Align < / strong > < / code > < / a > < / td > < td > 0< / td > < td > Leaves the glyph at the position computed by the font offset by the text position.< / td >
2017-07-28 19:18:29 +00:00
< / tr >
< tr >
2017-08-25 15:51:49 +00:00
< td > < a name = "SkPaint_kCenter_Align" > < code > < strong > SkPaint::kCenter_Align < / strong > < / code > < / a > < / td > < td > 1< / td > < td > Moves the glyph half its width if < a href = "#SkPaint_Flags" > Flags< / a > has < a href = "#SkPaint_kVerticalText_Flag" > kVerticalText Flag< / a > clear, and
half its height if < a href = "#SkPaint_Flags" > Flags< / a > has < a href = "#SkPaint_kVerticalText_Flag" > kVerticalText Flag< / a > set.< / td >
2017-07-28 19:18:29 +00:00
< / tr >
< tr >
2017-08-25 15:51:49 +00:00
< td > < a name = "SkPaint_kRight_Align" > < code > < strong > SkPaint::kRight_Align < / strong > < / code > < / a > < / td > < td > 2< / td > < td > Moves the glyph by its width if < a href = "#SkPaint_Flags" > Flags< / a > has < a href = "#SkPaint_kVerticalText_Flag" > kVerticalText Flag< / a > clear,
and by its height if < a href = "#SkPaint_Flags" > Flags< / a > has < a href = "#SkPaint_kVerticalText_Flag" > kVerticalText Flag< / a > set.< / td >
2017-07-28 19:18:29 +00:00
< / tr >
< / table >
2017-08-25 15:51:49 +00:00
## <a name="SkPaint__anonymous_2"></a> Enum SkPaint::_anonymous_2
2017-07-28 19:18:29 +00:00
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-07-28 19:18:29 +00:00
enum {
2017-08-25 15:51:49 +00:00
< a href = "#SkPaint_kAlignCount" > kAlignCount< / a > = 3,
2017-07-28 19:18:29 +00:00
};< / pre >
### Constants
< table >
< tr >
2017-08-25 15:51:49 +00:00
< td > < a name = "SkPaint_kAlignCount" > < code > < strong > SkPaint::kAlignCount < / strong > < / code > < / a > < / td > < td > 3< / td > < td > The number of different < a href = "#Text_Align" > Text Align< / a > values defined.< / td >
2017-07-28 19:18:29 +00:00
< / tr >
< / table >
### Example
< div > < fiddle-embed name = "702617fd9ebc3f12e30081b5db93e8a8" > < div > Each position separately moves the glyph in drawPosText.< / div > < / fiddle-embed > < / div >
### Example
2017-08-25 15:51:49 +00:00
< div > < fiddle-embed name = "f1cbbbafe6b3c52b81309cccbf96a308" > < div > < a href = "#Vertical_Text" > Vertical Text< / a > treats < a href = "#SkPaint_kLeft_Align" > kLeft Align< / a > as top align, and < a href = "#SkPaint_kRight_Align" > kRight Align< / a > as bottom align.< / div > < / fiddle-embed > < / div >
2017-07-28 19:18:29 +00:00
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_getTextAlign" > < / a >
2017-07-28 19:18:29 +00:00
## getTextAlign
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-07-28 19:18:29 +00:00
Align getTextAlign() const
< / pre >
2017-08-25 15:51:49 +00:00
Returns < a href = "#Text_Align" > Text Align< / a > .
Returns < a href = "#SkPaint_kLeft_Align" > kLeft Align< / a > if < a href = "#Text_Align" > Text Align< / a > has not been set.
2017-07-28 19:18:29 +00:00
### Return Value
text placement relative to position
### Example
< div > < fiddle-embed name = "2df932f526e810f74c89d30ec3f4c947" >
#### Example Output
~~~~
kLeft_Align == default
~~~~
< / fiddle-embed > < / div >
---
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_setTextAlign" > < / a >
2017-07-28 19:18:29 +00:00
## setTextAlign
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-07-28 19:18:29 +00:00
void setTextAlign(Align align)
< / pre >
2017-08-25 15:51:49 +00:00
Sets < a href = "#Text_Align" > Text Align< / a > to < a href = "#SkPaint_setTextAlign_align" > align< / a > .
Has no effect if < a href = "#SkPaint_setTextAlign_align" > align< / a > is an invalid value.
2017-07-28 19:18:29 +00:00
### Parameters
2017-08-25 15:51:49 +00:00
< table > < tr > < td > < a name = "SkPaint_setTextAlign_align" > < code > < strong > align < / strong > < / code > < / a > < / td > < td >
2017-07-28 19:18:29 +00:00
text placement relative to position< / td >
< / tr >
< / table >
### Example
2017-08-04 16:48:24 +00:00
< div > < fiddle-embed name = "d37540afd918506ac2594665ca63979b" > < div > < a href = "undocumented#Text" > Text< / a > is left-aligned by default, and then set to center. Setting the
2017-07-28 19:18:29 +00:00
alignment out of range has no effect.< / div > < / fiddle-embed > < / div >
---
# <a name="Text_Size"></a> Text Size
2017-08-25 15:51:49 +00:00
< a href = "#Text_Size" > Text Size< / a > adjusts the overall text size in points.
< a href = "#Text_Size" > Text Size< / a > can be set to any positive value or zero.
< a href = "#Text_Size" > Text Size< / a > defaults to 12.
2017-08-04 16:48:24 +00:00
Set < a href = "undocumented#SkPaintDefaults_TextSize" > SkPaintDefaults TextSize< / a > at compile time to change the default setting.
2017-07-28 19:18:29 +00:00
### Example
< div > < fiddle-embed name = "91c9a3e498bb9412e4522a95d076ed5f" > < / fiddle-embed > < / div >
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_getTextSize" > < / a >
2017-07-28 19:18:29 +00:00
## getTextSize
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-07-28 19:18:29 +00:00
SkScalar getTextSize() const
< / pre >
2017-08-25 15:51:49 +00:00
Returns < a href = "#Text_Size" > Text Size< / a > in points.
2017-07-28 19:18:29 +00:00
### Return Value
typographic height of text
### Example
< div > < fiddle-embed name = "983e2a71ba72d4ba8c945420040b8f1c" > < / fiddle-embed > < / div >
---
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_setTextSize" > < / a >
2017-07-28 19:18:29 +00:00
## setTextSize
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-07-28 19:18:29 +00:00
void setTextSize(SkScalar textSize)
< / pre >
2017-08-25 15:51:49 +00:00
Sets < a href = "#Text_Size" > Text Size< / a > in points.
Has no effect if < a href = "#SkPaint_setTextSize_textSize" > textSize< / a > is not greater than or equal to zero.
2017-07-28 19:18:29 +00:00
### Parameters
2017-08-25 15:51:49 +00:00
< table > < tr > < td > < a name = "SkPaint_setTextSize_textSize" > < code > < strong > textSize < / strong > < / code > < / a > < / td > < td >
2017-07-28 19:18:29 +00:00
typographic height of text< / td >
< / tr >
< / table >
### Example
< div > < fiddle-embed name = "6510c9e2f57b83c47e67829e7a68d493" > < / fiddle-embed > < / div >
---
# <a name="Text_Scale_X"></a> Text Scale X
2017-08-25 15:51:49 +00:00
< a href = "#Text_Scale_X" > Text Scale X< / a > adjusts the text horizontal scale.
2017-08-04 16:48:24 +00:00
< a href = "undocumented#Text" > Text< / a > scaling approximates condensed and expanded type faces when the actual face
2017-07-28 19:18:29 +00:00
is not available.
2017-08-25 15:51:49 +00:00
< a href = "#Text_Scale_X" > Text Scale X< / a > can be set to any value.
< a href = "#Text_Scale_X" > Text Scale X< / a > defaults to 1.
2017-07-28 19:18:29 +00:00
### Example
< div > < fiddle-embed name = "d13d787c1e36f515319fc998411c1d91" > < / fiddle-embed > < / div >
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_getTextScaleX" > < / a >
2017-07-28 19:18:29 +00:00
## getTextScaleX
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-07-28 19:18:29 +00:00
SkScalar getTextScaleX() const
< / pre >
2017-08-25 15:51:49 +00:00
Returns < a href = "#Text_Scale_X" > Text Scale X< / a > .
2017-07-28 19:18:29 +00:00
Default value is 1.
### Return Value
text horizontal scale
### Example
< div > < fiddle-embed name = "5dc8e58f6910cb8e4de9ed60f888188b" > < / fiddle-embed > < / div >
---
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_setTextScaleX" > < / a >
2017-07-28 19:18:29 +00:00
## setTextScaleX
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-07-28 19:18:29 +00:00
void setTextScaleX(SkScalar scaleX)
< / pre >
2017-08-25 15:51:49 +00:00
Sets < a href = "#Text_Scale_X" > Text Scale X< / a > .
2017-07-28 19:18:29 +00:00
Default value is 1.
### Parameters
2017-08-25 15:51:49 +00:00
< table > < tr > < td > < a name = "SkPaint_setTextScaleX_scaleX" > < code > < strong > scaleX < / strong > < / code > < / a > < / td > < td >
2017-07-28 19:18:29 +00:00
text horizontal scale< / td >
< / tr >
< / table >
### Example
< div > < fiddle-embed name = "a75bbdb8bb866b125c4c1dd5e967d470" > < / fiddle-embed > < / div >
---
# <a name="Text_Skew_X"></a> Text Skew X
2017-08-25 15:51:49 +00:00
< a href = "#Text_Skew_X" > Text Skew X< / a > adjusts the text horizontal slant.
2017-08-04 16:48:24 +00:00
< a href = "undocumented#Text" > Text< / a > skewing approximates italic and oblique type faces when the actual face
2017-07-28 19:18:29 +00:00
is not available.
2017-08-25 15:51:49 +00:00
< a href = "#Text_Skew_X" > Text Skew X< / a > can be set to any value.
< a href = "#Text_Skew_X" > Text Skew X< / a > defaults to 0.
2017-07-28 19:18:29 +00:00
### Example
< div > < fiddle-embed name = "aff208b0aab265f273045b27e683c17c" > < / fiddle-embed > < / div >
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_getTextSkewX" > < / a >
2017-07-28 19:18:29 +00:00
## getTextSkewX
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-07-28 19:18:29 +00:00
SkScalar getTextSkewX() const
< / pre >
2017-08-25 15:51:49 +00:00
Returns < a href = "#Text_Skew_X" > Text Skew X< / a > .
2017-07-28 19:18:29 +00:00
Default value is zero.
### Return Value
additional shear in x-axis relative to y-axis
### Example
< div > < fiddle-embed name = "11c10f466dae0d1639dbb9f6a0040218" > < / fiddle-embed > < / div >
---
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_setTextSkewX" > < / a >
2017-07-28 19:18:29 +00:00
## setTextSkewX
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-07-28 19:18:29 +00:00
void setTextSkewX(SkScalar skewX)
< / pre >
2017-08-25 15:51:49 +00:00
Sets < a href = "#Text_Skew_X" > Text Skew X< / a > .
2017-07-28 19:18:29 +00:00
Default value is zero.
### Parameters
2017-08-25 15:51:49 +00:00
< table > < tr > < td > < a name = "SkPaint_setTextSkewX_skewX" > < code > < strong > skewX < / strong > < / code > < / a > < / td > < td >
2017-07-28 19:18:29 +00:00
additional shear in x-axis relative to y-axis< / td >
< / tr >
< / table >
### Example
< div > < fiddle-embed name = "6bd705a6e0c5f8ee24f302fe531bfabc" > < / fiddle-embed > < / div >
---
# <a name="Text_Encoding"></a> Text Encoding
2017-08-25 15:51:49 +00:00
## <a name="SkPaint_TextEncoding"></a> Enum SkPaint::TextEncoding
2017-07-28 19:18:29 +00:00
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-08-25 15:51:49 +00:00
enum < a href = "#SkPaint_TextEncoding" > TextEncoding< / a > {
< a href = "#SkPaint_kUTF8_TextEncoding" > kUTF8 TextEncoding< / a > ,
< a href = "#SkPaint_kUTF16_TextEncoding" > kUTF16 TextEncoding< / a > ,
< a href = "#SkPaint_kUTF32_TextEncoding" > kUTF32 TextEncoding< / a > ,
< a href = "#SkPaint_kGlyphID_TextEncoding" > kGlyphID TextEncoding< / a > ,
2017-07-28 19:18:29 +00:00
};< / pre >
2017-09-21 16:31:06 +00:00
< a href = "#SkPaint_TextEncoding" > TextEncoding< / a > determines whether text specifies character codes and their encoded
2018-01-04 21:11:51 +00:00
size, or glyph indices. Characters are encoded as specified by the < a href = "http://unicode.org/standard/standard.html" > Unicode standard< / a > .
2017-09-21 16:31:06 +00:00
2017-11-27 15:44:06 +00:00
Character codes encoded size are specified by UTF-8, UTF-16, or UTF-32.
2018-01-04 21:11:51 +00:00
All character code formats are able to represent all of Unicode, differing only
2017-07-28 19:18:29 +00:00
in the total storage required.
2018-01-04 21:11:51 +00:00
< a href = "https://tools.ietf.org/html/rfc3629" > UTF-8 (RFC 3629)< / a > encodes each character as one or more 8-bit bytes.
2017-09-21 16:31:06 +00:00
2018-01-04 21:11:51 +00:00
< a href = "https://tools.ietf.org/html/rfc2781" > UTF-16 (RFC 2781)< / a > encodes each character as one or two 16-bit words.
2017-09-21 16:31:06 +00:00
2018-01-04 21:11:51 +00:00
< a href = "http://www.unicode.org/versions/Unicode5.0.0/ch03.pdf" > UTF-32< / a > encodes each character as one 32-bit word.
2017-07-28 19:18:29 +00:00
2018-01-04 21:11:51 +00:00
< a href = "undocumented#Font_Manager" > Font Manager< / a > uses font data to convert character code points into glyph indices.
2017-07-28 19:18:29 +00:00
A glyph index is a 16-bit word.
2017-08-25 15:51:49 +00:00
< a href = "#SkPaint_TextEncoding" > TextEncoding< / a > is set to < a href = "#SkPaint_kUTF8_TextEncoding" > kUTF8 TextEncoding< / a > by default.
2017-07-28 19:18:29 +00:00
### Constants
< table >
< tr >
2018-01-04 21:11:51 +00:00
< td > < a name = "SkPaint_kUTF8_TextEncoding" > < code > < strong > SkPaint::kUTF8_TextEncoding < / strong > < / code > < / a > < / td > < td > 0< / td > < td > Uses bytes to represent UTF-8 or ASCII.< / td >
2017-07-28 19:18:29 +00:00
< / tr >
< tr >
2018-01-04 21:11:51 +00:00
< td > < a name = "SkPaint_kUTF16_TextEncoding" > < code > < strong > SkPaint::kUTF16_TextEncoding < / strong > < / code > < / a > < / td > < td > 1< / td > < td > Uses two byte words to represent most of Unicode.< / td >
2017-07-28 19:18:29 +00:00
< / tr >
< tr >
2018-01-04 21:11:51 +00:00
< td > < a name = "SkPaint_kUTF32_TextEncoding" > < code > < strong > SkPaint::kUTF32_TextEncoding < / strong > < / code > < / a > < / td > < td > 2< / td > < td > Uses four byte words to represent all of Unicode.< / td >
2017-07-28 19:18:29 +00:00
< / tr >
< tr >
2017-08-25 15:51:49 +00:00
< td > < a name = "SkPaint_kGlyphID_TextEncoding" > < code > < strong > SkPaint::kGlyphID_TextEncoding < / strong > < / code > < / a > < / td > < td > 3< / td > < td > Uses two byte words to represent glyph indices.< / td >
2017-07-28 19:18:29 +00:00
< / tr >
< / table >
### Example
2017-11-27 15:44:06 +00:00
< div > < fiddle-embed name = "b29294e7f29d160a1b46abf2dcec9d2a" > < div > First line is encoded in UTF-8.
Second line is encoded in UTF-16.
Third line is encoded in UTF-32.
2017-07-28 19:18:29 +00:00
Fourth line has 16 bit glyph indices.< / div > < / fiddle-embed > < / div >
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_getTextEncoding" > < / a >
2017-07-28 19:18:29 +00:00
## getTextEncoding
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-07-28 19:18:29 +00:00
TextEncoding getTextEncoding() const
< / pre >
2017-08-25 15:51:49 +00:00
Returns < a href = "#Text_Encoding" > Text Encoding< / a > .
< a href = "#Text_Encoding" > Text Encoding< / a > determines how character code points are mapped to font glyph indices.
2017-07-28 19:18:29 +00:00
### Return Value
2018-01-04 21:11:51 +00:00
one of: < a href = "#SkPaint_kUTF8_TextEncoding" > kUTF8 TextEncoding< / a > , < a href = "#SkPaint_kUTF16_TextEncoding" > kUTF16 TextEncoding< / a > , < a href = "#SkPaint_kUTF32_TextEncoding" > kUTF32 TextEncoding< / a > , or
2017-08-25 15:51:49 +00:00
< a href = "#SkPaint_kGlyphID_TextEncoding" > kGlyphID TextEncoding< / a >
2017-07-28 19:18:29 +00:00
### Example
< div > < fiddle-embed name = "70ad28bbf7668b38474d7f225e3540bc" >
#### Example Output
~~~~
kUTF8_TextEncoding == text encoding
kGlyphID_TextEncoding == text encoding
~~~~
< / fiddle-embed > < / div >
---
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_setTextEncoding" > < / a >
2017-07-28 19:18:29 +00:00
## setTextEncoding
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-07-28 19:18:29 +00:00
void setTextEncoding(TextEncoding encoding)
< / pre >
2018-01-04 21:11:51 +00:00
Sets < a href = "#Text_Encoding" > Text Encoding< / a > to < a href = "#SkPaint_setTextEncoding_encoding" > encoding< / a > .
2017-08-25 15:51:49 +00:00
< a href = "#Text_Encoding" > Text Encoding< / a > determines how character code points are mapped to font glyph indices.
Invalid values for < a href = "#SkPaint_setTextEncoding_encoding" > encoding< / a > are ignored.
2017-07-28 19:18:29 +00:00
### Parameters
2017-08-25 15:51:49 +00:00
< table > < tr > < td > < a name = "SkPaint_setTextEncoding_encoding" > < code > < strong > encoding < / strong > < / code > < / a > < / td > < td >
2018-01-04 21:11:51 +00:00
one of: < a href = "#SkPaint_kUTF8_TextEncoding" > kUTF8 TextEncoding< / a > , < a href = "#SkPaint_kUTF16_TextEncoding" > kUTF16 TextEncoding< / a > , < a href = "#SkPaint_kUTF32_TextEncoding" > kUTF32 TextEncoding< / a > , or
2017-08-25 15:51:49 +00:00
< a href = "#SkPaint_kGlyphID_TextEncoding" > kGlyphID TextEncoding< / a > < / td >
2017-07-28 19:18:29 +00:00
< / tr >
2017-08-03 21:14:08 +00:00
#
2017-07-28 19:18:29 +00:00
< / table >
### Example
< div > < fiddle-embed name = "329b92fbc35151dee9aa0c0e70107665" >
#### Example Output
~~~~
4 != text encoding
~~~~
< / fiddle-embed > < / div >
---
# <a name="Font_Metrics"></a> Font Metrics
2017-09-01 19:51:02 +00:00
< a href = "#Font_Metrics" > Font Metrics< / a > describe dimensions common to the < a href = "#Glyph" > Glyphs< / a > in < a href = "undocumented#Typeface" > Typeface< / a > .
2018-01-04 21:11:51 +00:00
The dimensions are computed by < a href = "undocumented#Font_Manager" > Font Manager< / a > from font data and do not take
2017-08-25 15:51:49 +00:00
< a href = "#Paint" > Paint< / a > settings other than < a href = "#Text_Size" > Text Size< / a > into account.
2017-07-28 19:18:29 +00:00
2017-08-04 16:48:24 +00:00
< a href = "undocumented#Font" > Font< / a > dimensions specify the anchor to the left of the glyph at baseline as the origin.
2017-07-28 19:18:29 +00:00
X-axis values to the left of the glyph are negative, and to the right of the left glyph edge
are positive.
Y-axis values above the baseline are negative, and below the baseline are positive.
### Example
2017-11-09 17:08:31 +00:00
< div > < fiddle-embed name = "2bfa3783719fcd769af177a1b244e171" > < / fiddle-embed > < / div >
2017-07-28 19:18:29 +00:00
2017-08-25 15:51:49 +00:00
# <a name="SkPaint_FontMetrics"></a> Struct SkPaint::FontMetrics
2017-07-28 19:18:29 +00:00
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-08-25 15:51:49 +00:00
struct < a href = "#SkPaint_FontMetrics" > FontMetrics< / a > {
enum < a href = "#SkPaint_FontMetrics_FontMetricsFlags" > FontMetricsFlags< / a > {
< a href = "#SkPaint_FontMetrics_kUnderlineThicknessIsValid_Flag" > kUnderlineThicknessIsValid Flag< / a > = 1 < < 0 ,
< a href = "#SkPaint_FontMetrics_kUnderlinePositionIsValid_Flag" > kUnderlinePositionIsValid Flag< / a > = 1 < < 1 ,
< a href = "#SkPaint_FontMetrics_kStrikeoutThicknessIsValid_Flag" > kStrikeoutThicknessIsValid Flag< / a > = 1 < < 2 ,
< a href = "#SkPaint_FontMetrics_kStrikeoutPositionIsValid_Flag" > kStrikeoutPositionIsValid Flag< / a > = 1 < < 3 ,
2017-07-28 19:18:29 +00:00
};
2017-08-25 15:51:49 +00:00
uint32_t < a href = "#SkPaint_FontMetrics_fFlags" > fFlags< / a > ;
< a href = "undocumented#SkScalar" > SkScalar< / a > < a href = "#SkPaint_FontMetrics_fTop" > fTop< / a > ;
< a href = "undocumented#SkScalar" > SkScalar< / a > < a href = "#SkPaint_FontMetrics_fAscent" > fAscent< / a > ;
< a href = "undocumented#SkScalar" > SkScalar< / a > < a href = "#SkPaint_FontMetrics_fDescent" > fDescent< / a > ;
< a href = "undocumented#SkScalar" > SkScalar< / a > < a href = "#SkPaint_FontMetrics_fBottom" > fBottom< / a > ;
< a href = "undocumented#SkScalar" > SkScalar< / a > < a href = "#SkPaint_FontMetrics_fLeading" > fLeading< / a > ;
< a href = "undocumented#SkScalar" > SkScalar< / a > < a href = "#SkPaint_FontMetrics_fAvgCharWidth" > fAvgCharWidth< / a > ;
< a href = "undocumented#SkScalar" > SkScalar< / a > < a href = "#SkPaint_FontMetrics_fMaxCharWidth" > fMaxCharWidth< / a > ;
< a href = "undocumented#SkScalar" > SkScalar< / a > < a href = "#SkPaint_FontMetrics_fXMin" > fXMin< / a > ;
< a href = "undocumented#SkScalar" > SkScalar< / a > < a href = "#SkPaint_FontMetrics_fXMax" > fXMax< / a > ;
< a href = "undocumented#SkScalar" > SkScalar< / a > < a href = "#SkPaint_FontMetrics_fXHeight" > fXHeight< / a > ;
< a href = "undocumented#SkScalar" > SkScalar< / a > < a href = "#SkPaint_FontMetrics_fCapHeight" > fCapHeight< / a > ;
< a href = "undocumented#SkScalar" > SkScalar< / a > < a href = "#SkPaint_FontMetrics_fUnderlineThickness" > fUnderlineThickness< / a > ;
< a href = "undocumented#SkScalar" > SkScalar< / a > < a href = "#SkPaint_FontMetrics_fUnderlinePosition" > fUnderlinePosition< / a > ;
< a href = "undocumented#SkScalar" > SkScalar< / a > < a href = "#SkPaint_FontMetrics_fStrikeoutThickness" > fStrikeoutThickness< / a > ;
< a href = "undocumented#SkScalar" > SkScalar< / a > < a href = "#SkPaint_FontMetrics_fStrikeoutPosition" > fStrikeoutPosition< / a > ;
bool < a href = "#SkPaint_FontMetrics_hasUnderlineThickness" > hasUnderlineThickness(SkScalar* thickness)< / a > const;
bool < a href = "#SkPaint_FontMetrics_hasUnderlinePosition" > hasUnderlinePosition(SkScalar* position)< / a > const;
bool < a href = "#SkPaint_FontMetrics_hasStrikeoutThickness" > hasStrikeoutThickness(SkScalar* thickness)< / a > const;
bool < a href = "#SkPaint_FontMetrics_hasStrikeoutPosition" > hasStrikeoutPosition(SkScalar* position)< / a > const;
2017-07-28 19:18:29 +00:00
};< / pre >
2017-10-26 11:58:48 +00:00
< 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.
2017-07-28 19:18:29 +00:00
2017-11-09 17:08:31 +00:00
All vertical values relative to the baseline are given y-down. As such, zero is on the
baseline, negative values are above the baseline, and positive values are below the
baseline.
2017-10-26 11:58:48 +00:00
< 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.
2017-11-09 17:08:31 +00:00
2017-10-26 11:58:48 +00:00
< 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.
2017-09-15 06:56:12 +00:00
2017-10-26 11:58:48 +00:00
## <a name="SkPaint_FontMetrics_FontMetricsFlags"></a> Enum SkPaint::FontMetrics::FontMetricsFlags
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-08-25 15:51:49 +00:00
enum < a href = "#SkPaint_FontMetrics_FontMetricsFlags" > FontMetricsFlags< / a > {
< a href = "#SkPaint_FontMetrics_kUnderlineThicknessIsValid_Flag" > kUnderlineThicknessIsValid Flag< / a > = 1 < < 0 ,
< a href = "#SkPaint_FontMetrics_kUnderlinePositionIsValid_Flag" > kUnderlinePositionIsValid Flag< / a > = 1 < < 1 ,
< a href = "#SkPaint_FontMetrics_kStrikeoutThicknessIsValid_Flag" > kStrikeoutThicknessIsValid Flag< / a > = 1 < < 2 ,
< a href = "#SkPaint_FontMetrics_kStrikeoutPositionIsValid_Flag" > kStrikeoutPositionIsValid Flag< / a > = 1 < < 3 ,
2017-07-28 19:18:29 +00:00
};< / pre >
2017-10-26 11:58:48 +00:00
< 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.
2017-07-28 19:18:29 +00:00
### Constants
< table >
< tr >
2017-08-25 15:51:49 +00:00
< td > < a name = "SkPaint_FontMetrics_kUnderlineThicknessIsValid_Flag" > < code > < strong > SkPaint::FontMetrics::kUnderlineThicknessIsValid_Flag < / strong > < / code > < / a > < / td > < td > 0x0001< / td > < td > Set if < a href = "#SkPaint_FontMetrics_fUnderlineThickness" > fUnderlineThickness< / a > is valid.< / td >
2017-07-28 19:18:29 +00:00
< / tr >
< tr >
2017-08-25 15:51:49 +00:00
< td > < a name = "SkPaint_FontMetrics_kUnderlinePositionIsValid_Flag" > < code > < strong > SkPaint::FontMetrics::kUnderlinePositionIsValid_Flag < / strong > < / code > < / a > < / td > < td > 0x0002< / td > < td > Set if < a href = "#SkPaint_FontMetrics_fUnderlinePosition" > fUnderlinePosition< / a > is valid.< / td >
2017-07-28 19:18:29 +00:00
< / tr >
< tr >
2017-08-25 15:51:49 +00:00
< td > < a name = "SkPaint_FontMetrics_kStrikeoutThicknessIsValid_Flag" > < code > < strong > SkPaint::FontMetrics::kStrikeoutThicknessIsValid_Flag < / strong > < / code > < / a > < / td > < td > 0x0004< / td > < td > Set if < a href = "#SkPaint_FontMetrics_fStrikeoutThickness" > fStrikeoutThickness< / a > is valid.< / td >
2017-07-28 19:18:29 +00:00
< / tr >
< tr >
2017-08-25 15:51:49 +00:00
< td > < a name = "SkPaint_FontMetrics_kStrikeoutPositionIsValid_Flag" > < code > < strong > SkPaint::FontMetrics::kStrikeoutPositionIsValid_Flag < / strong > < / code > < / a > < / td > < td > 0x0008< / td > < td > Set if < a href = "#SkPaint_FontMetrics_fStrikeoutPosition" > fStrikeoutPosition< / a > is valid.< / td >
2017-07-28 19:18:29 +00:00
< / tr >
< / table >
2017-08-25 15:51:49 +00:00
< a name = "SkPaint_FontMetrics_fFlags" > < code > < strong > uint32_t fFlags< / strong > < / code > < / a >
2017-07-28 19:18:29 +00:00
2017-08-25 15:51:49 +00:00
< a href = "#SkPaint_FontMetrics_fFlags" > fFlags< / a > is set when underline metrics are valid.
2017-07-28 19:18:29 +00:00
2017-08-25 15:51:49 +00:00
< a name = "SkPaint_FontMetrics_fTop" > < code > < strong > SkScalar fTop< / strong > < / code > < / a >
2017-07-28 19:18:29 +00:00
2017-11-09 17:08:31 +00:00
Greatest extent above the baseline for any glyph.
Typically less than zero.
2017-07-28 19:18:29 +00:00
2017-08-25 15:51:49 +00:00
< a name = "SkPaint_FontMetrics_fAscent" > < code > < strong > SkScalar fAscent< / strong > < / code > < / a >
2017-07-28 19:18:29 +00:00
Recommended distance above the baseline to reserve for a line of text.
2017-11-09 17:08:31 +00:00
Typically less than zero.
2017-07-28 19:18:29 +00:00
2017-08-25 15:51:49 +00:00
< a name = "SkPaint_FontMetrics_fDescent" > < code > < strong > SkScalar fDescent< / strong > < / code > < / a >
2017-07-28 19:18:29 +00:00
Recommended distance below the baseline to reserve for a line of text.
2017-11-09 17:08:31 +00:00
Typically greater than zero.
2017-07-28 19:18:29 +00:00
2017-08-25 15:51:49 +00:00
< a name = "SkPaint_FontMetrics_fBottom" > < code > < strong > SkScalar fBottom< / strong > < / code > < / a >
2017-07-28 19:18:29 +00:00
2017-11-09 17:08:31 +00:00
Greatest extent below the baseline for any glyph.
Typically greater than zero.
2017-07-28 19:18:29 +00:00
2017-08-25 15:51:49 +00:00
< a name = "SkPaint_FontMetrics_fLeading" > < code > < strong > SkScalar fLeading< / strong > < / code > < / a >
2017-07-28 19:18:29 +00:00
Recommended distance to add between lines of text.
2017-11-09 17:08:31 +00:00
Typically greater than or equal to zero.
2017-07-28 19:18:29 +00:00
2017-08-25 15:51:49 +00:00
< a name = "SkPaint_FontMetrics_fAvgCharWidth" > < code > < strong > SkScalar fAvgCharWidth< / strong > < / code > < / a >
2017-07-28 19:18:29 +00:00
Average character width, if it is available.
Zero if no average width is stored in the font.
2017-08-25 15:51:49 +00:00
< a name = "SkPaint_FontMetrics_fMaxCharWidth" > < code > < strong > SkScalar fMaxCharWidth< / strong > < / code > < / a >
2017-07-28 19:18:29 +00:00
Maximum character width.
2017-08-25 15:51:49 +00:00
< a name = "SkPaint_FontMetrics_fXMin" > < code > < strong > SkScalar fXMin< / strong > < / code > < / a >
2017-07-28 19:18:29 +00:00
2017-11-09 17:08:31 +00:00
Minimum bounding box x value for all < a href = "#Glyph" > Glyphs< / a > .
2017-07-28 19:18:29 +00:00
Typically less than zero.
2017-08-25 15:51:49 +00:00
< a name = "SkPaint_FontMetrics_fXMax" > < code > < strong > SkScalar fXMax< / strong > < / code > < / a >
2017-07-28 19:18:29 +00:00
2017-09-01 19:51:02 +00:00
Maximum bounding box x value for all < a href = "#Glyph" > Glyphs< / a > .
2017-07-28 19:18:29 +00:00
Typically greater than zero.
2017-08-25 15:51:49 +00:00
< a name = "SkPaint_FontMetrics_fXHeight" > < code > < strong > SkScalar fXHeight< / strong > < / code > < / a >
2017-07-28 19:18:29 +00:00
Height of a lower-case 'x'.
May be zero if no lower-case height is stored in the font.
2017-08-25 15:51:49 +00:00
< a name = "SkPaint_FontMetrics_fCapHeight" > < code > < strong > SkScalar fCapHeight< / strong > < / code > < / a >
2017-07-28 19:18:29 +00:00
Height of an upper-case letter.
May be zero if no upper-case height is stored in the font.
2017-08-25 15:51:49 +00:00
< a name = "SkPaint_FontMetrics_fUnderlineThickness" > < code > < strong > SkScalar fUnderlineThickness< / strong > < / code > < / a >
2017-07-28 19:18:29 +00:00
2017-11-09 17:08:31 +00:00
Underline thickness.
If the metric is valid, the < a href = "#SkPaint_FontMetrics_kUnderlineThicknessIsValid_Flag" > kUnderlineThicknessIsValid Flag< / a > is set in < a href = "#SkPaint_FontMetrics_fFlags" > fFlags< / a > .
2017-08-25 15:51:49 +00:00
If < a href = "#SkPaint_FontMetrics_kUnderlineThicknessIsValid_Flag" > kUnderlineThicknessIsValid Flag< / a > is clear, < a href = "#SkPaint_FontMetrics_fUnderlineThickness" > fUnderlineThickness< / a > is zero.
2017-07-28 19:18:29 +00:00
2017-08-25 15:51:49 +00:00
< a name = "SkPaint_FontMetrics_fUnderlinePosition" > < code > < strong > SkScalar fUnderlinePosition< / strong > < / code > < / a >
2017-07-28 19:18:29 +00:00
2017-11-09 17:08:31 +00:00
Position of the top of the underline stroke relative to the baseline.
Typically positive when valid.
2017-07-28 19:18:29 +00:00
2017-08-25 15:51:49 +00:00
If the metric is valid, the < a href = "#SkPaint_FontMetrics_kUnderlinePositionIsValid_Flag" > kUnderlinePositionIsValid Flag< / a > is set in < a href = "#SkPaint_FontMetrics_fFlags" > fFlags< / a > .
If < a href = "#SkPaint_FontMetrics_kUnderlinePositionIsValid_Flag" > kUnderlinePositionIsValid Flag< / a > is clear, < a href = "#SkPaint_FontMetrics_fUnderlinePosition" > fUnderlinePosition< / a > is zero.
2017-07-28 19:18:29 +00:00
2017-08-25 15:51:49 +00:00
< a name = "SkPaint_FontMetrics_fStrikeoutThickness" > < code > < strong > SkScalar fStrikeoutThickness< / strong > < / code > < / a >
2017-07-28 19:18:29 +00:00
2017-11-09 17:08:31 +00:00
Strikeout thickness.
If the metric is valid, the < a href = "#SkPaint_FontMetrics_kStrikeoutThicknessIsValid_Flag" > kStrikeoutThicknessIsValid Flag< / a > is set in < a href = "#SkPaint_FontMetrics_fFlags" > fFlags< / a > .
2017-08-25 15:51:49 +00:00
If < a href = "#SkPaint_FontMetrics_kStrikeoutThicknessIsValid_Flag" > kStrikeoutThicknessIsValid Flag< / a > is clear, < a href = "#SkPaint_FontMetrics_fStrikeoutThickness" > fStrikeoutThickness< / a > is zero.
2017-07-28 19:18:29 +00:00
2017-08-25 15:51:49 +00:00
< a name = "SkPaint_FontMetrics_fStrikeoutPosition" > < code > < strong > SkScalar fStrikeoutPosition< / strong > < / code > < / a >
2017-07-28 19:18:29 +00:00
2017-11-09 17:08:31 +00:00
Position of the bottom of the strikeout stroke relative to the baseline.
Typically negative when valid.
2017-07-28 19:18:29 +00:00
2017-08-25 15:51:49 +00:00
If the metric is valid, the < a href = "#SkPaint_FontMetrics_kStrikeoutPositionIsValid_Flag" > kStrikeoutPositionIsValid Flag< / a > is set in < a href = "#SkPaint_FontMetrics_fFlags" > fFlags< / a > .
If < a href = "#SkPaint_FontMetrics_kStrikeoutPositionIsValid_Flag" > kStrikeoutPositionIsValid Flag< / a > is clear, < a href = "#SkPaint_FontMetrics_fStrikeoutPosition" > fStrikeoutPosition< / a > is zero.
2017-07-28 19:18:29 +00:00
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_FontMetrics_hasUnderlineThickness" > < / a >
2017-07-28 19:18:29 +00:00
## hasUnderlineThickness
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-07-28 19:18:29 +00:00
bool hasUnderlineThickness(SkScalar* thickness) const
< / pre >
2017-11-09 17:08:31 +00:00
If < a href = "#Font_Metrics" > Font Metrics< / a > has a valid underline < a href = "#SkPaint_FontMetrics_hasUnderlineThickness_thickness" > thickness< / a > , return true, and set
2017-09-01 19:51:02 +00:00
< a href = "#SkPaint_FontMetrics_hasUnderlineThickness_thickness" > thickness< / a > to that value. If the underline < a href = "#SkPaint_FontMetrics_hasUnderlineThickness_thickness" > thickness< / a > is not valid,
return false, and ignore < a href = "#SkPaint_FontMetrics_hasUnderlineThickness_thickness" > thickness< / a > .
2017-07-28 19:18:29 +00:00
### Parameters
2017-08-25 15:51:49 +00:00
< table > < tr > < td > < a name = "SkPaint_FontMetrics_hasUnderlineThickness_thickness" > < code > < strong > thickness < / strong > < / code > < / a > < / td > < td >
2017-07-28 19:18:29 +00:00
storage for underline width< / td >
< / tr >
< / table >
### Return Value
true if font specifies underline width
---
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_FontMetrics_hasUnderlinePosition" > < / a >
2017-07-28 19:18:29 +00:00
## hasUnderlinePosition
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-07-28 19:18:29 +00:00
bool hasUnderlinePosition(SkScalar* position) const
< / pre >
2017-11-09 17:08:31 +00:00
If < a href = "#Font_Metrics" > Font Metrics< / a > has a valid underline < a href = "#SkPaint_FontMetrics_hasUnderlinePosition_position" > position< / a > , return true, and set
2017-09-01 19:51:02 +00:00
< a href = "#SkPaint_FontMetrics_hasUnderlinePosition_position" > position< / a > to that value. If the underline < a href = "#SkPaint_FontMetrics_hasUnderlinePosition_position" > position< / a > is not valid,
return false, and ignore < a href = "#SkPaint_FontMetrics_hasUnderlinePosition_position" > position< / a > .
2017-07-28 19:18:29 +00:00
### Parameters
2017-08-25 15:51:49 +00:00
< table > < tr > < td > < a name = "SkPaint_FontMetrics_hasUnderlinePosition_position" > < code > < strong > position < / strong > < / code > < / a > < / td > < td >
storage for underline < a href = "#SkPaint_FontMetrics_hasUnderlinePosition_position" > position< / a > < / td >
2017-07-28 19:18:29 +00:00
< / tr >
< / table >
### Return Value
2017-08-25 15:51:49 +00:00
true if font specifies underline < a href = "#SkPaint_FontMetrics_hasUnderlinePosition_position" > position< / a >
2017-07-28 19:18:29 +00:00
---
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_FontMetrics_hasStrikeoutThickness" > < / a >
2017-07-28 19:18:29 +00:00
## hasStrikeoutThickness
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-07-28 19:18:29 +00:00
bool hasStrikeoutThickness(SkScalar* thickness) const
< / pre >
2017-11-09 17:08:31 +00:00
If < a href = "#Font_Metrics" > Font Metrics< / a > has a valid strikeout < a href = "#SkPaint_FontMetrics_hasStrikeoutThickness_thickness" > thickness< / a > , return true, and set
2017-09-01 19:51:02 +00:00
< a href = "#SkPaint_FontMetrics_hasStrikeoutThickness_thickness" > thickness< / a > to that value. If the underline < a href = "#SkPaint_FontMetrics_hasStrikeoutThickness_thickness" > thickness< / a > is not valid,
return false, and ignore < a href = "#SkPaint_FontMetrics_hasStrikeoutThickness_thickness" > thickness< / a > .
2017-07-28 19:18:29 +00:00
### Parameters
2017-08-25 15:51:49 +00:00
< table > < tr > < td > < a name = "SkPaint_FontMetrics_hasStrikeoutThickness_thickness" > < code > < strong > thickness < / strong > < / code > < / a > < / td > < td >
2017-07-28 19:18:29 +00:00
storage for strikeout width< / td >
< / tr >
< / table >
### Return Value
true if font specifies strikeout width
---
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_FontMetrics_hasStrikeoutPosition" > < / a >
2017-07-28 19:18:29 +00:00
## hasStrikeoutPosition
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-07-28 19:18:29 +00:00
bool hasStrikeoutPosition(SkScalar* position) const
< / pre >
2017-11-09 17:08:31 +00:00
If < a href = "#Font_Metrics" > Font Metrics< / a > has a valid strikeout < a href = "#SkPaint_FontMetrics_hasStrikeoutPosition_position" > position< / a > , return true, and set
2017-09-01 19:51:02 +00:00
< a href = "#SkPaint_FontMetrics_hasStrikeoutPosition_position" > position< / a > to that value. If the underline < a href = "#SkPaint_FontMetrics_hasStrikeoutPosition_position" > position< / a > is not valid,
return false, and ignore < a href = "#SkPaint_FontMetrics_hasStrikeoutPosition_position" > position< / a > .
2017-07-28 19:18:29 +00:00
### Parameters
2017-08-25 15:51:49 +00:00
< table > < tr > < td > < a name = "SkPaint_FontMetrics_hasStrikeoutPosition_position" > < code > < strong > position < / strong > < / code > < / a > < / td > < td >
storage for strikeout < a href = "#SkPaint_FontMetrics_hasStrikeoutPosition_position" > position< / a > < / td >
2017-07-28 19:18:29 +00:00
< / tr >
< / table >
### Return Value
2017-08-25 15:51:49 +00:00
true if font specifies strikeout < a href = "#SkPaint_FontMetrics_hasStrikeoutPosition_position" > position< / a >
2017-07-28 19:18:29 +00:00
---
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_getFontMetrics" > < / a >
2017-07-28 19:18:29 +00:00
## getFontMetrics
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-07-28 19:18:29 +00:00
SkScalar getFontMetrics(FontMetrics* metrics, SkScalar scale = 0) const
< / pre >
2017-08-25 15:51:49 +00:00
Returns < a href = "#Font_Metrics" > Font Metrics< / a > associated with < a href = "undocumented#Typeface" > Typeface< / a > .
The return value is the recommended spacing between lines: the sum of < a href = "#SkPaint_getFontMetrics_metrics" > metrics< / a >
2017-07-28 19:18:29 +00:00
descent, ascent, and leading.
2017-08-25 15:51:49 +00:00
If < a href = "#SkPaint_getFontMetrics_metrics" > metrics< / a > is not nullptr, < a href = "#Font_Metrics" > Font Metrics< / a > is copied to < a href = "#SkPaint_getFontMetrics_metrics" > metrics< / a > .
Results are scaled by < a href = "#Text_Size" > Text Size< / a > but does not take into account
dimensions required by < a href = "#Text_Scale_X" > Text Scale X< / a > , < a href = "#Text_Skew_X" > Text Skew X< / a > , < a href = "#Fake_Bold" > Fake Bold< / a > ,
< a href = "#Style_Stroke" > Style Stroke< / a > , and < a href = "undocumented#Path_Effect" > Path Effect< / a > .
Results can be additionally scaled by < a href = "#SkPaint_getFontMetrics_scale" > scale< / a > ; a < a href = "#SkPaint_getFontMetrics_scale" > scale< / a > of zero
2017-07-28 19:18:29 +00:00
is ignored.
### Parameters
2017-08-25 15:51:49 +00:00
< table > < tr > < td > < a name = "SkPaint_getFontMetrics_metrics" > < code > < strong > metrics < / strong > < / code > < / a > < / td > < td >
storage for < a href = "#Font_Metrics" > Font Metrics< / a > from < a href = "undocumented#Typeface" > Typeface< / a > ; may be nullptr< / td >
< / tr > < tr > < td > < a name = "SkPaint_getFontMetrics_scale" > < code > < strong > scale < / strong > < / code > < / a > < / td > < td >
2017-07-28 19:18:29 +00:00
additional multiplier for returned values< / td >
< / tr >
< / table >
### Return Value
recommended spacing between lines
### Example
< div > < fiddle-embed name = "b899d84caba6607340322d317992d070" > < / fiddle-embed > < / div >
### See Also
2017-08-25 15:51:49 +00:00
< a href = "#Text_Size" > Text Size< / a > < a href = "undocumented#Typeface" > Typeface< / a > < a href = "#Typeface_Methods" > Typeface Methods< / a >
2017-07-28 19:18:29 +00:00
---
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_getFontSpacing" > < / a >
2017-07-28 19:18:29 +00:00
## getFontSpacing
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-07-28 19:18:29 +00:00
SkScalar getFontSpacing() const
< / pre >
Returns the recommended spacing between lines: the sum of metrics
descent, ascent, and leading.
2017-08-25 15:51:49 +00:00
Result is scaled by < a href = "#Text_Size" > Text Size< / a > but does not take into account
2017-08-04 16:48:24 +00:00
dimensions required by stroking and < a href = "undocumented#Path_Effect" > Path Effect< / a > .
2017-08-25 15:51:49 +00:00
Returns the same result as < a href = "#SkPaint_getFontMetrics" > getFontMetrics< / a > .
2017-07-28 19:18:29 +00:00
### Return Value
recommended spacing between lines
### Example
< div > < fiddle-embed name = "424741e26e1b174e43087d67422ce14f" >
#### Example Output
~~~~
textSize: 12 fontSpacing: 13.9688
textSize: 18 fontSpacing: 20.9531
textSize: 24 fontSpacing: 27.9375
textSize: 32 fontSpacing: 37.25
~~~~
< / fiddle-embed > < / div >
---
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_getFontBounds" > < / a >
2017-07-28 19:18:29 +00:00
## getFontBounds
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-07-28 19:18:29 +00:00
SkRect getFontBounds() const
< / pre >
2017-09-01 19:51:02 +00:00
Returns the union of bounds of all < a href = "#Glyph" > Glyphs< / a > .
2018-01-04 21:11:51 +00:00
Returned dimensions are computed by < a href = "undocumented#Font_Manager" > Font Manager< / a > from font data,
2017-08-25 15:51:49 +00:00
ignoring < a href = "#SkPaint_Hinting" > Hinting< / a > . Includes < a href = "#Text_Size" > Text Size< / a > , < a href = "#Text_Scale_X" > Text Scale X< / a > ,
and < a href = "#Text_Skew_X" > Text Skew X< / a > , but not < a href = "#Fake_Bold" > Fake Bold< / a > or < a href = "undocumented#Path_Effect" > Path Effect< / a > .
2017-07-28 19:18:29 +00:00
2017-08-25 15:51:49 +00:00
If < a href = "#Text_Size" > Text Size< / a > is large, < a href = "#Text_Scale_X" > Text Scale X< / a > is one, and < a href = "#Text_Skew_X" > Text Skew X< / a > is zero,
2018-01-04 21:11:51 +00:00
returns the same bounds as < a href = "#Font_Metrics" > Font Metrics< / a > { < a href = "#SkPaint_FontMetrics_fXMin" > FontMetrics::fXMin< / a > ,
2017-08-25 15:51:49 +00:00
< a href = "#SkPaint_FontMetrics_fTop" > FontMetrics::fTop< / a > , < a href = "#SkPaint_FontMetrics_fXMax" > FontMetrics::fXMax< / a > , < a href = "#SkPaint_FontMetrics_fBottom" > FontMetrics::fBottom< / a > }.
2017-07-28 19:18:29 +00:00
### Return Value
2017-09-01 19:51:02 +00:00
union of bounds of all < a href = "#Glyph" > Glyphs< / a >
2017-07-28 19:18:29 +00:00
### Example
< div > < fiddle-embed name = "facaddeec7943bc491988e345e27e65f" >
#### Example Output
~~~~
metrics bounds = { -12.2461, -14.7891, 21.5215, 5.55469 }
font bounds = { -12.2461, -14.7891, 21.5215, 5.55469 }
~~~~
< / fiddle-embed > < / div >
---
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_textToGlyphs" > < / a >
2017-07-28 19:18:29 +00:00
## textToGlyphs
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-07-28 19:18:29 +00:00
int textToGlyphs(const void* text, size_t byteLength, SkGlyphID glyphs[]) const
< / pre >
2017-08-25 15:51:49 +00:00
Converts < a href = "#SkPaint_textToGlyphs_text" > text< / a > into glyph indices.
Returns the number of glyph indices represented by < a href = "#SkPaint_textToGlyphs_text" > text< / a > .
< a href = "#Text_Encoding" > Text Encoding< / a > specifies how < a href = "#SkPaint_textToGlyphs_text" > text< / a > represents characters or < a href = "#SkPaint_textToGlyphs_glyphs" > glyphs< / a > .
< a href = "#SkPaint_textToGlyphs_glyphs" > glyphs< / a > may be nullptr, to compute the glyph count.
2017-07-28 19:18:29 +00:00
2017-10-04 18:31:33 +00:00
Does not check < a href = "#SkPaint_textToGlyphs_text" > text< / a > for valid character codes or valid glyph indices.
2017-07-28 19:18:29 +00:00
2017-08-25 15:51:49 +00:00
If < a href = "#SkPaint_textToGlyphs_byteLength" > byteLength< / a > equals zero, returns zero.
If < a href = "#SkPaint_textToGlyphs_byteLength" > byteLength< / a > includes a partial character, the partial character is ignored.
2017-07-28 19:18:29 +00:00
2017-08-25 15:51:49 +00:00
If < a href = "#Text_Encoding" > Text Encoding< / a > is < a href = "#SkPaint_kUTF8_TextEncoding" > kUTF8 TextEncoding< / a > and
2017-11-27 15:44:06 +00:00
< a href = "#SkPaint_textToGlyphs_text" > text< / a > contains an invalid UTF-8 sequence, zero is returned.
2017-07-28 19:18:29 +00:00
### Parameters
2017-08-25 15:51:49 +00:00
< table > < tr > < td > < a name = "SkPaint_textToGlyphs_text" > < code > < strong > text < / strong > < / code > < / a > < / td > < td >
2017-09-01 19:51:02 +00:00
character storage encoded with < a href = "#Text_Encoding" > Text Encoding< / a > < / td >
2017-08-25 15:51:49 +00:00
< / tr > < tr > < td > < a name = "SkPaint_textToGlyphs_byteLength" > < code > < strong > byteLength < / strong > < / code > < / a > < / td > < td >
2017-07-28 19:18:29 +00:00
length of character storage in bytes< / td >
2017-08-25 15:51:49 +00:00
< / tr > < tr > < td > < a name = "SkPaint_textToGlyphs_glyphs" > < code > < strong > glyphs < / strong > < / code > < / a > < / td > < td >
2017-07-28 19:18:29 +00:00
storage for glyph indices; may be nullptr< / td >
< / tr >
< / table >
### Return Value
2017-08-25 15:51:49 +00:00
number of < a href = "#SkPaint_textToGlyphs_glyphs" > glyphs< / a > represented by < a href = "#SkPaint_textToGlyphs_text" > text< / a > of length < a href = "#SkPaint_textToGlyphs_byteLength" > byteLength< / a >
2017-07-28 19:18:29 +00:00
### Example
< div > < fiddle-embed name = "343e9471a7f7b5f09abdc3b44983433b" > < / fiddle-embed > < / div >
---
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_countText" > < / a >
2017-07-28 19:18:29 +00:00
## countText
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-07-28 19:18:29 +00:00
int countText(const void* text, size_t byteLength) const
< / pre >
2017-09-01 19:51:02 +00:00
Returns the number of < a href = "#Glyph" > Glyphs< / a > in < a href = "#SkPaint_countText_text" > text< / a > .
Uses < a href = "#Text_Encoding" > Text Encoding< / a > to count the < a href = "#Glyph" > Glyphs< / a > .
2017-08-25 15:51:49 +00:00
Returns the same result as < a href = "#SkPaint_textToGlyphs" > textToGlyphs< / a > .
2017-07-28 19:18:29 +00:00
### Parameters
2017-08-25 15:51:49 +00:00
< table > < tr > < td > < a name = "SkPaint_countText_text" > < code > < strong > text < / strong > < / code > < / a > < / td > < td >
2017-09-01 19:51:02 +00:00
character storage encoded with < a href = "#Text_Encoding" > Text Encoding< / a > < / td >
2017-08-25 15:51:49 +00:00
< / tr > < tr > < td > < a name = "SkPaint_countText_byteLength" > < code > < strong > byteLength < / strong > < / code > < / a > < / td > < td >
2017-07-28 19:18:29 +00:00
length of character storage in bytes< / td >
< / tr >
< / table >
### Return Value
2017-09-01 19:51:02 +00:00
number of < a href = "#Glyph" > Glyphs< / a > represented by < a href = "#SkPaint_countText_text" > text< / a > of length < a href = "#SkPaint_countText_byteLength" > byteLength< / a >
2017-07-28 19:18:29 +00:00
### Example
< div > < fiddle-embed name = "85436c71aab5410767fc688ab0573e09" >
#### Example Output
~~~~
count = 5
~~~~
< / fiddle-embed > < / div >
---
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_containsText" > < / a >
2017-07-28 19:18:29 +00:00
## containsText
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-07-28 19:18:29 +00:00
bool containsText(const void* text, size_t byteLength) const
< / pre >
2018-01-04 21:11:51 +00:00
Returns true if all < a href = "#SkPaint_containsText_text" > text< / a > corresponds to a non-zero glyph index.
2017-08-25 15:51:49 +00:00
Returns false if any characters in < a href = "#SkPaint_containsText_text" > text< / a > are not supported in
2017-08-04 16:48:24 +00:00
< a href = "undocumented#Typeface" > Typeface< / a > .
2017-07-28 19:18:29 +00:00
2017-08-25 15:51:49 +00:00
If < a href = "#Text_Encoding" > Text Encoding< / a > is < a href = "#SkPaint_kGlyphID_TextEncoding" > kGlyphID TextEncoding< / a > ,
returns true if all glyph indices in < a href = "#SkPaint_containsText_text" > text< / a > are non-zero;
does not check to see if < a href = "#SkPaint_containsText_text" > text< / a > contains valid glyph indices for < a href = "undocumented#Typeface" > Typeface< / a > .
2017-07-28 19:18:29 +00:00
2017-09-01 19:51:02 +00:00
Returns true if < a href = "#SkPaint_containsText_byteLength" > byteLength< / a > is zero.
2017-07-28 19:18:29 +00:00
### Parameters
2017-08-25 15:51:49 +00:00
< table > < tr > < td > < a name = "SkPaint_containsText_text" > < code > < strong > text < / strong > < / code > < / a > < / td > < td >
2017-09-01 19:51:02 +00:00
array of characters or < a href = "#Glyph" > Glyphs< / a > < / td >
2017-08-25 15:51:49 +00:00
< / tr > < tr > < td > < a name = "SkPaint_containsText_byteLength" > < code > < strong > byteLength < / strong > < / code > < / a > < / td > < td >
number of bytes in < a href = "#SkPaint_containsText_text" > text< / a > array< / td >
2017-07-28 19:18:29 +00:00
< / tr >
< / table >
### Return Value
2017-08-25 15:51:49 +00:00
true if all < a href = "#SkPaint_containsText_text" > text< / a > corresponds to a non-zero glyph index
2017-07-28 19:18:29 +00:00
### Example
2017-08-25 15:51:49 +00:00
< div > < fiddle-embed name = "9202369019552f09cd4bec7f3046fee4" > < div > < a href = "#SkPaint_containsText" > containsText< / a > succeeds for degree symbol, but cannot find a glyph index
2018-01-04 21:11:51 +00:00
corresponding to the Unicode surrogate code point.< / div >
2017-07-28 19:18:29 +00:00
#### Example Output
~~~~
0x00b0 == has char
0xd800 != has char
~~~~
< / fiddle-embed > < / div >
### Example
2017-08-25 15:51:49 +00:00
< div > < fiddle-embed name = "904227febfd1c2e264955da0ef66da73" > < div > < a href = "#SkPaint_containsText" > containsText< / a > returns true that glyph index is greater than zero, not
2017-08-04 16:48:24 +00:00
that it corresponds to an entry in < a href = "undocumented#Typeface" > Typeface< / a > .< / div >
2017-07-28 19:18:29 +00:00
#### Example Output
~~~~
0x01ff == has glyph
0x0000 != has glyph
0xffff == has glyph
~~~~
< / fiddle-embed > < / div >
### See Also
2017-08-25 15:51:49 +00:00
< a href = "#SkPaint_setTextEncoding" > setTextEncoding< / a > < a href = "undocumented#Typeface" > Typeface< / a >
2017-07-28 19:18:29 +00:00
---
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_glyphsToUnichars" > < / a >
2017-07-28 19:18:29 +00:00
## glyphsToUnichars
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-07-28 19:18:29 +00:00
void glyphsToUnichars(const SkGlyphID glyphs[], int count, SkUnichar text[]) const
< / pre >
2018-01-04 21:11:51 +00:00
Converts < a href = "#SkPaint_glyphsToUnichars_glyphs" > glyphs< / a > into < a href = "#SkPaint_glyphsToUnichars_text" > text< / a > if possible.
< a href = "undocumented#Glyph" > Glyph< / a > values without direct Unicode equivalents are mapped to zero.
2017-08-04 16:48:24 +00:00
Uses the < a href = "undocumented#Typeface" > Typeface< / a > , but is unaffected
2017-08-25 15:51:49 +00:00
by < a href = "#Text_Encoding" > Text Encoding< / a > ; the < a href = "#SkPaint_glyphsToUnichars_text" > text< / a > values returned are equivalent to < a href = "#SkPaint_kUTF32_TextEncoding" > kUTF32 TextEncoding< / a > .
2017-07-28 19:18:29 +00:00
2018-01-04 21:11:51 +00:00
Only supported on platforms that use FreeType as the < a href = "#Engine" > Font Engine< / a > .
2017-07-28 19:18:29 +00:00
### Parameters
2017-08-25 15:51:49 +00:00
< table > < tr > < td > < a name = "SkPaint_glyphsToUnichars_glyphs" > < code > < strong > glyphs < / strong > < / code > < / a > < / td > < td >
2017-07-28 19:18:29 +00:00
array of indices into font< / td >
2017-08-25 15:51:49 +00:00
< / tr > < tr > < td > < a name = "SkPaint_glyphsToUnichars_count" > < code > < strong > count < / strong > < / code > < / a > < / td > < td >
2017-07-28 19:18:29 +00:00
length of glyph array< / td >
2017-08-25 15:51:49 +00:00
< / tr > < tr > < td > < a name = "SkPaint_glyphsToUnichars_text" > < code > < strong > text < / strong > < / code > < / a > < / td > < td >
2017-07-28 19:18:29 +00:00
storage for character codes, one per glyph< / td >
< / tr >
< / table >
### Example
2018-01-04 21:11:51 +00:00
< div > < fiddle-embed name = "c12686b0b3e0a87d0a248bbfc57e9492" > < div > Convert UTF-8 < a href = "#SkPaint_glyphsToUnichars_text" > text< / a > to < a href = "#SkPaint_glyphsToUnichars_glyphs" > glyphs< / a > ; then convert < a href = "#SkPaint_glyphsToUnichars_glyphs" > glyphs< / a > to Unichar code points.< / div > < / fiddle-embed > < / div >
2017-07-28 19:18:29 +00:00
---
# <a name="Measure_Text"></a> Measure Text
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_measureText" > < / a >
2017-07-28 19:18:29 +00:00
## measureText
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-07-28 19:18:29 +00:00
SkScalar measureText(const void* text, size_t length, SkRect* bounds) const
< / pre >
2017-08-25 15:51:49 +00:00
Returns the advance width of < a href = "#SkPaint_measureText_text" > text< / a > if < a href = "#SkPaint_kVerticalText_Flag" > kVerticalText Flag< / a > is clear,
and the height of < a href = "#SkPaint_measureText_text" > text< / a > if < a href = "#SkPaint_kVerticalText_Flag" > kVerticalText Flag< / a > is set.
The advance is the normal distance to move before drawing additional < a href = "#SkPaint_measureText_text" > text< / a > .
Uses < a href = "#Text_Encoding" > Text Encoding< / a > to decode < a href = "#SkPaint_measureText_text" > text< / a > , < a href = "undocumented#Typeface" > Typeface< / a > to get the font metrics,
and < a href = "#Text_Size" > Text Size< / a > , < a href = "#Text_Scale_X" > Text Scale X< / a > , < a href = "#Text_Skew_X" > Text Skew X< / a > , < a href = "#Stroke_Width" > Stroke Width< / a > , and
< a href = "undocumented#Path_Effect" > Path Effect< / a > to scale the metrics and < a href = "#SkPaint_measureText_bounds" > bounds< / a > .
Returns the bounding box of < a href = "#SkPaint_measureText_text" > text< / a > if < a href = "#SkPaint_measureText_bounds" > bounds< / a > is not nullptr.
The bounding box is computed as if the < a href = "#SkPaint_measureText_text" > text< / a > was drawn at the origin.
2017-07-28 19:18:29 +00:00
### Parameters
2017-08-25 15:51:49 +00:00
< table > < tr > < td > < a name = "SkPaint_measureText_text" > < code > < strong > text < / strong > < / code > < / a > < / td > < td >
2017-07-28 19:18:29 +00:00
character codes or glyph indices to be measured< / td >
2017-08-25 15:51:49 +00:00
< / tr > < tr > < td > < a name = "SkPaint_measureText_length" > < code > < strong > length < / strong > < / code > < / a > < / td > < td >
number of bytes of < a href = "#SkPaint_measureText_text" > text< / a > to measure< / td >
< / tr > < tr > < td > < a name = "SkPaint_measureText_bounds" > < code > < strong > bounds < / strong > < / code > < / a > < / td > < td >
2017-07-28 19:18:29 +00:00
returns bounding box relative to (0, 0) if not nullptr< / td >
< / tr >
< / table >
### Return Value
advance width or height
### Example
< div > < fiddle-embed name = "06084f609184470135a9cd9ebc5af149" > < / fiddle-embed > < / div >
---
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-07-28 19:18:29 +00:00
SkScalar measureText(const void* text, size_t length) const
< / pre >
2017-08-25 15:51:49 +00:00
Returns the advance width of < a href = "#SkPaint_measureText_2_text" > text< / a > if < a href = "#SkPaint_kVerticalText_Flag" > kVerticalText Flag< / a > is clear,
and the height of < a href = "#SkPaint_measureText_2_text" > text< / a > if < a href = "#SkPaint_kVerticalText_Flag" > kVerticalText Flag< / a > is set.
The advance is the normal distance to move before drawing additional < a href = "#SkPaint_measureText_2_text" > text< / a > .
Uses < a href = "#Text_Encoding" > Text Encoding< / a > to decode < a href = "#SkPaint_measureText_2_text" > text< / a > , < a href = "undocumented#Typeface" > Typeface< / a > to get the font metrics,
and < a href = "#Text_Size" > Text Size< / a > to scale the metrics.
Does not scale the advance or bounds by < a href = "#Fake_Bold" > Fake Bold< / a > or < a href = "undocumented#Path_Effect" > Path Effect< / a > .
2017-07-28 19:18:29 +00:00
### Parameters
2017-08-25 15:51:49 +00:00
< table > < tr > < td > < a name = "SkPaint_measureText_2_text" > < code > < strong > text < / strong > < / code > < / a > < / td > < td >
2017-07-28 19:18:29 +00:00
character codes or glyph indices to be measured< / td >
2017-08-25 15:51:49 +00:00
< / tr > < tr > < td > < a name = "SkPaint_measureText_2_length" > < code > < strong > length < / strong > < / code > < / a > < / td > < td >
number of bytes of < a href = "#SkPaint_measureText_2_text" > text< / a > to measure< / td >
2017-07-28 19:18:29 +00:00
< / tr >
< / table >
### Return Value
advance width or height
### Example
< div > < fiddle-embed name = "f1139a5ddd17fd47c2f45f6e642cac76" >
#### Example Output
~~~~
default width = 5
double width = 10
~~~~
< / fiddle-embed > < / div >
---
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_breakText" > < / a >
2017-07-28 19:18:29 +00:00
## breakText
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-07-28 19:18:29 +00:00
size_t breakText(const void* text, size_t length, SkScalar maxWidth,
2017-08-29 21:36:51 +00:00
SkScalar* measuredWidth = nullptr) const
2017-07-28 19:18:29 +00:00
< / pre >
2017-08-25 15:51:49 +00:00
Returns the bytes of < a href = "#SkPaint_breakText_text" > text< / a > that fit within < a href = "#SkPaint_breakText_maxWidth" > maxWidth< / a > .
If < a href = "#SkPaint_kVerticalText_Flag" > kVerticalText Flag< / a > is clear, the < a href = "#SkPaint_breakText_text" > text< / a > fragment fits if its advance width is less than or
equal to < a href = "#SkPaint_breakText_maxWidth" > maxWidth< / a > .
If < a href = "#SkPaint_kVerticalText_Flag" > kVerticalText Flag< / a > is set, the < a href = "#SkPaint_breakText_text" > text< / a > fragment fits if its advance height is less than or
equal to < a href = "#SkPaint_breakText_maxWidth" > maxWidth< / a > .
Measures only while the advance is less than or equal to < a href = "#SkPaint_breakText_maxWidth" > maxWidth< / a > .
Returns the advance or the < a href = "#SkPaint_breakText_text" > text< / a > fragment in < a href = "#SkPaint_breakText_measuredWidth" > measuredWidth< / a > if it not nullptr.
Uses < a href = "#Text_Encoding" > Text Encoding< / a > to decode < a href = "#SkPaint_breakText_text" > text< / a > , < a href = "undocumented#Typeface" > Typeface< / a > to get the font metrics,
and < a href = "#Text_Size" > Text Size< / a > to scale the metrics.
Does not scale the advance or bounds by < a href = "#Fake_Bold" > Fake Bold< / a > or < a href = "undocumented#Path_Effect" > Path Effect< / a > .
2017-07-28 19:18:29 +00:00
### Parameters
2017-08-25 15:51:49 +00:00
< table > < tr > < td > < a name = "SkPaint_breakText_text" > < code > < strong > text < / strong > < / code > < / a > < / td > < td >
2017-07-28 19:18:29 +00:00
character codes or glyph indices to be measured< / td >
2017-08-25 15:51:49 +00:00
< / tr > < tr > < td > < a name = "SkPaint_breakText_length" > < code > < strong > length < / strong > < / code > < / a > < / td > < td >
number of bytes of < a href = "#SkPaint_breakText_text" > text< / a > to measure< / td >
< / tr > < tr > < td > < a name = "SkPaint_breakText_maxWidth" > < code > < strong > maxWidth < / strong > < / code > < / a > < / td > < td >
advance limit; < a href = "#SkPaint_breakText_text" > text< / a > is measured while advance is less than < a href = "#SkPaint_breakText_maxWidth" > maxWidth< / a > < / td >
< / tr > < tr > < td > < a name = "SkPaint_breakText_measuredWidth" > < code > < strong > measuredWidth < / strong > < / code > < / a > < / td > < td >
returns the width of the < a href = "#SkPaint_breakText_text" > text< / a > less than or equal to < a href = "#SkPaint_breakText_maxWidth" > maxWidth< / a > < / td >
2017-07-28 19:18:29 +00:00
< / tr >
< / table >
### Return Value
2017-08-25 15:51:49 +00:00
bytes of < a href = "#SkPaint_breakText_text" > text< / a > that fit, always less than or equal to < a href = "#SkPaint_breakText_length" > length< / a >
2017-07-28 19:18:29 +00:00
### Example
2017-08-04 16:48:24 +00:00
< div > < fiddle-embed name = "fd0033470ccbd5c7059670fdbf96cffc" > < div > < a href = "undocumented#Line" > Line< / a > under "" shows desired width, shorter than available characters.
2017-08-25 15:51:49 +00:00
< a href = "undocumented#Line" > Line< / a > under "" shows measured width after breaking < a href = "#SkPaint_breakText_text" > text< / a > .< / div > < / fiddle-embed > < / div >
2017-07-28 19:18:29 +00:00
---
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_getTextWidths" > < / a >
2017-07-28 19:18:29 +00:00
## getTextWidths
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
int getTextWidths(const void* text, size_t byteLength, SkScalar widths[], SkRect bounds[] = nullptr) const
2017-07-28 19:18:29 +00:00
< / pre >
2017-08-25 15:51:49 +00:00
Retrieves the advance and < a href = "#SkPaint_getTextWidths_bounds" > bounds< / a > for each glyph in < a href = "#SkPaint_getTextWidths_text" > text< / a > , and returns
the glyph count in < a href = "#SkPaint_getTextWidths_text" > text< / a > .
Both < a href = "#SkPaint_getTextWidths_widths" > widths< / a > and < a href = "#SkPaint_getTextWidths_bounds" > bounds< / a > may be nullptr.
If < a href = "#SkPaint_getTextWidths_widths" > widths< / a > is not nullptr, < a href = "#SkPaint_getTextWidths_widths" > widths< / a > must be an array of glyph count entries.
2018-01-04 21:11:51 +00:00
if < a href = "#SkPaint_getTextWidths_bounds" > bounds< / a > is not nullptr, < a href = "#SkPaint_getTextWidths_bounds" > bounds< / a > must be an array of glyph count entries.
2017-08-25 15:51:49 +00:00
If < a href = "#SkPaint_kVerticalText_Flag" > kVerticalText Flag< / a > is clear, < a href = "#SkPaint_getTextWidths_widths" > widths< / a > returns the horizontal advance.
If < a href = "#SkPaint_kVerticalText_Flag" > kVerticalText Flag< / a > is set, < a href = "#SkPaint_getTextWidths_widths" > widths< / a > returns the vertical advance.
Uses < a href = "#Text_Encoding" > Text Encoding< / a > to decode < a href = "#SkPaint_getTextWidths_text" > text< / a > , < a href = "undocumented#Typeface" > Typeface< / a > to get the font metrics,
and < a href = "#Text_Size" > Text Size< / a > to scale the < a href = "#SkPaint_getTextWidths_widths" > widths< / a > and < a href = "#SkPaint_getTextWidths_bounds" > bounds< / a > .
Does not scale the advance by < a href = "#Fake_Bold" > Fake Bold< / a > or < a href = "undocumented#Path_Effect" > Path Effect< / a > .
Does include < a href = "#Fake_Bold" > Fake Bold< / a > and < a href = "undocumented#Path_Effect" > Path Effect< / a > in the < a href = "#SkPaint_getTextWidths_bounds" > bounds< / a > .
2017-07-28 19:18:29 +00:00
### Parameters
2017-08-25 15:51:49 +00:00
< table > < tr > < td > < a name = "SkPaint_getTextWidths_text" > < code > < strong > text < / strong > < / code > < / a > < / td > < td >
2017-07-28 19:18:29 +00:00
character codes or glyph indices to be measured< / td >
2017-08-25 15:51:49 +00:00
< / tr > < tr > < td > < a name = "SkPaint_getTextWidths_byteLength" > < code > < strong > byteLength < / strong > < / code > < / a > < / td > < td >
number of bytes of < a href = "#SkPaint_getTextWidths_text" > text< / a > to measure< / td >
< / tr > < tr > < td > < a name = "SkPaint_getTextWidths_widths" > < code > < strong > widths < / strong > < / code > < / a > < / td > < td >
returns < a href = "#SkPaint_getTextWidths_text" > text< / a > advances for each glyph; may be nullptr< / td >
< / tr > < tr > < td > < a name = "SkPaint_getTextWidths_bounds" > < code > < strong > bounds < / strong > < / code > < / a > < / td > < td >
returns < a href = "#SkPaint_getTextWidths_bounds" > bounds< / a > for each glyph relative to (0, 0); may be nullptr< / td >
2017-07-28 19:18:29 +00:00
< / tr >
< / table >
### Return Value
2017-08-25 15:51:49 +00:00
glyph count in < a href = "#SkPaint_getTextWidths_text" > text< / a >
2017-07-28 19:18:29 +00:00
### Example
2017-09-01 19:51:02 +00:00
< div > < fiddle-embed name = "6b9e101f49e9c2c28755c5bdcef64dfb" > < div > Bounds of < a href = "#Glyph" > Glyphs< / a > increase for stroked < a href = "#SkPaint_getTextWidths_text" > text< / a > , but < a href = "#SkPaint_getTextWidths_text" > text< / a > advance remains the same.
2017-08-25 15:51:49 +00:00
The underlines show the < a href = "#SkPaint_getTextWidths_text" > text< / a > advance, spaced to keep them distinct.< / div > < / fiddle-embed > < / div >
2017-07-28 19:18:29 +00:00
---
# <a name="Text_Path"></a> Text Path
2017-09-01 19:51:02 +00:00
< a href = "#Text_Path" > Text Path< / a > describes the geometry of < a href = "#Glyph" > Glyphs< / a > used to draw text.
2017-07-28 19:18:29 +00:00
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_getTextPath" > < / a >
2017-07-28 19:18:29 +00:00
## getTextPath
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
void getTextPath(const void* text, size_t length, SkScalar x, SkScalar y, SkPath* path) const
2017-07-28 19:18:29 +00:00
< / pre >
2017-08-25 15:51:49 +00:00
Returns the geometry as < a href = "SkPath_Reference#Path" > Path< / a > equivalent to the drawn < a href = "#SkPaint_getTextPath_text" > text< / a > .
Uses < a href = "#Text_Encoding" > Text Encoding< / a > to decode < a href = "#SkPaint_getTextPath_text" > text< / a > , < a href = "undocumented#Typeface" > Typeface< / a > to get the glyph paths,
and < a href = "#Text_Size" > Text Size< / a > , < a href = "#Fake_Bold" > Fake Bold< / a > , and < a href = "undocumented#Path_Effect" > Path Effect< / a > to scale and modify the glyph paths.
All of the glyph paths are stored in < a href = "#SkPaint_getTextPath_path" > path< / a > .
Uses < a href = "#SkPaint_getTextPath_x" > x< / a > , < a href = "#SkPaint_getTextPath_y" > y< / a > , and < a href = "#Text_Align" > Text Align< / a > to position < a href = "#SkPaint_getTextPath_path" > path< / a > .
2017-07-28 19:18:29 +00:00
### Parameters
2017-08-25 15:51:49 +00:00
< table > < tr > < td > < a name = "SkPaint_getTextPath_text" > < code > < strong > text < / strong > < / code > < / a > < / td > < td >
2017-07-28 19:18:29 +00:00
character codes or glyph indices< / td >
2017-08-25 15:51:49 +00:00
< / tr > < tr > < td > < a name = "SkPaint_getTextPath_length" > < code > < strong > length < / strong > < / code > < / a > < / td > < td >
number of bytes of < a href = "#SkPaint_getTextPath_text" > text< / a > < / td >
< / tr > < tr > < td > < a name = "SkPaint_getTextPath_x" > < code > < strong > x < / strong > < / code > < / a > < / td > < td >
2017-11-27 15:44:06 +00:00
< a href = "#SkPaint_getTextPath_x" > x< / a > -coordinate of the origin of the < a href = "#SkPaint_getTextPath_text" > text< / a > < / td >
2017-08-25 15:51:49 +00:00
< / tr > < tr > < td > < a name = "SkPaint_getTextPath_y" > < code > < strong > y < / strong > < / code > < / a > < / td > < td >
2017-11-27 15:44:06 +00:00
< a href = "#SkPaint_getTextPath_y" > y< / a > -coordinate of the origin of the < a href = "#SkPaint_getTextPath_text" > text< / a > < / td >
2017-08-25 15:51:49 +00:00
< / tr > < tr > < td > < a name = "SkPaint_getTextPath_path" > < code > < strong > path < / strong > < / code > < / a > < / td > < td >
2017-09-01 19:51:02 +00:00
geometry of the < a href = "#Glyph" > Glyphs< / a > < / td >
2017-07-28 19:18:29 +00:00
< / tr >
< / table >
### Example
2017-08-04 16:48:24 +00:00
< div > < fiddle-embed name = "7c9e6a399f898d68026c1f0865e6f73e" > < div > < a href = "undocumented#Text" > Text< / a > is added to < a href = "SkPath_Reference#Path" > Path< / a > , offset, and subtracted from < a href = "SkPath_Reference#Path" > Path< / a > , then added at
2017-07-28 19:18:29 +00:00
the offset location. The result is rendered with one draw call.< / div > < / fiddle-embed > < / div >
---
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_getPosTextPath" > < / a >
2017-07-28 19:18:29 +00:00
## getPosTextPath
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
void getPosTextPath(const void* text, size_t length, const SkPoint pos[], SkPath* path) const
2017-07-28 19:18:29 +00:00
< / pre >
2017-08-25 15:51:49 +00:00
Returns the geometry as < a href = "SkPath_Reference#Path" > Path< / a > equivalent to the drawn < a href = "#SkPaint_getPosTextPath_text" > text< / a > .
Uses < a href = "#Text_Encoding" > Text Encoding< / a > to decode < a href = "#SkPaint_getPosTextPath_text" > text< / a > , < a href = "undocumented#Typeface" > Typeface< / a > to get the glyph paths,
and < a href = "#Text_Size" > Text Size< / a > , < a href = "#Fake_Bold" > Fake Bold< / a > , and < a href = "undocumented#Path_Effect" > Path Effect< / a > to scale and modify the glyph paths.
All of the glyph paths are stored in < a href = "#SkPaint_getPosTextPath_path" > path< / a > .
Uses < a href = "#SkPaint_getPosTextPath_pos" > pos< / a > array and < a href = "#Text_Align" > Text Align< / a > to position < a href = "#SkPaint_getPosTextPath_path" > path< / a > .
< a href = "#SkPaint_getPosTextPath_pos" > pos< / a > contains a position for each glyph.
2017-07-28 19:18:29 +00:00
### Parameters
2017-08-25 15:51:49 +00:00
< table > < tr > < td > < a name = "SkPaint_getPosTextPath_text" > < code > < strong > text < / strong > < / code > < / a > < / td > < td >
2017-07-28 19:18:29 +00:00
character codes or glyph indices< / td >
2017-08-25 15:51:49 +00:00
< / tr > < tr > < td > < a name = "SkPaint_getPosTextPath_length" > < code > < strong > length < / strong > < / code > < / a > < / td > < td >
number of bytes of < a href = "#SkPaint_getPosTextPath_text" > text< / a > < / td >
< / tr > < tr > < td > < a name = "SkPaint_getPosTextPath_pos" > < code > < strong > pos < / strong > < / code > < / a > < / td > < td >
2017-07-28 19:18:29 +00:00
positions of each glyph< / td >
2017-08-25 15:51:49 +00:00
< / tr > < tr > < td > < a name = "SkPaint_getPosTextPath_path" > < code > < strong > path < / strong > < / code > < / a > < / td > < td >
2017-09-01 19:51:02 +00:00
geometry of the < a href = "#Glyph" > Glyphs< / a > < / td >
2017-07-28 19:18:29 +00:00
< / tr >
< / table >
### Example
2017-09-01 19:51:02 +00:00
< div > < fiddle-embed name = "7f27c93472aa99a7542fb3493076f072" > < div > Simplifies three < a href = "#Glyph" > Glyphs< / a > to eliminate overlaps, and strokes the result.< / div > < / fiddle-embed > < / div >
2017-07-28 19:18:29 +00:00
---
# <a name="Text_Intercepts"></a> Text Intercepts
2017-09-01 19:51:02 +00:00
< a href = "#Text_Intercepts" > Text Intercepts< / a > describe the intersection of drawn text < a href = "#Glyph" > Glyphs< / a > with a pair
2017-08-25 15:51:49 +00:00
of lines parallel to the text advance. < a href = "#Text_Intercepts" > Text Intercepts< / a > permits creating a
2018-01-04 21:11:51 +00:00
underline that skips Descenders.
2017-07-28 19:18:29 +00:00
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_getTextIntercepts" > < / a >
2017-07-28 19:18:29 +00:00
## getTextIntercepts
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-07-28 19:18:29 +00:00
int getTextIntercepts(const void* text, size_t length, SkScalar x, SkScalar y,
const SkScalar bounds[2], SkScalar* intervals) const
< / pre >
2017-08-25 15:51:49 +00:00
Returns the number of < a href = "#SkPaint_getTextIntercepts_intervals" > intervals< / a > that intersect < a href = "#SkPaint_getTextIntercepts_bounds" > bounds< / a > .
< a href = "#SkPaint_getTextIntercepts_bounds" > bounds< / a > describes a pair of lines parallel to the < a href = "#SkPaint_getTextIntercepts_text" > text< / a > advance.
2017-09-01 19:51:02 +00:00
The return count is zero or a multiple of two, and is at most twice the number of < a href = "#Glyph" > Glyphs< / a > in
2018-01-04 21:11:51 +00:00
the string.
2017-08-25 15:51:49 +00:00
Uses < a href = "#Text_Encoding" > Text Encoding< / a > to decode < a href = "#SkPaint_getTextIntercepts_text" > text< / a > , < a href = "undocumented#Typeface" > Typeface< / a > to get the glyph paths,
and < a href = "#Text_Size" > Text Size< / a > , < a href = "#Fake_Bold" > Fake Bold< / a > , and < a href = "undocumented#Path_Effect" > Path Effect< / a > to scale and modify the glyph paths.
Uses < a href = "#SkPaint_getTextIntercepts_x" > x< / a > , < a href = "#SkPaint_getTextIntercepts_y" > y< / a > , and < a href = "#Text_Align" > Text Align< / a > to position < a href = "#SkPaint_getTextIntercepts_intervals" > intervals< / a > .
Pass nullptr for < a href = "#SkPaint_getTextIntercepts_intervals" > intervals< / a > to determine the size of the interval array.
< a href = "#SkPaint_getTextIntercepts_intervals" > intervals< / a > are cached to improve performance for multiple calls.
2017-07-28 19:18:29 +00:00
### Parameters
2017-08-25 15:51:49 +00:00
< table > < tr > < td > < a name = "SkPaint_getTextIntercepts_text" > < code > < strong > text < / strong > < / code > < / a > < / td > < td >
2017-07-28 19:18:29 +00:00
character codes or glyph indices< / td >
2017-08-25 15:51:49 +00:00
< / tr > < tr > < td > < a name = "SkPaint_getTextIntercepts_length" > < code > < strong > length < / strong > < / code > < / a > < / td > < td >
number of bytes of < a href = "#SkPaint_getTextIntercepts_text" > text< / a > < / td >
< / tr > < tr > < td > < a name = "SkPaint_getTextIntercepts_x" > < code > < strong > x < / strong > < / code > < / a > < / td > < td >
2017-11-27 15:44:06 +00:00
< a href = "#SkPaint_getTextIntercepts_x" > x< / a > -coordinate of the origin of the < a href = "#SkPaint_getTextIntercepts_text" > text< / a > < / td >
2017-08-25 15:51:49 +00:00
< / tr > < tr > < td > < a name = "SkPaint_getTextIntercepts_y" > < code > < strong > y < / strong > < / code > < / a > < / td > < td >
2017-11-27 15:44:06 +00:00
< a href = "#SkPaint_getTextIntercepts_y" > y< / a > -coordinate of the origin of the < a href = "#SkPaint_getTextIntercepts_text" > text< / a > < / td >
2017-08-25 15:51:49 +00:00
< / tr > < tr > < td > < a name = "SkPaint_getTextIntercepts_bounds" > < code > < strong > bounds < / strong > < / code > < / a > < / td > < td >
2017-07-28 19:18:29 +00:00
lower and upper line parallel to the advance< / td >
2017-08-25 15:51:49 +00:00
< / tr > < tr > < td > < a name = "SkPaint_getTextIntercepts_intervals" > < code > < strong > intervals < / strong > < / code > < / a > < / td > < td >
2017-07-28 19:18:29 +00:00
returned intersections; may be nullptr< / td >
< / tr >
< / table >
### Return Value
number of intersections; may be zero
### Example
2017-09-01 19:51:02 +00:00
< div > < fiddle-embed name = "2a0b80ed20d193c688085b79deb5bdc9" > < div > Underline uses intercepts to draw on either side of the glyph Descender.< / div > < / fiddle-embed > < / div >
2017-07-28 19:18:29 +00:00
---
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_getPosTextIntercepts" > < / a >
2017-07-28 19:18:29 +00:00
## getPosTextIntercepts
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-07-28 19:18:29 +00:00
int getPosTextIntercepts(const void* text, size_t length, const SkPoint pos[],
const SkScalar bounds[2], SkScalar* intervals) const
< / pre >
2017-08-25 15:51:49 +00:00
Returns the number of < a href = "#SkPaint_getPosTextIntercepts_intervals" > intervals< / a > that intersect < a href = "#SkPaint_getPosTextIntercepts_bounds" > bounds< / a > .
< a href = "#SkPaint_getPosTextIntercepts_bounds" > bounds< / a > describes a pair of lines parallel to the < a href = "#SkPaint_getPosTextIntercepts_text" > text< / a > advance.
2017-09-01 19:51:02 +00:00
The return count is zero or a multiple of two, and is at most twice the number of < a href = "#Glyph" > Glyphs< / a > in
2018-01-04 21:11:51 +00:00
the string.
2017-08-25 15:51:49 +00:00
Uses < a href = "#Text_Encoding" > Text Encoding< / a > to decode < a href = "#SkPaint_getPosTextIntercepts_text" > text< / a > , < a href = "undocumented#Typeface" > Typeface< / a > to get the glyph paths,
and < a href = "#Text_Size" > Text Size< / a > , < a href = "#Fake_Bold" > Fake Bold< / a > , and < a href = "undocumented#Path_Effect" > Path Effect< / a > to scale and modify the glyph paths.
Uses < a href = "#SkPaint_getPosTextIntercepts_pos" > pos< / a > array and < a href = "#Text_Align" > Text Align< / a > to position < a href = "#SkPaint_getPosTextIntercepts_intervals" > intervals< / a > .
Pass nullptr for < a href = "#SkPaint_getPosTextIntercepts_intervals" > intervals< / a > to determine the size of the interval array.
< a href = "#SkPaint_getPosTextIntercepts_intervals" > intervals< / a > are cached to improve performance for multiple calls.
2017-07-28 19:18:29 +00:00
### Parameters
2017-08-25 15:51:49 +00:00
< table > < tr > < td > < a name = "SkPaint_getPosTextIntercepts_text" > < code > < strong > text < / strong > < / code > < / a > < / td > < td >
2017-07-28 19:18:29 +00:00
character codes or glyph indices< / td >
2017-08-25 15:51:49 +00:00
< / tr > < tr > < td > < a name = "SkPaint_getPosTextIntercepts_length" > < code > < strong > length < / strong > < / code > < / a > < / td > < td >
number of bytes of < a href = "#SkPaint_getPosTextIntercepts_text" > text< / a > < / td >
< / tr > < tr > < td > < a name = "SkPaint_getPosTextIntercepts_pos" > < code > < strong > pos < / strong > < / code > < / a > < / td > < td >
2017-07-28 19:18:29 +00:00
positions of each glyph< / td >
2017-08-25 15:51:49 +00:00
< / tr > < tr > < td > < a name = "SkPaint_getPosTextIntercepts_bounds" > < code > < strong > bounds < / strong > < / code > < / a > < / td > < td >
2017-07-28 19:18:29 +00:00
lower and upper line parallel to the advance< / td >
2017-08-25 15:51:49 +00:00
< / tr > < tr > < td > < a name = "SkPaint_getPosTextIntercepts_intervals" > < code > < strong > intervals < / strong > < / code > < / a > < / td > < td >
2017-07-28 19:18:29 +00:00
returned intersections; may be nullptr< / td >
< / tr >
< / table >
### Return Value
2017-08-30 12:58:10 +00:00
number of intersections; may be zero
2017-07-28 19:18:29 +00:00
### Example
2017-09-01 19:51:02 +00:00
< div > < fiddle-embed name = "98b2dfc552d0540a7c041fe7a2839bd7" > < div > < a href = "undocumented#Text" > Text< / a > intercepts draw on either side of, but not inside, < a href = "#Glyph" > Glyphs< / a > in a run.< / div > < / fiddle-embed > < / div >
2017-07-28 19:18:29 +00:00
---
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_getPosTextHIntercepts" > < / a >
2017-07-28 19:18:29 +00:00
## getPosTextHIntercepts
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
int getPosTextHIntercepts(const void* text, size_t length, const SkScalar xpos[], SkScalar constY,
const SkScalar bounds[2], SkScalar* intervals) const
2017-07-28 19:18:29 +00:00
< / pre >
2017-08-25 15:51:49 +00:00
Returns the number of < a href = "#SkPaint_getPosTextHIntercepts_intervals" > intervals< / a > that intersect < a href = "#SkPaint_getPosTextHIntercepts_bounds" > bounds< / a > .
< a href = "#SkPaint_getPosTextHIntercepts_bounds" > bounds< / a > describes a pair of lines parallel to the < a href = "#SkPaint_getPosTextHIntercepts_text" > text< / a > advance.
2017-09-01 19:51:02 +00:00
The return count is zero or a multiple of two, and is at most twice the number of < a href = "#Glyph" > Glyphs< / a > in
2018-01-04 21:11:51 +00:00
the string.
2017-08-25 15:51:49 +00:00
Uses < a href = "#Text_Encoding" > Text Encoding< / a > to decode < a href = "#SkPaint_getPosTextHIntercepts_text" > text< / a > , < a href = "undocumented#Typeface" > Typeface< / a > to get the glyph paths,
and < a href = "#Text_Size" > Text Size< / a > , < a href = "#Fake_Bold" > Fake Bold< / a > , and < a href = "undocumented#Path_Effect" > Path Effect< / a > to scale and modify the glyph paths.
Uses < a href = "#SkPaint_getPosTextHIntercepts_xpos" > xpos< / a > array, < a href = "#SkPaint_getPosTextHIntercepts_constY" > constY< / a > , and < a href = "#Text_Align" > Text Align< / a > to position < a href = "#SkPaint_getPosTextHIntercepts_intervals" > intervals< / a > .
Pass nullptr for < a href = "#SkPaint_getPosTextHIntercepts_intervals" > intervals< / a > to determine the size of the interval array.
< a href = "#SkPaint_getPosTextHIntercepts_intervals" > intervals< / a > are cached to improve performance for multiple calls.
2017-07-28 19:18:29 +00:00
### Parameters
2017-08-25 15:51:49 +00:00
< table > < tr > < td > < a name = "SkPaint_getPosTextHIntercepts_text" > < code > < strong > text < / strong > < / code > < / a > < / td > < td >
2017-07-28 19:18:29 +00:00
character codes or glyph indices< / td >
2017-08-25 15:51:49 +00:00
< / tr > < tr > < td > < a name = "SkPaint_getPosTextHIntercepts_length" > < code > < strong > length < / strong > < / code > < / a > < / td > < td >
number of bytes of < a href = "#SkPaint_getPosTextHIntercepts_text" > text< / a > < / td >
< / tr > < tr > < td > < a name = "SkPaint_getPosTextHIntercepts_xpos" > < code > < strong > xpos < / strong > < / code > < / a > < / td > < td >
2017-07-28 19:18:29 +00:00
positions of each glyph in x< / td >
2017-08-25 15:51:49 +00:00
< / tr > < tr > < td > < a name = "SkPaint_getPosTextHIntercepts_constY" > < code > < strong > constY < / strong > < / code > < / a > < / td > < td >
2017-07-28 19:18:29 +00:00
position of each glyph in y< / td >
2017-08-25 15:51:49 +00:00
< / tr > < tr > < td > < a name = "SkPaint_getPosTextHIntercepts_bounds" > < code > < strong > bounds < / strong > < / code > < / a > < / td > < td >
2017-07-28 19:18:29 +00:00
lower and upper line parallel to the advance< / td >
2017-08-25 15:51:49 +00:00
< / tr > < tr > < td > < a name = "SkPaint_getPosTextHIntercepts_intervals" > < code > < strong > intervals < / strong > < / code > < / a > < / td > < td >
2017-07-28 19:18:29 +00:00
returned intersections; may be nullptr< / td >
< / tr >
< / table >
### Return Value
number of intersections; may be zero
### Example
2017-08-04 16:48:24 +00:00
< div > < fiddle-embed name = "dc9851c43acc3716aca8c9a4d40d452d" > < div > < a href = "undocumented#Text" > Text< / a > intercepts do not take stroke thickness into consideration.< / div > < / fiddle-embed > < / div >
2017-07-28 19:18:29 +00:00
---
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_getTextBlobIntercepts" > < / a >
2017-07-28 19:18:29 +00:00
## getTextBlobIntercepts
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
int getTextBlobIntercepts(const SkTextBlob* blob, const SkScalar bounds[2], SkScalar* intervals) const
2017-07-28 19:18:29 +00:00
< / pre >
2017-08-25 15:51:49 +00:00
Returns the number of < a href = "#SkPaint_getTextBlobIntercepts_intervals" > intervals< / a > that intersect < a href = "#SkPaint_getTextBlobIntercepts_bounds" > bounds< / a > .
< a href = "#SkPaint_getTextBlobIntercepts_bounds" > bounds< / a > describes a pair of lines parallel to the text advance.
2017-09-01 19:51:02 +00:00
The return count is zero or a multiple of two, and is at most twice the number of < a href = "#Glyph" > Glyphs< / a > in
2018-01-04 21:11:51 +00:00
the string.
2017-12-01 16:49:58 +00:00
Uses < a href = "undocumented#Typeface" > Typeface< / a > to get the glyph paths,
2017-08-25 15:51:49 +00:00
and < a href = "#Text_Size" > Text Size< / a > , < a href = "#Fake_Bold" > Fake Bold< / a > , and < a href = "undocumented#Path_Effect" > Path Effect< / a > to scale and modify the glyph paths.
2017-09-01 19:51:02 +00:00
Uses run array and < a href = "#Text_Align" > Text Align< / a > to position < a href = "#SkPaint_getTextBlobIntercepts_intervals" > intervals< / a > .
2017-12-01 16:49:58 +00:00
< a href = "#Text_Encoding" > Text Encoding< / a > must be set to < a href = "#SkPaint_kGlyphID_TextEncoding" > SkPaint::kGlyphID TextEncoding< / a > .
2017-08-25 15:51:49 +00:00
Pass nullptr for < a href = "#SkPaint_getTextBlobIntercepts_intervals" > intervals< / a > to determine the size of the interval array.
< a href = "#SkPaint_getTextBlobIntercepts_intervals" > intervals< / a > are cached to improve performance for multiple calls.
2017-07-28 19:18:29 +00:00
### Parameters
2017-08-25 15:51:49 +00:00
< table > < tr > < td > < a name = "SkPaint_getTextBlobIntercepts_blob" > < code > < strong > blob < / strong > < / code > < / a > < / td > < td >
2017-09-01 19:51:02 +00:00
< a href = "#Glyph" > Glyphs< / a > , positions, and text paint attributes< / td >
2017-08-25 15:51:49 +00:00
< / tr > < tr > < td > < a name = "SkPaint_getTextBlobIntercepts_bounds" > < code > < strong > bounds < / strong > < / code > < / a > < / td > < td >
2017-07-28 19:18:29 +00:00
lower and upper line parallel to the advance< / td >
2017-08-25 15:51:49 +00:00
< / tr > < tr > < td > < a name = "SkPaint_getTextBlobIntercepts_intervals" > < code > < strong > intervals < / strong > < / code > < / a > < / td > < td >
2017-07-28 19:18:29 +00:00
returned intersections; may be nullptr< / td >
< / tr >
< / table >
### Return Value
number of intersections; may be zero
### Example
2017-12-01 16:49:58 +00:00
< div > < fiddle-embed name = "71959a66b2290d70003887c0de339266" > < / fiddle-embed > < / div >
2017-07-28 19:18:29 +00:00
---
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_nothingToDraw" > < / a >
2017-07-28 19:18:29 +00:00
## nothingToDraw
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-07-28 19:18:29 +00:00
bool nothingToDraw() const
< / pre >
2017-08-25 15:51:49 +00:00
Returns true if < a href = "#Paint" > Paint< / a > prevents all drawing;
otherwise, the < a href = "#Paint" > Paint< / a > may or may not allow drawing.
2017-07-28 19:18:29 +00:00
2017-09-01 19:51:02 +00:00
Returns true if, for example, < a href = "undocumented#Blend_Mode" > Blend Mode< / a > combined with < a href = "#Alpha" > Color Alpha< / a > computes a
new < a href = "#Alpha" > Alpha< / a > of zero.
2017-07-28 19:18:29 +00:00
### Return Value
2017-08-25 15:51:49 +00:00
true if < a href = "#Paint" > Paint< / a > prevents all drawing
2017-07-28 19:18:29 +00:00
### Example
< div > < fiddle-embed name = "fc5a771b915ac341f56554f01d282831" >
#### Example Output
~~~~
initial nothing to draw: false
blend dst nothing to draw: true
blend src over nothing to draw: false
alpha 0 nothing to draw: true
~~~~
< / fiddle-embed > < / div >
---
# <a name="Fast_Bounds"></a> Fast Bounds
2017-08-25 15:51:49 +00:00
< a href = "#Fast_Bounds" > Fast Bounds< / a > methods conservatively outset a drawing bounds by additional area
< a href = "#Paint" > Paint< / a > may draw to.
2017-07-28 19:18:29 +00:00
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_canComputeFastBounds" > < / a >
2017-07-28 19:18:29 +00:00
## canComputeFastBounds
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-07-28 19:18:29 +00:00
bool canComputeFastBounds() const
< / pre >
2017-08-25 15:51:49 +00:00
Returns true if < a href = "#Paint" > Paint< / a > does not include elements requiring extensive computation
to compute < a href = "undocumented#Device" > Device< / a > bounds of drawn geometry. For instance, < a href = "#Paint" > Paint< / a > with < a href = "undocumented#Path_Effect" > Path Effect< / a >
2017-07-28 19:18:29 +00:00
always returns false.
### Return Value
2017-08-25 15:51:49 +00:00
true if < a href = "#Paint" > Paint< / a > allows for fast computation of bounds
2017-07-28 19:18:29 +00:00
---
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_computeFastBounds" > < / a >
2017-07-28 19:18:29 +00:00
## computeFastBounds
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-07-28 19:18:29 +00:00
const SkRect& computeFastBounds(const SkRect& orig, SkRect* storage) const
< / pre >
2017-08-25 15:51:49 +00:00
Only call this if < a href = "#SkPaint_canComputeFastBounds" > canComputeFastBounds< / a > returned true. This takes a
2017-07-28 19:18:29 +00:00
raw rectangle (the raw bounds of a shape), and adjusts it for stylistic
2017-08-25 15:51:49 +00:00
effects in the paint (e.g. stroking). If needed, it uses the < a href = "#SkPaint_computeFastBounds_storage" > storage< / a >
2017-09-01 19:51:02 +00:00
parameter. It returns the adjusted bounds that can then be used
2017-08-25 15:51:49 +00:00
for < a href = "#SkCanvas_quickReject" > SkCanvas::quickReject< / a > tests.
2017-07-28 19:18:29 +00:00
2017-10-04 18:31:33 +00:00
The returned < a href = "SkRect_Reference#Rect" > Rect< / a > will either be < a href = "#SkPaint_computeFastBounds_orig" > orig< / a > or < a href = "#SkPaint_computeFastBounds_storage" > storage< / a > , thus the caller
2017-08-25 15:51:49 +00:00
should not rely on < a href = "#SkPaint_computeFastBounds_storage" > storage< / a > being set to the result, but should always
2017-09-01 19:51:02 +00:00
use the returned value. It is legal for < a href = "#SkPaint_computeFastBounds_orig" > orig< / a > and < a href = "#SkPaint_computeFastBounds_storage" > storage< / a > to be the same
2017-10-04 18:31:33 +00:00
< a href = "SkRect_Reference#Rect" > Rect< / a > .
2017-07-28 19:18:29 +00:00
### Parameters
2017-08-25 15:51:49 +00:00
< table > < tr > < td > < a name = "SkPaint_computeFastBounds_orig" > < code > < strong > orig < / strong > < / code > < / a > < / td > < td >
geometry modified by < a href = "#Paint" > Paint< / a > when drawn< / td >
< / tr > < tr > < td > < a name = "SkPaint_computeFastBounds_storage" > < code > < strong > storage < / strong > < / code > < / a > < / td > < td >
2017-07-28 19:18:29 +00:00
computed bounds of geometry; may not be nullptr< / td >
< / tr >
< / table >
### Return Value
fast computed bounds
---
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_computeFastStrokeBounds" > < / a >
2017-07-28 19:18:29 +00:00
## computeFastStrokeBounds
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-07-28 19:18:29 +00:00
const SkRect& computeFastStrokeBounds(const SkRect& orig, SkRect* storage) const
< / pre >
### Parameters
2017-08-25 15:51:49 +00:00
< table > < tr > < td > < a name = "SkPaint_computeFastStrokeBounds_orig" > < code > < strong > orig < / strong > < / code > < / a > < / td > < td >
geometry modified by < a href = "#Paint" > Paint< / a > when drawn< / td >
< / tr > < tr > < td > < a name = "SkPaint_computeFastStrokeBounds_storage" > < code > < strong > storage < / strong > < / code > < / a > < / td > < td >
2017-07-28 19:18:29 +00:00
computed bounds of geometry< / td >
< / tr >
< / table >
### Return Value
fast computed bounds
---
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_doComputeFastBounds" > < / a >
2017-07-28 19:18:29 +00:00
## doComputeFastBounds
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
const SkRect& doComputeFastBounds(const SkRect& orig, SkRect* storage, Style style) const
2017-07-28 19:18:29 +00:00
< / pre >
2017-09-01 19:51:02 +00:00
Computes the bounds, overriding the < a href = "#Paint" > Paint< / a > < a href = "#SkPaint_Style" > Style< / a > . This can be used to
account for additional width required by stroking < a href = "#SkPaint_doComputeFastBounds_orig" > orig< / a > , without
altering < a href = "#SkPaint_Style" > Style< / a > set to fill.
2017-07-28 19:18:29 +00:00
### Parameters
2017-08-25 15:51:49 +00:00
< table > < tr > < td > < a name = "SkPaint_doComputeFastBounds_orig" > < code > < strong > orig < / strong > < / code > < / a > < / td > < td >
geometry modified by < a href = "#Paint" > Paint< / a > when drawn< / td >
< / tr > < tr > < td > < a name = "SkPaint_doComputeFastBounds_storage" > < code > < strong > storage < / strong > < / code > < / a > < / td > < td >
2017-07-28 19:18:29 +00:00
computed bounds of geometry< / td >
2017-08-25 15:51:49 +00:00
< / tr > < tr > < td > < a name = "SkPaint_doComputeFastBounds_style" > < code > < strong > style < / strong > < / code > < / a > < / td > < td >
overrides < a href = "#SkPaint_Style" > Style< / a > < / td >
2017-07-28 19:18:29 +00:00
< / tr >
< / table >
### Return Value
fast computed bounds
---
2017-08-25 17:14:33 +00:00
< a name = "SkPaint_toString" > < / a >
2017-07-28 19:18:29 +00:00
## toString
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2017-07-28 19:18:29 +00:00
void toString(SkString* str) const;
< / pre >
2017-09-01 19:51:02 +00:00
Creates string representation of < a href = "#Paint" > Paint< / a > . The representation is read by
internal debugging tools. The interface and implementation may be
2018-01-04 21:11:51 +00:00
suppressed by defining SK_IGNORE_TO_STRING.
2017-07-28 19:18:29 +00:00
### Parameters
2017-08-25 15:51:49 +00:00
< table > < tr > < td > < a name = "SkPaint_toString_str" > < code > < strong > str < / strong > < / code > < / a > < / td > < td >
2017-09-01 19:51:02 +00:00
storage for string representation of < a href = "#Paint" > Paint< / a > < / td >
2017-07-28 19:18:29 +00:00
< / tr >
< / table >
### Example
< div > < fiddle-embed name = "5670c04b4562908169a776c48c92d104" >
#### Example Output
~~~~
text size = 12
~~~~
< / fiddle-embed > < / div >
2017-11-02 21:49:34 +00:00
### See Also
< a href = "#SkPathEffect_toString" > SkPathEffect::toString< / a > < a href = "#SkMaskFilter_toString" > SkMaskFilter::toString< / a > < a href = "#SkColorFilter_toString" > SkColorFilter::toString< / a > < a href = "#SkImageFilter_toString" > SkImageFilter::toString< / a >
2017-07-28 19:18:29 +00:00
---
