Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1 | SkPaint Reference |
| 2 | === |
| 3 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 4 | |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 5 | <a name='SkPaint'></a> |
Cary Clark | e4aa371 | 2017-09-15 02:56:12 -0400 | [diff] [blame] | 6 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 7 | --- |
| 8 | |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 9 | <pre style="padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0"> |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 10 | class <a href='SkPaint_Reference#SkPaint'>SkPaint</a> { |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 11 | |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 12 | <a href='#SkPaint_empty_constructor'>SkPaint()</a>; |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 13 | <a href='#SkPaint_copy_const_SkPaint'>SkPaint</a>(const <a href='SkPaint_Reference#SkPaint'>SkPaint</a>& <a href='SkPaint_Reference#Paint'>paint</a>); |
| 14 | <a href='#SkPaint_move_SkPaint'>SkPaint</a>(<a href='SkPaint_Reference#SkPaint'>SkPaint</a>&& <a href='SkPaint_Reference#Paint'>paint</a>); |
| 15 | <a href='#SkPaint_destructor'>~SkPaint()</a>; |
| 16 | <a href='SkPaint_Reference#SkPaint'>SkPaint</a>& <a href='#SkPaint_copy_operator'>operator=</a>(const <a href='SkPaint_Reference#SkPaint'>SkPaint</a>& <a href='SkPaint_Reference#Paint'>paint</a>); |
| 17 | <a href='SkPaint_Reference#SkPaint'>SkPaint</a>& <a href='#SkPaint_move_operator'>operator=</a>(<a href='SkPaint_Reference#SkPaint'>SkPaint</a>&& <a href='SkPaint_Reference#Paint'>paint</a>); |
| 18 | friend bool <a href='#SkPaint_equal_operator'>operator==</a>(const <a href='SkPaint_Reference#SkPaint'>SkPaint</a>& a, const <a href='SkPaint_Reference#SkPaint'>SkPaint</a>& b); |
| 19 | friend bool <a href='#SkPaint_notequal_operator'>operator!=</a>(const <a href='SkPaint_Reference#SkPaint'>SkPaint</a>& a, const <a href='SkPaint_Reference#SkPaint'>SkPaint</a>& b); |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 20 | uint32_t <a href='#SkPaint_getHash'>getHash</a>() const; |
| 21 | void <a href='#SkPaint_reset'>reset()</a>; |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 22 | void <a href='#SkPaint_setHinting'>setHinting</a>(<a href='undocumented#SkFontHinting'>SkFontHinting</a> hintingLevel); |
Cary Clark | 8cc4cdc | 2018-11-09 23:16:58 -0500 | [diff] [blame] | 23 | <a href='undocumented#SkFontHinting'>SkFontHinting</a> <a href='#SkPaint_getHinting'>getHinting</a>() const; |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 24 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 25 | enum <a href='#SkPaint_Flags'>Flags</a> { |
| 26 | <a href='#SkPaint_kAntiAlias_Flag'>kAntiAlias_Flag</a> = 0x01, |
| 27 | <a href='#SkPaint_kDither_Flag'>kDither_Flag</a> = 0x04, |
| 28 | <a href='#SkPaint_kFakeBoldText_Flag'>kFakeBoldText_Flag</a> = 0x20, |
| 29 | <a href='#SkPaint_kLinearText_Flag'>kLinearText_Flag</a> = 0x40, |
| 30 | <a href='#SkPaint_kSubpixelText_Flag'>kSubpixelText_Flag</a> = 0x80, |
| 31 | <a href='#SkPaint_kLCDRenderText_Flag'>kLCDRenderText_Flag</a> = 0x200, |
| 32 | <a href='#SkPaint_kEmbeddedBitmapText_Flag'>kEmbeddedBitmapText_Flag</a> = 0x400, |
| 33 | <a href='#SkPaint_kAutoHinting_Flag'>kAutoHinting_Flag</a> = 0x800, |
| 34 | <a href='#SkPaint_kAllFlags'>kAllFlags</a> = 0xFFFF, |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 35 | }; |
| 36 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 37 | uint32_t <a href='#SkPaint_getFlags'>getFlags</a>() const; |
| 38 | void <a href='#SkPaint_setFlags'>setFlags</a>(uint32_t flags); |
| 39 | bool <a href='#SkPaint_isAntiAlias'>isAntiAlias</a>() const; |
| 40 | void <a href='#SkPaint_setAntiAlias'>setAntiAlias</a>(bool aa); |
| 41 | bool <a href='#SkPaint_isDither'>isDither</a>() const; |
| 42 | void <a href='#SkPaint_setDither'>setDither</a>(bool dither); |
| 43 | bool <a href='#SkPaint_isLinearText'>isLinearText</a>() const; |
| 44 | void <a href='#SkPaint_setLinearText'>setLinearText</a>(bool linearText); |
| 45 | bool <a href='#SkPaint_isSubpixelText'>isSubpixelText</a>() const; |
| 46 | void <a href='#SkPaint_setSubpixelText'>setSubpixelText</a>(bool subpixelText); |
| 47 | bool <a href='#SkPaint_isLCDRenderText'>isLCDRenderText</a>() const; |
| 48 | void <a href='#SkPaint_setLCDRenderText'>setLCDRenderText</a>(bool lcdText); |
| 49 | bool <a href='#SkPaint_isEmbeddedBitmapText'>isEmbeddedBitmapText</a>() const; |
| 50 | void <a href='#SkPaint_setEmbeddedBitmapText'>setEmbeddedBitmapText</a>(bool useEmbeddedBitmapText); |
| 51 | bool <a href='#SkPaint_isAutohinted'>isAutohinted</a>() const; |
| 52 | void <a href='#SkPaint_setAutohinted'>setAutohinted</a>(bool useAutohinter); |
| 53 | bool <a href='#SkPaint_isFakeBoldText'>isFakeBoldText</a>() const; |
| 54 | void <a href='#SkPaint_setFakeBoldText'>setFakeBoldText</a>(bool fakeBoldText); |
| 55 | <a href='undocumented#SkFilterQuality'>SkFilterQuality</a> <a href='#SkPaint_getFilterQuality'>getFilterQuality</a>() const; |
| 56 | void <a href='#SkPaint_setFilterQuality'>setFilterQuality</a>(<a href='undocumented#SkFilterQuality'>SkFilterQuality</a> quality); |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 57 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 58 | enum <a href='#SkPaint_Style'>Style</a> : uint8_t { |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 59 | <a href='#SkPaint_kFill_Style'>kFill_Style</a>, |
| 60 | <a href='#SkPaint_kStroke_Style'>kStroke_Style</a>, |
| 61 | <a href='#SkPaint_kStrokeAndFill_Style'>kStrokeAndFill_Style</a>, |
| 62 | }; |
| 63 | |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 64 | static constexpr int <a href='#SkPaint_kStyleCount'>kStyleCount</a> = <a href='#SkPaint_kStrokeAndFill_Style'>kStrokeAndFill_Style</a> + 1 |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 65 | <a href='#SkPaint_Style'>Style</a> <a href='#SkPaint_getStyle'>getStyle</a>() const; |
| 66 | void <a href='#SkPaint_setStyle'>setStyle</a>(<a href='#SkPaint_Style'>Style</a> style); |
| 67 | <a href='SkColor_Reference#SkColor'>SkColor</a> <a href='#SkPaint_getColor'>getColor</a>() const; |
| 68 | <a href='SkColor4f_Reference#SkColor4f'>SkColor4f</a> <a href='#SkPaint_getColor4f'>getColor4f</a>() const; |
| 69 | void <a href='#SkPaint_setColor'>setColor</a>(<a href='SkColor_Reference#SkColor'>SkColor</a> <a href='SkColor_Reference#Color'>color</a>); |
| 70 | void <a href='#SkPaint_setColor4f'>setColor4f</a>(const <a href='SkColor4f_Reference#SkColor4f'>SkColor4f</a>& <a href='SkColor_Reference#Color'>color</a>, <a href='undocumented#SkColorSpace'>SkColorSpace</a>* colorSpace); |
| 71 | uint8_t <a href='#SkPaint_getAlpha'>getAlpha</a>() const; |
| 72 | void <a href='#SkPaint_setAlpha'>setAlpha</a>(<a href='undocumented#U8CPU'>U8CPU</a> a); |
| 73 | void <a href='#SkPaint_setARGB'>setARGB</a>(<a href='undocumented#U8CPU'>U8CPU</a> a, <a href='undocumented#U8CPU'>U8CPU</a> r, <a href='undocumented#U8CPU'>U8CPU</a> g, <a href='undocumented#U8CPU'>U8CPU</a> b); |
| 74 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_getStrokeWidth'>getStrokeWidth</a>() const; |
| 75 | void <a href='#SkPaint_setStrokeWidth'>setStrokeWidth</a>(<a href='undocumented#SkScalar'>SkScalar</a> width); |
| 76 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_getStrokeMiter'>getStrokeMiter</a>() const; |
| 77 | void <a href='#SkPaint_setStrokeMiter'>setStrokeMiter</a>(<a href='undocumented#SkScalar'>SkScalar</a> miter); |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 78 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 79 | enum <a href='#SkPaint_Cap'>Cap</a> { |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 80 | <a href='#SkPaint_kButt_Cap'>kButt_Cap</a>, |
| 81 | <a href='#SkPaint_kRound_Cap'>kRound_Cap</a>, |
| 82 | <a href='#SkPaint_kSquare_Cap'>kSquare_Cap</a>, |
| 83 | <a href='#SkPaint_kLast_Cap'>kLast_Cap</a> = <a href='#SkPaint_kSquare_Cap'>kSquare_Cap</a>, |
| 84 | <a href='#SkPaint_kDefault_Cap'>kDefault_Cap</a> = <a href='#SkPaint_kButt_Cap'>kButt_Cap</a>, |
| 85 | }; |
| 86 | |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 87 | static constexpr int <a href='#SkPaint_kCapCount'>kCapCount</a> = <a href='#SkPaint_kLast_Cap'>kLast_Cap</a> + 1 |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 88 | enum <a href='#SkPaint_Join'>Join</a> : uint8_t { |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 89 | <a href='#SkPaint_kMiter_Join'>kMiter_Join</a>, |
| 90 | <a href='#SkPaint_kRound_Join'>kRound_Join</a>, |
| 91 | <a href='#SkPaint_kBevel_Join'>kBevel_Join</a>, |
| 92 | <a href='#SkPaint_kLast_Join'>kLast_Join</a> = <a href='#SkPaint_kBevel_Join'>kBevel_Join</a>, |
| 93 | <a href='#SkPaint_kDefault_Join'>kDefault_Join</a> = <a href='#SkPaint_kMiter_Join'>kMiter_Join</a>, |
| 94 | }; |
| 95 | |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 96 | static constexpr int <a href='#SkPaint_kJoinCount'>kJoinCount</a> = <a href='#SkPaint_kLast_Join'>kLast_Join</a> + 1 |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 97 | <a href='#SkPaint_Cap'>Cap</a> <a href='#SkPaint_getStrokeCap'>getStrokeCap</a>() const; |
| 98 | void <a href='#SkPaint_setStrokeCap'>setStrokeCap</a>(<a href='#SkPaint_Cap'>Cap</a> cap); |
| 99 | <a href='#SkPaint_Join'>Join</a> <a href='#SkPaint_getStrokeJoin'>getStrokeJoin</a>() const; |
| 100 | void <a href='#SkPaint_setStrokeJoin'>setStrokeJoin</a>(<a href='#SkPaint_Join'>Join</a> join); |
| 101 | bool <a href='#SkPaint_getFillPath'>getFillPath</a>(const <a href='SkPath_Reference#SkPath'>SkPath</a>& src, <a href='SkPath_Reference#SkPath'>SkPath</a>* dst, const <a href='SkRect_Reference#SkRect'>SkRect</a>* cullRect, |
| 102 | <a href='undocumented#SkScalar'>SkScalar</a> resScale = 1) const; |
| 103 | bool <a href='#SkPaint_getFillPath'>getFillPath</a>(const <a href='SkPath_Reference#SkPath'>SkPath</a>& src, <a href='SkPath_Reference#SkPath'>SkPath</a>* dst) const; |
| 104 | <a href='undocumented#SkShader'>SkShader</a>* <a href='#SkPaint_getShader'>getShader</a>() const; |
| 105 | <a href='undocumented#sk_sp'>sk_sp</a><<a href='undocumented#SkShader'>SkShader</a>> <a href='#SkPaint_refShader'>refShader</a>() const; |
| 106 | void <a href='#SkPaint_setShader'>setShader</a>(<a href='undocumented#sk_sp'>sk_sp</a><<a href='undocumented#SkShader'>SkShader</a>> <a href='undocumented#Shader'>shader</a>); |
| 107 | <a href='undocumented#SkColorFilter'>SkColorFilter</a>* <a href='#SkPaint_getColorFilter'>getColorFilter</a>() const; |
| 108 | <a href='undocumented#sk_sp'>sk_sp</a><<a href='undocumented#SkColorFilter'>SkColorFilter</a>> <a href='#SkPaint_refColorFilter'>refColorFilter</a>() const; |
| 109 | void <a href='#SkPaint_setColorFilter'>setColorFilter</a>(<a href='undocumented#sk_sp'>sk_sp</a><<a href='undocumented#SkColorFilter'>SkColorFilter</a>> colorFilter); |
| 110 | <a href='SkBlendMode_Reference#SkBlendMode'>SkBlendMode</a> <a href='#SkPaint_getBlendMode'>getBlendMode</a>() const; |
| 111 | bool <a href='#SkPaint_isSrcOver'>isSrcOver</a>() const; |
| 112 | void <a href='#SkPaint_setBlendMode'>setBlendMode</a>(<a href='SkBlendMode_Reference#SkBlendMode'>SkBlendMode</a> mode); |
| 113 | <a href='undocumented#SkPathEffect'>SkPathEffect</a>* <a href='#SkPaint_getPathEffect'>getPathEffect</a>() const; |
| 114 | <a href='undocumented#sk_sp'>sk_sp</a><<a href='undocumented#SkPathEffect'>SkPathEffect</a>> <a href='#SkPaint_refPathEffect'>refPathEffect</a>() const; |
| 115 | void <a href='#SkPaint_setPathEffect'>setPathEffect</a>(<a href='undocumented#sk_sp'>sk_sp</a><<a href='undocumented#SkPathEffect'>SkPathEffect</a>> pathEffect); |
| 116 | <a href='undocumented#SkMaskFilter'>SkMaskFilter</a>* <a href='#SkPaint_getMaskFilter'>getMaskFilter</a>() const; |
| 117 | <a href='undocumented#sk_sp'>sk_sp</a><<a href='undocumented#SkMaskFilter'>SkMaskFilter</a>> <a href='#SkPaint_refMaskFilter'>refMaskFilter</a>() const; |
| 118 | void <a href='#SkPaint_setMaskFilter'>setMaskFilter</a>(<a href='undocumented#sk_sp'>sk_sp</a><<a href='undocumented#SkMaskFilter'>SkMaskFilter</a>> maskFilter); |
| 119 | <a href='undocumented#SkTypeface'>SkTypeface</a>* <a href='#SkPaint_getTypeface'>getTypeface</a>() const; |
| 120 | <a href='undocumented#sk_sp'>sk_sp</a><<a href='undocumented#SkTypeface'>SkTypeface</a>> <a href='#SkPaint_refTypeface'>refTypeface</a>() const; |
| 121 | void <a href='#SkPaint_setTypeface'>setTypeface</a>(<a href='undocumented#sk_sp'>sk_sp</a><<a href='undocumented#SkTypeface'>SkTypeface</a>> <a href='undocumented#Typeface'>typeface</a>); |
| 122 | <a href='undocumented#SkImageFilter'>SkImageFilter</a>* <a href='#SkPaint_getImageFilter'>getImageFilter</a>() const; |
| 123 | <a href='undocumented#sk_sp'>sk_sp</a><<a href='undocumented#SkImageFilter'>SkImageFilter</a>> <a href='#SkPaint_refImageFilter'>refImageFilter</a>() const; |
| 124 | void <a href='#SkPaint_setImageFilter'>setImageFilter</a>(<a href='undocumented#sk_sp'>sk_sp</a><<a href='undocumented#SkImageFilter'>SkImageFilter</a>> imageFilter); |
| 125 | <a href='undocumented#SkDrawLooper'>SkDrawLooper</a>* <a href='#SkPaint_getDrawLooper'>getDrawLooper</a>() const; |
| 126 | <a href='undocumented#sk_sp'>sk_sp</a><<a href='undocumented#SkDrawLooper'>SkDrawLooper</a>> <a href='#SkPaint_refDrawLooper'>refDrawLooper</a>() const; |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 127 | void <a href='#SkPaint_setDrawLooper'>setDrawLooper</a>(<a href='undocumented#sk_sp'>sk_sp</a><<a href='undocumented#SkDrawLooper'>SkDrawLooper</a>> drawLooper); |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 128 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_getTextSize'>getTextSize</a>() const; |
| 129 | void <a href='#SkPaint_setTextSize'>setTextSize</a>(<a href='undocumented#SkScalar'>SkScalar</a> textSize); |
| 130 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_getTextScaleX'>getTextScaleX</a>() const; |
| 131 | void <a href='#SkPaint_setTextScaleX'>setTextScaleX</a>(<a href='undocumented#SkScalar'>SkScalar</a> scaleX); |
| 132 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_getTextSkewX'>getTextSkewX</a>() const; |
| 133 | void <a href='#SkPaint_setTextSkewX'>setTextSkewX</a>(<a href='undocumented#SkScalar'>SkScalar</a> skewX); |
Cary Clark | 3e73dcf | 2018-12-06 08:41:14 -0500 | [diff] [blame^] | 134 | <a href='undocumented#SkTextEncoding'>SkTextEncoding</a> <a href='#SkPaint_getTextEncoding'>getTextEncoding</a>() const; |
| 135 | void <a href='#SkPaint_setTextEncoding'>setTextEncoding</a>(<a href='undocumented#SkTextEncoding'>SkTextEncoding</a> encoding); |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 136 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 137 | typedef <a href='undocumented#SkFontMetrics'>SkFontMetrics</a> <a href='#SkPaint_FontMetrics'>FontMetrics</a>; |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 138 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 139 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_getFontMetrics'>getFontMetrics</a>(<a href='undocumented#SkFontMetrics'>SkFontMetrics</a>* metrics) const; |
| 140 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_getFontSpacing'>getFontSpacing</a>() const; |
| 141 | int <a href='#SkPaint_textToGlyphs'>textToGlyphs</a>(const void* <a href='undocumented#Text'>text</a>, size_t byteLength, |
| 142 | <a href='undocumented#SkGlyphID'>SkGlyphID</a> <a href='undocumented#Glyph'>glyphs</a>[]) const; |
| 143 | bool <a href='#SkPaint_containsText'>containsText</a>(const void* <a href='undocumented#Text'>text</a>, size_t byteLength) const; |
| 144 | void <a href='#SkPaint_glyphsToUnichars'>glyphsToUnichars</a>(const <a href='undocumented#SkGlyphID'>SkGlyphID</a> <a href='undocumented#Glyph'>glyphs</a>[], int count, <a href='undocumented#SkUnichar'>SkUnichar</a> <a href='undocumented#Text'>text</a>[]) const; |
| 145 | int <a href='#SkPaint_countText'>countText</a>(const void* <a href='undocumented#Text'>text</a>, size_t byteLength) const; |
| 146 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_measureText'>measureText</a>(const void* <a href='undocumented#Text'>text</a>, size_t length, <a href='SkRect_Reference#SkRect'>SkRect</a>* bounds) const; |
| 147 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_measureText'>measureText</a>(const void* <a href='undocumented#Text'>text</a>, size_t length) const; |
| 148 | size_t <a href='#SkPaint_breakText'>breakText</a>(const void* <a href='undocumented#Text'>text</a>, size_t length, <a href='undocumented#SkScalar'>SkScalar</a> maxWidth, |
| 149 | <a href='undocumented#SkScalar'>SkScalar</a>* measuredWidth = nullptr) const; |
| 150 | int <a href='#SkPaint_getTextWidths'>getTextWidths</a>(const void* <a href='undocumented#Text'>text</a>, size_t byteLength, <a href='undocumented#SkScalar'>SkScalar</a> widths[], |
| 151 | <a href='SkRect_Reference#SkRect'>SkRect</a> bounds[] = nullptr) const; |
| 152 | void <a href='#SkPaint_getTextPath'>getTextPath</a>(const void* <a href='undocumented#Text'>text</a>, size_t length, <a href='undocumented#SkScalar'>SkScalar</a> x, <a href='undocumented#SkScalar'>SkScalar</a> y, |
| 153 | <a href='SkPath_Reference#SkPath'>SkPath</a>* <a href='SkPath_Reference#Path'>path</a>) const; |
| 154 | void <a href='#SkPaint_getPosTextPath'>getPosTextPath</a>(const void* <a href='undocumented#Text'>text</a>, size_t length, |
| 155 | const <a href='SkPoint_Reference#SkPoint'>SkPoint</a> pos[], <a href='SkPath_Reference#SkPath'>SkPath</a>* <a href='SkPath_Reference#Path'>path</a>) const; |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 156 | int <a href='#SkPaint_getTextIntercepts'>getTextIntercepts</a>(const void* <a href='undocumented#Text'>text</a>, size_t length, <a href='undocumented#SkScalar'>SkScalar</a> x, <a href='undocumented#SkScalar'>SkScalar</a> y, |
| 157 | const <a href='undocumented#SkScalar'>SkScalar</a> bounds[2], <a href='undocumented#SkScalar'>SkScalar</a>* intervals) const; |
| 158 | int <a href='#SkPaint_getPosTextIntercepts'>getPosTextIntercepts</a>(const void* <a href='undocumented#Text'>text</a>, size_t length, const <a href='SkPoint_Reference#SkPoint'>SkPoint</a> pos[], |
| 159 | const <a href='undocumented#SkScalar'>SkScalar</a> bounds[2], <a href='undocumented#SkScalar'>SkScalar</a>* intervals) const; |
| 160 | int <a href='#SkPaint_getPosTextHIntercepts'>getPosTextHIntercepts</a>(const void* <a href='undocumented#Text'>text</a>, size_t length, const <a href='undocumented#SkScalar'>SkScalar</a> xpos[], |
| 161 | <a href='undocumented#SkScalar'>SkScalar</a> constY, const <a href='undocumented#SkScalar'>SkScalar</a> bounds[2], <a href='undocumented#SkScalar'>SkScalar</a>* intervals) const; |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 162 | int <a href='#SkPaint_getTextBlobIntercepts'>getTextBlobIntercepts</a>(const <a href='SkTextBlob_Reference#SkTextBlob'>SkTextBlob</a>* blob, const <a href='undocumented#SkScalar'>SkScalar</a> bounds[2], |
| 163 | <a href='undocumented#SkScalar'>SkScalar</a>* intervals) const; |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 164 | bool <a href='#SkPaint_nothingToDraw'>nothingToDraw</a>() const; |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 165 | }; |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 166 | |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 167 | </pre> |
| 168 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 169 | <a href='SkPaint_Reference#Paint'>Paint</a> controls options applied when drawing and measuring. <a href='SkPaint_Reference#Paint'>Paint</a> collects all |
| 170 | options outside of the <a href='#Canvas_Clip'>Canvas_Clip</a> and <a href='#Canvas_Matrix'>Canvas_Matrix</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 171 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 172 | Various options apply to <a href='undocumented#Text'>text</a>, strokes and fills, and images. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 173 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 174 | Some options may not be implemented on all platforms; in these cases, setting |
| 175 | the option has no effect. Some options are conveniences that duplicate <a href='SkCanvas_Reference#Canvas'>Canvas</a> |
| 176 | functionality; for instance, <a href='#Text_Size'>text size</a> is identical to <a href='SkMatrix_Reference#Matrix'>matrix</a> scale. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 177 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 178 | <a href='SkPaint_Reference#Paint'>Paint</a> options are rarely exclusive; each option modifies a stage of the drawing |
| 179 | pipeline and multiple pipeline stages may be affected by a single <a href='SkPaint_Reference#Paint'>Paint</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 180 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 181 | <a href='SkPaint_Reference#Paint'>Paint</a> collects effects and filters that describe single-pass and multiple-pass |
| 182 | algorithms that alter the drawing geometry, <a href='SkColor_Reference#Color'>color</a>, and transparency. For instance, |
| 183 | <a href='SkPaint_Reference#Paint'>Paint</a> does not directly implement dashing or blur, but contains the objects that do so. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 184 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 185 | The objects contained by <a href='SkPaint_Reference#Paint'>Paint</a> are opaque, and cannot be edited outside of the <a href='SkPaint_Reference#Paint'>Paint</a> |
| 186 | to affect it. The implementation is free to defer computations associated with the |
| 187 | <a href='SkPaint_Reference#Paint'>Paint</a>, or ignore them altogether. For instance, some GPU implementations draw all |
| 188 | <a href='SkPath_Reference#Path'>Path</a> geometries with <a href='#Paint_Anti_Alias'>Anti_Aliasing</a>, regardless of how <a href='SkPaint_Reference#SkPaint'>SkPaint</a>::<a href='#SkPaint_kAntiAlias_Flag'>kAntiAlias_Flag</a> |
| 189 | is set in <a href='SkPaint_Reference#Paint'>Paint</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 190 | |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 191 | <a href='SkPaint_Reference#Paint'>Paint</a> describes a single <a href='SkColor_Reference#Color'>color</a>, a single <a href='SkFont_Reference#Font'>font</a>, a single <a href='SkImage_Reference#Image'>image</a> quality, and so on. |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 192 | Multiple colors are drawn either by using multiple paints or with objects like |
| 193 | <a href='undocumented#Shader'>Shader</a> attached to <a href='SkPaint_Reference#Paint'>Paint</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 194 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 195 | <a name='SkPaint_empty_constructor'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 196 | |
| 197 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 198 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 199 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 200 | <a href='#SkPaint_empty_constructor'>SkPaint()</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 201 | </pre> |
| 202 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 203 | Constructs <a href='SkPaint_Reference#Paint'>Paint</a> with default values. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 204 | |
| 205 | | attribute | default value | |
| 206 | | --- | --- | |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 207 | | <a href='#Paint_Anti_Alias'>Anti_Alias</a> | false | |
| 208 | | <a href='#Blend_Mode'>Blend_Mode</a> | <a href='SkBlendMode_Reference#SkBlendMode'>SkBlendMode</a>::<a href='#SkBlendMode_kSrcOver'>kSrcOver</a> | |
| 209 | | <a href='SkColor_Reference#Color'>Color</a> | <a href='SkColor_Reference#SK_ColorBLACK'>SK_ColorBLACK</a> | |
| 210 | | <a href='#Color_Alpha'>Color_Alpha</a> | 255 | |
| 211 | | <a href='#Color_Filter'>Color_Filter</a> | nullptr | |
| 212 | | Dither | false | |
| 213 | | <a href='#Draw_Looper'>Draw_Looper</a> | nullptr | |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 214 | | <a href='#Filter_Quality'>Filter_Quality</a> | <a href='undocumented#kNone_SkFilterQuality'>kNone_SkFilterQuality</a> | |
Cary Clark | 3e73dcf | 2018-12-06 08:41:14 -0500 | [diff] [blame^] | 215 | | <a href='#Font_Force_Hinting'>Font_Force_Hinting</a> | false | |
| 216 | | <a href='#Font_Embedded_Bitmaps'>Font_Embedded_Bitmaps</a> | false | |
| 217 | | <a href='#Font_Embolden'>Font_Embolden</a> | false | |
| 218 | | <a href='#Font_Hinting'>Font_Hinting</a> | <a href='undocumented#SkFontHinting'>SkFontHinting</a>::<a href='#SkFontHinting_kNormal'>kNormal</a> | |
| 219 | | <a href='#Font_Hinting_Spacing'>Font_Hinting_Spacing</a> | false | |
| 220 | | <a href='#Font_Anti_Alias'>Font_Anti_Alias</a> | false | |
| 221 | | <a href='#Font_Linear'>Font_Linear</a> | false | |
| 222 | | <a href='#Font_Scale_X'>Font_Scale_X</a> | 1 | |
| 223 | | <a href='#Font_Size'>Font_Size</a> | 12 | |
| 224 | | <a href='#Font_Skew_X'>Font_Skew_X</a> | 0 | |
| 225 | | <a href='#Font_Subpixel'>Font_Subpixel</a> | false | |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 226 | | <a href='#Image_Filter'>Image_Filter</a> | nullptr | |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 227 | | <a href='#Paint_Miter_Limit'>Miter_Limit</a> | 4 | |
| 228 | | <a href='#Mask_Filter'>Mask_Filter</a> | nullptr | |
| 229 | | <a href='#Path_Effect'>Path_Effect</a> | nullptr | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 230 | | <a href='undocumented#Shader'>Shader</a> | nullptr | |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 231 | | <a href='#SkPaint_Style'>Style</a> | <a href='#SkPaint_kFill_Style'>kFill_Style</a> | |
Cary Clark | 3e73dcf | 2018-12-06 08:41:14 -0500 | [diff] [blame^] | 232 | | <a href='#Text_Encoding'>Text_Encoding</a> | <a href='undocumented#kUTF8_SkTextEncoding'>kUTF8_SkTextEncoding</a> | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 233 | | <a href='undocumented#Typeface'>Typeface</a> | nullptr | |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 234 | | <a href='#Paint_Stroke_Cap'>Stroke_Cap</a> | <a href='#SkPaint_kButt_Cap'>kButt_Cap</a> | |
| 235 | | <a href='#Paint_Stroke_Join'>Stroke_Join</a> | <a href='#SkPaint_kMiter_Join'>kMiter_Join</a> | |
| 236 | | <a href='#Paint_Stroke_Width'>Stroke_Width</a> | 0 | |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 237 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 238 | The flags, <a href='undocumented#Text'>text</a> <a href='undocumented#Size'>size</a>, hinting, and miter limit may be overridden at compile time by defining |
| 239 | <a href='SkPaint_Reference#Paint'>paint</a> default values. The overrides may be included in "SkUserConfig.h" or predefined by the |
| 240 | build system. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 241 | |
| 242 | ### Return Value |
| 243 | |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 244 | default initialized <a href='SkPaint_Reference#Paint'>Paint</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 245 | |
| 246 | ### Example |
| 247 | |
| 248 | <div><fiddle-embed name="c4b2186d85c142a481298f7144295ffd"></fiddle-embed></div> |
| 249 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 250 | <a name='SkPaint_copy_const_SkPaint'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 251 | |
| 252 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 253 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 254 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 255 | <a href='#SkPaint_copy_const_SkPaint'>SkPaint</a>(const <a href='SkPaint_Reference#SkPaint'>SkPaint</a>& <a href='SkPaint_Reference#Paint'>paint</a>) |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 256 | </pre> |
| 257 | |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 258 | Makes a shallow copy of <a href='SkPaint_Reference#SkPaint'>SkPaint</a>. <a href='undocumented#SkTypeface'>SkTypeface</a>, <a href='undocumented#SkPathEffect'>SkPathEffect</a>, <a href='undocumented#SkShader'>SkShader</a>, |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 259 | <a href='undocumented#SkMaskFilter'>SkMaskFilter</a>, <a href='undocumented#SkColorFilter'>SkColorFilter</a>, <a href='undocumented#SkDrawLooper'>SkDrawLooper</a>, and <a href='undocumented#SkImageFilter'>SkImageFilter</a> are shared |
| 260 | between the original <a href='#SkPaint_copy_const_SkPaint_paint'>paint</a> and the copy. Objects containing <a href='undocumented#SkRefCnt'>SkRefCnt</a> increment |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 261 | their references by one. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 262 | |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 263 | The referenced objects <a href='undocumented#SkPathEffect'>SkPathEffect</a>, <a href='undocumented#SkShader'>SkShader</a>, <a href='undocumented#SkMaskFilter'>SkMaskFilter</a>, <a href='undocumented#SkColorFilter'>SkColorFilter</a>, |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 264 | <a href='undocumented#SkDrawLooper'>SkDrawLooper</a>, and <a href='undocumented#SkImageFilter'>SkImageFilter</a> cannot be modified after they are created. |
| 265 | This prevents objects with <a href='undocumented#SkRefCnt'>SkRefCnt</a> from being modified once <a href='SkPaint_Reference#SkPaint'>SkPaint</a> refers to them. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 266 | |
| 267 | ### Parameters |
| 268 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 269 | <table> <tr> <td><a name='SkPaint_copy_const_SkPaint_paint'><code><strong>paint</strong></code></a></td> |
| 270 | <td>original to copy</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 271 | </tr> |
| 272 | </table> |
| 273 | |
| 274 | ### Return Value |
| 275 | |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 276 | shallow copy of <a href='#SkPaint_copy_const_SkPaint_paint'>paint</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 277 | |
| 278 | ### Example |
| 279 | |
skia-bookmaker | 44bad2e | 2018-07-05 05:35:27 +0000 | [diff] [blame] | 280 | <div><fiddle-embed name="b99971ad0ef243d617925289d963b62d"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 281 | |
| 282 | #### Example Output |
| 283 | |
| 284 | ~~~~ |
| 285 | SK_ColorRED == paint1.getColor() |
| 286 | SK_ColorBLUE == paint2.getColor() |
| 287 | ~~~~ |
| 288 | |
| 289 | </fiddle-embed></div> |
| 290 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 291 | <a name='SkPaint_move_SkPaint'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 292 | |
| 293 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 294 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 295 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 296 | <a href='#SkPaint_move_SkPaint'>SkPaint</a>(<a href='SkPaint_Reference#SkPaint'>SkPaint</a>&& <a href='SkPaint_Reference#Paint'>paint</a>) |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 297 | </pre> |
| 298 | |
Cary Clark | d0530ba | 2017-09-14 11:25:39 -0400 | [diff] [blame] | 299 | Implements a move constructor to avoid increasing the reference counts |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 300 | of objects referenced by the <a href='#SkPaint_move_SkPaint_paint'>paint</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 301 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 302 | After the call, <a href='#SkPaint_move_SkPaint_paint'>paint</a> is undefined, and can be safely destructed. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 303 | |
| 304 | ### Parameters |
| 305 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 306 | <table> <tr> <td><a name='SkPaint_move_SkPaint_paint'><code><strong>paint</strong></code></a></td> |
| 307 | <td>original to move</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 308 | </tr> |
| 309 | </table> |
| 310 | |
| 311 | ### Return Value |
| 312 | |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 313 | content of <a href='#SkPaint_move_SkPaint_paint'>paint</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 314 | |
| 315 | ### Example |
| 316 | |
Cary Clark | 8364706 | 2018-07-18 16:21:51 -0400 | [diff] [blame] | 317 | <div><fiddle-embed name="8ed1488a503cd5282b86a51614aa90b1"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 318 | |
| 319 | #### Example Output |
| 320 | |
| 321 | ~~~~ |
| 322 | path effect unique: true |
| 323 | ~~~~ |
| 324 | |
| 325 | </fiddle-embed></div> |
| 326 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 327 | <a name='SkPaint_reset'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 328 | |
| 329 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 330 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 331 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 332 | void <a href='#SkPaint_reset'>reset()</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 333 | </pre> |
| 334 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 335 | Sets all <a href='SkPaint_Reference#SkPaint'>SkPaint</a> contents to their initial values. This is equivalent to replacing |
| 336 | <a href='SkPaint_Reference#SkPaint'>SkPaint</a> with the result of <a href='#SkPaint_empty_constructor'>SkPaint()</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 337 | |
| 338 | ### Example |
| 339 | |
| 340 | <div><fiddle-embed name="ef269937ade7e7353635121d9a64f9f7"> |
| 341 | |
| 342 | #### Example Output |
| 343 | |
| 344 | ~~~~ |
| 345 | paint1 == paint2 |
| 346 | ~~~~ |
| 347 | |
| 348 | </fiddle-embed></div> |
| 349 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 350 | <a name='SkPaint_destructor'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 351 | |
| 352 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 353 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 354 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 355 | <a href='#SkPaint_destructor'>~SkPaint()</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 356 | </pre> |
| 357 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 358 | Decreases <a href='SkPaint_Reference#SkPaint'>SkPaint</a> <a href='undocumented#SkRefCnt'>SkRefCnt</a> of owned objects: <a href='undocumented#SkTypeface'>SkTypeface</a>, <a href='undocumented#SkPathEffect'>SkPathEffect</a>, <a href='undocumented#SkShader'>SkShader</a>, |
| 359 | <a href='undocumented#SkMaskFilter'>SkMaskFilter</a>, <a href='undocumented#SkColorFilter'>SkColorFilter</a>, <a href='undocumented#SkDrawLooper'>SkDrawLooper</a>, and <a href='undocumented#SkImageFilter'>SkImageFilter</a>. If the |
| 360 | objects containing <a href='undocumented#SkRefCnt'>SkRefCnt</a> go to zero, they are deleted. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 361 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 362 | <a name='Management'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 363 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 364 | <a name='SkPaint_copy_operator'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 365 | |
| 366 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 367 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 368 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 369 | <a href='SkPaint_Reference#SkPaint'>SkPaint</a>& <a href='#SkPaint_copy_operator'>operator=</a>(const <a href='SkPaint_Reference#SkPaint'>SkPaint</a>& <a href='SkPaint_Reference#Paint'>paint</a>) |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 370 | </pre> |
| 371 | |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 372 | Makes a shallow copy of <a href='SkPaint_Reference#SkPaint'>SkPaint</a>. <a href='undocumented#SkTypeface'>SkTypeface</a>, <a href='undocumented#SkPathEffect'>SkPathEffect</a>, <a href='undocumented#SkShader'>SkShader</a>, |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 373 | <a href='undocumented#SkMaskFilter'>SkMaskFilter</a>, <a href='undocumented#SkColorFilter'>SkColorFilter</a>, <a href='undocumented#SkDrawLooper'>SkDrawLooper</a>, and <a href='undocumented#SkImageFilter'>SkImageFilter</a> are shared |
| 374 | between the original <a href='#SkPaint_copy_operator_paint'>paint</a> and the copy. Objects containing <a href='undocumented#SkRefCnt'>SkRefCnt</a> in the |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 375 | prior destination are decreased by one, and the referenced objects are deleted if the |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 376 | resulting count is zero. Objects containing <a href='undocumented#SkRefCnt'>SkRefCnt</a> in the parameter <a href='#SkPaint_copy_operator_paint'>paint</a> |
| 377 | are increased by one. <a href='#SkPaint_copy_operator_paint'>paint</a> is unmodified. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 378 | |
| 379 | ### Parameters |
| 380 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 381 | <table> <tr> <td><a name='SkPaint_copy_operator_paint'><code><strong>paint</strong></code></a></td> |
| 382 | <td>original to copy</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 383 | </tr> |
| 384 | </table> |
| 385 | |
| 386 | ### Return Value |
| 387 | |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 388 | content of <a href='#SkPaint_copy_operator_paint'>paint</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 389 | |
| 390 | ### Example |
| 391 | |
| 392 | <div><fiddle-embed name="b476a9088f80dece176ed577807d3992"> |
| 393 | |
| 394 | #### Example Output |
| 395 | |
| 396 | ~~~~ |
| 397 | SK_ColorRED == paint1.getColor() |
| 398 | SK_ColorRED == paint2.getColor() |
| 399 | ~~~~ |
| 400 | |
| 401 | </fiddle-embed></div> |
| 402 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 403 | <a name='SkPaint_move_operator'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 404 | |
| 405 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 406 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 407 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 408 | <a href='SkPaint_Reference#SkPaint'>SkPaint</a>& <a href='#SkPaint_move_operator'>operator=</a>(<a href='SkPaint_Reference#SkPaint'>SkPaint</a>&& <a href='SkPaint_Reference#Paint'>paint</a>) |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 409 | </pre> |
| 410 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 411 | Moves the <a href='#SkPaint_move_operator_paint'>paint</a> to avoid increasing the reference counts |
| 412 | of objects referenced by the <a href='#SkPaint_move_operator_paint'>paint</a> parameter. Objects containing <a href='undocumented#SkRefCnt'>SkRefCnt</a> in the |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 413 | prior destination are decreased by one; those objects are deleted if the resulting count |
| 414 | is zero. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 415 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 416 | After the call, <a href='#SkPaint_move_operator_paint'>paint</a> is undefined, and can be safely destructed. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 417 | |
| 418 | ### Parameters |
| 419 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 420 | <table> <tr> <td><a name='SkPaint_move_operator_paint'><code><strong>paint</strong></code></a></td> |
| 421 | <td>original to move</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 422 | </tr> |
| 423 | </table> |
| 424 | |
| 425 | ### Return Value |
| 426 | |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 427 | content of <a href='#SkPaint_move_operator_paint'>paint</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 428 | |
| 429 | ### Example |
| 430 | |
Ravi Mistry | 874e22b | 2018-07-19 03:49:13 +0000 | [diff] [blame] | 431 | <div><fiddle-embed name="9fb7459b097d713f5f1fe5675afe14f5"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 432 | |
| 433 | #### Example Output |
| 434 | |
| 435 | ~~~~ |
| 436 | SK_ColorRED == paint2.getColor() |
| 437 | ~~~~ |
| 438 | |
| 439 | </fiddle-embed></div> |
| 440 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 441 | <a name='SkPaint_equal_operator'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 442 | |
| 443 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 444 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 445 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 446 | bool <a href='#SkPaint_equal_operator'>operator==</a>(const <a href='SkPaint_Reference#SkPaint'>SkPaint</a>& a, const <a href='SkPaint_Reference#SkPaint'>SkPaint</a>& b) |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 447 | </pre> |
| 448 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 449 | 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 |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 450 | if <a href='undocumented#SkTypeface'>SkTypeface</a>, <a href='undocumented#SkPathEffect'>SkPathEffect</a>, <a href='undocumented#SkShader'>SkShader</a>, <a href='undocumented#SkMaskFilter'>SkMaskFilter</a>, <a href='undocumented#SkColorFilter'>SkColorFilter</a>, |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 451 | <a href='undocumented#SkDrawLooper'>SkDrawLooper</a>, or <a href='undocumented#SkImageFilter'>SkImageFilter</a> have identical contents but different pointers. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 452 | |
| 453 | ### Parameters |
| 454 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 455 | <table> <tr> <td><a name='SkPaint_equal_operator_a'><code><strong>a</strong></code></a></td> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 456 | <td><a href='SkPaint_Reference#SkPaint'>SkPaint</a> to compare</td> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 457 | </tr> |
| 458 | <tr> <td><a name='SkPaint_equal_operator_b'><code><strong>b</strong></code></a></td> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 459 | <td><a href='SkPaint_Reference#SkPaint'>SkPaint</a> to compare</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 460 | </tr> |
| 461 | </table> |
| 462 | |
| 463 | ### Return Value |
| 464 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 465 | true if <a href='SkPaint_Reference#SkPaint'>SkPaint</a> pair are equivalent |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 466 | |
| 467 | ### Example |
| 468 | |
| 469 | <div><fiddle-embed name="7481a948e34672720337a631830586dd"> |
| 470 | |
| 471 | #### Example Output |
| 472 | |
| 473 | ~~~~ |
| 474 | paint1 == paint2 |
| 475 | paint1 != paint2 |
| 476 | ~~~~ |
| 477 | |
| 478 | </fiddle-embed></div> |
| 479 | |
Cary Clark | 06c20f3 | 2018-03-20 15:53:27 -0400 | [diff] [blame] | 480 | ### See Also |
| 481 | |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 482 | <a href='#SkPaint_notequal_operator'>operator!=</a>(const <a href='SkPaint_Reference#SkPaint'>SkPaint</a>& <a href='#SkPaint_equal_operator_a'>a</a>, const <a href='SkPaint_Reference#SkPaint'>SkPaint</a>& <a href='#SkPaint_equal_operator_b'>b</a>) |
Cary Clark | 06c20f3 | 2018-03-20 15:53:27 -0400 | [diff] [blame] | 483 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 484 | <a name='SkPaint_notequal_operator'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 485 | |
| 486 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 487 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 488 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 489 | bool <a href='#SkPaint_notequal_operator'>operator!=</a>(const <a href='SkPaint_Reference#SkPaint'>SkPaint</a>& a, const <a href='SkPaint_Reference#SkPaint'>SkPaint</a>& b) |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 490 | </pre> |
| 491 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 492 | 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 |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 493 | if <a href='undocumented#SkTypeface'>SkTypeface</a>, <a href='undocumented#SkPathEffect'>SkPathEffect</a>, <a href='undocumented#SkShader'>SkShader</a>, <a href='undocumented#SkMaskFilter'>SkMaskFilter</a>, <a href='undocumented#SkColorFilter'>SkColorFilter</a>, |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 494 | <a href='undocumented#SkDrawLooper'>SkDrawLooper</a>, or <a href='undocumented#SkImageFilter'>SkImageFilter</a> have identical contents but different pointers. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 495 | |
| 496 | ### Parameters |
| 497 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 498 | <table> <tr> <td><a name='SkPaint_notequal_operator_a'><code><strong>a</strong></code></a></td> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 499 | <td><a href='SkPaint_Reference#SkPaint'>SkPaint</a> to compare</td> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 500 | </tr> |
| 501 | <tr> <td><a name='SkPaint_notequal_operator_b'><code><strong>b</strong></code></a></td> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 502 | <td><a href='SkPaint_Reference#SkPaint'>SkPaint</a> to compare</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 503 | </tr> |
| 504 | </table> |
| 505 | |
| 506 | ### Return Value |
| 507 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 508 | true if <a href='SkPaint_Reference#SkPaint'>SkPaint</a> pair are not equivalent |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 509 | |
| 510 | ### Example |
| 511 | |
skia-bookmaker | a717ca9 | 2018-07-08 05:32:09 +0000 | [diff] [blame] | 512 | <div><fiddle-embed name="b6c8484b1187f555b435ad5369833be4"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 513 | |
| 514 | #### Example Output |
| 515 | |
| 516 | ~~~~ |
| 517 | paint1 == paint2 |
| 518 | paint1 == paint2 |
| 519 | ~~~~ |
| 520 | |
| 521 | </fiddle-embed></div> |
| 522 | |
Cary Clark | 06c20f3 | 2018-03-20 15:53:27 -0400 | [diff] [blame] | 523 | ### See Also |
| 524 | |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 525 | <a href='#SkPaint_equal_operator'>operator==</a>(const <a href='SkPaint_Reference#SkPaint'>SkPaint</a>& <a href='#SkPaint_notequal_operator_a'>a</a>, const <a href='SkPaint_Reference#SkPaint'>SkPaint</a>& <a href='#SkPaint_notequal_operator_b'>b</a>) |
Cary Clark | 06c20f3 | 2018-03-20 15:53:27 -0400 | [diff] [blame] | 526 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 527 | <a name='SkPaint_getHash'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 528 | |
| 529 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 530 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 531 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 532 | uint32_t <a href='#SkPaint_getHash'>getHash</a>()const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 533 | </pre> |
| 534 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 535 | Returns a hash generated from <a href='SkPaint_Reference#SkPaint'>SkPaint</a> values and pointers. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 536 | Identical hashes guarantee that the paints are |
| 537 | equivalent, but differing hashes do not guarantee that the paints have differing |
| 538 | contents. |
| 539 | |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 540 | If <a href='#SkPaint_equal_operator'>operator==</a>(const <a href='SkPaint_Reference#SkPaint'>SkPaint</a>& a, const <a href='SkPaint_Reference#SkPaint'>SkPaint</a>& b) returns true for two paints, |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 541 | their hashes are also equal. |
| 542 | |
| 543 | The hash returned is platform and implementation specific. |
| 544 | |
| 545 | ### Return Value |
| 546 | |
| 547 | a shallow hash |
| 548 | |
| 549 | ### Example |
| 550 | |
Cary Clark | 8364706 | 2018-07-18 16:21:51 -0400 | [diff] [blame] | 551 | <div><fiddle-embed name="7f7e1b701361912b344f90ae6b530393"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 552 | |
| 553 | #### Example Output |
| 554 | |
| 555 | ~~~~ |
| 556 | paint1 == paint2 |
| 557 | paint1.getHash() == paint2.getHash() |
| 558 | ~~~~ |
| 559 | |
| 560 | </fiddle-embed></div> |
| 561 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 562 | <a name='Hinting'></a> |
| 563 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 564 | <a name='SkPaint_setHinting'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 565 | |
| 566 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 567 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 568 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 569 | void <a href='#SkPaint_setHinting'>setHinting</a>(<a href='undocumented#SkFontHinting'>SkFontHinting</a> hintingLevel) |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 570 | </pre> |
| 571 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 572 | Sets level of <a href='undocumented#Glyph'>glyph</a> outline adjustment. |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 573 | Does not check for valid values of <a href='#SkPaint_setHinting_hintingLevel'>hintingLevel</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 574 | |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 575 | ### Parameters |
| 576 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 577 | <table> <tr> <td><a name='SkPaint_setHinting_hintingLevel'><code><strong>hintingLevel</strong></code></a></td> |
Cary Clark | 885f107 | 2018-11-08 13:31:39 -0500 | [diff] [blame] | 578 | <td>one of: <a href='undocumented#SkFontHinting'>SkFontHinting</a>::<a href='#SkFontHinting_kNone'>kNone</a>, <a href='undocumented#SkFontHinting'>SkFontHinting</a>::<a href='#SkFontHinting_kSlight'>kSlight</a>,</td> |
skia-bookmaker | e6c8575 | 2018-11-06 05:32:09 +0000 | [diff] [blame] | 579 | </tr> |
| 580 | </table> |
| 581 | |
Cary Clark | 885f107 | 2018-11-08 13:31:39 -0500 | [diff] [blame] | 582 | <a href='undocumented#SkFontHinting'>SkFontHinting</a>::<a href='#SkFontHinting_kNormal'>kNormal</a>, <a href='undocumented#SkFontHinting'>SkFontHinting</a>::<a href='#SkFontHinting_kFull'>kFull</a> |
skia-bookmaker | e6c8575 | 2018-11-06 05:32:09 +0000 | [diff] [blame] | 583 | |
| 584 | ### Example |
| 585 | |
skia-bookmaker | 6894f22 | 2018-12-02 05:59:00 +0000 | [diff] [blame] | 586 | <div><fiddle-embed name="bb179ec5698ec1398ff18f3657ab73f7"> |
skia-bookmaker | e6c8575 | 2018-11-06 05:32:09 +0000 | [diff] [blame] | 587 | |
| 588 | #### Example Output |
| 589 | |
| 590 | ~~~~ |
| 591 | paint1 == paint2 |
| 592 | ~~~~ |
| 593 | |
| 594 | </fiddle-embed></div> |
| 595 | |
Cary Clark | 8cc4cdc | 2018-11-09 23:16:58 -0500 | [diff] [blame] | 596 | <a name='SkPaint_getHinting'></a> |
| 597 | |
| 598 | --- |
| 599 | |
| 600 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 601 | <a href='undocumented#SkFontHinting'>SkFontHinting</a> <a href='#SkPaint_getHinting'>getHinting</a>()const |
Cary Clark | 8cc4cdc | 2018-11-09 23:16:58 -0500 | [diff] [blame] | 602 | </pre> |
| 603 | |
| 604 | Returns level of <a href='undocumented#Glyph'>glyph</a> outline adjustment. |
| 605 | |
| 606 | ### Return Value |
| 607 | |
Cary Clark | abaffd8 | 2018-11-15 08:25:12 -0500 | [diff] [blame] | 608 | one of: <a href='undocumented#SkFontHinting'>SkFontHinting</a>::<a href='#SkFontHinting_kNone'>kNone</a>, <a href='undocumented#SkFontHinting'>SkFontHinting</a>::<a href='#SkFontHinting_kSlight'>kSlight</a>, <a href='undocumented#SkFontHinting'>SkFontHinting</a>::<a href='#SkFontHinting_kNormal'>kNormal</a>, |
Cary Clark | 8cc4cdc | 2018-11-09 23:16:58 -0500 | [diff] [blame] | 609 | |
Cary Clark | abaffd8 | 2018-11-15 08:25:12 -0500 | [diff] [blame] | 610 | <a href='undocumented#SkFontHinting'>SkFontHinting</a>::<a href='#SkFontHinting_kFull'>kFull</a> |
Cary Clark | 8cc4cdc | 2018-11-09 23:16:58 -0500 | [diff] [blame] | 611 | |
Cary Clark | abaffd8 | 2018-11-15 08:25:12 -0500 | [diff] [blame] | 612 | ### Example |
Cary Clark | 8cc4cdc | 2018-11-09 23:16:58 -0500 | [diff] [blame] | 613 | |
Cary Clark | abaffd8 | 2018-11-15 08:25:12 -0500 | [diff] [blame] | 614 | <div><fiddle-embed name="b56b70c7ea2453c41bfa58b626953bed"> |
Cary Clark | 8cc4cdc | 2018-11-09 23:16:58 -0500 | [diff] [blame] | 615 | |
Cary Clark | abaffd8 | 2018-11-15 08:25:12 -0500 | [diff] [blame] | 616 | #### Example Output |
Cary Clark | 8cc4cdc | 2018-11-09 23:16:58 -0500 | [diff] [blame] | 617 | |
Cary Clark | abaffd8 | 2018-11-15 08:25:12 -0500 | [diff] [blame] | 618 | ~~~~ |
| 619 | SkFontHinting::kNormal == paint.getHinting() |
| 620 | ~~~~ |
Cary Clark | 8cc4cdc | 2018-11-09 23:16:58 -0500 | [diff] [blame] | 621 | |
Cary Clark | abaffd8 | 2018-11-15 08:25:12 -0500 | [diff] [blame] | 622 | </fiddle-embed></div> |
Cary Clark | 8cc4cdc | 2018-11-09 23:16:58 -0500 | [diff] [blame] | 623 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 624 | <a name='Flags'></a> |
| 625 | |
| 626 | <a name='SkPaint_Flags'></a> |
| 627 | |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 628 | --- |
| 629 | |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 630 | <pre style="padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0"> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 631 | enum <a href='#SkPaint_Flags'>Flags</a> { |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 632 | <a href='#SkPaint_kAntiAlias_Flag'>kAntiAlias_Flag</a> = 0x01, |
| 633 | <a href='#SkPaint_kDither_Flag'>kDither_Flag</a> = 0x04, |
| 634 | <a href='#SkPaint_kFakeBoldText_Flag'>kFakeBoldText_Flag</a> = 0x20, |
| 635 | <a href='#SkPaint_kLinearText_Flag'>kLinearText_Flag</a> = 0x40, |
| 636 | <a href='#SkPaint_kSubpixelText_Flag'>kSubpixelText_Flag</a> = 0x80, |
| 637 | <a href='#SkPaint_kLCDRenderText_Flag'>kLCDRenderText_Flag</a> = 0x200, |
| 638 | <a href='#SkPaint_kEmbeddedBitmapText_Flag'>kEmbeddedBitmapText_Flag</a> = 0x400, |
| 639 | <a href='#SkPaint_kAutoHinting_Flag'>kAutoHinting_Flag</a> = 0x800, |
| 640 | <a href='#SkPaint_kAllFlags'>kAllFlags</a> = 0xFFFF, |
Cary Clark | 186d08f | 2018-04-03 08:43:27 -0400 | [diff] [blame] | 641 | }; |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 642 | |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 643 | </pre> |
| 644 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 645 | The bit values stored in <a href='#SkPaint_Flags'>Flags</a>. |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 646 | The default value for <a href='#SkPaint_Flags'>Flags</a>, normally zero, can be changed at compile time |
| 647 | with a custom definition of <a href='undocumented#SkPaintDefaults_Flags'>SkPaintDefaults_Flags</a>. |
| 648 | All flags can be read and written explicitly; <a href='#SkPaint_Flags'>Flags</a> allows manipulating |
| 649 | multiple settings at once. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 650 | |
| 651 | ### Constants |
| 652 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 653 | <table style='border-collapse: collapse; width: 62.5em'> |
| 654 | <tr><th style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>Const</th> |
| 655 | <th style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>Value</th> |
| 656 | <th style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>Description</th></tr> |
| 657 | <tr style='background-color: #f0f0f0; '> |
| 658 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kAntiAlias_Flag'><code>SkPaint::kAntiAlias_Flag</code></a></td> |
| 659 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>0x0001</td> |
| 660 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
Cary Clark | ffb3d68 | 2018-05-17 12:17:28 -0400 | [diff] [blame] | 661 | mask for setting Anti_Alias</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 662 | </tr> |
| 663 | <tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 664 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kDither_Flag'><code>SkPaint::kDither_Flag</code></a></td> |
| 665 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>0x0004</td> |
| 666 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 667 | mask for setting Dither</td> |
| 668 | </tr> |
| 669 | <tr style='background-color: #f0f0f0; '> |
| 670 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kFakeBoldText_Flag'><code>SkPaint::kFakeBoldText_Flag</code></a></td> |
| 671 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>0x0020</td> |
| 672 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
Cary Clark | 3e73dcf | 2018-12-06 08:41:14 -0500 | [diff] [blame^] | 673 | mask for setting Font_Embolden</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 674 | </tr> |
| 675 | <tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 676 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kLinearText_Flag'><code>SkPaint::kLinearText_Flag</code></a></td> |
| 677 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>0x0040</td> |
| 678 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
Cary Clark | 3e73dcf | 2018-12-06 08:41:14 -0500 | [diff] [blame^] | 679 | mask for setting Font_Linear</td> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 680 | </tr> |
| 681 | <tr style='background-color: #f0f0f0; '> |
| 682 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kSubpixelText_Flag'><code>SkPaint::kSubpixelText_Flag</code></a></td> |
| 683 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>0x0080</td> |
| 684 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
Cary Clark | 3e73dcf | 2018-12-06 08:41:14 -0500 | [diff] [blame^] | 685 | mask for setting Font_Subpixel</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 686 | </tr> |
| 687 | <tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 688 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kLCDRenderText_Flag'><code>SkPaint::kLCDRenderText_Flag</code></a></td> |
| 689 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>0x0200</td> |
| 690 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
Cary Clark | 3e73dcf | 2018-12-06 08:41:14 -0500 | [diff] [blame^] | 691 | mask for setting Font_Anti_Alias</td> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 692 | </tr> |
| 693 | <tr style='background-color: #f0f0f0; '> |
| 694 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kEmbeddedBitmapText_Flag'><code>SkPaint::kEmbeddedBitmapText_Flag</code></a></td> |
| 695 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>0x0400</td> |
| 696 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 697 | mask for setting Font_Embedded_Bitmaps</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 698 | </tr> |
| 699 | <tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 700 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kAutoHinting_Flag'><code>SkPaint::kAutoHinting_Flag</code></a></td> |
| 701 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>0x0800</td> |
| 702 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
Cary Clark | 3e73dcf | 2018-12-06 08:41:14 -0500 | [diff] [blame^] | 703 | mask for setting Font_Force_Hinting</td> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 704 | </tr> |
| 705 | <tr style='background-color: #f0f0f0; '> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 706 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kAllFlags'><code>SkPaint::kAllFlags</code></a></td> |
| 707 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>0xFFFF</td> |
| 708 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 709 | mask of all <a href='#SkPaint_Flags'>Flags</a>, including private flags and flags reserved for future use |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 710 | </td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 711 | </tr> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 712 | <a href='#SkPaint_Flags'>Flags</a> default to all flags clear, disabling the associated feature. |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 713 | </table> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 714 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 715 | <a name='SkPaint_getFlags'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 716 | |
| 717 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 718 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 719 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 720 | uint32_t <a href='#SkPaint_getFlags'>getFlags</a>()const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 721 | </pre> |
| 722 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 723 | Returns <a href='SkPaint_Reference#Paint'>paint</a> settings described by <a href='SkPaint_Reference#SkPaint'>SkPaint</a>::<a href='#SkPaint_Flags'>Flags</a>. Each setting uses one |
| 724 | bit, and can be tested with <a href='SkPaint_Reference#SkPaint'>SkPaint</a>::<a href='#SkPaint_Flags'>Flags</a> members. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 725 | |
| 726 | ### Return Value |
| 727 | |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 728 | zero, one, or more bits described by <a href='SkPaint_Reference#SkPaint'>SkPaint</a>::<a href='#SkPaint_Flags'>Flags</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 729 | |
| 730 | ### Example |
| 731 | |
| 732 | <div><fiddle-embed name="8a3f8c309533388b01aa66e1267f322d"> |
| 733 | |
| 734 | #### Example Output |
| 735 | |
| 736 | ~~~~ |
| 737 | (SkPaint::kAntiAlias_Flag & paint.getFlags()) != 0 |
| 738 | ~~~~ |
| 739 | |
| 740 | </fiddle-embed></div> |
| 741 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 742 | <a name='SkPaint_setFlags'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 743 | |
| 744 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 745 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 746 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 747 | void <a href='#SkPaint_setFlags'>setFlags</a>(uint32_t flags) |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 748 | </pre> |
| 749 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 750 | Replaces <a href='SkPaint_Reference#SkPaint'>SkPaint</a>::<a href='#SkPaint_Flags'>Flags</a> with <a href='#SkPaint_setFlags_flags'>flags</a>, the union of the <a href='SkPaint_Reference#SkPaint'>SkPaint</a>::<a href='#SkPaint_Flags'>Flags</a> members. |
| 751 | All <a href='SkPaint_Reference#SkPaint'>SkPaint</a>::<a href='#SkPaint_Flags'>Flags</a> members may be cleared, or one or more may be set. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 752 | |
| 753 | ### Parameters |
| 754 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 755 | <table> <tr> <td><a name='SkPaint_setFlags_flags'><code><strong>flags</strong></code></a></td> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 756 | <td>union of <a href='SkPaint_Reference#SkPaint'>SkPaint</a>::<a href='#SkPaint_Flags'>Flags</a> for <a href='SkPaint_Reference#SkPaint'>SkPaint</a></td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 757 | </tr> |
| 758 | </table> |
| 759 | |
| 760 | ### Example |
| 761 | |
| 762 | <div><fiddle-embed name="54baed3f6bc4b9c31ba664e27767fdc7"> |
| 763 | |
| 764 | #### Example Output |
| 765 | |
| 766 | ~~~~ |
| 767 | paint.isAntiAlias() |
| 768 | paint.isDither() |
| 769 | ~~~~ |
| 770 | |
| 771 | </fiddle-embed></div> |
| 772 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 773 | <a name='Anti_Alias'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 774 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 775 | --- |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 776 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 777 | <a href='#Paint_Anti_Alias'>Anti_Alias</a> drawing approximates partial <a href='undocumented#Pixel'>pixel</a> coverage with transparency. |
| 778 | If <a href='#SkPaint_kAntiAlias_Flag'>kAntiAlias_Flag</a> is clear, <a href='undocumented#Pixel'>pixel</a> centers contained by the shape edge are drawn opaque. |
| 779 | If <a href='#SkPaint_kAntiAlias_Flag'>kAntiAlias_Flag</a> is set, pixels are drawn with <a href='#Color_Alpha'>Color_Alpha</a> equal to their coverage. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 780 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 781 | The rule for <a href='undocumented#Alias'>Aliased</a> pixels is inconsistent across platforms. A shape edge |
| 782 | passing through the <a href='undocumented#Pixel'>pixel</a> center may, but is not required to, draw the <a href='undocumented#Pixel'>pixel</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 783 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 784 | <a href='#Raster_Engine'>Raster_Engine</a> draws <a href='undocumented#Alias'>Aliased</a> pixels whose centers are on or to the right of the start of an |
| 785 | 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. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 786 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 787 | A platform may only support <a href='#Paint_Anti_Alias'>Anti_Aliased</a> drawing. Some GPU-backed platforms use |
| 788 | <a href='undocumented#Supersampling'>Supersampling</a> to <a href='#Paint_Anti_Alias'>Anti_Alias</a> all drawing, and have no mechanism to selectively |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 789 | <a href='undocumented#Alias'>Alias</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 790 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 791 | The amount of coverage computed for <a href='#Paint_Anti_Alias'>Anti_Aliased</a> pixels also varies across platforms. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 792 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 793 | <a href='#Paint_Anti_Alias'>Anti_Alias</a> is disabled by default. |
| 794 | <a href='#Paint_Anti_Alias'>Anti_Alias</a> can be enabled by default by setting <a href='undocumented#SkPaintDefaults_Flags'>SkPaintDefaults_Flags</a> to <a href='#SkPaint_kAntiAlias_Flag'>kAntiAlias_Flag</a> |
| 795 | at compile time. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 796 | |
| 797 | ### Example |
| 798 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 799 | <div><fiddle-embed name="a6575a49467ce8d28bb01cc7638fa04d"><div>A red <a href='undocumented#Line'>line</a> is drawn with transparency on the edges to make it look smoother. |
| 800 | A blue <a href='undocumented#Line'>line</a> draws only where the <a href='undocumented#Pixel'>pixel</a> centers are contained. |
| 801 | The <a href='undocumented#Line'>lines</a> are drawn into <a href='SkBitmap_Reference#Bitmap'>Bitmap</a>, then drawn magnified to make the |
| 802 | <a href='undocumented#Alias'>Aliasing</a> easier to see. |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 803 | </div></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 804 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 805 | <a name='SkPaint_isAntiAlias'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 806 | |
| 807 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 808 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 809 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 810 | bool <a href='#SkPaint_isAntiAlias'>isAntiAlias</a>()const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 811 | </pre> |
| 812 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 813 | Returns true if pixels on the active edges of <a href='SkPath_Reference#SkPath'>SkPath</a> may be drawn with partial transparency. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 814 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 815 | Equivalent to <a href='#SkPaint_getFlags'>getFlags</a>() masked with <a href='#SkPaint_kAntiAlias_Flag'>kAntiAlias_Flag</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 816 | |
| 817 | ### Return Value |
| 818 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 819 | <a href='#SkPaint_kAntiAlias_Flag'>kAntiAlias_Flag</a> state |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 820 | |
| 821 | ### Example |
| 822 | |
skia-bookmaker | b95bbba | 2018-07-06 05:23:23 +0000 | [diff] [blame] | 823 | <div><fiddle-embed name="d7d5f4f7da7acd5104a652f490c6f7b8"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 824 | |
| 825 | #### Example Output |
| 826 | |
| 827 | ~~~~ |
| 828 | paint.isAntiAlias() == !!(paint.getFlags() & SkPaint::kAntiAlias_Flag) |
| 829 | paint.isAntiAlias() == !!(paint.getFlags() & SkPaint::kAntiAlias_Flag) |
| 830 | ~~~~ |
| 831 | |
| 832 | </fiddle-embed></div> |
| 833 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 834 | <a name='SkPaint_setAntiAlias'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 835 | |
| 836 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 837 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 838 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 839 | void <a href='#SkPaint_setAntiAlias'>setAntiAlias</a>(bool aa) |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 840 | </pre> |
| 841 | |
skia-bookmaker | 8be4196 | 2018-11-20 05:34:36 +0000 | [diff] [blame] | 842 | Requests, but does not require, that edge pixels draw opaque or with |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 843 | partial transparency. |
| 844 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 845 | Sets <a href='#SkPaint_kAntiAlias_Flag'>kAntiAlias_Flag</a> if <a href='#SkPaint_setAntiAlias_aa'>aa</a> is true. |
| 846 | Clears <a href='#SkPaint_kAntiAlias_Flag'>kAntiAlias_Flag</a> if <a href='#SkPaint_setAntiAlias_aa'>aa</a> is false. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 847 | |
| 848 | ### Parameters |
| 849 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 850 | <table> <tr> <td><a name='SkPaint_setAntiAlias_aa'><code><strong>aa</strong></code></a></td> |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 851 | <td>setting for <a href='#SkPaint_kAntiAlias_Flag'>kAntiAlias_Flag</a></td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 852 | </tr> |
| 853 | </table> |
| 854 | |
| 855 | ### Example |
| 856 | |
skia-bookmaker | b95bbba | 2018-07-06 05:23:23 +0000 | [diff] [blame] | 857 | <div><fiddle-embed name="c2ff148374d01cbef845b223e725905c"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 858 | |
| 859 | #### Example Output |
| 860 | |
| 861 | ~~~~ |
| 862 | paint1 == paint2 |
| 863 | ~~~~ |
| 864 | |
| 865 | </fiddle-embed></div> |
| 866 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 867 | <a name='Dither'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 868 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 869 | --- |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 870 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 871 | Dither increases fidelity by adjusting the <a href='SkColor_Reference#Color'>color</a> of adjacent pixels. |
| 872 | This can help to smooth <a href='SkColor_Reference#Color'>color</a> transitions and reducing banding in gradients. |
| 873 | Dithering lessens visible banding from <a href='SkImageInfo_Reference#kRGB_565_SkColorType'>kRGB_565_SkColorType</a> |
| 874 | and <a href='SkImageInfo_Reference#kRGBA_8888_SkColorType'>kRGBA_8888_SkColorType</a> gradients, |
| 875 | and improves rendering into a <a href='SkImageInfo_Reference#kRGB_565_SkColorType'>kRGB_565_SkColorType</a> <a href='SkSurface_Reference#Surface'>Surface</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 876 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 877 | Dithering is always enabled for linear gradients drawing into |
| 878 | <a href='SkImageInfo_Reference#kRGB_565_SkColorType'>kRGB_565_SkColorType</a> <a href='SkSurface_Reference#Surface'>Surface</a> and <a href='SkImageInfo_Reference#kRGBA_8888_SkColorType'>kRGBA_8888_SkColorType</a> <a href='SkSurface_Reference#Surface'>Surface</a>. |
| 879 | Dither cannot be enabled for <a href='SkImageInfo_Reference#kAlpha_8_SkColorType'>kAlpha_8_SkColorType</a> <a href='SkSurface_Reference#Surface'>Surface</a> and |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 880 | <a href='SkImageInfo_Reference#kRGBA_F16_SkColorType'>kRGBA_F16_SkColorType</a> <a href='SkSurface_Reference#Surface'>Surface</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 881 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 882 | Dither is disabled by default. |
| 883 | Dither can be enabled by default by setting <a href='undocumented#SkPaintDefaults_Flags'>SkPaintDefaults_Flags</a> to <a href='#SkPaint_kDither_Flag'>kDither_Flag</a> |
| 884 | at compile time. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 885 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 886 | Some platform implementations may ignore dithering. Set <code>SK_IGNORE_GPU_DITHER</code>to ignore Dither on <a href='#GPU_Surface'>GPU_Surface</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 887 | |
| 888 | ### Example |
| 889 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 890 | <div><fiddle-embed name="8b26507690b71462f44642b911890bbf"><div>Dithering in the bottom half more closely approximates the requested <a href='SkColor_Reference#Color'>color</a> by |
| 891 | alternating nearby colors from <a href='undocumented#Pixel'>pixel</a> to <a href='undocumented#Pixel'>pixel</a>. |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 892 | </div></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 893 | |
| 894 | ### Example |
| 895 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 896 | <div><fiddle-embed name="76d4d4a7931a48495e4d5f54e073be53"><div>Dithering introduces subtle adjustments to <a href='SkColor_Reference#Color'>color</a> to smooth gradients. |
| 897 | Drawing the gradient repeatedly with <a href='SkBlendMode_Reference#SkBlendMode'>SkBlendMode</a>::<a href='#SkBlendMode_kPlus'>kPlus</a> exaggerates the |
| 898 | dither, making it easier to see. |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 899 | </div></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 900 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 901 | ### See Also |
| 902 | |
| 903 | Gradient <a href='SkImageInfo_Reference#kRGB_565_SkColorType'>kRGB_565_SkColorType</a> |
| 904 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 905 | <a name='SkPaint_isDither'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 906 | |
| 907 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 908 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 909 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 910 | bool <a href='#SkPaint_isDither'>isDither</a>()const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 911 | </pre> |
| 912 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 913 | Returns true if <a href='SkColor_Reference#Color'>color</a> error may be distributed to smooth <a href='SkColor_Reference#Color'>color</a> transition. |
skia-bookmaker | 525f9a9 | 2018-05-03 06:27:39 +0000 | [diff] [blame] | 914 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 915 | Equivalent to <a href='#SkPaint_getFlags'>getFlags</a>() masked with <a href='#SkPaint_kDither_Flag'>kDither_Flag</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 916 | |
| 917 | ### Return Value |
| 918 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 919 | <a href='#SkPaint_kDither_Flag'>kDither_Flag</a> state |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 920 | |
| 921 | ### Example |
| 922 | |
| 923 | <div><fiddle-embed name="f4ce93f6c5e7335436a985377fd980c0"> |
| 924 | |
| 925 | #### Example Output |
| 926 | |
| 927 | ~~~~ |
| 928 | paint.isDither() == !!(paint.getFlags() & SkPaint::kDither_Flag) |
| 929 | paint.isDither() == !!(paint.getFlags() & SkPaint::kDither_Flag) |
| 930 | ~~~~ |
| 931 | |
| 932 | </fiddle-embed></div> |
| 933 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 934 | <a name='SkPaint_setDither'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 935 | |
| 936 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 937 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 938 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 939 | void <a href='#SkPaint_setDither'>setDither</a>(bool dither) |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 940 | </pre> |
| 941 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 942 | Requests, but does not require, to distribute <a href='SkColor_Reference#Color'>color</a> error. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 943 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 944 | Sets <a href='#SkPaint_kDither_Flag'>kDither_Flag</a> if <a href='#SkPaint_setDither_dither'>dither</a> is true. |
| 945 | Clears <a href='#SkPaint_kDither_Flag'>kDither_Flag</a> if <a href='#SkPaint_setDither_dither'>dither</a> is false. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 946 | |
| 947 | ### Parameters |
| 948 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 949 | <table> <tr> <td><a name='SkPaint_setDither_dither'><code><strong>dither</strong></code></a></td> |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 950 | <td>setting for <a href='#SkPaint_kDither_Flag'>kDither_Flag</a></td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 951 | </tr> |
| 952 | </table> |
| 953 | |
| 954 | ### Example |
| 955 | |
| 956 | <div><fiddle-embed name="69b7162e8324d9239dd02dd9ada2bdff"> |
| 957 | |
| 958 | #### Example Output |
| 959 | |
| 960 | ~~~~ |
| 961 | paint1 == paint2 |
| 962 | ~~~~ |
| 963 | |
| 964 | </fiddle-embed></div> |
| 965 | |
| 966 | ### See Also |
| 967 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 968 | <a href='SkImageInfo_Reference#kRGB_565_SkColorType'>kRGB_565_SkColorType</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 969 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 970 | <a name='Device_Text'></a> |
| 971 | |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 972 | --- |
| 973 | |
Cary Clark | 3e73dcf | 2018-12-06 08:41:14 -0500 | [diff] [blame^] | 974 | <a href='#Font_Anti_Alias'>Font_Anti_Alias</a> and <a href='#Font_Subpixel'>Font_Subpixel</a> increase the precision of <a href='undocumented#Glyph'>glyph</a> position. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 975 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 976 | When set, <a href='#SkPaint_Flags'>Flags</a> <a href='#SkPaint_kLCDRenderText_Flag'>kLCDRenderText_Flag</a> takes advantage of the organization of RGB stripes that |
| 977 | create a <a href='SkColor_Reference#Color'>color</a>, and relies |
| 978 | on the small <a href='undocumented#Size'>size</a> of the stripe and visual perception to make the <a href='SkColor_Reference#Color'>color</a> fringing imperceptible. |
Cary Clark | 3e73dcf | 2018-12-06 08:41:14 -0500 | [diff] [blame^] | 979 | <a href='#Font_Anti_Alias'>Font_Anti_Alias</a> can be enabled on devices that orient stripes horizontally or vertically, and that order |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 980 | the <a href='SkColor_Reference#Color'>color</a> components as RGB or BGR. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 981 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 982 | <a href='#SkPaint_Flags'>Flags</a> <a href='#SkPaint_kSubpixelText_Flag'>kSubpixelText_Flag</a> uses the <a href='undocumented#Pixel'>pixel</a> transparency to represent a fractional offset. |
| 983 | As the opaqueness |
| 984 | of the <a href='SkColor_Reference#Color'>color</a> increases, the edge of the <a href='undocumented#Glyph'>glyph</a> appears to move towards the outside of the <a href='undocumented#Pixel'>pixel</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 985 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 986 | Either or both techniques can be enabled. |
| 987 | <a href='#SkPaint_kLCDRenderText_Flag'>kLCDRenderText_Flag</a> and <a href='#SkPaint_kSubpixelText_Flag'>kSubpixelText_Flag</a> are clear by default. |
Cary Clark | 3e73dcf | 2018-12-06 08:41:14 -0500 | [diff] [blame^] | 988 | <a href='#Font_Anti_Alias'>Font_Anti_Alias</a> or <a href='#Font_Subpixel'>Font_Subpixel</a> can be enabled by default by setting <a href='undocumented#SkPaintDefaults_Flags'>SkPaintDefaults_Flags</a> to |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 989 | <a href='#SkPaint_kLCDRenderText_Flag'>kLCDRenderText_Flag</a> or <a href='#SkPaint_kSubpixelText_Flag'>kSubpixelText_Flag</a> (or both) at compile time. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 990 | |
| 991 | ### Example |
| 992 | |
Cary Clark | 3e73dcf | 2018-12-06 08:41:14 -0500 | [diff] [blame^] | 993 | <div><fiddle-embed name="4606ae1be792d6bc46d496432f050ee9"><div>Four commas are drawn normally and with combinations of <a href='#Font_Anti_Alias'>Font_Anti_Alias</a> and <a href='#Font_Subpixel'>Font_Subpixel</a>. |
| 994 | When <a href='#Font_Subpixel'>Font_Subpixel</a> is disabled, the comma <a href='undocumented#Glyph'>Glyphs</a> are identical, but not evenly spaced. |
| 995 | When <a href='#Font_Subpixel'>Font_Subpixel</a> is enabled, the comma <a href='undocumented#Glyph'>Glyphs</a> are unique, but appear evenly spaced. |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 996 | </div></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 997 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 998 | <a name='Linear_Text'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 999 | |
Cary Clark | 3e73dcf | 2018-12-06 08:41:14 -0500 | [diff] [blame^] | 1000 | <a href='#Font_Linear'>Font_Linear</a> selects whether <a href='undocumented#Text'>text</a> is rendered as a <a href='undocumented#Glyph'>Glyph</a> or as a <a href='SkPath_Reference#Path'>Path</a>. |
| 1001 | If <a href='#Font_Linear'>Font_Linear</a> is set, it has the same effect as setting Hinting to <a href='undocumented#SkFontHinting'>SkFontHinting</a>::<a href='#SkFontHinting_kNormal'>kNormal</a>. |
| 1002 | If <a href='#Font_Linear'>Font_Linear</a> is clear, it is the same as setting Hinting to <a href='undocumented#SkFontHinting'>SkFontHinting</a>::<a href='#SkFontHinting_kNone'>kNone</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1003 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1004 | <a name='SkPaint_isLinearText'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1005 | |
| 1006 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1007 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1008 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 1009 | bool <a href='#SkPaint_isLinearText'>isLinearText</a>()const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1010 | </pre> |
| 1011 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1012 | Returns true if <a href='undocumented#Text'>text</a> is converted to <a href='SkPath_Reference#SkPath'>SkPath</a> before drawing and measuring. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1013 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1014 | Equivalent to <a href='#SkPaint_getFlags'>getFlags</a>() masked with <a href='#SkPaint_kLinearText_Flag'>kLinearText_Flag</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1015 | |
| 1016 | ### Return Value |
| 1017 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1018 | <a href='#SkPaint_kLinearText_Flag'>kLinearText_Flag</a> state |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1019 | |
| 1020 | ### Example |
| 1021 | |
| 1022 | <div><fiddle-embed name="2890ad644f980637837e6fcb386fb462"></fiddle-embed></div> |
| 1023 | |
| 1024 | ### See Also |
| 1025 | |
Cary Clark | abaffd8 | 2018-11-15 08:25:12 -0500 | [diff] [blame] | 1026 | <a href='#SkPaint_setLinearText'>setLinearText</a> Hinting |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1027 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1028 | <a name='SkPaint_setLinearText'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1029 | |
| 1030 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1031 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1032 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1033 | void <a href='#SkPaint_setLinearText'>setLinearText</a>(bool linearText) |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1034 | </pre> |
| 1035 | |
skia-bookmaker | 8be4196 | 2018-11-20 05:34:36 +0000 | [diff] [blame] | 1036 | Requests, but does not require, that <a href='undocumented#Glyph'>glyphs</a> are converted to <a href='SkPath_Reference#SkPath'>SkPath</a> |
| 1037 | before drawing and measuring. |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1038 | By default, <a href='#SkPaint_kLinearText_Flag'>kLinearText_Flag</a> is clear. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1039 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1040 | Sets <a href='#SkPaint_kLinearText_Flag'>kLinearText_Flag</a> if <a href='#SkPaint_setLinearText_linearText'>linearText</a> is true. |
| 1041 | Clears <a href='#SkPaint_kLinearText_Flag'>kLinearText_Flag</a> if <a href='#SkPaint_setLinearText_linearText'>linearText</a> is false. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1042 | |
| 1043 | ### Parameters |
| 1044 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1045 | <table> <tr> <td><a name='SkPaint_setLinearText_linearText'><code><strong>linearText</strong></code></a></td> |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 1046 | <td>setting for <a href='#SkPaint_kLinearText_Flag'>kLinearText_Flag</a></td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1047 | </tr> |
| 1048 | </table> |
| 1049 | |
| 1050 | ### Example |
| 1051 | |
Cary Clark | 8364706 | 2018-07-18 16:21:51 -0400 | [diff] [blame] | 1052 | <div><fiddle-embed name="c93bb912f3bddfb4d96d3ad70ada552b"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1053 | |
| 1054 | ### See Also |
| 1055 | |
Cary Clark | abaffd8 | 2018-11-15 08:25:12 -0500 | [diff] [blame] | 1056 | <a href='#SkPaint_isLinearText'>isLinearText</a> Hinting |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1057 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1058 | <a name='Subpixel_Text'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1059 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1060 | <a href='#SkPaint_Flags'>Flags</a> <a href='#SkPaint_kSubpixelText_Flag'>kSubpixelText_Flag</a> uses the <a href='undocumented#Pixel'>pixel</a> transparency to represent a fractional offset. |
| 1061 | As the opaqueness |
| 1062 | of the <a href='SkColor_Reference#Color'>color</a> increases, the edge of the <a href='undocumented#Glyph'>glyph</a> appears to move towards the outside of the <a href='undocumented#Pixel'>pixel</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1063 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1064 | <a name='SkPaint_isSubpixelText'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1065 | |
| 1066 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1067 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1068 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 1069 | bool <a href='#SkPaint_isSubpixelText'>isSubpixelText</a>()const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1070 | </pre> |
| 1071 | |
Cary Clark | 3e73dcf | 2018-12-06 08:41:14 -0500 | [diff] [blame^] | 1072 | Returns true if <a href='undocumented#Glyph'>glyphs</a> at different <a href='SkFont_Reference#Subpixel'>sub-pixel</a> positions may differ on <a href='undocumented#Pixel'>pixel</a> edge coverage. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1073 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1074 | Equivalent to <a href='#SkPaint_getFlags'>getFlags</a>() masked with <a href='#SkPaint_kSubpixelText_Flag'>kSubpixelText_Flag</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1075 | |
| 1076 | ### Return Value |
| 1077 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1078 | <a href='#SkPaint_kSubpixelText_Flag'>kSubpixelText_Flag</a> state |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1079 | |
| 1080 | ### Example |
| 1081 | |
| 1082 | <div><fiddle-embed name="abe9afc0932e2199324ae6cbb396e67c"> |
| 1083 | |
| 1084 | #### Example Output |
| 1085 | |
| 1086 | ~~~~ |
| 1087 | paint.isSubpixelText() == !!(paint.getFlags() & SkPaint::kSubpixelText_Flag) |
| 1088 | paint.isSubpixelText() == !!(paint.getFlags() & SkPaint::kSubpixelText_Flag) |
| 1089 | ~~~~ |
| 1090 | |
| 1091 | </fiddle-embed></div> |
| 1092 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1093 | <a name='SkPaint_setSubpixelText'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1094 | |
| 1095 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1096 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1097 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1098 | void <a href='#SkPaint_setSubpixelText'>setSubpixelText</a>(bool subpixelText) |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1099 | </pre> |
| 1100 | |
Cary Clark | 3e73dcf | 2018-12-06 08:41:14 -0500 | [diff] [blame^] | 1101 | Requests, but does not require, that <a href='undocumented#Glyph'>glyphs</a> respect <a href='SkFont_Reference#Subpixel'>sub-pixel</a> positioning. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1102 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1103 | Sets <a href='#SkPaint_kSubpixelText_Flag'>kSubpixelText_Flag</a> if <a href='#SkPaint_setSubpixelText_subpixelText'>subpixelText</a> is true. |
| 1104 | Clears <a href='#SkPaint_kSubpixelText_Flag'>kSubpixelText_Flag</a> if <a href='#SkPaint_setSubpixelText_subpixelText'>subpixelText</a> is false. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1105 | |
| 1106 | ### Parameters |
| 1107 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1108 | <table> <tr> <td><a name='SkPaint_setSubpixelText_subpixelText'><code><strong>subpixelText</strong></code></a></td> |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 1109 | <td>setting for <a href='#SkPaint_kSubpixelText_Flag'>kSubpixelText_Flag</a></td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1110 | </tr> |
| 1111 | </table> |
| 1112 | |
| 1113 | ### Example |
| 1114 | |
| 1115 | <div><fiddle-embed name="a77bbc1a4e3be9a8ab0f842f877c5ee4"> |
| 1116 | |
| 1117 | #### Example Output |
| 1118 | |
| 1119 | ~~~~ |
| 1120 | paint1 == paint2 |
| 1121 | ~~~~ |
| 1122 | |
| 1123 | </fiddle-embed></div> |
| 1124 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1125 | <a name='LCD_Text'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1126 | |
Cary Clark | 3e73dcf | 2018-12-06 08:41:14 -0500 | [diff] [blame^] | 1127 | When set, <a href='#Font_Anti_Alias'>Font_Anti_Alias</a> takes advantage of the organization of RGB stripes that |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1128 | create a <a href='SkColor_Reference#Color'>color</a>, and relies |
| 1129 | on the small <a href='undocumented#Size'>size</a> of the stripe and visual perception to make the <a href='SkColor_Reference#Color'>color</a> fringing imperceptible. |
Cary Clark | 3e73dcf | 2018-12-06 08:41:14 -0500 | [diff] [blame^] | 1130 | <a href='#Font_Anti_Alias'>Font_Anti_Alias</a> can be enabled on devices that orient stripes horizontally or vertically, and that order |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1131 | the <a href='SkColor_Reference#Color'>color</a> components as RGB or BGR. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1132 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1133 | <a name='SkPaint_isLCDRenderText'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1134 | |
| 1135 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1136 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1137 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 1138 | bool <a href='#SkPaint_isLCDRenderText'>isLCDRenderText</a>()const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1139 | </pre> |
| 1140 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1141 | Returns true if <a href='undocumented#Glyph'>glyphs</a> may use LCD striping to improve <a href='undocumented#Glyph'>glyph</a> edges. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1142 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1143 | Returns true if <a href='SkPaint_Reference#SkPaint'>SkPaint</a>::<a href='#SkPaint_Flags'>Flags</a> <a href='#SkPaint_kLCDRenderText_Flag'>kLCDRenderText_Flag</a> is set. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1144 | |
| 1145 | ### Return Value |
| 1146 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1147 | <a href='#SkPaint_kLCDRenderText_Flag'>kLCDRenderText_Flag</a> state |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1148 | |
| 1149 | ### Example |
| 1150 | |
skia-bookmaker | a391c72 | 2018-07-09 05:28:19 +0000 | [diff] [blame] | 1151 | <div><fiddle-embed name="68e1fd95dd2fd06a333899d2bd2396b9"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1152 | |
| 1153 | #### Example Output |
| 1154 | |
| 1155 | ~~~~ |
| 1156 | paint.isLCDRenderText() == !!(paint.getFlags() & SkPaint::kLCDRenderText_Flag) |
| 1157 | paint.isLCDRenderText() == !!(paint.getFlags() & SkPaint::kLCDRenderText_Flag) |
| 1158 | ~~~~ |
| 1159 | |
| 1160 | </fiddle-embed></div> |
| 1161 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1162 | <a name='SkPaint_setLCDRenderText'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1163 | |
| 1164 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1165 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1166 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1167 | void <a href='#SkPaint_setLCDRenderText'>setLCDRenderText</a>(bool lcdText) |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1168 | </pre> |
| 1169 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1170 | Requests, but does not require, that <a href='undocumented#Glyph'>glyphs</a> use LCD striping for <a href='undocumented#Glyph'>glyph</a> edges. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1171 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1172 | Sets <a href='#SkPaint_kLCDRenderText_Flag'>kLCDRenderText_Flag</a> if <a href='#SkPaint_setLCDRenderText_lcdText'>lcdText</a> is true. |
| 1173 | Clears <a href='#SkPaint_kLCDRenderText_Flag'>kLCDRenderText_Flag</a> if <a href='#SkPaint_setLCDRenderText_lcdText'>lcdText</a> is false. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1174 | |
| 1175 | ### Parameters |
| 1176 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1177 | <table> <tr> <td><a name='SkPaint_setLCDRenderText_lcdText'><code><strong>lcdText</strong></code></a></td> |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 1178 | <td>setting for <a href='#SkPaint_kLCDRenderText_Flag'>kLCDRenderText_Flag</a></td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1179 | </tr> |
| 1180 | </table> |
| 1181 | |
| 1182 | ### Example |
| 1183 | |
skia-bookmaker | e0a458f | 2018-07-16 05:29:00 +0000 | [diff] [blame] | 1184 | <div><fiddle-embed name="50dedf8450159571a3edaf4f0050defe"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1185 | |
| 1186 | #### Example Output |
| 1187 | |
| 1188 | ~~~~ |
| 1189 | paint1 == paint2 |
| 1190 | ~~~~ |
| 1191 | |
| 1192 | </fiddle-embed></div> |
| 1193 | |
Cary Clark | 3e73dcf | 2018-12-06 08:41:14 -0500 | [diff] [blame^] | 1194 | <a name='Embedded_Bitmaps'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1195 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1196 | --- |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 1197 | |
Cary Clark | 3e73dcf | 2018-12-06 08:41:14 -0500 | [diff] [blame^] | 1198 | <a href='#Font_Embedded_Bitmaps'>Font_Embedded_Bitmaps</a> allows selecting custom sized <a href='SkBitmap_Reference#Bitmap'>bitmap</a> <a href='undocumented#Glyph'>Glyphs</a>. |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1199 | <a href='#SkPaint_Flags'>Flags</a> <a href='#SkPaint_kEmbeddedBitmapText_Flag'>kEmbeddedBitmapText_Flag</a> when set chooses an embedded <a href='SkBitmap_Reference#Bitmap'>bitmap</a> <a href='undocumented#Glyph'>glyph</a> over an outline contained |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 1200 | in a <a href='SkFont_Reference#Font'>font</a> if the platform supports this option. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1201 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1202 | FreeType selects the <a href='SkBitmap_Reference#Bitmap'>bitmap</a> <a href='undocumented#Glyph'>glyph</a> if available when <a href='#SkPaint_kEmbeddedBitmapText_Flag'>kEmbeddedBitmapText_Flag</a> is set, and selects |
| 1203 | the outline <a href='undocumented#Glyph'>glyph</a> if <a href='#SkPaint_kEmbeddedBitmapText_Flag'>kEmbeddedBitmapText_Flag</a> is clear. |
| 1204 | Windows may select the <a href='SkBitmap_Reference#Bitmap'>bitmap</a> <a href='undocumented#Glyph'>glyph</a> but is not required to do so. |
| 1205 | <a href='#OS_X'>OS_X</a> and iOS do not support this option. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1206 | |
Cary Clark | 3e73dcf | 2018-12-06 08:41:14 -0500 | [diff] [blame^] | 1207 | <a href='#Font_Embedded_Bitmaps'>Font_Embedded_Bitmaps</a> is disabled by default. |
| 1208 | <a href='#Font_Embedded_Bitmaps'>Font_Embedded_Bitmaps</a> can be enabled by default by setting <a href='undocumented#SkPaintDefaults_Flags'>SkPaintDefaults_Flags</a> to |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1209 | <a href='#SkPaint_kEmbeddedBitmapText_Flag'>kEmbeddedBitmapText_Flag</a> at compile time. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1210 | |
| 1211 | ### Example |
| 1212 | |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 1213 | <pre style="padding: 1em 1em 1em 1em; font-size: 13px width: 62.5em; background-color: #f0f0f0"> |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 1214 | <div>The "hintgasp" TrueType font in the Skia resources/fonts directory |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 1215 | includes an embedded bitmap Glyph at odd font sizes. This example works |
| 1216 | on platforms that use FreeType as their Font_Engine. |
| 1217 | Windows may, but is not required to, return a bitmap glyph if |
| 1218 | kEmbeddedBitmapText_Flag is set.</div>SkBitmap bitmap; |
| 1219 | bitmap.allocN32Pixels(30, 15); |
| 1220 | bitmap.eraseColor(0); |
| 1221 | SkCanvas offscreen(bitmap); |
| 1222 | SkPaint paint; |
| 1223 | paint.setAntiAlias(true); |
| 1224 | paint.setTextSize(13); |
Hal Canary | 53e5e7d | 2017-12-08 14:25:14 -0500 | [diff] [blame] | 1225 | paint.setTypeface(MakeResourceAsTypeface("fonts/hintgasp.ttf")); |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 1226 | for (bool embedded : { false, true}) { |
| 1227 | paint.setEmbeddedBitmapText(embedded); |
| 1228 | offscreen.drawString("A", embedded ? 5 : 15, 15, paint); |
| 1229 | } |
| 1230 | canvas->drawBitmap(bitmap, 0, 0); |
| 1231 | canvas->scale(10, 10); |
| 1232 | canvas->drawBitmap(bitmap, -2, 1); |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 1233 | |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 1234 | </pre> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1235 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1236 | <a name='SkPaint_isEmbeddedBitmapText'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1237 | |
| 1238 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1239 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1240 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 1241 | bool <a href='#SkPaint_isEmbeddedBitmapText'>isEmbeddedBitmapText</a>()const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1242 | </pre> |
| 1243 | |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 1244 | Returns true if <a href='SkFont_Reference#Font'>font</a> engine may return <a href='undocumented#Glyph'>glyphs</a> from <a href='SkFont_Reference#Font'>font</a> <a href='SkBitmap_Reference#Bitmap'>bitmaps</a> instead of from outlines. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1245 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1246 | Equivalent to <a href='#SkPaint_getFlags'>getFlags</a>() masked with <a href='#SkPaint_kEmbeddedBitmapText_Flag'>kEmbeddedBitmapText_Flag</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1247 | |
| 1248 | ### Return Value |
| 1249 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1250 | <a href='#SkPaint_kEmbeddedBitmapText_Flag'>kEmbeddedBitmapText_Flag</a> state |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1251 | |
| 1252 | ### Example |
| 1253 | |
| 1254 | <div><fiddle-embed name="eba10b27b790e87183ae451b3fc5c4b1"> |
| 1255 | |
| 1256 | #### Example Output |
| 1257 | |
| 1258 | ~~~~ |
| 1259 | paint.isEmbeddedBitmapText() == !!(paint.getFlags() & SkPaint::kEmbeddedBitmapText_Flag) |
| 1260 | paint.isEmbeddedBitmapText() == !!(paint.getFlags() & SkPaint::kEmbeddedBitmapText_Flag) |
| 1261 | ~~~~ |
| 1262 | |
| 1263 | </fiddle-embed></div> |
| 1264 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1265 | <a name='SkPaint_setEmbeddedBitmapText'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1266 | |
| 1267 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1268 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1269 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1270 | void <a href='#SkPaint_setEmbeddedBitmapText'>setEmbeddedBitmapText</a>(bool useEmbeddedBitmapText) |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1271 | </pre> |
| 1272 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1273 | Requests, but does not require, to use <a href='SkBitmap_Reference#Bitmap'>bitmaps</a> in fonts instead of outlines. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1274 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1275 | Sets <a href='#SkPaint_kEmbeddedBitmapText_Flag'>kEmbeddedBitmapText_Flag</a> if <a href='#SkPaint_setEmbeddedBitmapText_useEmbeddedBitmapText'>useEmbeddedBitmapText</a> is true. |
| 1276 | Clears <a href='#SkPaint_kEmbeddedBitmapText_Flag'>kEmbeddedBitmapText_Flag</a> if <a href='#SkPaint_setEmbeddedBitmapText_useEmbeddedBitmapText'>useEmbeddedBitmapText</a> is false. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1277 | |
| 1278 | ### Parameters |
| 1279 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1280 | <table> <tr> <td><a name='SkPaint_setEmbeddedBitmapText_useEmbeddedBitmapText'><code><strong>useEmbeddedBitmapText</strong></code></a></td> |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 1281 | <td>setting for <a href='#SkPaint_kEmbeddedBitmapText_Flag'>kEmbeddedBitmapText_Flag</a></td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1282 | </tr> |
| 1283 | </table> |
| 1284 | |
| 1285 | ### Example |
| 1286 | |
| 1287 | <div><fiddle-embed name="246dffdd93a484ba4ad7ecf71198a5d4"> |
| 1288 | |
| 1289 | #### Example Output |
| 1290 | |
| 1291 | ~~~~ |
| 1292 | paint1 == paint2 |
| 1293 | ~~~~ |
| 1294 | |
| 1295 | </fiddle-embed></div> |
| 1296 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1297 | <a name='Automatic_Hinting'></a> |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 1298 | |
Cary Clark | 3e73dcf | 2018-12-06 08:41:14 -0500 | [diff] [blame^] | 1299 | If Hinting is set to <a href='undocumented#SkFontHinting'>SkFontHinting</a>::<a href='#SkFontHinting_kNormal'>kNormal</a> or <a href='undocumented#SkFontHinting'>SkFontHinting</a>::<a href='#SkFontHinting_kFull'>kFull</a>, <a href='#Font_Force_Hinting'>Font_Force_Hinting</a> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1300 | instructs the <a href='#Font_Manager'>Font_Manager</a> to always hint <a href='undocumented#Glyph'>Glyphs</a>. |
Cary Clark | 3e73dcf | 2018-12-06 08:41:14 -0500 | [diff] [blame^] | 1301 | <a href='#Font_Force_Hinting'>Font_Force_Hinting</a> has no effect if Hinting is set to <a href='undocumented#SkFontHinting'>SkFontHinting</a>::<a href='#SkFontHinting_kNone'>kNone</a> or |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1302 | <a href='undocumented#SkFontHinting'>SkFontHinting</a>::<a href='#SkFontHinting_kSlight'>kSlight</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1303 | |
Cary Clark | 3e73dcf | 2018-12-06 08:41:14 -0500 | [diff] [blame^] | 1304 | <a href='#Font_Force_Hinting'>Font_Force_Hinting</a> only affects platforms that use FreeType as the <a href='#Font_Manager'>Font_Manager</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1305 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1306 | <a name='SkPaint_isAutohinted'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1307 | |
| 1308 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1309 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1310 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 1311 | bool <a href='#SkPaint_isAutohinted'>isAutohinted</a>()const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1312 | </pre> |
| 1313 | |
Cary Clark | abaffd8 | 2018-11-15 08:25:12 -0500 | [diff] [blame] | 1314 | Returns true if <a href='SkPaint_Reference#SkPaint'>SkPaint</a>::Hinting is set to <a href='undocumented#SkFontHinting'>SkFontHinting</a>::<a href='#SkFontHinting_kNormal'>kNormal</a> or |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 1315 | <a href='undocumented#SkFontHinting'>SkFontHinting</a>::<a href='#SkFontHinting_kFull'>kFull</a>, and if platform uses FreeType as the <a href='SkFont_Reference#Font'>font</a> manager. |
| 1316 | If true, instructs the <a href='SkFont_Reference#Font'>font</a> manager to always hint <a href='undocumented#Glyph'>glyphs</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1317 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1318 | Equivalent to <a href='#SkPaint_getFlags'>getFlags</a>() masked with <a href='#SkPaint_kAutoHinting_Flag'>kAutoHinting_Flag</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1319 | |
| 1320 | ### Return Value |
| 1321 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1322 | <a href='#SkPaint_kAutoHinting_Flag'>kAutoHinting_Flag</a> state |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1323 | |
| 1324 | ### Example |
| 1325 | |
| 1326 | <div><fiddle-embed name="aa4781afbe3b90e7ef56a287e5b9ce1e"> |
| 1327 | |
| 1328 | #### Example Output |
| 1329 | |
| 1330 | ~~~~ |
| 1331 | paint.isAutohinted() == !!(paint.getFlags() & SkPaint::kAutoHinting_Flag) |
| 1332 | paint.isAutohinted() == !!(paint.getFlags() & SkPaint::kAutoHinting_Flag) |
| 1333 | ~~~~ |
| 1334 | |
| 1335 | </fiddle-embed></div> |
| 1336 | |
| 1337 | ### See Also |
| 1338 | |
Cary Clark | abaffd8 | 2018-11-15 08:25:12 -0500 | [diff] [blame] | 1339 | <a href='#SkPaint_setAutohinted'>setAutohinted</a> Hinting |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1340 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1341 | <a name='SkPaint_setAutohinted'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1342 | |
| 1343 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1344 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1345 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1346 | void <a href='#SkPaint_setAutohinted'>setAutohinted</a>(bool useAutohinter) |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1347 | </pre> |
| 1348 | |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 1349 | Sets whether to always hint <a href='undocumented#Glyph'>glyphs</a>. |
Cary Clark | abaffd8 | 2018-11-15 08:25:12 -0500 | [diff] [blame] | 1350 | If <a href='SkPaint_Reference#SkPaint'>SkPaint</a>::Hinting is set to <a href='undocumented#SkFontHinting'>SkFontHinting</a>::<a href='#SkFontHinting_kNormal'>kNormal</a> or <a href='undocumented#SkFontHinting'>SkFontHinting</a>::<a href='#SkFontHinting_kFull'>kFull</a> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1351 | and <a href='#SkPaint_setAutohinted_useAutohinter'>useAutohinter</a> is set, instructs the <a href='undocumented#Font_Manager'>font manager</a> to always hint <a href='undocumented#Glyph'>glyphs</a>. |
Cary Clark | 3e73dcf | 2018-12-06 08:41:14 -0500 | [diff] [blame^] | 1352 | <a href='#SkPaint_setAutohinted_useAutohinter'>useAutohinter</a> has no effect if <a href='SkPaint_Reference#SkPaint'>SkPaint</a>::Hinting is set to <a href='undocumented#SkFontHinting'>SkFontHinting</a>::<a href='#SkFontHinting_kNone'>kNone</a> or |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1353 | <a href='undocumented#SkFontHinting'>SkFontHinting</a>::<a href='#SkFontHinting_kSlight'>kSlight</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1354 | |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 1355 | Only affects platforms that use FreeType as the <a href='undocumented#Font_Manager'>font manager</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1356 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1357 | Sets <a href='#SkPaint_kAutoHinting_Flag'>kAutoHinting_Flag</a> if <a href='#SkPaint_setAutohinted_useAutohinter'>useAutohinter</a> is true. |
| 1358 | Clears <a href='#SkPaint_kAutoHinting_Flag'>kAutoHinting_Flag</a> if <a href='#SkPaint_setAutohinted_useAutohinter'>useAutohinter</a> is false. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1359 | |
| 1360 | ### Parameters |
| 1361 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1362 | <table> <tr> <td><a name='SkPaint_setAutohinted_useAutohinter'><code><strong>useAutohinter</strong></code></a></td> |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 1363 | <td>setting for <a href='#SkPaint_kAutoHinting_Flag'>kAutoHinting_Flag</a></td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1364 | </tr> |
| 1365 | </table> |
| 1366 | |
| 1367 | ### Example |
| 1368 | |
| 1369 | <div><fiddle-embed name="4e185306d7de9390fe8445eed0139309"></fiddle-embed></div> |
| 1370 | |
| 1371 | ### See Also |
| 1372 | |
Cary Clark | abaffd8 | 2018-11-15 08:25:12 -0500 | [diff] [blame] | 1373 | <a href='#SkPaint_isAutohinted'>isAutohinted</a> Hinting |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1374 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1375 | <a name='Fake_Bold'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1376 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1377 | --- |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 1378 | |
Cary Clark | 3e73dcf | 2018-12-06 08:41:14 -0500 | [diff] [blame^] | 1379 | <a href='#Font_Embolden'>Font_Embolden</a> approximates the bold <a href='SkFont_Reference#Font'>font</a> style accompanying a normal <a href='SkFont_Reference#Font'>font</a> when a bold <a href='SkFont_Reference#Font'>font</a> face |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 1380 | is not available. Skia does not provide <a href='SkFont_Reference#Font'>font</a> substitution; it is up to the client to find the |
| 1381 | bold <a href='SkFont_Reference#Font'>font</a> face using the platform <a href='#Font_Manager'>Font_Manager</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1382 | |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 1383 | Use <a href='#Paint_Text_Skew_X'>Text_Skew_X</a> to approximate an italic <a href='SkFont_Reference#Font'>font</a> style when the italic <a href='SkFont_Reference#Font'>font</a> face |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1384 | is not available. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1385 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1386 | A FreeType based port may define SK_USE_FREETYPE_EMBOLDEN at compile time to direct |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 1387 | the <a href='SkFont_Reference#Font_Engine'>font engine</a> to create the bold <a href='undocumented#Glyph'>Glyphs</a>. Otherwise, the extra bold is computed |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1388 | by increasing the <a href='#Stroke_Width'>stroke width</a> and setting the <a href='#SkPaint_Style'>Style</a> to <a href='#SkPaint_kStrokeAndFill_Style'>kStrokeAndFill_Style</a> as needed. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1389 | |
Cary Clark | 3e73dcf | 2018-12-06 08:41:14 -0500 | [diff] [blame^] | 1390 | <a href='#Font_Embolden'>Font_Embolden</a> is disabled by default. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1391 | |
| 1392 | ### Example |
| 1393 | |
| 1394 | <div><fiddle-embed name="e811f4829a2daaaeaad3795504a7e02a"></fiddle-embed></div> |
| 1395 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1396 | <a name='SkPaint_isFakeBoldText'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1397 | |
| 1398 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1399 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1400 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 1401 | bool <a href='#SkPaint_isFakeBoldText'>isFakeBoldText</a>()const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1402 | </pre> |
| 1403 | |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 1404 | Returns true if approximate bold by increasing the stroke width when creating <a href='undocumented#Glyph'>glyph</a> <a href='SkBitmap_Reference#Bitmap'>bitmaps</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1405 | from outlines. |
| 1406 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1407 | Equivalent to <a href='#SkPaint_getFlags'>getFlags</a>() masked with <a href='#SkPaint_kFakeBoldText_Flag'>kFakeBoldText_Flag</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1408 | |
| 1409 | ### Return Value |
| 1410 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1411 | <a href='#SkPaint_kFakeBoldText_Flag'>kFakeBoldText_Flag</a> state |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1412 | |
| 1413 | ### Example |
| 1414 | |
| 1415 | <div><fiddle-embed name="f54d1f85b16073b80b9eef2e1a1d151d"> |
| 1416 | |
| 1417 | #### Example Output |
| 1418 | |
| 1419 | ~~~~ |
| 1420 | paint.isFakeBoldText() == !!(paint.getFlags() & SkPaint::kFakeBoldText_Flag) |
| 1421 | paint.isFakeBoldText() == !!(paint.getFlags() & SkPaint::kFakeBoldText_Flag) |
| 1422 | ~~~~ |
| 1423 | |
| 1424 | </fiddle-embed></div> |
| 1425 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1426 | <a name='SkPaint_setFakeBoldText'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1427 | |
| 1428 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1429 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1430 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1431 | void <a href='#SkPaint_setFakeBoldText'>setFakeBoldText</a>(bool fakeBoldText) |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1432 | </pre> |
| 1433 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1434 | Increases <a href='#Stroke_Width'>stroke width</a> when creating <a href='undocumented#Glyph'>glyph</a> <a href='SkBitmap_Reference#Bitmap'>bitmaps</a> to approximate a bold <a href='undocumented#Typeface'>typeface</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1435 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1436 | Sets <a href='#SkPaint_kFakeBoldText_Flag'>kFakeBoldText_Flag</a> if <a href='#SkPaint_setFakeBoldText_fakeBoldText'>fakeBoldText</a> is true. |
| 1437 | Clears <a href='#SkPaint_kFakeBoldText_Flag'>kFakeBoldText_Flag</a> if <a href='#SkPaint_setFakeBoldText_fakeBoldText'>fakeBoldText</a> is false. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1438 | |
| 1439 | ### Parameters |
| 1440 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1441 | <table> <tr> <td><a name='SkPaint_setFakeBoldText_fakeBoldText'><code><strong>fakeBoldText</strong></code></a></td> |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 1442 | <td>setting for <a href='#SkPaint_kFakeBoldText_Flag'>kFakeBoldText_Flag</a></td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1443 | </tr> |
| 1444 | </table> |
| 1445 | |
| 1446 | ### Example |
| 1447 | |
| 1448 | <div><fiddle-embed name="594d47858eb11028cb626515a520910a"> |
| 1449 | |
| 1450 | #### Example Output |
| 1451 | |
| 1452 | ~~~~ |
| 1453 | paint1 == paint2 |
| 1454 | ~~~~ |
| 1455 | |
| 1456 | </fiddle-embed></div> |
| 1457 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1458 | <a name='Filter_Quality_Methods'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1459 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1460 | --- |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 1461 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1462 | <a href='#Filter_Quality'>Filter_Quality</a> trades speed for <a href='SkImage_Reference#Image'>image</a> filtering when the <a href='SkImage_Reference#Image'>image</a> is scaled. |
| 1463 | A lower <a href='#Filter_Quality'>Filter_Quality</a> draws faster, but has less fidelity. |
| 1464 | A higher <a href='#Filter_Quality'>Filter_Quality</a> draws slower, but looks better. |
| 1465 | If the <a href='SkImage_Reference#Image'>image</a> is drawn without scaling, the <a href='#Filter_Quality'>Filter_Quality</a> choice will not result |
| 1466 | in a noticeable difference. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1467 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1468 | <a href='#Filter_Quality'>Filter_Quality</a> is used in <a href='SkPaint_Reference#Paint'>Paint</a> passed as a parameter to |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1469 | |
| 1470 | <table> <tr> |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 1471 | <td><a href='SkCanvas_Reference#SkCanvas'>SkCanvas</a>::<a href='#SkCanvas_drawBitmap'>drawBitmap</a></td> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1472 | </tr> <tr> |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 1473 | <td><a href='SkCanvas_Reference#SkCanvas'>SkCanvas</a>::<a href='#SkCanvas_drawBitmapRect'>drawBitmapRect</a></td> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1474 | </tr> <tr> |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 1475 | <td><a href='SkCanvas_Reference#SkCanvas'>SkCanvas</a>::<a href='#SkCanvas_drawImage'>drawImage</a></td> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1476 | </tr> <tr> |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 1477 | <td><a href='SkCanvas_Reference#SkCanvas'>SkCanvas</a>::<a href='#SkCanvas_drawImageRect'>drawImageRect</a></td> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1478 | </tr> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1479 | </table> |
| 1480 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1481 | and when <a href='SkPaint_Reference#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>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1482 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1483 | <a href='#Filter_Quality'>Filter_Quality</a> is <a href='undocumented#kNone_SkFilterQuality'>kNone_SkFilterQuality</a> by default. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1484 | |
| 1485 | ### Example |
| 1486 | |
skia-bookmaker | 525f9a9 | 2018-05-03 06:27:39 +0000 | [diff] [blame] | 1487 | <div><fiddle-embed name="69369cff2f5b145a6f616092513266a0"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1488 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1489 | <a name='SkPaint_getFilterQuality'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1490 | |
| 1491 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1492 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1493 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 1494 | <a href='undocumented#SkFilterQuality'>SkFilterQuality</a> <a href='#SkPaint_getFilterQuality'>getFilterQuality</a>()const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1495 | </pre> |
| 1496 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1497 | Returns <a href='undocumented#SkFilterQuality'>SkFilterQuality</a>, the <a href='SkImage_Reference#Image'>image</a> filtering level. A lower setting |
| 1498 | draws faster; a higher setting looks better when the <a href='SkImage_Reference#Image'>image</a> is scaled. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1499 | |
| 1500 | ### Return Value |
| 1501 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1502 | one of: <a href='undocumented#kNone_SkFilterQuality'>kNone_SkFilterQuality</a>, <a href='undocumented#kLow_SkFilterQuality'>kLow_SkFilterQuality</a>, |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 1503 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1504 | <a href='undocumented#kMedium_SkFilterQuality'>kMedium_SkFilterQuality</a>, <a href='undocumented#kHigh_SkFilterQuality'>kHigh_SkFilterQuality</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1505 | |
| 1506 | ### Example |
| 1507 | |
| 1508 | <div><fiddle-embed name="d4ca1f23809b6835c4ba46ea98a86900"> |
| 1509 | |
| 1510 | #### Example Output |
| 1511 | |
| 1512 | ~~~~ |
| 1513 | kNone_SkFilterQuality == paint.getFilterQuality() |
| 1514 | ~~~~ |
| 1515 | |
| 1516 | </fiddle-embed></div> |
| 1517 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1518 | <a name='SkPaint_setFilterQuality'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1519 | |
| 1520 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1521 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1522 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1523 | void <a href='#SkPaint_setFilterQuality'>setFilterQuality</a>(<a href='undocumented#SkFilterQuality'>SkFilterQuality</a> quality) |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1524 | </pre> |
| 1525 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1526 | Sets <a href='undocumented#SkFilterQuality'>SkFilterQuality</a>, the <a href='SkImage_Reference#Image'>image</a> filtering level. A lower setting |
| 1527 | draws faster; a higher setting looks better when the <a href='SkImage_Reference#Image'>image</a> is scaled. |
| 1528 | Does not check to see if <a href='#SkPaint_setFilterQuality_quality'>quality</a> is valid. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1529 | |
| 1530 | ### Parameters |
| 1531 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1532 | <table> <tr> <td><a name='SkPaint_setFilterQuality_quality'><code><strong>quality</strong></code></a></td> |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 1533 | <td>one of: <a href='undocumented#kNone_SkFilterQuality'>kNone_SkFilterQuality</a>, <a href='undocumented#kLow_SkFilterQuality'>kLow_SkFilterQuality</a>,</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1534 | </tr> |
| 1535 | </table> |
| 1536 | |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 1537 | <a href='undocumented#kMedium_SkFilterQuality'>kMedium_SkFilterQuality</a>, <a href='undocumented#kHigh_SkFilterQuality'>kHigh_SkFilterQuality</a> |
| 1538 | |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1539 | ### Example |
| 1540 | |
| 1541 | <div><fiddle-embed name="e4288fabf24ee60b645e8bb6ea0afadf"> |
| 1542 | |
| 1543 | #### Example Output |
| 1544 | |
| 1545 | ~~~~ |
| 1546 | kHigh_SkFilterQuality == paint.getFilterQuality() |
| 1547 | ~~~~ |
| 1548 | |
| 1549 | </fiddle-embed></div> |
| 1550 | |
| 1551 | ### See Also |
| 1552 | |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 1553 | <a href='undocumented#SkFilterQuality'>SkFilterQuality</a> <a href='#Image_Scaling'>Image_Scaling</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1554 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1555 | <a name='Color_Methods'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1556 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1557 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1558 | |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 1559 | | name | description | |
| 1560 | | --- | --- | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1561 | | <a href='#SkPaint_getColor'>getColor</a> | returns <a href='#Color_Alpha'>Color_Alpha</a> and RGB, one drawing <a href='SkColor_Reference#Color'>color</a> | |
| 1562 | | <a href='#SkPaint_setColor'>setColor</a> | sets <a href='#Color_Alpha'>Color_Alpha</a> and RGB, one drawing <a href='SkColor_Reference#Color'>color</a> | |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1563 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1564 | <a href='SkColor_Reference#Color'>Color</a> specifies the red, blue, green, and <a href='#Color_Alpha'>Color_Alpha</a> |
| 1565 | values used to draw a filled or stroked shape in a 32-bit value. Each component |
| 1566 | occupies 8-bits, ranging from zero: no contribution; to 255: full intensity. |
| 1567 | All values in any combination are valid. |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 1568 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1569 | <a href='SkColor_Reference#Color'>Color</a> is not <a href='undocumented#Premultiply'>Premultiplied</a>; <a href='#Color_Alpha'>Color_Alpha</a> sets the transparency independent of |
| 1570 | RGB: red, blue, and green. |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 1571 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1572 | The bit positions of <a href='#Color_Alpha'>Color_Alpha</a> and RGB are independent of the bit |
| 1573 | positions on the output <a href='undocumented#Device'>device</a>, which may have more or fewer bits, and may have |
| 1574 | a different arrangement. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1575 | |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 1576 | | bit positions | <a href='#Color_Alpha'>Color_Alpha</a> | red | blue | green | |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1577 | | --- | --- | --- | --- | --- | |
| 1578 | | | 31 - 24 | 23 - 16 | 15 - 8 | 7 - 0 | |
| 1579 | |
| 1580 | ### Example |
| 1581 | |
Ravi Mistry | 874e22b | 2018-07-19 03:49:13 +0000 | [diff] [blame] | 1582 | <div><fiddle-embed name="214b559d75c65a7bef6ef4be1f860053"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1583 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1584 | <a name='SkPaint_getColor'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1585 | |
| 1586 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1587 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1588 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 1589 | <a href='SkColor_Reference#SkColor'>SkColor</a> <a href='#SkPaint_getColor'>getColor</a>()const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1590 | </pre> |
| 1591 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1592 | Retrieves <a href='SkColor_Reference#Alpha'>alpha</a> and RGB, <a href='undocumented#Unpremultiply'>unpremultiplied</a>, packed into 32 bits. |
| 1593 | Use helpers <a href='SkColor_Reference#SkColorGetA'>SkColorGetA</a>(), <a href='SkColor_Reference#SkColorGetR'>SkColorGetR</a>(), <a href='SkColor_Reference#SkColorGetG'>SkColorGetG</a>(), and <a href='SkColor_Reference#SkColorGetB'>SkColorGetB</a>() to extract |
| 1594 | a <a href='SkColor_Reference#Color'>color</a> component. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1595 | |
| 1596 | ### Return Value |
| 1597 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1598 | <a href='undocumented#Unpremultiply'>unpremultiplied</a> ARGB |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1599 | |
| 1600 | ### Example |
| 1601 | |
skia-bookmaker | 61cc9fa | 2018-07-11 05:28:17 +0000 | [diff] [blame] | 1602 | <div><fiddle-embed name="72d41f890203109a41f589a7403acae9"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1603 | |
| 1604 | #### Example Output |
| 1605 | |
| 1606 | ~~~~ |
| 1607 | Yellow is 100% red, 100% green, and 0% blue. |
| 1608 | ~~~~ |
| 1609 | |
| 1610 | </fiddle-embed></div> |
| 1611 | |
| 1612 | ### See Also |
| 1613 | |
Cary Clark | bbe8ff9 | 2018-09-05 11:39:01 -0400 | [diff] [blame] | 1614 | <a href='#SkPaint_getColor4f'>getColor4f</a> <a href='SkColor_Reference#SkColor'>SkColor</a> |
| 1615 | |
Cary Clark | bbe8ff9 | 2018-09-05 11:39:01 -0400 | [diff] [blame] | 1616 | <a name='SkPaint_getColor4f'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1617 | |
| 1618 | --- |
Cary Clark | bbe8ff9 | 2018-09-05 11:39:01 -0400 | [diff] [blame] | 1619 | |
| 1620 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 1621 | <a href='SkColor4f_Reference#SkColor4f'>SkColor4f</a> <a href='#SkPaint_getColor4f'>getColor4f</a>()const |
Cary Clark | bbe8ff9 | 2018-09-05 11:39:01 -0400 | [diff] [blame] | 1622 | </pre> |
| 1623 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1624 | Retrieves <a href='SkColor_Reference#Alpha'>alpha</a> and RGB, <a href='undocumented#Unpremultiply'>unpremultiplied</a>, as four floating <a href='SkPoint_Reference#Point'>point</a> values. RGB are |
Cary Clark | bbe8ff9 | 2018-09-05 11:39:01 -0400 | [diff] [blame] | 1625 | are extended sRGB values (sRGB gamut, and encoded with the sRGB transfer function). |
| 1626 | |
| 1627 | ### Return Value |
| 1628 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1629 | <a href='undocumented#Unpremultiply'>unpremultiplied</a> RGBA |
Cary Clark | bbe8ff9 | 2018-09-05 11:39:01 -0400 | [diff] [blame] | 1630 | |
| 1631 | ### Example |
| 1632 | |
| 1633 | <div><fiddle-embed name="8512ea2176f36e8f1aeef311ff228790"> |
| 1634 | |
| 1635 | #### Example Output |
| 1636 | |
| 1637 | ~~~~ |
| 1638 | Yellow is 100% red, 100% green, and 0% blue. |
| 1639 | ~~~~ |
| 1640 | |
| 1641 | </fiddle-embed></div> |
| 1642 | |
| 1643 | ### See Also |
| 1644 | |
| 1645 | <a href='#SkPaint_getColor'>getColor</a> <a href='SkColor_Reference#SkColor'>SkColor</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1646 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1647 | <a name='SkPaint_setColor'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1648 | |
| 1649 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1650 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1651 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 1652 | void <a href='#SkPaint_setColor'>setColor</a>(<a href='SkColor_Reference#SkColor'>SkColor</a> <a href='SkColor_Reference#Color'>color</a>) |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1653 | </pre> |
| 1654 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1655 | Sets <a href='SkColor_Reference#Alpha'>alpha</a> and RGB used when stroking and filling. The <a href='#SkPaint_setColor_color'>color</a> is a 32-bit value, |
| 1656 | <a href='undocumented#Unpremultiply'>unpremultiplied</a>, packing 8-bit components for <a href='SkColor_Reference#Alpha'>alpha</a>, red, blue, and green. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1657 | |
| 1658 | ### Parameters |
| 1659 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1660 | <table> <tr> <td><a name='SkPaint_setColor_color'><code><strong>color</strong></code></a></td> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1661 | <td><a href='undocumented#Unpremultiply'>unpremultiplied</a> ARGB</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1662 | </tr> |
| 1663 | </table> |
| 1664 | |
| 1665 | ### Example |
| 1666 | |
skia-bookmaker | 233c652 | 2018-07-04 05:33:26 +0000 | [diff] [blame] | 1667 | <div><fiddle-embed name="6e70f18300bd676a3c056ceb6b62f8df"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1668 | |
| 1669 | #### Example Output |
| 1670 | |
| 1671 | ~~~~ |
| 1672 | green1 == green2 |
| 1673 | ~~~~ |
| 1674 | |
| 1675 | </fiddle-embed></div> |
| 1676 | |
| 1677 | ### See Also |
| 1678 | |
Cary Clark | bbe8ff9 | 2018-09-05 11:39:01 -0400 | [diff] [blame] | 1679 | <a href='SkColor_Reference#SkColor'>SkColor</a> <a href='#SkPaint_setColor4f'>setColor4f</a> <a href='#SkPaint_setARGB'>setARGB</a> <a href='SkColor_Reference#SkColorSetARGB'>SkColorSetARGB</a> |
| 1680 | |
Cary Clark | bbe8ff9 | 2018-09-05 11:39:01 -0400 | [diff] [blame] | 1681 | <a name='SkPaint_setColor4f'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1682 | |
| 1683 | --- |
Cary Clark | bbe8ff9 | 2018-09-05 11:39:01 -0400 | [diff] [blame] | 1684 | |
| 1685 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1686 | void <a href='#SkPaint_setColor4f'>setColor4f</a>(const <a href='SkColor4f_Reference#SkColor4f'>SkColor4f</a>& <a href='SkColor_Reference#Color'>color</a>, <a href='undocumented#SkColorSpace'>SkColorSpace</a>* colorSpace) |
Cary Clark | bbe8ff9 | 2018-09-05 11:39:01 -0400 | [diff] [blame] | 1687 | </pre> |
| 1688 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1689 | Sets <a href='SkColor_Reference#Alpha'>alpha</a> and RGB used when stroking and filling. The <a href='#SkPaint_setColor4f_color'>color</a> is four floating |
| 1690 | <a href='SkPoint_Reference#Point'>point</a> values, <a href='undocumented#Unpremultiply'>unpremultiplied</a>. The <a href='#SkPaint_setColor4f_color'>color</a> values are interpreted as being in |
| 1691 | the <a href='#SkPaint_setColor4f_colorSpace'>colorSpace</a>. If <a href='#SkPaint_setColor4f_colorSpace'>colorSpace</a> is nullptr, then <a href='#SkPaint_setColor4f_color'>color</a> is assumed to be in the |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 1692 | sRGB <a href='undocumented#Color_Space'>color space</a>. |
Cary Clark | bbe8ff9 | 2018-09-05 11:39:01 -0400 | [diff] [blame] | 1693 | |
| 1694 | ### Parameters |
| 1695 | |
| 1696 | <table> <tr> <td><a name='SkPaint_setColor4f_color'><code><strong>color</strong></code></a></td> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1697 | <td><a href='undocumented#Unpremultiply'>unpremultiplied</a> RGBA</td> |
Cary Clark | bbe8ff9 | 2018-09-05 11:39:01 -0400 | [diff] [blame] | 1698 | </tr> |
| 1699 | <tr> <td><a name='SkPaint_setColor4f_colorSpace'><code><strong>colorSpace</strong></code></a></td> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1700 | <td><a href='undocumented#SkColorSpace'>SkColorSpace</a> describing the encoding of <a href='#SkPaint_setColor4f_color'>color</a></td> |
Cary Clark | bbe8ff9 | 2018-09-05 11:39:01 -0400 | [diff] [blame] | 1701 | </tr> |
| 1702 | </table> |
| 1703 | |
| 1704 | ### Example |
| 1705 | |
| 1706 | <div><fiddle-embed name="fa60859e3d03bdc117a05b32e093a8f1"> |
| 1707 | |
| 1708 | #### Example Output |
| 1709 | |
| 1710 | ~~~~ |
| 1711 | green1 == green2 |
| 1712 | ~~~~ |
| 1713 | |
| 1714 | </fiddle-embed></div> |
| 1715 | |
| 1716 | ### See Also |
| 1717 | |
| 1718 | <a href='SkColor_Reference#SkColor'>SkColor</a> <a href='#SkPaint_setColor'>setColor</a> <a href='#SkPaint_setARGB'>setARGB</a> <a href='SkColor_Reference#SkColorSetARGB'>SkColorSetARGB</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1719 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1720 | <a name='Alpha_Methods'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1721 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1722 | <a href='#Color_Alpha'>Color_Alpha</a> sets the transparency independent of RGB: red, blue, and green. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1723 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1724 | <a name='SkPaint_getAlpha'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1725 | |
| 1726 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1727 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1728 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 1729 | uint8_t <a href='#SkPaint_getAlpha'>getAlpha</a>()const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1730 | </pre> |
| 1731 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1732 | Retrieves <a href='SkColor_Reference#Alpha'>alpha</a> from the <a href='SkColor_Reference#Color'>color</a> used when stroking and filling. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1733 | |
| 1734 | ### Return Value |
| 1735 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1736 | <a href='SkColor_Reference#Alpha'>alpha</a> ranging from zero, fully transparent, to 255, fully opaque |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1737 | |
| 1738 | ### Example |
| 1739 | |
Cary Clark | 8364706 | 2018-07-18 16:21:51 -0400 | [diff] [blame] | 1740 | <div><fiddle-embed name="9a85bb62fe3d877b18fb7f952c4fa7f7"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1741 | |
| 1742 | #### Example Output |
| 1743 | |
| 1744 | ~~~~ |
| 1745 | 255 == paint.getAlpha() |
| 1746 | ~~~~ |
| 1747 | |
| 1748 | </fiddle-embed></div> |
| 1749 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1750 | <a name='SkPaint_setAlpha'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1751 | |
| 1752 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1753 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1754 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1755 | void <a href='#SkPaint_setAlpha'>setAlpha</a>(<a href='undocumented#U8CPU'>U8CPU</a> a) |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1756 | </pre> |
| 1757 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1758 | Replaces <a href='SkColor_Reference#Alpha'>alpha</a>, leaving RGB |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1759 | unchanged. An out of range value triggers an assert in the debug |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1760 | build. <a href='#SkPaint_setAlpha_a'>a</a> is <a href='#SkPaint_setAlpha_a'>a</a> value from zero to 255. |
| 1761 | <a href='#SkPaint_setAlpha_a'>a</a> set to zero makes <a href='SkColor_Reference#Color'>color</a> fully transparent; <a href='#SkPaint_setAlpha_a'>a</a> set to 255 makes <a href='SkColor_Reference#Color'>color</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1762 | fully opaque. |
| 1763 | |
| 1764 | ### Parameters |
| 1765 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1766 | <table> <tr> <td><a name='SkPaint_setAlpha_a'><code><strong>a</strong></code></a></td> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1767 | <td><a href='SkColor_Reference#Alpha'>alpha</a> component of <a href='SkColor_Reference#Color'>color</a></td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1768 | </tr> |
| 1769 | </table> |
| 1770 | |
| 1771 | ### Example |
| 1772 | |
Ravi Mistry | 874e22b | 2018-07-19 03:49:13 +0000 | [diff] [blame] | 1773 | <div><fiddle-embed name="6ddc0360512dfb9947e75c17e6a8103d"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1774 | |
| 1775 | #### Example Output |
| 1776 | |
| 1777 | ~~~~ |
| 1778 | 0x44112233 == paint.getColor() |
| 1779 | ~~~~ |
| 1780 | |
| 1781 | </fiddle-embed></div> |
| 1782 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1783 | <a name='SkPaint_setARGB'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1784 | |
| 1785 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1786 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1787 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1788 | void <a href='#SkPaint_setARGB'>setARGB</a>(<a href='undocumented#U8CPU'>U8CPU</a> a, <a href='undocumented#U8CPU'>U8CPU</a> r, <a href='undocumented#U8CPU'>U8CPU</a> g, <a href='undocumented#U8CPU'>U8CPU</a> b) |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1789 | </pre> |
| 1790 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1791 | Sets <a href='SkColor_Reference#Color'>color</a> used when drawing solid fills. The <a href='SkColor_Reference#Color'>color</a> components range from 0 to 255. |
| 1792 | The <a href='SkColor_Reference#Color'>color</a> is <a href='undocumented#Unpremultiply'>unpremultiplied</a>; <a href='SkColor_Reference#Alpha'>alpha</a> sets the transparency independent of RGB. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1793 | |
| 1794 | ### Parameters |
| 1795 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1796 | <table> <tr> <td><a name='SkPaint_setARGB_a'><code><strong>a</strong></code></a></td> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1797 | <td>amount of <a href='SkColor_Reference#Alpha'>alpha</a>, from fully transparent (0) to fully opaque (255)</td> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1798 | </tr> |
| 1799 | <tr> <td><a name='SkPaint_setARGB_r'><code><strong>r</strong></code></a></td> |
Cary Clark | ffb3d68 | 2018-05-17 12:17:28 -0400 | [diff] [blame] | 1800 | <td>amount of red, from no red (0) to full red (255)</td> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1801 | </tr> |
| 1802 | <tr> <td><a name='SkPaint_setARGB_g'><code><strong>g</strong></code></a></td> |
Cary Clark | ffb3d68 | 2018-05-17 12:17:28 -0400 | [diff] [blame] | 1803 | <td>amount of green, from no green (0) to full green (255)</td> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1804 | </tr> |
| 1805 | <tr> <td><a name='SkPaint_setARGB_b'><code><strong>b</strong></code></a></td> |
Cary Clark | ffb3d68 | 2018-05-17 12:17:28 -0400 | [diff] [blame] | 1806 | <td>amount of blue, from no blue (0) to full blue (255)</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1807 | </tr> |
| 1808 | </table> |
| 1809 | |
| 1810 | ### Example |
| 1811 | |
skia-bookmaker | 61cc9fa | 2018-07-11 05:28:17 +0000 | [diff] [blame] | 1812 | <div><fiddle-embed name="cb62e4755789ed32f7120dc55984959d"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1813 | |
| 1814 | #### Example Output |
| 1815 | |
| 1816 | ~~~~ |
| 1817 | transRed1 == transRed2 |
| 1818 | ~~~~ |
| 1819 | |
| 1820 | </fiddle-embed></div> |
| 1821 | |
| 1822 | ### See Also |
| 1823 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1824 | <a href='#SkPaint_setColor'>setColor</a> <a href='SkColor_Reference#SkColorSetARGB'>SkColorSetARGB</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1825 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1826 | <a name='Style'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1827 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1828 | --- |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 1829 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1830 | <a href='#SkPaint_Style'>Style</a> specifies if the geometry is filled, stroked, or both filled and stroked. |
| 1831 | Some shapes ignore <a href='#SkPaint_Style'>Style</a> and are always drawn filled or stroked. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1832 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1833 | <a name='Style_Fill'></a> |
| 1834 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1835 | Set <a href='#SkPaint_Style'>Style</a> to <a href='#SkPaint_kFill_Style'>kFill_Style</a> to fill the shape. |
| 1836 | The fill covers the area inside the geometry for most shapes. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1837 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1838 | <a name='Style_Stroke'></a> |
| 1839 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1840 | Set <a href='#SkPaint_Style'>Style</a> to <a href='#SkPaint_kStroke_Style'>kStroke_Style</a> to stroke the shape. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1841 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1842 | The stroke covers the area described by following the shape edge with a pen or brush of |
| 1843 | <a href='#Paint_Stroke_Width'>Stroke_Width</a>. The area covered where the shape starts and stops is described by <a href='#Paint_Stroke_Cap'>Stroke_Cap</a>. |
| 1844 | The area covered where the shape turns a corner is described by <a href='#Paint_Stroke_Join'>Stroke_Join</a>. |
| 1845 | The stroke is centered on the shape; it extends equally on either side of the shape edge.As <a href='#Paint_Stroke_Width'>Stroke_Width</a> gets smaller, the drawn <a href='SkPath_Reference#Path'>path</a> frame is thinner. <a href='#Paint_Stroke_Width'>Stroke_Width</a> less than one |
| 1846 | may have gaps, and if <a href='#SkPaint_kAntiAlias_Flag'>kAntiAlias_Flag</a> is set, <a href='#Color_Alpha'>Color_Alpha</a> will increase to visually decrease coverage. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1847 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1848 | ### See Also |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1849 | |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 1850 | <a href='#Path_Fill_Type'>Path_Fill_Type</a> <a href='#Path_Effect'>Path_Effect</a> <a href='#Paint_Style_Fill'>Style_Fill</a> <a href='#Paint_Style_Stroke'>Style_Stroke</a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1851 | |
| 1852 | <a name='Hairline'></a> |
| 1853 | |
| 1854 | --- |
| 1855 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1856 | <a href='#Paint_Stroke_Width'>Stroke_Width</a> of zero has a special meaning and switches drawing to use Hairline. |
| 1857 | Hairline draws the thinnest continuous frame. If <a href='#SkPaint_kAntiAlias_Flag'>kAntiAlias_Flag</a> is clear, adjacent pixels |
| 1858 | flow horizontally, vertically,or diagonally. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1859 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1860 | <a href='SkPath_Reference#Path'>Path</a> drawing with Hairline may hit the same <a href='undocumented#Pixel'>pixel</a> more than once. For instance, <a href='SkPath_Reference#Path'>Path</a> containing |
| 1861 | two <a href='undocumented#Line'>lines</a> in one <a href='#Path_Overview_Contour'>Path_Contour</a> will draw the corner <a href='SkPoint_Reference#Point'>point</a> once, but may both <a href='undocumented#Line'>lines</a> may draw the adjacent |
| 1862 | <a href='undocumented#Pixel'>pixel</a>. If <a href='#SkPaint_kAntiAlias_Flag'>kAntiAlias_Flag</a> is set, transparency is applied twice, resulting in a darker <a href='undocumented#Pixel'>pixel</a>. Some |
| 1863 | GPU-backed implementations apply transparency at a later drawing stage, avoiding double hit pixels |
| 1864 | while stroking. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1865 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1866 | ### See Also |
| 1867 | |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 1868 | <a href='#Path_Fill_Type'>Path_Fill_Type</a> <a href='#Path_Effect'>Path_Effect</a> <a href='#Paint_Style_Fill'>Style_Fill</a> <a href='#Paint_Style_Stroke'>Style_Stroke</a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1869 | |
| 1870 | <a name='SkPaint_Style'></a> |
| 1871 | |
| 1872 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1873 | |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 1874 | <pre style="padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0"> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1875 | enum <a href='#SkPaint_Style'>Style</a> : uint8_t { |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 1876 | <a href='#SkPaint_kFill_Style'>kFill_Style</a>, |
| 1877 | <a href='#SkPaint_kStroke_Style'>kStroke_Style</a>, |
| 1878 | <a href='#SkPaint_kStrokeAndFill_Style'>kStrokeAndFill_Style</a>, |
Cary Clark | 186d08f | 2018-04-03 08:43:27 -0400 | [diff] [blame] | 1879 | }; |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 1880 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1881 | </pre> |
Cary Clark | d98f78c | 2018-04-26 08:32:37 -0400 | [diff] [blame] | 1882 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1883 | <pre style="padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0"> |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 1884 | static constexpr int <a href='#SkPaint_kStyleCount'>kStyleCount</a> = <a href='#SkPaint_kStrokeAndFill_Style'>kStrokeAndFill_Style</a> + 1; |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 1885 | </pre> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1886 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1887 | Set <a href='#SkPaint_Style'>Style</a> to fill, stroke, or both fill and stroke geometry. |
| 1888 | The stroke and fill |
| 1889 | share all <a href='SkPaint_Reference#Paint'>paint</a> attributes; for instance, they are drawn with the same <a href='SkColor_Reference#Color'>color</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1890 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1891 | Use <a href='#SkPaint_kStrokeAndFill_Style'>kStrokeAndFill_Style</a> to avoid hitting the same pixels twice with a stroke draw and |
| 1892 | a fill draw. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1893 | |
| 1894 | ### Constants |
| 1895 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1896 | <table style='border-collapse: collapse; width: 62.5em'> |
| 1897 | <tr><th style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>Const</th> |
| 1898 | <th style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>Value</th> |
| 1899 | <th style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>Description</th></tr> |
| 1900 | <tr style='background-color: #f0f0f0; '> |
| 1901 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kFill_Style'><code>SkPaint::kFill_Style</code></a></td> |
| 1902 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>0</td> |
| 1903 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1904 | Applies to <a href='SkRect_Reference#Rect'>Rect</a>, <a href='SkRegion_Reference#Region'>Region</a>, <a href='#RRect'>Round_Rect</a>, <a href='undocumented#Circle'>Circles</a>, <a href='undocumented#Oval'>Ovals</a>, <a href='SkPath_Reference#Path'>Path</a>, and <a href='undocumented#Text'>Text</a>. |
| 1905 | <a href='SkBitmap_Reference#Bitmap'>Bitmap</a>, <a href='SkImage_Reference#Image'>Image</a>, <a href='undocumented#Patch'>Patches</a>, <a href='SkRegion_Reference#Region'>Region</a>, <a href='undocumented#Sprite'>Sprites</a>, and <a href='undocumented#Vertices'>Vertices</a> are painted as if |
| 1906 | <a href='#SkPaint_kFill_Style'>kFill_Style</a> is set, and ignore the set <a href='#SkPaint_Style'>Style</a>. |
| 1907 | The <a href='#Path_Fill_Type'>Path_Fill_Type</a> specifies additional rules to fill the area outside the <a href='SkPath_Reference#Path'>path</a> edge, |
| 1908 | and to create an unfilled hole inside the shape. |
| 1909 | <a href='#SkPaint_Style'>Style</a> is set to <a href='#SkPaint_kFill_Style'>kFill_Style</a> by default. |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 1910 | </td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1911 | </tr> |
| 1912 | <tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1913 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kStroke_Style'><code>SkPaint::kStroke_Style</code></a></td> |
| 1914 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>1</td> |
| 1915 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1916 | Applies to <a href='SkRect_Reference#Rect'>Rect</a>, <a href='SkRegion_Reference#Region'>Region</a>, <a href='#RRect'>Round_Rect</a>, <a href='undocumented#Arc'>Arcs</a>, <a href='undocumented#Circle'>Circles</a>, <a href='undocumented#Oval'>Ovals</a>, <a href='SkPath_Reference#Path'>Path</a>, and <a href='undocumented#Text'>Text</a>. |
| 1917 | <a href='undocumented#Arc'>Arcs</a>, <a href='undocumented#Line'>Lines</a>, and <a href='SkPoint_Reference#Point'>points</a>, are always drawn as if <a href='#SkPaint_kStroke_Style'>kStroke_Style</a> is set, |
| 1918 | and ignore the set <a href='#SkPaint_Style'>Style</a>. |
| 1919 | The stroke construction is unaffected by the <a href='#Path_Fill_Type'>Path_Fill_Type</a>. |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1920 | </td> |
| 1921 | </tr> |
| 1922 | <tr style='background-color: #f0f0f0; '> |
| 1923 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kStrokeAndFill_Style'><code>SkPaint::kStrokeAndFill_Style</code></a></td> |
| 1924 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>2</td> |
| 1925 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1926 | Applies to <a href='SkRect_Reference#Rect'>Rect</a>, <a href='SkRegion_Reference#Region'>Region</a>, <a href='#RRect'>Round_Rect</a>, <a href='undocumented#Circle'>Circles</a>, <a href='undocumented#Oval'>Ovals</a>, <a href='SkPath_Reference#Path'>Path</a>, and <a href='undocumented#Text'>Text</a>. |
| 1927 | <a href='SkPath_Reference#Path'>Path</a> is treated as if it is set to <a href='SkPath_Reference#SkPath'>SkPath</a>::<a href='#SkPath_kWinding_FillType'>kWinding_FillType</a>, |
| 1928 | and the set <a href='#Path_Fill_Type'>Path_Fill_Type</a> is ignored. |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 1929 | </td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1930 | </tr> |
| 1931 | <tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1932 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kStyleCount'><code>SkPaint::kStyleCount</code></a></td> |
| 1933 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>3</td> |
| 1934 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1935 | May be used to verify that <a href='#SkPaint_Style'>Style</a> is a legal value. |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 1936 | </td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1937 | </tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1938 | </table> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1939 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1940 | <a name='SkPaint_getStyle'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1941 | |
| 1942 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1943 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1944 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 1945 | <a href='#SkPaint_Style'>Style</a> <a href='#SkPaint_getStyle'>getStyle</a>()const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1946 | </pre> |
| 1947 | |
Cary Clark | 80247e5 | 2018-07-11 16:18:41 -0400 | [diff] [blame] | 1948 | Returns whether the geometry is filled, stroked, or filled and stroked. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1949 | |
| 1950 | ### Return Value |
| 1951 | |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 1952 | 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> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1953 | |
| 1954 | ### Example |
| 1955 | |
| 1956 | <div><fiddle-embed name="1c5e18c3c0102d2dac86a78ba8c8ce01"> |
| 1957 | |
| 1958 | #### Example Output |
| 1959 | |
| 1960 | ~~~~ |
| 1961 | SkPaint::kFill_Style == paint.getStyle() |
| 1962 | ~~~~ |
| 1963 | |
| 1964 | </fiddle-embed></div> |
| 1965 | |
| 1966 | ### See Also |
| 1967 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1968 | <a href='#SkPaint_Style'>Style</a> <a href='#SkPaint_setStyle'>setStyle</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1969 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1970 | <a name='SkPaint_setStyle'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1971 | |
| 1972 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1973 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1974 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1975 | void <a href='#SkPaint_setStyle'>setStyle</a>(<a href='#SkPaint_Style'>Style</a> style) |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1976 | </pre> |
| 1977 | |
| 1978 | Sets whether the geometry is filled, stroked, or filled and stroked. |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1979 | Has no effect if <a href='#SkPaint_setStyle_style'>style</a> is not a legal <a href='SkPaint_Reference#SkPaint'>SkPaint</a>::<a href='#SkPaint_Style'>Style</a> value. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1980 | |
| 1981 | ### Parameters |
| 1982 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1983 | <table> <tr> <td><a name='SkPaint_setStyle_style'><code><strong>style</strong></code></a></td> |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 1984 | <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> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1985 | </tr> |
| 1986 | </table> |
| 1987 | |
| 1988 | ### Example |
| 1989 | |
| 1990 | <div><fiddle-embed name="c7bb6248e4735b8d1a32d02fba40d344"></fiddle-embed></div> |
| 1991 | |
| 1992 | ### See Also |
| 1993 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1994 | <a href='#SkPaint_Style'>Style</a> <a href='#SkPaint_getStyle'>getStyle</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1995 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1996 | <a name='Stroke_Width'></a> |
| 1997 | |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1998 | --- |
| 1999 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2000 | <a href='#Paint_Stroke_Width'>Stroke_Width</a> sets the width for stroking. The width is the thickness |
| 2001 | of the stroke perpendicular to the <a href='SkPath_Reference#Path_Direction'>path direction</a> when the <a href='SkPaint_Reference#Paint'>paint style</a> is |
| 2002 | set to <a href='#SkPaint_kStroke_Style'>kStroke_Style</a> or <a href='#SkPaint_kStrokeAndFill_Style'>kStrokeAndFill_Style</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2003 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2004 | When width is greater than zero, the stroke encompasses as many pixels partially |
| 2005 | or fully as needed. When the width equals zero, the <a href='SkPaint_Reference#Paint'>paint</a> enables hairlines; |
| 2006 | the stroke is always one <a href='undocumented#Pixel'>pixel</a> wide. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2007 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2008 | The stroke dimensions are scaled by the <a href='SkCanvas_Reference#Canvas_Matrix'>canvas matrix</a>, but Hairline stroke |
| 2009 | remains one <a href='undocumented#Pixel'>pixel</a> wide regardless of scaling. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2010 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2011 | The default width for the <a href='SkPaint_Reference#Paint'>paint</a> is zero. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2012 | |
| 2013 | ### Example |
| 2014 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2015 | <div><fiddle-embed name="5112c7209a19e035c61cef33a624a652" gpu="true"><div>The pixels hit to represent thin <a href='undocumented#Line'>lines</a> vary with the angle of the |
| 2016 | <a href='undocumented#Line'>line</a> and the platform implementation. |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 2017 | </div></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2018 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2019 | <a name='SkPaint_getStrokeWidth'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2020 | |
| 2021 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2022 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2023 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 2024 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_getStrokeWidth'>getStrokeWidth</a>()const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2025 | </pre> |
| 2026 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2027 | Returns the thickness of the pen used by <a href='SkPaint_Reference#SkPaint'>SkPaint</a> to |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2028 | outline the shape. |
| 2029 | |
| 2030 | ### Return Value |
| 2031 | |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 2032 | zero for hairline, greater than zero for pen thickness |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2033 | |
| 2034 | ### Example |
| 2035 | |
skia-bookmaker | b95bbba | 2018-07-06 05:23:23 +0000 | [diff] [blame] | 2036 | <div><fiddle-embed name="99aa73f64df8bbf06e656cd891a81b9e"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2037 | |
| 2038 | #### Example Output |
| 2039 | |
| 2040 | ~~~~ |
| 2041 | 0 == paint.getStrokeWidth() |
| 2042 | ~~~~ |
| 2043 | |
| 2044 | </fiddle-embed></div> |
| 2045 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2046 | <a name='SkPaint_setStrokeWidth'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2047 | |
| 2048 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2049 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2050 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2051 | void <a href='#SkPaint_setStrokeWidth'>setStrokeWidth</a>(<a href='undocumented#SkScalar'>SkScalar</a> width) |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2052 | </pre> |
| 2053 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2054 | Sets the thickness of the pen used by the <a href='SkPaint_Reference#Paint'>paint</a> to |
Cary Clark | 7cfcbca | 2018-01-04 16:11:51 -0500 | [diff] [blame] | 2055 | outline the shape. |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2056 | Has no effect if <a href='#SkPaint_setStrokeWidth_width'>width</a> is less than zero. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2057 | |
| 2058 | ### Parameters |
| 2059 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2060 | <table> <tr> <td><a name='SkPaint_setStrokeWidth_width'><code><strong>width</strong></code></a></td> |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 2061 | <td>zero thickness for hairline; greater than zero for pen thickness</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2062 | </tr> |
| 2063 | </table> |
| 2064 | |
| 2065 | ### Example |
| 2066 | |
| 2067 | <div><fiddle-embed name="0c4446c0870b5c7b5a2efe77ff92afb8"> |
| 2068 | |
| 2069 | #### Example Output |
| 2070 | |
| 2071 | ~~~~ |
| 2072 | 5 == paint.getStrokeWidth() |
| 2073 | ~~~~ |
| 2074 | |
| 2075 | </fiddle-embed></div> |
| 2076 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2077 | <a name='Miter_Limit'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2078 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2079 | --- |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 2080 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2081 | <a href='#Paint_Miter_Limit'>Miter_Limit</a> specifies the maximum miter length, |
| 2082 | relative to the <a href='#Stroke_Width'>stroke width</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2083 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2084 | <a href='#Paint_Miter_Limit'>Miter_Limit</a> is used when the <a href='#Paint_Stroke_Join'>Stroke_Join</a> |
| 2085 | 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> |
| 2086 | or <a href='#SkPaint_kStrokeAndFill_Style'>kStrokeAndFill_Style</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2087 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2088 | If the miter at a corner exceeds this limit, <a href='#SkPaint_kMiter_Join'>kMiter_Join</a> |
| 2089 | is replaced with <a href='#SkPaint_kBevel_Join'>kBevel_Join</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2090 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2091 | <a href='#Paint_Miter_Limit'>Miter_Limit</a> can be computed from the corner angle using: |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 2092 | <code><a href='#Miter_Limit'>miter limit</a> = 1 / sin ( angle / 2 )</code>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2093 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2094 | <a href='#Paint_Miter_Limit'>Miter_Limit</a> default value is 4. |
| 2095 | The default may be changed at compile time by setting <a href='undocumented#SkPaintDefaults_MiterLimit'>SkPaintDefaults_MiterLimit</a> |
| 2096 | in "SkUserConfig.h" or as a define supplied by the build environment. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2097 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2098 | Here are some miter limits and the angles that triggers them. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2099 | |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 2100 | | <a href='#Miter_Limit'>miter limit</a> | angle in degrees | |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2101 | | --- | --- | |
| 2102 | | 10 | 11.48 | |
| 2103 | | 9 | 12.76 | |
| 2104 | | 8 | 14.36 | |
| 2105 | | 7 | 16.43 | |
| 2106 | | 6 | 19.19 | |
| 2107 | | 5 | 23.07 | |
| 2108 | | 4 | 28.96 | |
| 2109 | | 3 | 38.94 | |
| 2110 | | 2 | 60 | |
| 2111 | | 1 | 180 | |
| 2112 | |
| 2113 | ### Example |
| 2114 | |
Cary Clark | a619d45 | 2018-07-16 08:12:01 -0400 | [diff] [blame] | 2115 | <div><fiddle-embed name="5de2de0f00354e59074a9bb1a42d5a63"><div>This example draws a stroked corner and the miter length beneath. |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 2116 | When the <a href='#Miter_Limit'>miter limit</a> is decreased slightly, the miter join is replaced |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 2117 | by a bevel join. |
| 2118 | </div></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2119 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2120 | <a name='SkPaint_getStrokeMiter'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2121 | |
| 2122 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2123 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2124 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 2125 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_getStrokeMiter'>getStrokeMiter</a>()const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2126 | </pre> |
| 2127 | |
Cary Clark | 80247e5 | 2018-07-11 16:18:41 -0400 | [diff] [blame] | 2128 | Returns the limit at which a sharp corner is drawn beveled. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2129 | |
| 2130 | ### Return Value |
| 2131 | |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 2132 | zero and greater miter limit |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2133 | |
| 2134 | ### Example |
| 2135 | |
| 2136 | <div><fiddle-embed name="50da74a43b725f07a914df588c867d36"> |
| 2137 | |
| 2138 | #### Example Output |
| 2139 | |
| 2140 | ~~~~ |
| 2141 | default miter limit == 4 |
| 2142 | ~~~~ |
| 2143 | |
| 2144 | </fiddle-embed></div> |
| 2145 | |
| 2146 | ### See Also |
| 2147 | |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 2148 | <a href='#Paint_Miter_Limit'>Miter_Limit</a> <a href='#SkPaint_setStrokeMiter'>setStrokeMiter</a> <a href='#SkPaint_Join'>Join</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2149 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2150 | <a name='SkPaint_setStrokeMiter'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2151 | |
| 2152 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2153 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2154 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2155 | void <a href='#SkPaint_setStrokeMiter'>setStrokeMiter</a>(<a href='undocumented#SkScalar'>SkScalar</a> miter) |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2156 | </pre> |
| 2157 | |
Cary Clark | 80247e5 | 2018-07-11 16:18:41 -0400 | [diff] [blame] | 2158 | Sets the limit at which a sharp corner is drawn beveled. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2159 | Valid values are zero and greater. |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2160 | Has no effect if <a href='#SkPaint_setStrokeMiter_miter'>miter</a> is less than zero. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2161 | |
| 2162 | ### Parameters |
| 2163 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2164 | <table> <tr> <td><a name='SkPaint_setStrokeMiter_miter'><code><strong>miter</strong></code></a></td> |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 2165 | <td>zero and greater <a href='#Miter_Limit'>miter limit</a></td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2166 | </tr> |
| 2167 | </table> |
| 2168 | |
| 2169 | ### Example |
| 2170 | |
skia-bookmaker | a717ca9 | 2018-07-08 05:32:09 +0000 | [diff] [blame] | 2171 | <div><fiddle-embed name="700b284dbc97785c6a9c9636088713ad"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2172 | |
| 2173 | #### Example Output |
| 2174 | |
| 2175 | ~~~~ |
| 2176 | default miter limit == 8 |
| 2177 | ~~~~ |
| 2178 | |
| 2179 | </fiddle-embed></div> |
| 2180 | |
| 2181 | ### See Also |
| 2182 | |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 2183 | <a href='#Paint_Miter_Limit'>Miter_Limit</a> <a href='#SkPaint_getStrokeMiter'>getStrokeMiter</a> <a href='#SkPaint_Join'>Join</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2184 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2185 | <a name='Stroke_Cap'></a> |
| 2186 | |
| 2187 | <a name='SkPaint_Cap'></a> |
| 2188 | |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2189 | --- |
| 2190 | |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 2191 | <pre style="padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0"> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2192 | enum <a href='#SkPaint_Cap'>Cap</a> { |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 2193 | <a href='#SkPaint_kButt_Cap'>kButt_Cap</a>, |
| 2194 | <a href='#SkPaint_kRound_Cap'>kRound_Cap</a>, |
| 2195 | <a href='#SkPaint_kSquare_Cap'>kSquare_Cap</a>, |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 2196 | <a href='#SkPaint_kLast_Cap'>kLast_Cap</a> = <a href='#SkPaint_kSquare_Cap'>kSquare_Cap</a>, |
| 2197 | <a href='#SkPaint_kDefault_Cap'>kDefault_Cap</a> = <a href='#SkPaint_kButt_Cap'>kButt_Cap</a>, |
Cary Clark | 186d08f | 2018-04-03 08:43:27 -0400 | [diff] [blame] | 2198 | }; |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 2199 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2200 | </pre> |
Cary Clark | 6fc5041 | 2017-09-21 12:31:06 -0400 | [diff] [blame] | 2201 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2202 | <pre style="padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0"> |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 2203 | static constexpr int <a href='#SkPaint_kCapCount'>kCapCount</a> = <a href='#SkPaint_kLast_Cap'>kLast_Cap</a> + 1; |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 2204 | </pre> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2205 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2206 | <a href='#Paint_Stroke_Cap'>Stroke_Cap</a> draws at the beginning and end of an open <a href='#Path_Overview_Contour'>Path_Contour</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2207 | |
| 2208 | ### Constants |
| 2209 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2210 | <table style='border-collapse: collapse; width: 62.5em'> |
| 2211 | <tr><th style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>Const</th> |
| 2212 | <th style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>Value</th> |
| 2213 | <th style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>Description</th></tr> |
| 2214 | <tr style='background-color: #f0f0f0; '> |
| 2215 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kButt_Cap'><code>SkPaint::kButt_Cap</code></a></td> |
| 2216 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>0</td> |
| 2217 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 2218 | Does not extend the stroke past the beginning or the end. |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 2219 | </td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2220 | </tr> |
| 2221 | <tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2222 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kRound_Cap'><code>SkPaint::kRound_Cap</code></a></td> |
| 2223 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>1</td> |
| 2224 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2225 | Adds a <a href='undocumented#Circle'>circle</a> with a diameter equal to <a href='#Paint_Stroke_Width'>Stroke_Width</a> at the beginning |
| 2226 | and end. |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 2227 | </td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2228 | </tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2229 | <tr style='background-color: #f0f0f0; '> |
| 2230 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kSquare_Cap'><code>SkPaint::kSquare_Cap</code></a></td> |
| 2231 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>2</td> |
| 2232 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2233 | Adds a square with sides equal to <a href='#Paint_Stroke_Width'>Stroke_Width</a> at the beginning |
| 2234 | and end. The square sides are parallel to the initial and final direction |
| 2235 | of the stroke. |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 2236 | </td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2237 | </tr> |
| 2238 | <tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2239 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kLast_Cap'><code>SkPaint::kLast_Cap</code></a></td> |
| 2240 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>2</td> |
| 2241 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 2242 | Equivalent to the largest value for <a href='#Paint_Stroke_Cap'>Stroke_Cap</a>. |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2243 | </td> |
| 2244 | </tr> |
| 2245 | <tr style='background-color: #f0f0f0; '> |
| 2246 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kDefault_Cap'><code>SkPaint::kDefault_Cap</code></a></td> |
| 2247 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>0</td> |
| 2248 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2249 | <a href='#Paint_Stroke_Cap'>Stroke_Cap</a> is set to <a href='#SkPaint_kButt_Cap'>kButt_Cap</a> by default. |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 2250 | </td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2251 | </tr> |
| 2252 | <tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2253 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kCapCount'><code>SkPaint::kCapCount</code></a></td> |
| 2254 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>3</td> |
| 2255 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2256 | May be used to verify that <a href='#Paint_Stroke_Cap'>Stroke_Cap</a> is a legal value. |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 2257 | </td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2258 | </tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2259 | </table> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2260 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2261 | Stroke describes the area covered by a pen of <a href='#Paint_Stroke_Width'>Stroke_Width</a> as it |
| 2262 | follows the <a href='#Path_Overview_Contour'>Path_Contour</a>, moving parallel to the <a href='SkPath_Overview#Contour'>contour</a> direction. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2263 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2264 | If the <a href='#Path_Overview_Contour'>Path_Contour</a> is not terminated by <a href='SkPath_Reference#SkPath'>SkPath</a>::<a href='#SkPath_kClose_Verb'>kClose_Verb</a>, the <a href='SkPath_Overview#Contour'>contour</a> has a |
| 2265 | visible beginning and end. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2266 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2267 | <a href='#Path_Overview_Contour'>Path_Contour</a> may start and end at the same <a href='SkPoint_Reference#Point'>point</a>; defining <a href='#Path_Overview_Contour_Zero_Length'>Zero_Length_Contour</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2268 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2269 | <a href='#SkPaint_kButt_Cap'>kButt_Cap</a> and <a href='#Path_Overview_Contour_Zero_Length'>Zero_Length_Contour</a> is not drawn. |
| 2270 | <a href='#SkPaint_kRound_Cap'>kRound_Cap</a> and <a href='#Path_Overview_Contour_Zero_Length'>Zero_Length_Contour</a> draws a <a href='undocumented#Circle'>circle</a> of diameter <a href='#Paint_Stroke_Width'>Stroke_Width</a> |
| 2271 | at the <a href='SkPath_Overview#Contour'>contour</a> <a href='SkPoint_Reference#Point'>point</a>. |
| 2272 | <a href='#SkPaint_kSquare_Cap'>kSquare_Cap</a> and <a href='#Path_Overview_Contour_Zero_Length'>Zero_Length_Contour</a> draws an upright square with a side of |
| 2273 | <a href='#Paint_Stroke_Width'>Stroke_Width</a> at the <a href='SkPath_Overview#Contour'>contour</a> <a href='SkPoint_Reference#Point'>point</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2274 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2275 | <a href='#Paint_Stroke_Cap'>Stroke_Cap</a> is <a href='#SkPaint_kButt_Cap'>kButt_Cap</a> by default. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2276 | |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2277 | ### Example |
| 2278 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 2279 | <div><fiddle-embed name="2bffb6384cc20077e632e7d01da045ca"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2280 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2281 | <a name='SkPaint_getStrokeCap'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2282 | |
| 2283 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2284 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2285 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 2286 | <a href='#SkPaint_Cap'>Cap</a> <a href='#SkPaint_getStrokeCap'>getStrokeCap</a>()const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2287 | </pre> |
| 2288 | |
Cary Clark | 80247e5 | 2018-07-11 16:18:41 -0400 | [diff] [blame] | 2289 | Returns the geometry drawn at the beginning and end of strokes. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2290 | |
| 2291 | ### Return Value |
| 2292 | |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 2293 | 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> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2294 | |
| 2295 | ### Example |
| 2296 | |
| 2297 | <div><fiddle-embed name="aabf9baee8e026fae36fca30e955512b"> |
| 2298 | |
| 2299 | #### Example Output |
| 2300 | |
| 2301 | ~~~~ |
| 2302 | kButt_Cap == default stroke cap |
| 2303 | ~~~~ |
| 2304 | |
| 2305 | </fiddle-embed></div> |
| 2306 | |
| 2307 | ### See Also |
| 2308 | |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 2309 | <a href='#Paint_Stroke_Cap'>Stroke_Cap</a> <a href='#SkPaint_setStrokeCap'>setStrokeCap</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2310 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2311 | <a name='SkPaint_setStrokeCap'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2312 | |
| 2313 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2314 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2315 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2316 | void <a href='#SkPaint_setStrokeCap'>setStrokeCap</a>(<a href='#SkPaint_Cap'>Cap</a> cap) |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2317 | </pre> |
| 2318 | |
Cary Clark | 80247e5 | 2018-07-11 16:18:41 -0400 | [diff] [blame] | 2319 | Sets the geometry drawn at the beginning and end of strokes. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2320 | |
| 2321 | ### Parameters |
| 2322 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2323 | <table> <tr> <td><a name='SkPaint_setStrokeCap_cap'><code><strong>cap</strong></code></a></td> |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 2324 | <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>;</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2325 | </tr> |
| 2326 | </table> |
| 2327 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2328 | has no effect if <a href='#SkPaint_setStrokeCap_cap'>cap</a> is not valid |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 2329 | |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2330 | ### Example |
| 2331 | |
| 2332 | <div><fiddle-embed name="de83fbd848a4625345b4b87a6e55d98a"> |
| 2333 | |
| 2334 | #### Example Output |
| 2335 | |
| 2336 | ~~~~ |
| 2337 | kRound_Cap == paint.getStrokeCap() |
| 2338 | ~~~~ |
| 2339 | |
| 2340 | </fiddle-embed></div> |
| 2341 | |
| 2342 | ### See Also |
| 2343 | |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 2344 | <a href='#Paint_Stroke_Cap'>Stroke_Cap</a> <a href='#SkPaint_getStrokeCap'>getStrokeCap</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2345 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2346 | <a name='Stroke_Join'></a> |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 2347 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2348 | <a href='#Paint_Stroke_Join'>Stroke_Join</a> draws at the sharp corners of an open or closed <a href='#Path_Overview_Contour'>Path_Contour</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2349 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2350 | Stroke describes the area covered by a pen of <a href='#Paint_Stroke_Width'>Stroke_Width</a> as it |
| 2351 | follows the <a href='#Path_Overview_Contour'>Path_Contour</a>, moving parallel to the <a href='SkPath_Overview#Contour'>contour</a> direction. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2352 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2353 | If the <a href='SkPath_Overview#Contour'>contour</a> direction changes abruptly, because the tangent direction leading |
| 2354 | to the end of a <a href='undocumented#Curve'>curve</a> within the <a href='SkPath_Overview#Contour'>contour</a> does not match the tangent direction of |
| 2355 | the following <a href='undocumented#Curve'>curve</a>, the pair of <a href='undocumented#Curve'>curves</a> meet at <a href='#Paint_Stroke_Join'>Stroke_Join</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2356 | |
| 2357 | ### Example |
| 2358 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 2359 | <div><fiddle-embed name="917c44b504d3f9308571fd3835d90a0d"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2360 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2361 | <a name='SkPaint_Join'></a> |
| 2362 | |
| 2363 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2364 | |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 2365 | <pre style="padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0"> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2366 | enum <a href='#SkPaint_Join'>Join</a> : uint8_t { |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 2367 | <a href='#SkPaint_kMiter_Join'>kMiter_Join</a>, |
| 2368 | <a href='#SkPaint_kRound_Join'>kRound_Join</a>, |
| 2369 | <a href='#SkPaint_kBevel_Join'>kBevel_Join</a>, |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 2370 | <a href='#SkPaint_kLast_Join'>kLast_Join</a> = <a href='#SkPaint_kBevel_Join'>kBevel_Join</a>, |
| 2371 | <a href='#SkPaint_kDefault_Join'>kDefault_Join</a> = <a href='#SkPaint_kMiter_Join'>kMiter_Join</a>, |
Cary Clark | 186d08f | 2018-04-03 08:43:27 -0400 | [diff] [blame] | 2372 | }; |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 2373 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2374 | </pre> |
Cary Clark | 6fc5041 | 2017-09-21 12:31:06 -0400 | [diff] [blame] | 2375 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2376 | <pre style="padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0"> |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 2377 | static constexpr int <a href='#SkPaint_kJoinCount'>kJoinCount</a> = <a href='#SkPaint_kLast_Join'>kLast_Join</a> + 1; |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 2378 | </pre> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2379 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2380 | <a href='#SkPaint_Join'>Join</a> specifies how corners are drawn when a shape is stroked. <a href='#SkPaint_Join'>Join</a> |
| 2381 | affects the four corners of a stroked rectangle, and the connected segments in a |
| 2382 | stroked <a href='SkPath_Reference#Path'>path</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2383 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2384 | Choose miter join to draw sharp corners. Choose round join to draw a <a href='undocumented#Circle'>circle</a> with a |
| 2385 | radius equal to the <a href='#Stroke_Width'>stroke width</a> on top of the corner. Choose bevel join to minimally |
| 2386 | connect the thick strokes. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2387 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2388 | The <a href='#Fill_Path'>fill path</a> constructed to describe the stroked <a href='SkPath_Reference#Path'>path</a> respects the join setting but may |
| 2389 | not contain the actual join. For instance, a <a href='#Fill_Path'>fill path</a> constructed with round joins does |
| 2390 | not necessarily include <a href='undocumented#Circle'>circles</a> at each connected segment. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2391 | |
| 2392 | ### Constants |
| 2393 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2394 | <table style='border-collapse: collapse; width: 62.5em'> |
| 2395 | <tr><th style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>Const</th> |
| 2396 | <th style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>Value</th> |
| 2397 | <th style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>Description</th></tr> |
| 2398 | <tr style='background-color: #f0f0f0; '> |
| 2399 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kMiter_Join'><code>SkPaint::kMiter_Join</code></a></td> |
| 2400 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>0</td> |
| 2401 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 2402 | Extends the outside corner to the extent allowed by <a href='#Paint_Miter_Limit'>Miter_Limit</a>. |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2403 | If the extension exceeds <a href='#Paint_Miter_Limit'>Miter_Limit</a>, <a href='#SkPaint_kBevel_Join'>kBevel_Join</a> is used instead. |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 2404 | </td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2405 | </tr> |
| 2406 | <tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2407 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kRound_Join'><code>SkPaint::kRound_Join</code></a></td> |
| 2408 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>1</td> |
| 2409 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2410 | Adds a <a href='undocumented#Circle'>circle</a> with a diameter of <a href='#Paint_Stroke_Width'>Stroke_Width</a> at the sharp corner. |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2411 | </td> |
| 2412 | </tr> |
| 2413 | <tr style='background-color: #f0f0f0; '> |
| 2414 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kBevel_Join'><code>SkPaint::kBevel_Join</code></a></td> |
| 2415 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>2</td> |
| 2416 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 2417 | Connects the outside edges of the sharp corner. |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 2418 | </td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2419 | </tr> |
| 2420 | <tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2421 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kLast_Join'><code>SkPaint::kLast_Join</code></a></td> |
| 2422 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>2</td> |
| 2423 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 2424 | equivalent to the largest value for Stroke_Join</td> |
| 2425 | </tr> |
| 2426 | <tr style='background-color: #f0f0f0; '> |
| 2427 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kDefault_Join'><code>SkPaint::kDefault_Join</code></a></td> |
| 2428 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>1</td> |
| 2429 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2430 | <a href='#Paint_Stroke_Join'>Stroke_Join</a> is set to <a href='#SkPaint_kMiter_Join'>kMiter_Join</a> by default. |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 2431 | </td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2432 | </tr> |
| 2433 | <tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2434 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kJoinCount'><code>SkPaint::kJoinCount</code></a></td> |
| 2435 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>3</td> |
| 2436 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2437 | May be used to verify that <a href='#Paint_Stroke_Join'>Stroke_Join</a> is a legal value. |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 2438 | </td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2439 | </tr> |
| 2440 | </table> |
| 2441 | |
| 2442 | ### Example |
| 2443 | |
| 2444 | <div><fiddle-embed name="3b1aebacc21c1836a52876b9b0b3905e"></fiddle-embed></div> |
| 2445 | |
| 2446 | ### See Also |
| 2447 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2448 | <a href='#SkPaint_setStrokeJoin'>setStrokeJoin</a> <a href='#SkPaint_getStrokeJoin'>getStrokeJoin</a> <a href='#SkPaint_setStrokeMiter'>setStrokeMiter</a> <a href='#SkPaint_getStrokeMiter'>getStrokeMiter</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2449 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2450 | <a name='SkPaint_getStrokeJoin'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2451 | |
| 2452 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2453 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2454 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 2455 | <a href='#SkPaint_Join'>Join</a> <a href='#SkPaint_getStrokeJoin'>getStrokeJoin</a>()const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2456 | </pre> |
| 2457 | |
Cary Clark | 80247e5 | 2018-07-11 16:18:41 -0400 | [diff] [blame] | 2458 | Returns the geometry drawn at the corners of strokes. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2459 | |
| 2460 | ### Return Value |
| 2461 | |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 2462 | 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> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2463 | |
| 2464 | ### Example |
| 2465 | |
Cary Clark | 7f644ec | 2018-07-19 10:50:44 -0400 | [diff] [blame] | 2466 | <div><fiddle-embed name="31bf751d0a8ddf176b871810820d8199"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2467 | |
| 2468 | #### Example Output |
| 2469 | |
| 2470 | ~~~~ |
| 2471 | kMiter_Join == default stroke join |
| 2472 | ~~~~ |
| 2473 | |
| 2474 | </fiddle-embed></div> |
| 2475 | |
| 2476 | ### See Also |
| 2477 | |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 2478 | <a href='#Paint_Stroke_Join'>Stroke_Join</a> <a href='#SkPaint_setStrokeJoin'>setStrokeJoin</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2479 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2480 | <a name='SkPaint_setStrokeJoin'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2481 | |
| 2482 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2483 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2484 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2485 | void <a href='#SkPaint_setStrokeJoin'>setStrokeJoin</a>(<a href='#SkPaint_Join'>Join</a> join) |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2486 | </pre> |
| 2487 | |
Cary Clark | 80247e5 | 2018-07-11 16:18:41 -0400 | [diff] [blame] | 2488 | Sets the geometry drawn at the corners of strokes. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2489 | |
| 2490 | ### Parameters |
| 2491 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2492 | <table> <tr> <td><a name='SkPaint_setStrokeJoin_join'><code><strong>join</strong></code></a></td> |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 2493 | <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>;</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2494 | </tr> |
| 2495 | </table> |
| 2496 | |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 2497 | otherwise, has no effect |
| 2498 | |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2499 | ### Example |
| 2500 | |
| 2501 | <div><fiddle-embed name="48d963ad4286eddf680f9c511eb6da91"> |
| 2502 | |
| 2503 | #### Example Output |
| 2504 | |
| 2505 | ~~~~ |
| 2506 | kMiter_Join == paint.getStrokeJoin() |
| 2507 | ~~~~ |
| 2508 | |
| 2509 | </fiddle-embed></div> |
| 2510 | |
| 2511 | ### See Also |
| 2512 | |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 2513 | <a href='#Paint_Stroke_Join'>Stroke_Join</a> <a href='#SkPaint_getStrokeJoin'>getStrokeJoin</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2514 | |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2515 | ### See Also |
| 2516 | |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 2517 | <a href='#Paint_Miter_Limit'>Miter_Limit</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2518 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2519 | <a name='Fill_Path'></a> |
| 2520 | |
| 2521 | --- |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 2522 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2523 | <a href='#Paint_Fill_Path'>Fill_Path</a> creates a <a href='SkPath_Reference#Path'>Path</a> by applying the <a href='#Path_Effect'>Path_Effect</a>, followed by the <a href='#Paint_Style_Stroke'>Style_Stroke</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2524 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2525 | If <a href='SkPaint_Reference#Paint'>Paint</a> contains <a href='#Path_Effect'>Path_Effect</a>, <a href='#Path_Effect'>Path_Effect</a> operates on the source <a href='SkPath_Reference#Path'>Path</a>; the result |
| 2526 | replaces the destination <a href='SkPath_Reference#Path'>Path</a>. Otherwise, the source <a href='SkPath_Reference#Path'>Path</a> is replaces the |
| 2527 | destination <a href='SkPath_Reference#Path'>Path</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2528 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2529 | Fill <a href='SkPath_Reference#Path'>Path</a> can request the <a href='#Path_Effect'>Path_Effect</a> to restrict to a culling rectangle, but |
| 2530 | the <a href='#Path_Effect'>Path_Effect</a> is not required to do so. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2531 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2532 | 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>, |
| 2533 | and <a href='#Paint_Stroke_Width'>Stroke_Width</a> is greater than zero, the <a href='#Paint_Stroke_Width'>Stroke_Width</a>, <a href='#Paint_Stroke_Cap'>Stroke_Cap</a>, <a href='#Paint_Stroke_Join'>Stroke_Join</a>, |
| 2534 | and <a href='#Paint_Miter_Limit'>Miter_Limit</a> operate on the destination <a href='SkPath_Reference#Path'>Path</a>, replacing it. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2535 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2536 | Fill <a href='SkPath_Reference#Path'>Path</a> can specify the precision used by <a href='#Paint_Stroke_Width'>Stroke_Width</a> to approximate the stroke geometry. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2537 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2538 | If the <a href='#SkPaint_Style'>Style</a> is <a href='#SkPaint_kStroke_Style'>kStroke_Style</a> and the <a href='#Paint_Stroke_Width'>Stroke_Width</a> is zero, <a href='#SkPaint_getFillPath'>getFillPath</a> |
| 2539 | returns false since Hairline has no filled equivalent. |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2540 | |
| 2541 | ### See Also |
| 2542 | |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 2543 | <a href='#Paint_Style_Stroke'>Style_Stroke</a> <a href='#Paint_Stroke_Width'>Stroke_Width</a> <a href='#Path_Effect'>Path_Effect</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2544 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2545 | <a name='SkPaint_getFillPath'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2546 | |
| 2547 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2548 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2549 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 2550 | bool <a href='#SkPaint_getFillPath'>getFillPath</a>(const <a href='SkPath_Reference#SkPath'>SkPath</a>& src, <a href='SkPath_Reference#SkPath'>SkPath</a>* dst, const <a href='SkRect_Reference#SkRect'>SkRect</a>* cullRect, <a href='undocumented#SkScalar'>SkScalar</a> resScale = 1)const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2551 | </pre> |
| 2552 | |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 2553 | Returns the filled equivalent of the stroked <a href='SkPath_Reference#Path'>path</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2554 | |
| 2555 | ### Parameters |
| 2556 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2557 | <table> <tr> <td><a name='SkPaint_getFillPath_src'><code><strong>src</strong></code></a></td> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2558 | <td><a href='SkPath_Reference#SkPath'>SkPath</a> read to create a filled version</td> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2559 | </tr> |
| 2560 | <tr> <td><a name='SkPaint_getFillPath_dst'><code><strong>dst</strong></code></a></td> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2561 | <td>resulting <a href='SkPath_Reference#SkPath'>SkPath</a>; may be the same as <a href='#SkPaint_getFillPath_src'>src</a>, but may not be nullptr</td> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2562 | </tr> |
| 2563 | <tr> <td><a name='SkPaint_getFillPath_cullRect'><code><strong>cullRect</strong></code></a></td> |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 2564 | <td>optional limit passed to <a href='undocumented#SkPathEffect'>SkPathEffect</a></td> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2565 | </tr> |
| 2566 | <tr> <td><a name='SkPaint_getFillPath_resScale'><code><strong>resScale</strong></code></a></td> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2567 | <td>if > 1, increase precision, else if (0 < <a href='#SkPaint_getFillPath_resScale'>resScale</a> < 1) reduce precision</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2568 | </tr> |
| 2569 | </table> |
| 2570 | |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 2571 | to favor speed and <a href='undocumented#Size'>size</a> |
| 2572 | |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2573 | ### Return Value |
| 2574 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2575 | true if the <a href='SkPath_Reference#Path'>path</a> represents <a href='#Style_Fill'>style fill</a>, or false if it represents hairline |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2576 | |
| 2577 | ### Example |
| 2578 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2579 | <div><fiddle-embed name="cedd6233848198e1fca4d1e14816baaf"><div>A very small <a href='SkPath_Reference#Quad'>Quad</a> stroke is turned into a filled <a href='SkPath_Reference#Path'>path</a> with increasing levels of precision. |
| 2580 | At the lowest precision, the <a href='SkPath_Reference#Quad'>Quad</a> stroke is approximated by a rectangle. |
| 2581 | At the highest precision, the filled <a href='SkPath_Reference#Path'>path</a> has high fidelity compared to the original stroke. |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 2582 | </div></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2583 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2584 | <a name='SkPaint_getFillPath_2'></a> |
Cary Clark | 2dc84ad | 2018-01-26 12:56:22 -0500 | [diff] [blame] | 2585 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2586 | --- |
| 2587 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2588 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 2589 | bool <a href='#SkPaint_getFillPath'>getFillPath</a>(const <a href='SkPath_Reference#SkPath'>SkPath</a>& src, <a href='SkPath_Reference#SkPath'>SkPath</a>* dst)const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2590 | </pre> |
| 2591 | |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 2592 | Returns the filled equivalent of the stroked <a href='SkPath_Reference#Path'>path</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2593 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2594 | Replaces <a href='#SkPaint_getFillPath_2_dst'>dst</a> with the <a href='#SkPaint_getFillPath_2_src'>src</a> <a href='SkPath_Reference#Path'>path</a> modified by <a href='undocumented#SkPathEffect'>SkPathEffect</a> and <a href='#Style_Stroke'>style stroke</a>. |
| 2595 | <a href='undocumented#SkPathEffect'>SkPathEffect</a>, if any, is not culled. <a href='#Stroke_Width'>stroke width</a> is created with default precision. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2596 | |
| 2597 | ### Parameters |
| 2598 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2599 | <table> <tr> <td><a name='SkPaint_getFillPath_2_src'><code><strong>src</strong></code></a></td> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2600 | <td><a href='SkPath_Reference#SkPath'>SkPath</a> read to create a filled version</td> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2601 | </tr> |
| 2602 | <tr> <td><a name='SkPaint_getFillPath_2_dst'><code><strong>dst</strong></code></a></td> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2603 | <td>resulting <a href='SkPath_Reference#SkPath'>SkPath</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> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2604 | </tr> |
| 2605 | </table> |
| 2606 | |
| 2607 | ### Return Value |
| 2608 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2609 | true if the <a href='SkPath_Reference#Path'>path</a> represents <a href='#Style_Fill'>style fill</a>, or false if it represents hairline |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2610 | |
| 2611 | ### Example |
| 2612 | |
| 2613 | <div><fiddle-embed name="e6d8ca0cc17e0b475bd54dd995825468"></fiddle-embed></div> |
| 2614 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2615 | <a name='Shader_Methods'></a> |
| 2616 | |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2617 | --- |
| 2618 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2619 | <a href='undocumented#Shader'>Shader</a> defines the colors used when drawing a shape. |
| 2620 | <a href='undocumented#Shader'>Shader</a> may be an <a href='SkImage_Reference#Image'>image</a>, a gradient, or a computed fill. |
| 2621 | If <a href='SkPaint_Reference#Paint'>Paint</a> has no <a href='undocumented#Shader'>Shader</a>, then <a href='SkColor_Reference#Color'>Color</a> fills the shape. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2622 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2623 | <a href='undocumented#Shader'>Shader</a> is modulated by <a href='#Color_Alpha'>Color_Alpha</a> component of <a href='SkColor_Reference#Color'>Color</a>. |
| 2624 | If <a href='undocumented#Shader'>Shader</a> object defines only <a href='#Color_Alpha'>Color_Alpha</a>, then <a href='SkColor_Reference#Color'>Color</a> modulated by <a href='#Color_Alpha'>Color_Alpha</a> describes |
| 2625 | the fill. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2626 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2627 | The drawn transparency can be modified without altering <a href='undocumented#Shader'>Shader</a>, by changing <a href='#Color_Alpha'>Color_Alpha</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2628 | |
| 2629 | ### Example |
| 2630 | |
| 2631 | <div><fiddle-embed name="c015dc2010c15e1c00b4f7330232b0f7"></fiddle-embed></div> |
| 2632 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2633 | If <a href='undocumented#Shader'>Shader</a> generates only <a href='#Color_Alpha'>Color_Alpha</a> then all components of <a href='SkColor_Reference#Color'>Color</a> modulate the output. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2634 | |
| 2635 | ### Example |
| 2636 | |
skia-bookmaker | 525f9a9 | 2018-05-03 06:27:39 +0000 | [diff] [blame] | 2637 | <div><fiddle-embed name="fe80fd80b98a20823db7fb9a077243c7"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2638 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2639 | <a name='SkPaint_getShader'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2640 | |
| 2641 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2642 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2643 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 2644 | <a href='undocumented#SkShader'>SkShader</a>* <a href='#SkPaint_getShader'>getShader</a>()const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2645 | </pre> |
| 2646 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2647 | Returns optional colors used when filling a <a href='SkPath_Reference#Path'>path</a>, such as a gradient. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2648 | |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 2649 | Does not alter <a href='undocumented#SkShader'>SkShader</a> <a href='undocumented#SkRefCnt'>SkRefCnt</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2650 | |
| 2651 | ### Return Value |
| 2652 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2653 | <a href='undocumented#SkShader'>SkShader</a> if previously set, nullptr otherwise |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2654 | |
| 2655 | ### Example |
| 2656 | |
| 2657 | <div><fiddle-embed name="09f15b9fd88882850da2d235eb86292f"> |
| 2658 | |
| 2659 | #### Example Output |
| 2660 | |
| 2661 | ~~~~ |
| 2662 | nullptr == shader |
| 2663 | nullptr != shader |
| 2664 | ~~~~ |
| 2665 | |
| 2666 | </fiddle-embed></div> |
| 2667 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2668 | <a name='SkPaint_refShader'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2669 | |
| 2670 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2671 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2672 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 2673 | <a href='undocumented#sk_sp'>sk_sp</a><<a href='undocumented#SkShader'>SkShader</a>> <a href='#SkPaint_refShader'>refShader</a>()const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2674 | </pre> |
| 2675 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2676 | Returns optional colors used when filling a <a href='SkPath_Reference#Path'>path</a>, such as a gradient. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2677 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2678 | Increases <a href='undocumented#SkShader'>SkShader</a> <a href='undocumented#SkRefCnt'>SkRefCnt</a> by one. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2679 | |
| 2680 | ### Return Value |
| 2681 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2682 | <a href='undocumented#SkShader'>SkShader</a> if previously set, nullptr otherwise |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2683 | |
| 2684 | ### Example |
| 2685 | |
| 2686 | <div><fiddle-embed name="53da0295972a418cbc9607bbb17feaa8"> |
| 2687 | |
| 2688 | #### Example Output |
| 2689 | |
| 2690 | ~~~~ |
| 2691 | shader unique: true |
| 2692 | shader unique: false |
| 2693 | ~~~~ |
| 2694 | |
| 2695 | </fiddle-embed></div> |
| 2696 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2697 | <a name='SkPaint_setShader'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2698 | |
| 2699 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2700 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2701 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2702 | void <a href='#SkPaint_setShader'>setShader</a>(<a href='undocumented#sk_sp'>sk_sp</a><<a href='undocumented#SkShader'>SkShader</a>> <a href='undocumented#Shader'>shader</a>) |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2703 | </pre> |
| 2704 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2705 | Sets optional colors used when filling a <a href='SkPath_Reference#Path'>path</a>, such as a gradient. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2706 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2707 | Sets <a href='undocumented#SkShader'>SkShader</a> to <a href='#SkPaint_setShader_shader'>shader</a>, decreasing <a href='undocumented#SkRefCnt'>SkRefCnt</a> of the previous <a href='undocumented#SkShader'>SkShader</a>. |
| 2708 | Increments <a href='#SkPaint_setShader_shader'>shader</a> <a href='undocumented#SkRefCnt'>SkRefCnt</a> by one. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2709 | |
| 2710 | ### Parameters |
| 2711 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2712 | <table> <tr> <td><a name='SkPaint_setShader_shader'><code><strong>shader</strong></code></a></td> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2713 | <td>how geometry is filled with <a href='SkColor_Reference#Color'>color</a>; if nullptr, <a href='SkColor_Reference#Color'>color</a> is used instead</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2714 | </tr> |
| 2715 | </table> |
| 2716 | |
| 2717 | ### Example |
| 2718 | |
skia-bookmaker | e0a458f | 2018-07-16 05:29:00 +0000 | [diff] [blame] | 2719 | <div><fiddle-embed name="77e64d5bae9b1ba037fd99252bb4aa58"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2720 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2721 | <a name='Color_Filter_Methods'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2722 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2723 | --- |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 2724 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2725 | <a href='#Color_Filter'>Color_Filter</a> alters the <a href='SkColor_Reference#Color'>color</a> used when drawing a shape. |
| 2726 | <a href='#Color_Filter'>Color_Filter</a> may apply <a href='#Blend_Mode'>Blend_Mode</a>, transform the <a href='SkColor_Reference#Color'>color</a> through a <a href='SkMatrix_Reference#Matrix'>matrix</a>, or composite multiple filters. |
| 2727 | If <a href='SkPaint_Reference#Paint'>Paint</a> has no <a href='#Color_Filter'>Color_Filter</a>, the <a href='SkColor_Reference#Color'>color</a> is unaltered. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2728 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2729 | The drawn transparency can be modified without altering <a href='#Color_Filter'>Color_Filter</a>, by changing <a href='#Color_Alpha'>Color_Alpha</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2730 | |
| 2731 | ### Example |
| 2732 | |
| 2733 | <div><fiddle-embed name="5abde56ca2f89a18b8e231abd1b57c56"></fiddle-embed></div> |
| 2734 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2735 | <a name='SkPaint_getColorFilter'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2736 | |
| 2737 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2738 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2739 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 2740 | <a href='undocumented#SkColorFilter'>SkColorFilter</a>* <a href='#SkPaint_getColorFilter'>getColorFilter</a>()const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2741 | </pre> |
| 2742 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2743 | Returns <a href='undocumented#SkColorFilter'>SkColorFilter</a> if set, or nullptr. |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 2744 | Does not alter <a href='undocumented#SkColorFilter'>SkColorFilter</a> <a href='undocumented#SkRefCnt'>SkRefCnt</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2745 | |
| 2746 | ### Return Value |
| 2747 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2748 | <a href='undocumented#SkColorFilter'>SkColorFilter</a> if previously set, nullptr otherwise |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2749 | |
| 2750 | ### Example |
| 2751 | |
| 2752 | <div><fiddle-embed name="093bdc627d6b59002670fd290931f6c9"> |
| 2753 | |
| 2754 | #### Example Output |
| 2755 | |
| 2756 | ~~~~ |
| 2757 | nullptr == color filter |
| 2758 | nullptr != color filter |
| 2759 | ~~~~ |
| 2760 | |
| 2761 | </fiddle-embed></div> |
| 2762 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2763 | <a name='SkPaint_refColorFilter'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2764 | |
| 2765 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2766 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2767 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 2768 | <a href='undocumented#sk_sp'>sk_sp</a><<a href='undocumented#SkColorFilter'>SkColorFilter</a>> <a href='#SkPaint_refColorFilter'>refColorFilter</a>()const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2769 | </pre> |
| 2770 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2771 | Returns <a href='undocumented#SkColorFilter'>SkColorFilter</a> if set, or nullptr. |
| 2772 | Increases <a href='undocumented#SkColorFilter'>SkColorFilter</a> <a href='undocumented#SkRefCnt'>SkRefCnt</a> by one. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2773 | |
| 2774 | ### Return Value |
| 2775 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2776 | <a href='undocumented#SkColorFilter'>SkColorFilter</a> if set, or nullptr |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2777 | |
| 2778 | ### Example |
| 2779 | |
| 2780 | <div><fiddle-embed name="b588c95fa4c86ddbc4b0546762f08297"> |
| 2781 | |
| 2782 | #### Example Output |
| 2783 | |
| 2784 | ~~~~ |
| 2785 | color filter unique: true |
| 2786 | color filter unique: false |
| 2787 | ~~~~ |
| 2788 | |
| 2789 | </fiddle-embed></div> |
| 2790 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2791 | <a name='SkPaint_setColorFilter'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2792 | |
| 2793 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2794 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2795 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2796 | void <a href='#SkPaint_setColorFilter'>setColorFilter</a>(<a href='undocumented#sk_sp'>sk_sp</a><<a href='undocumented#SkColorFilter'>SkColorFilter</a>> colorFilter) |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2797 | </pre> |
| 2798 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2799 | Sets <a href='undocumented#SkColorFilter'>SkColorFilter</a> to filter, decreasing <a href='undocumented#SkRefCnt'>SkRefCnt</a> of the previous |
| 2800 | <a href='undocumented#SkColorFilter'>SkColorFilter</a>. Pass nullptr to clear <a href='undocumented#SkColorFilter'>SkColorFilter</a>. |
Cary Clark | 6fc5041 | 2017-09-21 12:31:06 -0400 | [diff] [blame] | 2801 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2802 | Increments filter <a href='undocumented#SkRefCnt'>SkRefCnt</a> by one. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2803 | |
| 2804 | ### Parameters |
| 2805 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2806 | <table> <tr> <td><a name='SkPaint_setColorFilter_colorFilter'><code><strong>colorFilter</strong></code></a></td> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2807 | <td><a href='undocumented#SkColorFilter'>SkColorFilter</a> to apply to subsequent draw</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2808 | </tr> |
| 2809 | </table> |
| 2810 | |
| 2811 | ### Example |
| 2812 | |
skia-bookmaker | 61cc9fa | 2018-07-11 05:28:17 +0000 | [diff] [blame] | 2813 | <div><fiddle-embed name="c7b786dc9b3501cd0eaba47494b6fa31"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2814 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2815 | <a name='Blend_Mode_Methods'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2816 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2817 | --- |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 2818 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2819 | <a href='#Blend_Mode'>Blend_Mode</a> describes how <a href='SkColor_Reference#Color'>Color</a> combines with the destination <a href='SkColor_Reference#Color'>color</a>. |
| 2820 | The default setting, <a href='SkBlendMode_Reference#SkBlendMode'>SkBlendMode</a>::<a href='#SkBlendMode_kSrcOver'>kSrcOver</a>, draws the source <a href='SkColor_Reference#Color'>color</a> |
| 2821 | over the destination <a href='SkColor_Reference#Color'>color</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2822 | |
| 2823 | ### Example |
| 2824 | |
Cary Clark | 8364706 | 2018-07-18 16:21:51 -0400 | [diff] [blame] | 2825 | <div><fiddle-embed name="73092d4d06faecea3c204d852a4dd8a8"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2826 | |
| 2827 | ### See Also |
| 2828 | |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 2829 | <a href='#Blend_Mode'>Blend_Mode</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2830 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2831 | <a name='SkPaint_getBlendMode'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2832 | |
| 2833 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2834 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2835 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 2836 | <a href='SkBlendMode_Reference#SkBlendMode'>SkBlendMode</a> <a href='#SkPaint_getBlendMode'>getBlendMode</a>()const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2837 | </pre> |
| 2838 | |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 2839 | Returns <a href='SkBlendMode_Reference#SkBlendMode'>SkBlendMode</a>. |
| 2840 | By default, returns <a href='SkBlendMode_Reference#SkBlendMode'>SkBlendMode</a>::<a href='#SkBlendMode_kSrcOver'>kSrcOver</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2841 | |
| 2842 | ### Return Value |
| 2843 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2844 | mode used to combine source <a href='SkColor_Reference#Color'>color</a> with destination <a href='SkColor_Reference#Color'>color</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2845 | |
| 2846 | ### Example |
| 2847 | |
skia-bookmaker | 525f9a9 | 2018-05-03 06:27:39 +0000 | [diff] [blame] | 2848 | <div><fiddle-embed name="a1e059c8f6740fa2044cc64152b39dda"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2849 | |
| 2850 | #### Example Output |
| 2851 | |
| 2852 | ~~~~ |
| 2853 | kSrcOver == getBlendMode |
| 2854 | kSrcOver != getBlendMode |
| 2855 | ~~~~ |
| 2856 | |
| 2857 | </fiddle-embed></div> |
| 2858 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2859 | <a name='SkPaint_isSrcOver'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2860 | |
| 2861 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2862 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2863 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 2864 | bool <a href='#SkPaint_isSrcOver'>isSrcOver</a>()const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2865 | </pre> |
| 2866 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2867 | Returns true if <a href='SkBlendMode_Reference#SkBlendMode'>SkBlendMode</a> is <a href='SkBlendMode_Reference#SkBlendMode'>SkBlendMode</a>::<a href='#SkBlendMode_kSrcOver'>kSrcOver</a>, the default. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2868 | |
| 2869 | ### Return Value |
| 2870 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2871 | true if <a href='SkBlendMode_Reference#SkBlendMode'>SkBlendMode</a> is <a href='SkBlendMode_Reference#SkBlendMode'>SkBlendMode</a>::<a href='#SkBlendMode_kSrcOver'>kSrcOver</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2872 | |
| 2873 | ### Example |
| 2874 | |
| 2875 | <div><fiddle-embed name="257c9473db7a2b3a0fb2b9e2431e59a6"> |
| 2876 | |
| 2877 | #### Example Output |
| 2878 | |
| 2879 | ~~~~ |
| 2880 | isSrcOver == true |
| 2881 | isSrcOver != true |
| 2882 | ~~~~ |
| 2883 | |
| 2884 | </fiddle-embed></div> |
| 2885 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2886 | <a name='SkPaint_setBlendMode'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2887 | |
| 2888 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2889 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2890 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2891 | void <a href='#SkPaint_setBlendMode'>setBlendMode</a>(<a href='SkBlendMode_Reference#SkBlendMode'>SkBlendMode</a> mode) |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2892 | </pre> |
| 2893 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2894 | Sets <a href='SkBlendMode_Reference#SkBlendMode'>SkBlendMode</a> to <a href='#SkPaint_setBlendMode_mode'>mode</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2895 | Does not check for valid input. |
| 2896 | |
| 2897 | ### Parameters |
| 2898 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2899 | <table> <tr> <td><a name='SkPaint_setBlendMode_mode'><code><strong>mode</strong></code></a></td> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2900 | <td><a href='SkBlendMode_Reference#SkBlendMode'>SkBlendMode</a> used to combine source <a href='SkColor_Reference#Color'>color</a> and destination</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2901 | </tr> |
| 2902 | </table> |
| 2903 | |
| 2904 | ### Example |
| 2905 | |
| 2906 | <div><fiddle-embed name="257c9473db7a2b3a0fb2b9e2431e59a6"> |
| 2907 | |
| 2908 | #### Example Output |
| 2909 | |
| 2910 | ~~~~ |
| 2911 | isSrcOver == true |
| 2912 | isSrcOver != true |
| 2913 | ~~~~ |
| 2914 | |
| 2915 | </fiddle-embed></div> |
| 2916 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2917 | <a name='Path_Effect_Methods'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2918 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2919 | --- |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 2920 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2921 | <a href='#Path_Effect'>Path_Effect</a> modifies the <a href='SkPath_Reference#Path'>path</a> geometry before drawing it. |
| 2922 | <a href='#Path_Effect'>Path_Effect</a> may implement dashing, custom fill effects and custom stroke effects. |
| 2923 | If <a href='SkPaint_Reference#Paint'>Paint</a> has no <a href='#Path_Effect'>Path_Effect</a>, the <a href='SkPath_Reference#Path'>path</a> geometry is unaltered when filled or stroked. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2924 | |
| 2925 | ### Example |
| 2926 | |
| 2927 | <div><fiddle-embed name="8cf5684b187d60f09e11c4a48993ea39"></fiddle-embed></div> |
| 2928 | |
| 2929 | ### See Also |
| 2930 | |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 2931 | <a href='#Path_Effect'>Path_Effect</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2932 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2933 | <a name='SkPaint_getPathEffect'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2934 | |
| 2935 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2936 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2937 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 2938 | <a href='undocumented#SkPathEffect'>SkPathEffect</a>* <a href='#SkPaint_getPathEffect'>getPathEffect</a>()const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2939 | </pre> |
| 2940 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2941 | Returns <a href='undocumented#SkPathEffect'>SkPathEffect</a> if set, or nullptr. |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 2942 | Does not alter <a href='undocumented#SkPathEffect'>SkPathEffect</a> <a href='undocumented#SkRefCnt'>SkRefCnt</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2943 | |
| 2944 | ### Return Value |
| 2945 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2946 | <a href='undocumented#SkPathEffect'>SkPathEffect</a> if previously set, nullptr otherwise |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2947 | |
| 2948 | ### Example |
| 2949 | |
skia-bookmaker | b95bbba | 2018-07-06 05:23:23 +0000 | [diff] [blame] | 2950 | <div><fiddle-embed name="211a1b14bfa6c4332082c8eab4fbc5fd"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2951 | |
| 2952 | #### Example Output |
| 2953 | |
| 2954 | ~~~~ |
| 2955 | nullptr == path effect |
| 2956 | nullptr != path effect |
| 2957 | ~~~~ |
| 2958 | |
| 2959 | </fiddle-embed></div> |
| 2960 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2961 | <a name='SkPaint_refPathEffect'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2962 | |
| 2963 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2964 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2965 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 2966 | <a href='undocumented#sk_sp'>sk_sp</a><<a href='undocumented#SkPathEffect'>SkPathEffect</a>> <a href='#SkPaint_refPathEffect'>refPathEffect</a>()const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2967 | </pre> |
| 2968 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2969 | Returns <a href='undocumented#SkPathEffect'>SkPathEffect</a> if set, or nullptr. |
| 2970 | Increases <a href='undocumented#SkPathEffect'>SkPathEffect</a> <a href='undocumented#SkRefCnt'>SkRefCnt</a> by one. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2971 | |
| 2972 | ### Return Value |
| 2973 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2974 | <a href='undocumented#SkPathEffect'>SkPathEffect</a> if previously set, nullptr otherwise |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2975 | |
| 2976 | ### Example |
| 2977 | |
Cary Clark | 8364706 | 2018-07-18 16:21:51 -0400 | [diff] [blame] | 2978 | <div><fiddle-embed name="f56039b94c702c2704c8c5100e623aca"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2979 | |
| 2980 | #### Example Output |
| 2981 | |
| 2982 | ~~~~ |
| 2983 | path effect unique: true |
| 2984 | path effect unique: false |
| 2985 | ~~~~ |
| 2986 | |
| 2987 | </fiddle-embed></div> |
| 2988 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2989 | <a name='SkPaint_setPathEffect'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2990 | |
| 2991 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2992 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2993 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2994 | void <a href='#SkPaint_setPathEffect'>setPathEffect</a>(<a href='undocumented#sk_sp'>sk_sp</a><<a href='undocumented#SkPathEffect'>SkPathEffect</a>> pathEffect) |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2995 | </pre> |
| 2996 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2997 | Sets <a href='undocumented#SkPathEffect'>SkPathEffect</a> to <a href='#SkPaint_setPathEffect_pathEffect'>pathEffect</a>, decreasing <a href='undocumented#SkRefCnt'>SkRefCnt</a> of the previous |
| 2998 | <a href='undocumented#SkPathEffect'>SkPathEffect</a>. Pass nullptr to leave the <a href='SkPath_Reference#Path'>path</a> geometry unaltered. |
Cary Clark | 6fc5041 | 2017-09-21 12:31:06 -0400 | [diff] [blame] | 2999 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3000 | Increments <a href='#SkPaint_setPathEffect_pathEffect'>pathEffect</a> <a href='undocumented#SkRefCnt'>SkRefCnt</a> by one. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3001 | |
| 3002 | ### Parameters |
| 3003 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3004 | <table> <tr> <td><a name='SkPaint_setPathEffect_pathEffect'><code><strong>pathEffect</strong></code></a></td> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3005 | <td>replace <a href='SkPath_Reference#SkPath'>SkPath</a> with a modification when drawn</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3006 | </tr> |
| 3007 | </table> |
| 3008 | |
| 3009 | ### Example |
| 3010 | |
| 3011 | <div><fiddle-embed name="52dd55074ca0b7d520d04e750ca2a0d7"></fiddle-embed></div> |
| 3012 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3013 | <a name='Mask_Filter_Methods'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3014 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3015 | --- |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 3016 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3017 | <a href='#Mask_Filter'>Mask_Filter</a> uses coverage of the shape drawn to create <a href='#Mask_Alpha'>Mask_Alpha</a>. |
| 3018 | <a href='#Mask_Filter'>Mask_Filter</a> takes a Mask, and returns a Mask. |
Cary Clark | 6fc5041 | 2017-09-21 12:31:06 -0400 | [diff] [blame] | 3019 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3020 | <a href='#Mask_Filter'>Mask_Filter</a> may change the geometry and transparency of the shape, such as |
| 3021 | creating a blur effect. Set <a href='#Mask_Filter'>Mask_Filter</a> to nullptr to prevent <a href='#Mask_Filter'>Mask_Filter</a> from |
| 3022 | modifying the draw. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3023 | |
| 3024 | ### Example |
| 3025 | |
Cary Clark | 681287e | 2018-03-16 11:34:15 -0400 | [diff] [blame] | 3026 | <div><fiddle-embed name="55d7b9d482ac8e17a6153f555a8adb8d"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3027 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3028 | <a name='SkPaint_getMaskFilter'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3029 | |
| 3030 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3031 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3032 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 3033 | <a href='undocumented#SkMaskFilter'>SkMaskFilter</a>* <a href='#SkPaint_getMaskFilter'>getMaskFilter</a>()const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3034 | </pre> |
| 3035 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3036 | Returns <a href='undocumented#SkMaskFilter'>SkMaskFilter</a> if set, or nullptr. |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 3037 | Does not alter <a href='undocumented#SkMaskFilter'>SkMaskFilter</a> <a href='undocumented#SkRefCnt'>SkRefCnt</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3038 | |
| 3039 | ### Return Value |
| 3040 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3041 | <a href='undocumented#SkMaskFilter'>SkMaskFilter</a> if previously set, nullptr otherwise |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3042 | |
| 3043 | ### Example |
| 3044 | |
Cary Clark | 681287e | 2018-03-16 11:34:15 -0400 | [diff] [blame] | 3045 | <div><fiddle-embed name="5ac4b31371726da87bb7390b385e9fee"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3046 | |
| 3047 | #### Example Output |
| 3048 | |
| 3049 | ~~~~ |
| 3050 | nullptr == mask filter |
| 3051 | nullptr != mask filter |
| 3052 | ~~~~ |
| 3053 | |
| 3054 | </fiddle-embed></div> |
| 3055 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3056 | <a name='SkPaint_refMaskFilter'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3057 | |
| 3058 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3059 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3060 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 3061 | <a href='undocumented#sk_sp'>sk_sp</a><<a href='undocumented#SkMaskFilter'>SkMaskFilter</a>> <a href='#SkPaint_refMaskFilter'>refMaskFilter</a>()const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3062 | </pre> |
| 3063 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3064 | Returns <a href='undocumented#SkMaskFilter'>SkMaskFilter</a> if set, or nullptr. |
Cary Clark | 6fc5041 | 2017-09-21 12:31:06 -0400 | [diff] [blame] | 3065 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3066 | Increases <a href='undocumented#SkMaskFilter'>SkMaskFilter</a> <a href='undocumented#SkRefCnt'>SkRefCnt</a> by one. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3067 | |
| 3068 | ### Return Value |
| 3069 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3070 | <a href='undocumented#SkMaskFilter'>SkMaskFilter</a> if previously set, nullptr otherwise |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3071 | |
| 3072 | ### Example |
| 3073 | |
Cary Clark | 8364706 | 2018-07-18 16:21:51 -0400 | [diff] [blame] | 3074 | <div><fiddle-embed name="084b0dc3cebd78718c651d58f257f799"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3075 | |
| 3076 | #### Example Output |
| 3077 | |
| 3078 | ~~~~ |
| 3079 | mask filter unique: true |
| 3080 | mask filter unique: false |
| 3081 | ~~~~ |
| 3082 | |
| 3083 | </fiddle-embed></div> |
| 3084 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3085 | <a name='SkPaint_setMaskFilter'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3086 | |
| 3087 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3088 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3089 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3090 | void <a href='#SkPaint_setMaskFilter'>setMaskFilter</a>(<a href='undocumented#sk_sp'>sk_sp</a><<a href='undocumented#SkMaskFilter'>SkMaskFilter</a>> maskFilter) |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3091 | </pre> |
| 3092 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3093 | Sets <a href='undocumented#SkMaskFilter'>SkMaskFilter</a> to <a href='#SkPaint_setMaskFilter_maskFilter'>maskFilter</a>, decreasing <a href='undocumented#SkRefCnt'>SkRefCnt</a> of the previous |
| 3094 | <a href='undocumented#SkMaskFilter'>SkMaskFilter</a>. Pass nullptr to clear <a href='undocumented#SkMaskFilter'>SkMaskFilter</a> and leave <a href='undocumented#SkMaskFilter'>SkMaskFilter</a> effect on |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 3095 | <a href='undocumented#Mask_Alpha'>mask alpha</a> unaltered. |
Cary Clark | 6fc5041 | 2017-09-21 12:31:06 -0400 | [diff] [blame] | 3096 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3097 | Increments <a href='#SkPaint_setMaskFilter_maskFilter'>maskFilter</a> <a href='undocumented#SkRefCnt'>SkRefCnt</a> by one. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3098 | |
| 3099 | ### Parameters |
| 3100 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3101 | <table> <tr> <td><a name='SkPaint_setMaskFilter_maskFilter'><code><strong>maskFilter</strong></code></a></td> |
| 3102 | <td>modifies clipping mask generated from drawn geometry</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3103 | </tr> |
| 3104 | </table> |
| 3105 | |
| 3106 | ### Example |
| 3107 | |
Cary Clark | 681287e | 2018-03-16 11:34:15 -0400 | [diff] [blame] | 3108 | <div><fiddle-embed name="a993831c40f3e134f809134e3b74e4a6"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3109 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3110 | <a name='Typeface_Methods'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3111 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3112 | --- |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 3113 | |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 3114 | <a href='undocumented#Typeface'>Typeface</a> identifies the <a href='SkFont_Reference#Font'>font</a> used when drawing and measuring <a href='undocumented#Text'>text</a>. |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3115 | <a href='undocumented#Typeface'>Typeface</a> may be specified by name, from a file, or from a <a href='undocumented#Data'>data</a> <a href='SkStream_Reference#Stream'>stream</a>. |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 3116 | The default <a href='undocumented#Typeface'>Typeface</a> defers to the platform-specific default <a href='SkFont_Reference#Font'>font</a> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3117 | implementation. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3118 | |
| 3119 | ### Example |
| 3120 | |
skia-bookmaker | 61cc9fa | 2018-07-11 05:28:17 +0000 | [diff] [blame] | 3121 | <div><fiddle-embed name="1a7a5062725139760962582f599f1b97"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3122 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3123 | <a name='SkPaint_getTypeface'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3124 | |
| 3125 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3126 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3127 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 3128 | <a href='undocumented#SkTypeface'>SkTypeface</a>* <a href='#SkPaint_getTypeface'>getTypeface</a>()const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3129 | </pre> |
| 3130 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3131 | Returns <a href='undocumented#SkTypeface'>SkTypeface</a> if set, or nullptr. |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 3132 | Does not alter <a href='undocumented#SkTypeface'>SkTypeface</a> <a href='undocumented#SkRefCnt'>SkRefCnt</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3133 | |
| 3134 | ### Return Value |
| 3135 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3136 | <a href='undocumented#SkTypeface'>SkTypeface</a> if previously set, nullptr otherwise |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3137 | |
| 3138 | ### Example |
| 3139 | |
Cary Clark | f960398 | 2018-07-17 08:20:27 -0400 | [diff] [blame] | 3140 | <div><fiddle-embed name="5ce718e5a184baaac80e7098d7dad67b"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3141 | |
| 3142 | #### Example Output |
| 3143 | |
| 3144 | ~~~~ |
| 3145 | nullptr == typeface |
| 3146 | nullptr != typeface |
| 3147 | ~~~~ |
| 3148 | |
| 3149 | </fiddle-embed></div> |
| 3150 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3151 | <a name='SkPaint_refTypeface'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3152 | |
| 3153 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3154 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3155 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 3156 | <a href='undocumented#sk_sp'>sk_sp</a><<a href='undocumented#SkTypeface'>SkTypeface</a>> <a href='#SkPaint_refTypeface'>refTypeface</a>()const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3157 | </pre> |
| 3158 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3159 | Increases <a href='undocumented#SkTypeface'>SkTypeface</a> <a href='undocumented#SkRefCnt'>SkRefCnt</a> by one. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3160 | |
| 3161 | ### Return Value |
| 3162 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3163 | <a href='undocumented#SkTypeface'>SkTypeface</a> if previously set, nullptr otherwise |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3164 | |
| 3165 | ### Example |
| 3166 | |
Cary Clark | 8364706 | 2018-07-18 16:21:51 -0400 | [diff] [blame] | 3167 | <div><fiddle-embed name="8b5aa7e555a0dc31be69db7cadf471a1"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3168 | |
| 3169 | #### Example Output |
| 3170 | |
| 3171 | ~~~~ |
| 3172 | typeface1 != typeface2 |
| 3173 | typeface1 == typeface2 |
| 3174 | ~~~~ |
| 3175 | |
| 3176 | </fiddle-embed></div> |
| 3177 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3178 | <a name='SkPaint_setTypeface'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3179 | |
| 3180 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3181 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3182 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3183 | void <a href='#SkPaint_setTypeface'>setTypeface</a>(<a href='undocumented#sk_sp'>sk_sp</a><<a href='undocumented#SkTypeface'>SkTypeface</a>> <a href='undocumented#Typeface'>typeface</a>) |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3184 | </pre> |
| 3185 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3186 | Sets <a href='undocumented#SkTypeface'>SkTypeface</a> to <a href='#SkPaint_setTypeface_typeface'>typeface</a>, decreasing <a href='undocumented#SkRefCnt'>SkRefCnt</a> of the previous <a href='undocumented#SkTypeface'>SkTypeface</a>. |
| 3187 | Pass nullptr to clear <a href='undocumented#SkTypeface'>SkTypeface</a> and use the default <a href='#SkPaint_setTypeface_typeface'>typeface</a>. Increments |
| 3188 | <a href='#SkPaint_setTypeface_typeface'>typeface</a> <a href='undocumented#SkRefCnt'>SkRefCnt</a> by one. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3189 | |
| 3190 | ### Parameters |
| 3191 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3192 | <table> <tr> <td><a name='SkPaint_setTypeface_typeface'><code><strong>typeface</strong></code></a></td> |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 3193 | <td><a href='SkFont_Reference#Font'>font</a> and style used to draw <a href='undocumented#Text'>text</a></td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3194 | </tr> |
| 3195 | </table> |
| 3196 | |
| 3197 | ### Example |
| 3198 | |
Cary Clark | 71961fb | 2018-01-05 14:21:59 -0500 | [diff] [blame] | 3199 | <div><fiddle-embed name="0e6fbb7773cd925b274552f4cd1abef2"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3200 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3201 | <a name='Image_Filter_Methods'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3202 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3203 | --- |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 3204 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3205 | <a href='#Image_Filter'>Image_Filter</a> operates on the <a href='undocumented#Pixel'>pixel</a> representation of the shape, as modified by <a href='SkPaint_Reference#Paint'>Paint</a> |
| 3206 | with <a href='#Blend_Mode'>Blend_Mode</a> set to <a href='SkBlendMode_Reference#SkBlendMode'>SkBlendMode</a>::<a href='#SkBlendMode_kSrcOver'>kSrcOver</a>. <a href='#Image_Filter'>Image_Filter</a> creates a new <a href='SkBitmap_Reference#Bitmap'>bitmap</a>, |
| 3207 | which is drawn to the <a href='undocumented#Device'>device</a> using the set <a href='#Blend_Mode'>Blend_Mode</a>. |
Cary Clark | 6fc5041 | 2017-09-21 12:31:06 -0400 | [diff] [blame] | 3208 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3209 | <a href='#Image_Filter'>Image_Filter</a> is higher level than <a href='#Mask_Filter'>Mask_Filter</a>; for instance, an <a href='#Image_Filter'>Image_Filter</a> |
| 3210 | can operate on all channels of <a href='SkColor_Reference#Color'>Color</a>, while <a href='#Mask_Filter'>Mask_Filter</a> generates <a href='SkColor_Reference#Alpha'>Alpha</a> only. |
| 3211 | <a href='#Image_Filter'>Image_Filter</a> operates independently of and can be used in combination with |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 3212 | <a href='#Mask_Filter'>Mask_Filter</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3213 | |
| 3214 | ### Example |
| 3215 | |
skia-bookmaker | 44bad2e | 2018-07-05 05:35:27 +0000 | [diff] [blame] | 3216 | <div><fiddle-embed name="ece04ee3d3761e3425f37c8f06f054c1"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3217 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3218 | <a name='SkPaint_getImageFilter'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3219 | |
| 3220 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3221 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3222 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 3223 | <a href='undocumented#SkImageFilter'>SkImageFilter</a>* <a href='#SkPaint_getImageFilter'>getImageFilter</a>()const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3224 | </pre> |
| 3225 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3226 | Returns <a href='undocumented#SkImageFilter'>SkImageFilter</a> if set, or nullptr. |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 3227 | Does not alter <a href='undocumented#SkImageFilter'>SkImageFilter</a> <a href='undocumented#SkRefCnt'>SkRefCnt</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3228 | |
| 3229 | ### Return Value |
| 3230 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3231 | <a href='undocumented#SkImageFilter'>SkImageFilter</a> if previously set, nullptr otherwise |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3232 | |
| 3233 | ### Example |
| 3234 | |
skia-bookmaker | b95bbba | 2018-07-06 05:23:23 +0000 | [diff] [blame] | 3235 | <div><fiddle-embed name="c11f8eaa1dd149bc18db21e23ce26904"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3236 | |
| 3237 | #### Example Output |
| 3238 | |
| 3239 | ~~~~ |
| 3240 | nullptr == image filter |
| 3241 | nullptr != image filter |
| 3242 | ~~~~ |
| 3243 | |
| 3244 | </fiddle-embed></div> |
| 3245 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3246 | <a name='SkPaint_refImageFilter'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3247 | |
| 3248 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3249 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3250 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 3251 | <a href='undocumented#sk_sp'>sk_sp</a><<a href='undocumented#SkImageFilter'>SkImageFilter</a>> <a href='#SkPaint_refImageFilter'>refImageFilter</a>()const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3252 | </pre> |
| 3253 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3254 | Returns <a href='undocumented#SkImageFilter'>SkImageFilter</a> if set, or nullptr. |
| 3255 | Increases <a href='undocumented#SkImageFilter'>SkImageFilter</a> <a href='undocumented#SkRefCnt'>SkRefCnt</a> by one. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3256 | |
| 3257 | ### Return Value |
| 3258 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3259 | <a href='undocumented#SkImageFilter'>SkImageFilter</a> if previously set, nullptr otherwise |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3260 | |
| 3261 | ### Example |
| 3262 | |
| 3263 | <div><fiddle-embed name="13f09088b569251547107d14ae989dc1"> |
| 3264 | |
| 3265 | #### Example Output |
| 3266 | |
| 3267 | ~~~~ |
| 3268 | image filter unique: true |
| 3269 | image filter unique: false |
| 3270 | ~~~~ |
| 3271 | |
| 3272 | </fiddle-embed></div> |
| 3273 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3274 | <a name='SkPaint_setImageFilter'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3275 | |
| 3276 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3277 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3278 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3279 | void <a href='#SkPaint_setImageFilter'>setImageFilter</a>(<a href='undocumented#sk_sp'>sk_sp</a><<a href='undocumented#SkImageFilter'>SkImageFilter</a>> imageFilter) |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3280 | </pre> |
| 3281 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3282 | Sets <a href='undocumented#SkImageFilter'>SkImageFilter</a> to <a href='#SkPaint_setImageFilter_imageFilter'>imageFilter</a>, decreasing <a href='undocumented#SkRefCnt'>SkRefCnt</a> of the previous |
| 3283 | <a href='undocumented#SkImageFilter'>SkImageFilter</a>. Pass nullptr to clear <a href='undocumented#SkImageFilter'>SkImageFilter</a>, and remove <a href='undocumented#SkImageFilter'>SkImageFilter</a> effect |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3284 | on drawing. |
Cary Clark | 6fc5041 | 2017-09-21 12:31:06 -0400 | [diff] [blame] | 3285 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3286 | Increments <a href='#SkPaint_setImageFilter_imageFilter'>imageFilter</a> <a href='undocumented#SkRefCnt'>SkRefCnt</a> by one. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3287 | |
| 3288 | ### Parameters |
| 3289 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3290 | <table> <tr> <td><a name='SkPaint_setImageFilter_imageFilter'><code><strong>imageFilter</strong></code></a></td> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3291 | <td>how <a href='SkImage_Reference#SkImage'>SkImage</a> is sampled when transformed</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3292 | </tr> |
| 3293 | </table> |
| 3294 | |
| 3295 | ### Example |
| 3296 | |
| 3297 | <div><fiddle-embed name="6679d6e4ec632715ee03e68391bd7f9a"></fiddle-embed></div> |
| 3298 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3299 | <a name='Draw_Looper_Methods'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3300 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3301 | --- |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 3302 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3303 | <a href='#Draw_Looper'>Draw_Looper</a> sets a modifier that communicates state from one <a href='#Draw_Layer'>Draw_Layer</a> |
| 3304 | to another to construct the draw. |
Cary Clark | 6fc5041 | 2017-09-21 12:31:06 -0400 | [diff] [blame] | 3305 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3306 | <a href='#Draw_Looper'>Draw_Looper</a> draws one or more times, modifying the <a href='SkCanvas_Reference#Canvas'>canvas</a> and <a href='SkPaint_Reference#Paint'>paint</a> each time. |
| 3307 | <a href='#Draw_Looper'>Draw_Looper</a> may be used to draw multiple colors or create a colored shadow. |
| 3308 | Set <a href='#Draw_Looper'>Draw_Looper</a> to nullptr to prevent <a href='#Draw_Looper'>Draw_Looper</a> from modifying the draw. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3309 | |
| 3310 | ### Example |
| 3311 | |
| 3312 | <div><fiddle-embed name="84ec12a36e50df5ac565cc7a75ffbe9f"></fiddle-embed></div> |
| 3313 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3314 | <a name='SkPaint_getDrawLooper'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3315 | |
| 3316 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3317 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3318 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 3319 | <a href='undocumented#SkDrawLooper'>SkDrawLooper</a>* <a href='#SkPaint_getDrawLooper'>getDrawLooper</a>()const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3320 | </pre> |
| 3321 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3322 | Returns <a href='undocumented#SkDrawLooper'>SkDrawLooper</a> if set, or nullptr. |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 3323 | Does not alter <a href='undocumented#SkDrawLooper'>SkDrawLooper</a> <a href='undocumented#SkRefCnt'>SkRefCnt</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3324 | |
| 3325 | ### Return Value |
| 3326 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3327 | <a href='undocumented#SkDrawLooper'>SkDrawLooper</a> if previously set, nullptr otherwise |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3328 | |
| 3329 | ### Example |
| 3330 | |
| 3331 | <div><fiddle-embed name="af4c5acc7a91e7f23c2af48018903ad4"> |
| 3332 | |
| 3333 | #### Example Output |
| 3334 | |
| 3335 | ~~~~ |
| 3336 | nullptr == draw looper |
| 3337 | nullptr != draw looper |
| 3338 | ~~~~ |
| 3339 | |
| 3340 | </fiddle-embed></div> |
| 3341 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3342 | <a name='SkPaint_refDrawLooper'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3343 | |
| 3344 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3345 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3346 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 3347 | <a href='undocumented#sk_sp'>sk_sp</a><<a href='undocumented#SkDrawLooper'>SkDrawLooper</a>> <a href='#SkPaint_refDrawLooper'>refDrawLooper</a>()const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3348 | </pre> |
| 3349 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3350 | Returns <a href='undocumented#SkDrawLooper'>SkDrawLooper</a> if set, or nullptr. |
| 3351 | Increases <a href='undocumented#SkDrawLooper'>SkDrawLooper</a> <a href='undocumented#SkRefCnt'>SkRefCnt</a> by one. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3352 | |
| 3353 | ### Return Value |
| 3354 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3355 | <a href='undocumented#SkDrawLooper'>SkDrawLooper</a> if previously set, nullptr otherwise |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3356 | |
| 3357 | ### Example |
| 3358 | |
| 3359 | <div><fiddle-embed name="2a3782c33f04ed17a725d0e449c6f7c3"> |
| 3360 | |
| 3361 | #### Example Output |
| 3362 | |
| 3363 | ~~~~ |
| 3364 | draw looper unique: true |
| 3365 | draw looper unique: false |
| 3366 | ~~~~ |
| 3367 | |
| 3368 | </fiddle-embed></div> |
| 3369 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3370 | <a name='SkPaint_setDrawLooper'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3371 | |
| 3372 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3373 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3374 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | abaffd8 | 2018-11-15 08:25:12 -0500 | [diff] [blame] | 3375 | void <a href='#SkPaint_setDrawLooper'>setDrawLooper</a>(<a href='undocumented#sk_sp'>sk_sp</a><<a href='undocumented#SkDrawLooper'>SkDrawLooper</a>> drawLooper) |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3376 | </pre> |
| 3377 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3378 | Sets <a href='undocumented#SkDrawLooper'>SkDrawLooper</a> to <a href='#SkPaint_setDrawLooper_drawLooper'>drawLooper</a>, decreasing <a href='undocumented#SkRefCnt'>SkRefCnt</a> of the previous |
| 3379 | <a href='#SkPaint_setDrawLooper_drawLooper'>drawLooper</a>. Pass nullptr to clear <a href='undocumented#SkDrawLooper'>SkDrawLooper</a> and leave <a href='undocumented#SkDrawLooper'>SkDrawLooper</a> effect on |
Cary Clark | 6fc5041 | 2017-09-21 12:31:06 -0400 | [diff] [blame] | 3380 | drawing unaltered. |
| 3381 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3382 | Increments <a href='#SkPaint_setDrawLooper_drawLooper'>drawLooper</a> <a href='undocumented#SkRefCnt'>SkRefCnt</a> by one. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3383 | |
| 3384 | ### Parameters |
| 3385 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3386 | <table> <tr> <td><a name='SkPaint_setDrawLooper_drawLooper'><code><strong>drawLooper</strong></code></a></td> |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 3387 | <td>iterates through drawing one or more time, altering <a href='SkPaint_Reference#SkPaint'>SkPaint</a></td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3388 | </tr> |
| 3389 | </table> |
| 3390 | |
| 3391 | ### Example |
| 3392 | |
| 3393 | <div><fiddle-embed name="bf10f838b330f0a3a3266d42ea68a638"></fiddle-embed></div> |
| 3394 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3395 | <a name='Text_Size'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3396 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3397 | --- |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 3398 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3399 | <a href='#Paint_Text_Size'>Text_Size</a> adjusts the overall <a href='#Text_Size'>text size</a> in <a href='SkPoint_Reference#Point'>points</a>. |
| 3400 | <a href='#Paint_Text_Size'>Text_Size</a> can be set to any positive value or zero. |
| 3401 | <a href='#Paint_Text_Size'>Text_Size</a> defaults to 12. |
| 3402 | Set <a href='undocumented#SkPaintDefaults_TextSize'>SkPaintDefaults_TextSize</a> at compile time to change the default setting. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3403 | |
| 3404 | ### Example |
| 3405 | |
| 3406 | <div><fiddle-embed name="91c9a3e498bb9412e4522a95d076ed5f"></fiddle-embed></div> |
| 3407 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3408 | <a name='SkPaint_getTextSize'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3409 | |
| 3410 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3411 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3412 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 3413 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_getTextSize'>getTextSize</a>()const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3414 | </pre> |
| 3415 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3416 | Returns <a href='undocumented#Text'>text</a> <a href='undocumented#Size'>size</a> in <a href='SkPoint_Reference#Point'>points</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3417 | |
| 3418 | ### Return Value |
| 3419 | |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 3420 | typographic height of <a href='undocumented#Text'>text</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3421 | |
| 3422 | ### Example |
| 3423 | |
skia-bookmaker | 233c652 | 2018-07-04 05:33:26 +0000 | [diff] [blame] | 3424 | <div><fiddle-embed name="983e2a71ba72d4ba8c945420040b8f1c"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3425 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3426 | <a name='SkPaint_setTextSize'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3427 | |
| 3428 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3429 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3430 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3431 | void <a href='#SkPaint_setTextSize'>setTextSize</a>(<a href='undocumented#SkScalar'>SkScalar</a> textSize) |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3432 | </pre> |
| 3433 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3434 | Sets <a href='#Text_Size'>text size</a> in <a href='SkPoint_Reference#Point'>points</a>. |
| 3435 | Has no effect if <a href='#SkPaint_setTextSize_textSize'>textSize</a> is not greater than or equal to zero. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3436 | |
| 3437 | ### Parameters |
| 3438 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3439 | <table> <tr> <td><a name='SkPaint_setTextSize_textSize'><code><strong>textSize</strong></code></a></td> |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 3440 | <td>typographic height of <a href='undocumented#Text'>text</a></td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3441 | </tr> |
| 3442 | </table> |
| 3443 | |
| 3444 | ### Example |
| 3445 | |
skia-bookmaker | 44bad2e | 2018-07-05 05:35:27 +0000 | [diff] [blame] | 3446 | <div><fiddle-embed name="6510c9e2f57b83c47e67829e7a68d493"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3447 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3448 | <a name='Text_Scale_X'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3449 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3450 | --- |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 3451 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3452 | <a href='#Paint_Text_Scale_X'>Text_Scale_X</a> adjusts the <a href='undocumented#Text'>text</a> horizontal scale. |
| 3453 | <a href='undocumented#Text'>Text</a> scaling approximates condensed and expanded type faces when the actual face |
| 3454 | is not available. |
| 3455 | <a href='#Paint_Text_Scale_X'>Text_Scale_X</a> can be set to any value. |
| 3456 | <a href='#Paint_Text_Scale_X'>Text_Scale_X</a> defaults to 1. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3457 | |
| 3458 | ### Example |
| 3459 | |
skia-bookmaker | 44bad2e | 2018-07-05 05:35:27 +0000 | [diff] [blame] | 3460 | <div><fiddle-embed name="d13d787c1e36f515319fc998411c1d91"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3461 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3462 | <a name='SkPaint_getTextScaleX'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3463 | |
| 3464 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3465 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3466 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 3467 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_getTextScaleX'>getTextScaleX</a>()const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3468 | </pre> |
| 3469 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3470 | Returns <a href='undocumented#Text'>text</a> scale on x-axis. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3471 | Default value is 1. |
| 3472 | |
| 3473 | ### Return Value |
| 3474 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3475 | <a href='undocumented#Text'>text</a> horizontal scale |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3476 | |
| 3477 | ### Example |
| 3478 | |
| 3479 | <div><fiddle-embed name="5dc8e58f6910cb8e4de9ed60f888188b"></fiddle-embed></div> |
| 3480 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3481 | <a name='SkPaint_setTextScaleX'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3482 | |
| 3483 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3484 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3485 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3486 | void <a href='#SkPaint_setTextScaleX'>setTextScaleX</a>(<a href='undocumented#SkScalar'>SkScalar</a> scaleX) |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3487 | </pre> |
| 3488 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3489 | Sets <a href='undocumented#Text'>text scale</a> on x-axis. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3490 | Default value is 1. |
| 3491 | |
| 3492 | ### Parameters |
| 3493 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3494 | <table> <tr> <td><a name='SkPaint_setTextScaleX_scaleX'><code><strong>scaleX</strong></code></a></td> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3495 | <td><a href='undocumented#Text'>text</a> horizontal scale</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3496 | </tr> |
| 3497 | </table> |
| 3498 | |
| 3499 | ### Example |
| 3500 | |
| 3501 | <div><fiddle-embed name="a75bbdb8bb866b125c4c1dd5e967d470"></fiddle-embed></div> |
| 3502 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3503 | <a name='Text_Skew_X'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3504 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3505 | --- |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 3506 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3507 | <a href='#Paint_Text_Skew_X'>Text_Skew_X</a> adjusts the <a href='undocumented#Text'>text</a> horizontal slant. |
| 3508 | <a href='undocumented#Text'>Text</a> skewing approximates italic and oblique type faces when the actual face |
| 3509 | is not available. |
| 3510 | <a href='#Paint_Text_Skew_X'>Text_Skew_X</a> can be set to any value. |
| 3511 | <a href='#Paint_Text_Skew_X'>Text_Skew_X</a> defaults to 0. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3512 | |
| 3513 | ### Example |
| 3514 | |
| 3515 | <div><fiddle-embed name="aff208b0aab265f273045b27e683c17c"></fiddle-embed></div> |
| 3516 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3517 | <a name='SkPaint_getTextSkewX'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3518 | |
| 3519 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3520 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3521 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 3522 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_getTextSkewX'>getTextSkewX</a>()const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3523 | </pre> |
| 3524 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3525 | Returns <a href='undocumented#Text'>text</a> skew on x-axis. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3526 | Default value is zero. |
| 3527 | |
| 3528 | ### Return Value |
| 3529 | |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 3530 | additional shear on x-axis relative to y-axis |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3531 | |
| 3532 | ### Example |
| 3533 | |
Cary Clark | 7f644ec | 2018-07-19 10:50:44 -0400 | [diff] [blame] | 3534 | <div><fiddle-embed name="11c10f466dae0d1639dbb9f6a0040218"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3535 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3536 | <a name='SkPaint_setTextSkewX'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3537 | |
| 3538 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3539 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3540 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3541 | void <a href='#SkPaint_setTextSkewX'>setTextSkewX</a>(<a href='undocumented#SkScalar'>SkScalar</a> skewX) |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3542 | </pre> |
| 3543 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3544 | Sets <a href='undocumented#Text'>text skew</a> on x-axis. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3545 | Default value is zero. |
| 3546 | |
| 3547 | ### Parameters |
| 3548 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3549 | <table> <tr> <td><a name='SkPaint_setTextSkewX_skewX'><code><strong>skewX</strong></code></a></td> |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 3550 | <td>additional shear on x-axis relative to y-axis</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3551 | </tr> |
| 3552 | </table> |
| 3553 | |
| 3554 | ### Example |
| 3555 | |
skia-bookmaker | 61cc9fa | 2018-07-11 05:28:17 +0000 | [diff] [blame] | 3556 | <div><fiddle-embed name="6bd705a6e0c5f8ee24f302fe531bfabc"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3557 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3558 | <a name='Text_Encoding'></a> |
| 3559 | |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3560 | --- |
| 3561 | |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3562 | ### Example |
| 3563 | |
Cary Clark | 3e73dcf | 2018-12-06 08:41:14 -0500 | [diff] [blame^] | 3564 | <div><fiddle-embed name="767fa4e7b6300e16a419f9881f0f9d3d"><div>First <a href='undocumented#Line'>line</a> is encoded in UTF-8. |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3565 | Second <a href='undocumented#Line'>line</a> is encoded in UTF-16. |
| 3566 | Third <a href='undocumented#Line'>line</a> is encoded in UTF-32. |
| 3567 | Fourth <a href='undocumented#Line'>line</a> has 16-bit <a href='undocumented#Glyph'>glyph</a> indices. |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 3568 | </div></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3569 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3570 | <a name='SkPaint_getTextEncoding'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3571 | |
| 3572 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3573 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3574 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | 3e73dcf | 2018-12-06 08:41:14 -0500 | [diff] [blame^] | 3575 | <a href='undocumented#SkTextEncoding'>SkTextEncoding</a> <a href='#SkPaint_getTextEncoding'>getTextEncoding</a>()const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3576 | </pre> |
| 3577 | |
Cary Clark | 3e73dcf | 2018-12-06 08:41:14 -0500 | [diff] [blame^] | 3578 | Returns the <a href='undocumented#Text'>text</a> encoding. <a href='undocumented#Text'>Text</a> encoding describes how to interpret the <a href='undocumented#Text'>text</a> bytes pass |
| 3579 | to methods like <a href='#SkPaint_measureText'>measureText</a>() and <a href='SkCanvas_Reference#SkCanvas'>SkCanvas</a>::<a href='#SkCanvas_drawText'>drawText</a>(). |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3580 | |
| 3581 | ### Return Value |
| 3582 | |
Cary Clark | 3e73dcf | 2018-12-06 08:41:14 -0500 | [diff] [blame^] | 3583 | the <a href='undocumented#Text'>text</a> encoding |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3584 | |
| 3585 | ### Example |
| 3586 | |
Cary Clark | 3e73dcf | 2018-12-06 08:41:14 -0500 | [diff] [blame^] | 3587 | <div><fiddle-embed name="0d21e968e9a4c78c902ae3ef494941a0"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3588 | |
| 3589 | #### Example Output |
| 3590 | |
| 3591 | ~~~~ |
Cary Clark | 3e73dcf | 2018-12-06 08:41:14 -0500 | [diff] [blame^] | 3592 | kUTF8_SkTextEncoding == text encoding |
| 3593 | kGlyphID_SkTextEncoding == text encoding |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3594 | ~~~~ |
| 3595 | |
| 3596 | </fiddle-embed></div> |
| 3597 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3598 | <a name='SkPaint_setTextEncoding'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3599 | |
| 3600 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3601 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3602 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | 3e73dcf | 2018-12-06 08:41:14 -0500 | [diff] [blame^] | 3603 | void <a href='#SkPaint_setTextEncoding'>setTextEncoding</a>(<a href='undocumented#SkTextEncoding'>SkTextEncoding</a> encoding) |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3604 | </pre> |
| 3605 | |
Cary Clark | 3e73dcf | 2018-12-06 08:41:14 -0500 | [diff] [blame^] | 3606 | Sets the <a href='#Text_Encoding'>text encoding</a>. <a href='undocumented#Text'>Text</a> <a href='#SkPaint_setTextEncoding_encoding'>encoding</a> describes how to interpret the <a href='undocumented#Text'>text</a> bytes pass |
| 3607 | to methods like <a href='#SkPaint_measureText'>measureText</a>() and <a href='SkCanvas_Reference#SkCanvas'>SkCanvas</a>::<a href='#SkCanvas_drawText'>drawText</a>(). |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3608 | |
| 3609 | ### Parameters |
| 3610 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3611 | <table> <tr> <td><a name='SkPaint_setTextEncoding_encoding'><code><strong>encoding</strong></code></a></td> |
Cary Clark | 3e73dcf | 2018-12-06 08:41:14 -0500 | [diff] [blame^] | 3612 | <td>the new <a href='#Text_Encoding'>text encoding</a></td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3613 | </tr> |
| 3614 | </table> |
| 3615 | |
| 3616 | ### Example |
| 3617 | |
Cary Clark | 3e73dcf | 2018-12-06 08:41:14 -0500 | [diff] [blame^] | 3618 | <div><fiddle-embed name="a5d1ba0dbf42afb797ffdb07647b5cb9"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3619 | |
| 3620 | #### Example Output |
| 3621 | |
| 3622 | ~~~~ |
| 3623 | 4 != text encoding |
| 3624 | ~~~~ |
| 3625 | |
| 3626 | </fiddle-embed></div> |
| 3627 | |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 3628 | <a name='SkPaint_FontMetrics'></a> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3629 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3630 | --- |
| 3631 | |
Cary Clark | 7e69c8f | 2018-11-06 20:40:45 -0500 | [diff] [blame] | 3632 | <a name='Font_Metrics'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3633 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3634 | <a name='SkPaint_getFontMetrics'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3635 | |
| 3636 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3637 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3638 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 3639 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_getFontMetrics'>getFontMetrics</a>(<a href='undocumented#SkFontMetrics'>SkFontMetrics</a>* metrics)const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3640 | </pre> |
| 3641 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3642 | Returns <a href='undocumented#SkFontMetrics'>SkFontMetrics</a> associated with <a href='undocumented#SkTypeface'>SkTypeface</a>. |
| 3643 | The return value is the recommended spacing between <a href='undocumented#Line'>lines</a>: the sum of <a href='#SkPaint_getFontMetrics_metrics'>metrics</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3644 | descent, ascent, and leading. |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3645 | If <a href='#SkPaint_getFontMetrics_metrics'>metrics</a> is not nullptr, <a href='undocumented#SkFontMetrics'>SkFontMetrics</a> is copied to <a href='#SkPaint_getFontMetrics_metrics'>metrics</a>. |
| 3646 | Results are scaled by <a href='#Text_Size'>text size</a> but does not take into account |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 3647 | 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>, |
| 3648 | <a href='#Style_Stroke'>style stroke</a>, and <a href='undocumented#SkPathEffect'>SkPathEffect</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3649 | |
| 3650 | ### Parameters |
| 3651 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3652 | <table> <tr> <td><a name='SkPaint_getFontMetrics_metrics'><code><strong>metrics</strong></code></a></td> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3653 | <td>storage for <a href='undocumented#SkFontMetrics'>SkFontMetrics</a>; may be nullptr</td> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3654 | </tr> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3655 | </table> |
| 3656 | |
| 3657 | ### Return Value |
| 3658 | |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 3659 | recommended spacing between <a href='undocumented#Line'>lines</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3660 | |
| 3661 | ### Example |
| 3662 | |
skia-bookmaker | 2dc1e34 | 2018-11-02 05:33:11 +0000 | [diff] [blame] | 3663 | <div><fiddle-embed name="59d9b8249afa1c2af6186711250ce240"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3664 | |
| 3665 | ### See Also |
| 3666 | |
Cary Clark | 3e73dcf | 2018-12-06 08:41:14 -0500 | [diff] [blame^] | 3667 | <a href='#Font_Size'>Font_Size</a> <a href='undocumented#Typeface'>Typeface</a> <a href='#Paint_Typeface_Methods'>Typeface_Methods</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3668 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3669 | <a name='SkPaint_getFontSpacing'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3670 | |
| 3671 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3672 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3673 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 3674 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_getFontSpacing'>getFontSpacing</a>()const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3675 | </pre> |
| 3676 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3677 | Returns the recommended spacing between <a href='undocumented#Line'>lines</a>: the sum of metrics |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3678 | descent, ascent, and leading. |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3679 | Result is scaled by <a href='undocumented#Text'>text</a> <a href='undocumented#Size'>size</a> but does not take into account |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 3680 | dimensions required by stroking and <a href='undocumented#SkPathEffect'>SkPathEffect</a>. |
| 3681 | Returns the same result as <a href='#SkPaint_getFontMetrics'>getFontMetrics</a>(). |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3682 | |
| 3683 | ### Return Value |
| 3684 | |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 3685 | recommended spacing between <a href='undocumented#Line'>lines</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3686 | |
| 3687 | ### Example |
| 3688 | |
| 3689 | <div><fiddle-embed name="424741e26e1b174e43087d67422ce14f"> |
| 3690 | |
| 3691 | #### Example Output |
| 3692 | |
| 3693 | ~~~~ |
| 3694 | textSize: 12 fontSpacing: 13.9688 |
| 3695 | textSize: 18 fontSpacing: 20.9531 |
| 3696 | textSize: 24 fontSpacing: 27.9375 |
| 3697 | textSize: 32 fontSpacing: 37.25 |
| 3698 | ~~~~ |
| 3699 | |
| 3700 | </fiddle-embed></div> |
| 3701 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3702 | <a name='SkPaint_textToGlyphs'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3703 | |
| 3704 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3705 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3706 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 3707 | int <a href='#SkPaint_textToGlyphs'>textToGlyphs</a>(const void* <a href='undocumented#Text'>text</a>, size_t byteLength, <a href='undocumented#SkGlyphID'>SkGlyphID</a> <a href='undocumented#Glyph'>glyphs</a>[])const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3708 | </pre> |
| 3709 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3710 | Converts <a href='#SkPaint_textToGlyphs_text'>text</a> into <a href='undocumented#Glyph'>glyph</a> indices. |
| 3711 | Returns the number of <a href='undocumented#Glyph'>glyph</a> indices represented by <a href='#SkPaint_textToGlyphs_text'>text</a>. |
skia-bookmaker | fe47c2a | 2018-12-04 06:13:55 +0000 | [diff] [blame] | 3712 | <a href='undocumented#SkTextEncoding'>SkTextEncoding</a> specifies how <a href='#SkPaint_textToGlyphs_text'>text</a> represents characters or <a href='#SkPaint_textToGlyphs_glyphs'>glyphs</a>. |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3713 | <a href='#SkPaint_textToGlyphs_glyphs'>glyphs</a> may be nullptr, to compute the <a href='undocumented#Glyph'>glyph</a> count. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3714 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3715 | Does not check <a href='#SkPaint_textToGlyphs_text'>text</a> for valid character codes or valid <a href='undocumented#Glyph'>glyph</a> indices. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3716 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3717 | If <a href='#SkPaint_textToGlyphs_byteLength'>byteLength</a> equals zero, returns zero. |
| 3718 | If <a href='#SkPaint_textToGlyphs_byteLength'>byteLength</a> includes a partial character, the partial character is ignored. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3719 | |
skia-bookmaker | fe47c2a | 2018-12-04 06:13:55 +0000 | [diff] [blame] | 3720 | If <a href='undocumented#SkTextEncoding'>SkTextEncoding</a> is <a href='undocumented#kUTF8_SkTextEncoding'>kUTF8_SkTextEncoding</a> and |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3721 | <a href='#SkPaint_textToGlyphs_text'>text</a> contains an invalid UTF-8 sequence, zero is returned. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3722 | |
| 3723 | ### Parameters |
| 3724 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3725 | <table> <tr> <td><a name='SkPaint_textToGlyphs_text'><code><strong>text</strong></code></a></td> |
skia-bookmaker | fe47c2a | 2018-12-04 06:13:55 +0000 | [diff] [blame] | 3726 | <td>character storage encoded with <a href='undocumented#SkTextEncoding'>SkTextEncoding</a></td> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3727 | </tr> |
| 3728 | <tr> <td><a name='SkPaint_textToGlyphs_byteLength'><code><strong>byteLength</strong></code></a></td> |
| 3729 | <td>length of character storage in bytes</td> |
| 3730 | </tr> |
| 3731 | <tr> <td><a name='SkPaint_textToGlyphs_glyphs'><code><strong>glyphs</strong></code></a></td> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3732 | <td>storage for <a href='undocumented#Glyph'>glyph</a> indices; may be nullptr</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3733 | </tr> |
| 3734 | </table> |
| 3735 | |
| 3736 | ### Return Value |
| 3737 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3738 | 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> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3739 | |
| 3740 | ### Example |
| 3741 | |
Cary Clark | 3e73dcf | 2018-12-06 08:41:14 -0500 | [diff] [blame^] | 3742 | <div><fiddle-embed name="d11136d8a74f63009da2a7f550710823"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3743 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3744 | <a name='SkPaint_countText'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3745 | |
| 3746 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3747 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3748 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 3749 | int <a href='#SkPaint_countText'>countText</a>(const void* <a href='undocumented#Text'>text</a>, size_t byteLength)const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3750 | </pre> |
| 3751 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3752 | Returns the number of <a href='undocumented#Glyph'>glyphs</a> in <a href='#SkPaint_countText_text'>text</a>. |
skia-bookmaker | fe47c2a | 2018-12-04 06:13:55 +0000 | [diff] [blame] | 3753 | Uses <a href='undocumented#SkTextEncoding'>SkTextEncoding</a> to count the <a href='undocumented#Glyph'>glyphs</a>. |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 3754 | Returns the same result as <a href='#SkPaint_textToGlyphs'>textToGlyphs</a>(). |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3755 | |
| 3756 | ### Parameters |
| 3757 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3758 | <table> <tr> <td><a name='SkPaint_countText_text'><code><strong>text</strong></code></a></td> |
skia-bookmaker | fe47c2a | 2018-12-04 06:13:55 +0000 | [diff] [blame] | 3759 | <td>character storage encoded with <a href='undocumented#SkTextEncoding'>SkTextEncoding</a></td> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3760 | </tr> |
| 3761 | <tr> <td><a name='SkPaint_countText_byteLength'><code><strong>byteLength</strong></code></a></td> |
| 3762 | <td>length of character storage in bytes</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3763 | </tr> |
| 3764 | </table> |
| 3765 | |
| 3766 | ### Return Value |
| 3767 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3768 | number of <a href='undocumented#Glyph'>glyphs</a> represented by <a href='#SkPaint_countText_text'>text</a> of length <a href='#SkPaint_countText_byteLength'>byteLength</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3769 | |
| 3770 | ### Example |
| 3771 | |
Cary Clark | f960398 | 2018-07-17 08:20:27 -0400 | [diff] [blame] | 3772 | <div><fiddle-embed name="85436c71aab5410767fc688ab0573e09"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3773 | |
| 3774 | #### Example Output |
| 3775 | |
| 3776 | ~~~~ |
| 3777 | count = 5 |
| 3778 | ~~~~ |
| 3779 | |
| 3780 | </fiddle-embed></div> |
| 3781 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3782 | <a name='SkPaint_containsText'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3783 | |
| 3784 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3785 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3786 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 3787 | bool <a href='#SkPaint_containsText'>containsText</a>(const void* <a href='undocumented#Text'>text</a>, size_t byteLength)const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3788 | </pre> |
| 3789 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3790 | Returns true if all <a href='#SkPaint_containsText_text'>text</a> corresponds to a non-zero <a href='undocumented#Glyph'>glyph</a> index. |
| 3791 | Returns false if any characters in <a href='#SkPaint_containsText_text'>text</a> are not supported in |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 3792 | <a href='undocumented#SkTypeface'>SkTypeface</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3793 | |
skia-bookmaker | fe47c2a | 2018-12-04 06:13:55 +0000 | [diff] [blame] | 3794 | If <a href='undocumented#SkTextEncoding'>SkTextEncoding</a> is <a href='undocumented#kGlyphID_SkTextEncoding'>kGlyphID_SkTextEncoding</a>, |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3795 | returns true if all <a href='undocumented#Glyph'>glyph</a> indices in <a href='#SkPaint_containsText_text'>text</a> are non-zero; |
| 3796 | does not check to see if <a href='#SkPaint_containsText_text'>text</a> contains valid <a href='undocumented#Glyph'>glyph</a> indices for <a href='undocumented#SkTypeface'>SkTypeface</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3797 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3798 | Returns true if <a href='#SkPaint_containsText_byteLength'>byteLength</a> is zero. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3799 | |
| 3800 | ### Parameters |
| 3801 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3802 | <table> <tr> <td><a name='SkPaint_containsText_text'><code><strong>text</strong></code></a></td> |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 3803 | <td>array of characters or <a href='undocumented#Glyph'>glyphs</a></td> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3804 | </tr> |
| 3805 | <tr> <td><a name='SkPaint_containsText_byteLength'><code><strong>byteLength</strong></code></a></td> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3806 | <td>number of bytes in <a href='#SkPaint_containsText_text'>text</a> array</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3807 | </tr> |
| 3808 | </table> |
| 3809 | |
| 3810 | ### Return Value |
| 3811 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3812 | true if all <a href='#SkPaint_containsText_text'>text</a> corresponds to a non-zero <a href='undocumented#Glyph'>glyph</a> index |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3813 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3814 | <div><a href='#SkPaint_containsText'>containsText</a> succeeds for degree symbol, but cannot find a <a href='undocumented#Glyph'>glyph</a> index |
| 3815 | corresponding to the Unicode surrogate code <a href='SkPoint_Reference#Point'>point</a>. |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 3816 | </div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3817 | |
| 3818 | #### Example Output |
| 3819 | |
| 3820 | ~~~~ |
| 3821 | 0x00b0 == has char |
| 3822 | 0xd800 != has char |
| 3823 | ~~~~ |
| 3824 | |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3825 | ### Example |
| 3826 | |
Cary Clark | 3e73dcf | 2018-12-06 08:41:14 -0500 | [diff] [blame^] | 3827 | <div><fiddle-embed name="6a68cb3c8b81a5976c81ee004f559247"><div><a href='#SkPaint_containsText'>containsText</a> returns true that <a href='undocumented#Glyph'>glyph</a> index is greater than zero, not |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3828 | that it corresponds to an entry in <a href='undocumented#Typeface'>Typeface</a>. |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 3829 | </div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3830 | |
| 3831 | #### Example Output |
| 3832 | |
| 3833 | ~~~~ |
| 3834 | 0x01ff == has glyph |
| 3835 | 0x0000 != has glyph |
| 3836 | 0xffff == has glyph |
| 3837 | ~~~~ |
| 3838 | |
| 3839 | </fiddle-embed></div> |
| 3840 | |
| 3841 | ### See Also |
| 3842 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3843 | <a href='#SkPaint_setTextEncoding'>setTextEncoding</a> <a href='undocumented#Typeface'>Typeface</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3844 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3845 | <a name='SkPaint_glyphsToUnichars'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3846 | |
| 3847 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3848 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3849 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 3850 | void <a href='#SkPaint_glyphsToUnichars'>glyphsToUnichars</a>(const <a href='undocumented#SkGlyphID'>SkGlyphID</a> <a href='undocumented#Glyph'>glyphs</a>[], int count, <a href='undocumented#SkUnichar'>SkUnichar</a> <a href='undocumented#Text'>text</a>[])const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3851 | </pre> |
| 3852 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3853 | Converts <a href='#SkPaint_glyphsToUnichars_glyphs'>glyphs</a> into <a href='#SkPaint_glyphsToUnichars_text'>text</a> if possible. |
| 3854 | <a href='undocumented#Glyph'>Glyph</a> values without direct Unicode equivalents are mapped to zero. |
| 3855 | Uses the <a href='undocumented#SkTypeface'>SkTypeface</a>, but is unaffected |
skia-bookmaker | fe47c2a | 2018-12-04 06:13:55 +0000 | [diff] [blame] | 3856 | by <a href='undocumented#SkTextEncoding'>SkTextEncoding</a>; the <a href='#SkPaint_glyphsToUnichars_text'>text</a> values returned are equivalent to <a href='undocumented#kUTF32_SkTextEncoding'>kUTF32_SkTextEncoding</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3857 | |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 3858 | Only supported on platforms that use FreeType as the <a href='SkFont_Reference#Font_Engine'>font engine</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3859 | |
| 3860 | ### Parameters |
| 3861 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3862 | <table> <tr> <td><a name='SkPaint_glyphsToUnichars_glyphs'><code><strong>glyphs</strong></code></a></td> |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 3863 | <td>array of indices into <a href='SkFont_Reference#Font'>font</a></td> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3864 | </tr> |
| 3865 | <tr> <td><a name='SkPaint_glyphsToUnichars_count'><code><strong>count</strong></code></a></td> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3866 | <td>length of <a href='undocumented#Glyph'>glyph</a> array</td> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3867 | </tr> |
| 3868 | <tr> <td><a name='SkPaint_glyphsToUnichars_text'><code><strong>text</strong></code></a></td> |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 3869 | <td>storage for character codes, one per <a href='undocumented#Glyph'>glyph</a></td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3870 | </tr> |
| 3871 | </table> |
| 3872 | |
| 3873 | ### Example |
| 3874 | |
Cary Clark | 3e73dcf | 2018-12-06 08:41:14 -0500 | [diff] [blame^] | 3875 | <div><fiddle-embed name="79c550ec6c34054ab60fbcd1b81adc03"><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 <a href='SkPoint_Reference#Point'>points</a>. |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 3876 | </div></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3877 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3878 | <a name='Measure_Text'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3879 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3880 | <a name='SkPaint_measureText'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3881 | |
| 3882 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3883 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3884 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 3885 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_measureText'>measureText</a>(const void* <a href='undocumented#Text'>text</a>, size_t length, <a href='SkRect_Reference#SkRect'>SkRect</a>* bounds)const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3886 | </pre> |
| 3887 | |
Cary Clark | 3aca39d | 2018-10-23 14:44:05 -0400 | [diff] [blame] | 3888 | Returns the advance width of <a href='#SkPaint_measureText_text'>text</a>. |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3889 | The advance is the normal distance to move before drawing additional <a href='#SkPaint_measureText_text'>text</a>. |
skia-bookmaker | fe47c2a | 2018-12-04 06:13:55 +0000 | [diff] [blame] | 3890 | Uses <a href='undocumented#SkTextEncoding'>SkTextEncoding</a> to decode <a href='#SkPaint_measureText_text'>text</a>, <a href='undocumented#SkTypeface'>SkTypeface</a> to get the <a href='#Font_Metrics'>font metrics</a>, |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3891 | 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 |
| 3892 | <a href='undocumented#SkPathEffect'>SkPathEffect</a> to scale the metrics and <a href='#SkPaint_measureText_bounds'>bounds</a>. |
| 3893 | Returns the bounding box of <a href='#SkPaint_measureText_text'>text</a> if <a href='#SkPaint_measureText_bounds'>bounds</a> is not nullptr. |
| 3894 | The bounding box is computed as if the <a href='#SkPaint_measureText_text'>text</a> was drawn at the origin. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3895 | |
| 3896 | ### Parameters |
| 3897 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3898 | <table> <tr> <td><a name='SkPaint_measureText_text'><code><strong>text</strong></code></a></td> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3899 | <td>character codes or <a href='undocumented#Glyph'>glyph</a> indices to be measured</td> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3900 | </tr> |
| 3901 | <tr> <td><a name='SkPaint_measureText_length'><code><strong>length</strong></code></a></td> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3902 | <td>number of bytes of <a href='#SkPaint_measureText_text'>text</a> to measure</td> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3903 | </tr> |
| 3904 | <tr> <td><a name='SkPaint_measureText_bounds'><code><strong>bounds</strong></code></a></td> |
| 3905 | <td>returns bounding box relative to (0, 0) if not nullptr</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3906 | </tr> |
| 3907 | </table> |
| 3908 | |
| 3909 | ### Return Value |
| 3910 | |
| 3911 | advance width or height |
| 3912 | |
| 3913 | ### Example |
| 3914 | |
Cary Clark | 8364706 | 2018-07-18 16:21:51 -0400 | [diff] [blame] | 3915 | <div><fiddle-embed name="06084f609184470135a9cd9ebc5af149"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3916 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3917 | <a name='SkPaint_measureText_2'></a> |
Cary Clark | 2dc84ad | 2018-01-26 12:56:22 -0500 | [diff] [blame] | 3918 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3919 | --- |
| 3920 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3921 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 3922 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_measureText'>measureText</a>(const void* <a href='undocumented#Text'>text</a>, size_t length)const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3923 | </pre> |
| 3924 | |
Cary Clark | 3aca39d | 2018-10-23 14:44:05 -0400 | [diff] [blame] | 3925 | Returns the advance width of <a href='#SkPaint_measureText_2_text'>text</a>. |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3926 | The advance is the normal distance to move before drawing additional <a href='#SkPaint_measureText_2_text'>text</a>. |
skia-bookmaker | fe47c2a | 2018-12-04 06:13:55 +0000 | [diff] [blame] | 3927 | Uses <a href='undocumented#SkTextEncoding'>SkTextEncoding</a> to decode <a href='#SkPaint_measureText_2_text'>text</a>, <a href='undocumented#SkTypeface'>SkTypeface</a> to get the <a href='#Font_Metrics'>font metrics</a>, |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3928 | and <a href='#Text_Size'>text size</a> to scale the metrics. |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 3929 | Does not scale the advance or bounds by <a href='#Fake_Bold'>fake bold</a> or <a href='undocumented#SkPathEffect'>SkPathEffect</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3930 | |
| 3931 | ### Parameters |
| 3932 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3933 | <table> <tr> <td><a name='SkPaint_measureText_2_text'><code><strong>text</strong></code></a></td> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3934 | <td>character codes or <a href='undocumented#Glyph'>glyph</a> indices to be measured</td> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3935 | </tr> |
| 3936 | <tr> <td><a name='SkPaint_measureText_2_length'><code><strong>length</strong></code></a></td> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3937 | <td>number of bytes of <a href='#SkPaint_measureText_2_text'>text</a> to measure</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3938 | </tr> |
| 3939 | </table> |
| 3940 | |
| 3941 | ### Return Value |
| 3942 | |
| 3943 | advance width or height |
| 3944 | |
| 3945 | ### Example |
| 3946 | |
| 3947 | <div><fiddle-embed name="f1139a5ddd17fd47c2f45f6e642cac76"> |
| 3948 | |
| 3949 | #### Example Output |
| 3950 | |
| 3951 | ~~~~ |
| 3952 | default width = 5 |
| 3953 | double width = 10 |
| 3954 | ~~~~ |
| 3955 | |
| 3956 | </fiddle-embed></div> |
| 3957 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3958 | <a name='SkPaint_breakText'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3959 | |
| 3960 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3961 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3962 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3963 | size_t <a href='#SkPaint_breakText'>breakText</a>(const void* <a href='undocumented#Text'>text</a>, size_t length, <a href='undocumented#SkScalar'>SkScalar</a> maxWidth, |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 3964 | <a href='undocumented#SkScalar'>SkScalar</a>* measuredWidth = nullptr)const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3965 | </pre> |
| 3966 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3967 | Returns the bytes of <a href='#SkPaint_breakText_text'>text</a> that fit within <a href='#SkPaint_breakText_maxWidth'>maxWidth</a>. |
| 3968 | 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>. |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3969 | Measures only while the advance is less than or equal to <a href='#SkPaint_breakText_maxWidth'>maxWidth</a>. |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3970 | 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. |
skia-bookmaker | fe47c2a | 2018-12-04 06:13:55 +0000 | [diff] [blame] | 3971 | Uses <a href='undocumented#SkTextEncoding'>SkTextEncoding</a> to decode <a href='#SkPaint_breakText_text'>text</a>, <a href='undocumented#SkTypeface'>SkTypeface</a> to get the <a href='#Font_Metrics'>font metrics</a>, |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3972 | and <a href='#Text_Size'>text size</a> to scale the metrics. |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 3973 | Does not scale the advance or bounds by <a href='#Fake_Bold'>fake bold</a> or <a href='undocumented#SkPathEffect'>SkPathEffect</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3974 | |
| 3975 | ### Parameters |
| 3976 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3977 | <table> <tr> <td><a name='SkPaint_breakText_text'><code><strong>text</strong></code></a></td> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3978 | <td>character codes or <a href='undocumented#Glyph'>glyph</a> indices to be measured</td> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3979 | </tr> |
| 3980 | <tr> <td><a name='SkPaint_breakText_length'><code><strong>length</strong></code></a></td> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3981 | <td>number of bytes of <a href='#SkPaint_breakText_text'>text</a> to measure</td> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3982 | </tr> |
| 3983 | <tr> <td><a name='SkPaint_breakText_maxWidth'><code><strong>maxWidth</strong></code></a></td> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3984 | <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> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3985 | </tr> |
| 3986 | <tr> <td><a name='SkPaint_breakText_measuredWidth'><code><strong>measuredWidth</strong></code></a></td> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3987 | <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> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3988 | </tr> |
| 3989 | </table> |
| 3990 | |
| 3991 | ### Return Value |
| 3992 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3993 | bytes of <a href='#SkPaint_breakText_text'>text</a> that fit, always less than or equal to <a href='#SkPaint_breakText_length'>length</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3994 | |
| 3995 | ### Example |
| 3996 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3997 | <div><fiddle-embed name="fd0033470ccbd5c7059670fdbf96cffc"><div><a href='undocumented#Line'>Line</a> under "Breakfast" shows desired width, shorter than available characters. |
| 3998 | <a href='undocumented#Line'>Line</a> under "Bre" shows measured width after breaking <a href='#SkPaint_breakText_text'>text</a>. |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 3999 | </div></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4000 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4001 | <a name='SkPaint_getTextWidths'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 4002 | |
| 4003 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4004 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4005 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 4006 | int <a href='#SkPaint_getTextWidths'>getTextWidths</a>(const void* <a href='undocumented#Text'>text</a>, size_t byteLength, <a href='undocumented#SkScalar'>SkScalar</a> widths[], <a href='SkRect_Reference#SkRect'>SkRect</a> bounds[] = nullptr)const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4007 | </pre> |
| 4008 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4009 | Retrieves the advance and <a href='#SkPaint_getTextWidths_bounds'>bounds</a> for each <a href='undocumented#Glyph'>glyph</a> in <a href='#SkPaint_getTextWidths_text'>text</a>, and returns |
| 4010 | the <a href='undocumented#Glyph'>glyph</a> count in <a href='#SkPaint_getTextWidths_text'>text</a>. |
| 4011 | Both <a href='#SkPaint_getTextWidths_widths'>widths</a> and <a href='#SkPaint_getTextWidths_bounds'>bounds</a> may be nullptr. |
| 4012 | If <a href='#SkPaint_getTextWidths_widths'>widths</a> is not nullptr, <a href='#SkPaint_getTextWidths_widths'>widths</a> must be an array of <a href='undocumented#Glyph'>glyph</a> count entries. |
| 4013 | if <a href='#SkPaint_getTextWidths_bounds'>bounds</a> is not nullptr, <a href='#SkPaint_getTextWidths_bounds'>bounds</a> must be an array of <a href='undocumented#Glyph'>glyph</a> count entries. |
skia-bookmaker | fe47c2a | 2018-12-04 06:13:55 +0000 | [diff] [blame] | 4014 | Uses <a href='undocumented#SkTextEncoding'>SkTextEncoding</a> to decode <a href='#SkPaint_getTextWidths_text'>text</a>, <a href='undocumented#SkTypeface'>SkTypeface</a> to get the <a href='#Font_Metrics'>font metrics</a>, |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4015 | 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>. |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 4016 | Does not scale the advance by <a href='#Fake_Bold'>fake bold</a> or <a href='undocumented#SkPathEffect'>SkPathEffect</a>. |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4017 | Does include <a href='#Fake_Bold'>fake bold</a> and <a href='undocumented#SkPathEffect'>SkPathEffect</a> in the <a href='#SkPaint_getTextWidths_bounds'>bounds</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4018 | |
| 4019 | ### Parameters |
| 4020 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4021 | <table> <tr> <td><a name='SkPaint_getTextWidths_text'><code><strong>text</strong></code></a></td> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4022 | <td>character codes or <a href='undocumented#Glyph'>glyph</a> indices to be measured</td> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4023 | </tr> |
| 4024 | <tr> <td><a name='SkPaint_getTextWidths_byteLength'><code><strong>byteLength</strong></code></a></td> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4025 | <td>number of bytes of <a href='#SkPaint_getTextWidths_text'>text</a> to measure</td> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4026 | </tr> |
| 4027 | <tr> <td><a name='SkPaint_getTextWidths_widths'><code><strong>widths</strong></code></a></td> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4028 | <td>returns <a href='#SkPaint_getTextWidths_text'>text</a> advances for each <a href='undocumented#Glyph'>glyph</a>; may be nullptr</td> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4029 | </tr> |
| 4030 | <tr> <td><a name='SkPaint_getTextWidths_bounds'><code><strong>bounds</strong></code></a></td> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4031 | <td>returns <a href='#SkPaint_getTextWidths_bounds'>bounds</a> for each <a href='undocumented#Glyph'>glyph</a> relative to (0, 0); may be nullptr</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4032 | </tr> |
| 4033 | </table> |
| 4034 | |
| 4035 | ### Return Value |
| 4036 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4037 | <a href='undocumented#Glyph'>glyph</a> count in <a href='#SkPaint_getTextWidths_text'>text</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4038 | |
| 4039 | ### Example |
| 4040 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4041 | <div><fiddle-embed name="6b9e101f49e9c2c28755c5bdcef64dfb"><div>Bounds of <a href='undocumented#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. |
| 4042 | The underlines show the <a href='#SkPaint_getTextWidths_text'>text</a> advance, spaced to keep them distinct. |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 4043 | </div></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4044 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 4045 | <a name='Text_Path'></a> |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 4046 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4047 | <a href='#Paint_Text_Path'>Text_Path</a> describes the geometry of <a href='undocumented#Glyph'>Glyphs</a> used to draw <a href='undocumented#Text'>text</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4048 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4049 | <a name='SkPaint_getTextPath'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 4050 | |
| 4051 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4052 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4053 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 4054 | void <a href='#SkPaint_getTextPath'>getTextPath</a>(const void* <a href='undocumented#Text'>text</a>, size_t length, <a href='undocumented#SkScalar'>SkScalar</a> x, <a href='undocumented#SkScalar'>SkScalar</a> y, <a href='SkPath_Reference#SkPath'>SkPath</a>* <a href='SkPath_Reference#Path'>path</a>)const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4055 | </pre> |
| 4056 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4057 | Returns the geometry as <a href='SkPath_Reference#SkPath'>SkPath</a> equivalent to the drawn <a href='#SkPaint_getTextPath_text'>text</a>. |
skia-bookmaker | fe47c2a | 2018-12-04 06:13:55 +0000 | [diff] [blame] | 4058 | Uses <a href='undocumented#SkTextEncoding'>SkTextEncoding</a> to decode <a href='#SkPaint_getTextPath_text'>text</a>, <a href='undocumented#SkTypeface'>SkTypeface</a> to get the <a href='undocumented#Glyph'>glyph</a> <a href='SkPath_Reference#Path'>paths</a>, |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4059 | and <a href='#Text_Size'>text size</a>, <a href='#Fake_Bold'>fake bold</a>, and <a href='undocumented#SkPathEffect'>SkPathEffect</a> to scale and modify the <a href='undocumented#Glyph'>glyph</a> <a href='SkPath_Reference#Path'>paths</a>. |
| 4060 | All of the <a href='undocumented#Glyph'>glyph</a> <a href='SkPath_Reference#Path'>paths</a> are stored in <a href='#SkPaint_getTextPath_path'>path</a>. |
| 4061 | Uses <a href='#SkPaint_getTextPath_x'>x</a>, <a href='#SkPaint_getTextPath_y'>y</a>, to position <a href='#SkPaint_getTextPath_path'>path</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4062 | |
| 4063 | ### Parameters |
| 4064 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4065 | <table> <tr> <td><a name='SkPaint_getTextPath_text'><code><strong>text</strong></code></a></td> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4066 | <td>character codes or <a href='undocumented#Glyph'>glyph</a> indices</td> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4067 | </tr> |
| 4068 | <tr> <td><a name='SkPaint_getTextPath_length'><code><strong>length</strong></code></a></td> |
| 4069 | <td>number of bytes of <a href='#SkPaint_getTextPath_text'>text</a></td> |
| 4070 | </tr> |
| 4071 | <tr> <td><a name='SkPaint_getTextPath_x'><code><strong>x</strong></code></a></td> |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 4072 | <td>x-axis value of the origin of the <a href='#SkPaint_getTextPath_text'>text</a></td> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4073 | </tr> |
| 4074 | <tr> <td><a name='SkPaint_getTextPath_y'><code><strong>y</strong></code></a></td> |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 4075 | <td>y-axis value of the origin of the <a href='#SkPaint_getTextPath_text'>text</a></td> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4076 | </tr> |
| 4077 | <tr> <td><a name='SkPaint_getTextPath_path'><code><strong>path</strong></code></a></td> |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 4078 | <td>geometry of the <a href='undocumented#Glyph'>glyphs</a></td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4079 | </tr> |
| 4080 | </table> |
| 4081 | |
| 4082 | ### Example |
| 4083 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4084 | <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 |
| 4085 | the offset location. The result is rendered with one draw call. |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 4086 | </div></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4087 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4088 | <a name='SkPaint_getPosTextPath'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 4089 | |
| 4090 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4091 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4092 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 4093 | void <a href='#SkPaint_getPosTextPath'>getPosTextPath</a>(const void* <a href='undocumented#Text'>text</a>, size_t length, const <a href='SkPoint_Reference#SkPoint'>SkPoint</a> pos[], <a href='SkPath_Reference#SkPath'>SkPath</a>* <a href='SkPath_Reference#Path'>path</a>)const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4094 | </pre> |
| 4095 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4096 | Returns the geometry as <a href='SkPath_Reference#SkPath'>SkPath</a> equivalent to the drawn <a href='#SkPaint_getPosTextPath_text'>text</a>. |
skia-bookmaker | fe47c2a | 2018-12-04 06:13:55 +0000 | [diff] [blame] | 4097 | Uses <a href='undocumented#SkTextEncoding'>SkTextEncoding</a> to decode <a href='#SkPaint_getPosTextPath_text'>text</a>, <a href='undocumented#SkTypeface'>SkTypeface</a> to get the <a href='undocumented#Glyph'>glyph</a> <a href='SkPath_Reference#Path'>paths</a>, |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4098 | and <a href='#Text_Size'>text size</a>, <a href='#Fake_Bold'>fake bold</a>, and <a href='undocumented#SkPathEffect'>SkPathEffect</a> to scale and modify the <a href='undocumented#Glyph'>glyph</a> <a href='SkPath_Reference#Path'>paths</a>. |
| 4099 | All of the <a href='undocumented#Glyph'>glyph</a> <a href='SkPath_Reference#Path'>paths</a> are stored in <a href='#SkPaint_getPosTextPath_path'>path</a>. |
| 4100 | Uses <a href='#SkPaint_getPosTextPath_pos'>pos</a> array to position <a href='#SkPaint_getPosTextPath_path'>path</a>. |
| 4101 | <a href='#SkPaint_getPosTextPath_pos'>pos</a> contains a position for each <a href='undocumented#Glyph'>glyph</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4102 | |
| 4103 | ### Parameters |
| 4104 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4105 | <table> <tr> <td><a name='SkPaint_getPosTextPath_text'><code><strong>text</strong></code></a></td> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4106 | <td>character codes or <a href='undocumented#Glyph'>glyph</a> indices</td> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4107 | </tr> |
| 4108 | <tr> <td><a name='SkPaint_getPosTextPath_length'><code><strong>length</strong></code></a></td> |
| 4109 | <td>number of bytes of <a href='#SkPaint_getPosTextPath_text'>text</a></td> |
| 4110 | </tr> |
| 4111 | <tr> <td><a name='SkPaint_getPosTextPath_pos'><code><strong>pos</strong></code></a></td> |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 4112 | <td>positions of each <a href='undocumented#Glyph'>glyph</a></td> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4113 | </tr> |
| 4114 | <tr> <td><a name='SkPaint_getPosTextPath_path'><code><strong>path</strong></code></a></td> |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 4115 | <td>geometry of the <a href='undocumented#Glyph'>glyphs</a></td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4116 | </tr> |
| 4117 | </table> |
| 4118 | |
| 4119 | ### Example |
| 4120 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4121 | <div><fiddle-embed name="7f27c93472aa99a7542fb3493076f072"><div>Simplifies three <a href='undocumented#Glyph'>Glyphs</a> to eliminate overlaps, and strokes the result. |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 4122 | </div></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4123 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 4124 | <a name='Text_Intercepts'></a> |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 4125 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4126 | <a href='#Paint_Text_Intercepts'>Text_Intercepts</a> describe the intersection of drawn <a href='undocumented#Text'>text</a> <a href='undocumented#Glyph'>Glyphs</a> with a pair |
| 4127 | of <a href='undocumented#Line'>lines</a> parallel to the <a href='undocumented#Text'>text</a> advance. <a href='#Paint_Text_Intercepts'>Text_Intercepts</a> permits creating a |
| 4128 | underline that skips Descenders. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4129 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4130 | <a name='SkPaint_getTextIntercepts'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 4131 | |
| 4132 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4133 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4134 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4135 | int <a href='#SkPaint_getTextIntercepts'>getTextIntercepts</a>(const void* <a href='undocumented#Text'>text</a>, size_t length, <a href='undocumented#SkScalar'>SkScalar</a> x, <a href='undocumented#SkScalar'>SkScalar</a> y, |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 4136 | const <a href='undocumented#SkScalar'>SkScalar</a> bounds[2], <a href='undocumented#SkScalar'>SkScalar</a>* intervals)const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4137 | </pre> |
| 4138 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4139 | Returns the number of <a href='#SkPaint_getTextIntercepts_intervals'>intervals</a> that intersect <a href='#SkPaint_getTextIntercepts_bounds'>bounds</a>. |
| 4140 | <a href='#SkPaint_getTextIntercepts_bounds'>bounds</a> describes a pair of <a href='undocumented#Line'>lines</a> parallel to the <a href='#SkPaint_getTextIntercepts_text'>text</a> advance. |
| 4141 | The return count is zero or a multiple of two, and is at most twice the number of <a href='undocumented#Glyph'>glyphs</a> in |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 4142 | the <a href='undocumented#String'>string</a>. |
skia-bookmaker | fe47c2a | 2018-12-04 06:13:55 +0000 | [diff] [blame] | 4143 | Uses <a href='undocumented#SkTextEncoding'>SkTextEncoding</a> to decode <a href='#SkPaint_getTextIntercepts_text'>text</a>, <a href='undocumented#SkTypeface'>SkTypeface</a> to get the <a href='undocumented#Glyph'>glyph</a> <a href='SkPath_Reference#Path'>paths</a>, |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4144 | and <a href='#Text_Size'>text size</a>, <a href='#Fake_Bold'>fake bold</a>, and <a href='undocumented#SkPathEffect'>SkPathEffect</a> to scale and modify the <a href='undocumented#Glyph'>glyph</a> <a href='SkPath_Reference#Path'>paths</a>. |
| 4145 | Uses <a href='#SkPaint_getTextIntercepts_x'>x</a>, <a href='#SkPaint_getTextIntercepts_y'>y</a> to position <a href='#SkPaint_getTextIntercepts_intervals'>intervals</a>. |
skia-bookmaker | 525f9a9 | 2018-05-03 06:27:39 +0000 | [diff] [blame] | 4146 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4147 | Pass nullptr for <a href='#SkPaint_getTextIntercepts_intervals'>intervals</a> to determine the <a href='undocumented#Size'>size</a> of the interval array. |
skia-bookmaker | 525f9a9 | 2018-05-03 06:27:39 +0000 | [diff] [blame] | 4148 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4149 | <a href='#SkPaint_getTextIntercepts_intervals'>intervals</a> are cached to improve performance for multiple calls. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4150 | |
| 4151 | ### Parameters |
| 4152 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4153 | <table> <tr> <td><a name='SkPaint_getTextIntercepts_text'><code><strong>text</strong></code></a></td> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4154 | <td>character codes or <a href='undocumented#Glyph'>glyph</a> indices</td> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4155 | </tr> |
| 4156 | <tr> <td><a name='SkPaint_getTextIntercepts_length'><code><strong>length</strong></code></a></td> |
| 4157 | <td>number of bytes of <a href='#SkPaint_getTextIntercepts_text'>text</a></td> |
| 4158 | </tr> |
| 4159 | <tr> <td><a name='SkPaint_getTextIntercepts_x'><code><strong>x</strong></code></a></td> |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 4160 | <td>x-axis value of the origin of the <a href='#SkPaint_getTextIntercepts_text'>text</a></td> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4161 | </tr> |
| 4162 | <tr> <td><a name='SkPaint_getTextIntercepts_y'><code><strong>y</strong></code></a></td> |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 4163 | <td>y-axis value of the origin of the <a href='#SkPaint_getTextIntercepts_text'>text</a></td> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4164 | </tr> |
| 4165 | <tr> <td><a name='SkPaint_getTextIntercepts_bounds'><code><strong>bounds</strong></code></a></td> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4166 | <td>lower and upper <a href='undocumented#Line'>line</a> parallel to the advance</td> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4167 | </tr> |
| 4168 | <tr> <td><a name='SkPaint_getTextIntercepts_intervals'><code><strong>intervals</strong></code></a></td> |
| 4169 | <td>returned intersections; may be nullptr</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4170 | </tr> |
| 4171 | </table> |
| 4172 | |
| 4173 | ### Return Value |
| 4174 | |
| 4175 | number of intersections; may be zero |
| 4176 | |
Cary Clark | e9c5a15 | 2018-11-21 11:45:57 -0500 | [diff] [blame] | 4177 | <div>Underline uses intercepts to draw on either side of the <a href='undocumented#Glyph'>glyph</a> Descender. |
| 4178 | </div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4179 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4180 | <a name='SkPaint_getPosTextIntercepts'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 4181 | |
| 4182 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4183 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4184 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4185 | int <a href='#SkPaint_getPosTextIntercepts'>getPosTextIntercepts</a>(const void* <a href='undocumented#Text'>text</a>, size_t length, const <a href='SkPoint_Reference#SkPoint'>SkPoint</a> pos[], |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 4186 | const <a href='undocumented#SkScalar'>SkScalar</a> bounds[2], <a href='undocumented#SkScalar'>SkScalar</a>* intervals)const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4187 | </pre> |
| 4188 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4189 | Returns the number of <a href='#SkPaint_getPosTextIntercepts_intervals'>intervals</a> that intersect <a href='#SkPaint_getPosTextIntercepts_bounds'>bounds</a>. |
| 4190 | <a href='#SkPaint_getPosTextIntercepts_bounds'>bounds</a> describes a pair of <a href='undocumented#Line'>lines</a> parallel to the <a href='#SkPaint_getPosTextIntercepts_text'>text</a> advance. |
| 4191 | The return count is zero or a multiple of two, and is at most twice the number of <a href='undocumented#Glyph'>glyphs</a> in |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 4192 | the <a href='undocumented#String'>string</a>. |
skia-bookmaker | fe47c2a | 2018-12-04 06:13:55 +0000 | [diff] [blame] | 4193 | Uses <a href='undocumented#SkTextEncoding'>SkTextEncoding</a> to decode <a href='#SkPaint_getPosTextIntercepts_text'>text</a>, <a href='undocumented#SkTypeface'>SkTypeface</a> to get the <a href='undocumented#Glyph'>glyph</a> <a href='SkPath_Reference#Path'>paths</a>, |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4194 | and <a href='#Text_Size'>text size</a>, <a href='#Fake_Bold'>fake bold</a>, and <a href='undocumented#SkPathEffect'>SkPathEffect</a> to scale and modify the <a href='undocumented#Glyph'>glyph</a> <a href='SkPath_Reference#Path'>paths</a>. |
| 4195 | Uses <a href='#SkPaint_getPosTextIntercepts_pos'>pos</a> array to position <a href='#SkPaint_getPosTextIntercepts_intervals'>intervals</a>. |
skia-bookmaker | 525f9a9 | 2018-05-03 06:27:39 +0000 | [diff] [blame] | 4196 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4197 | Pass nullptr for <a href='#SkPaint_getPosTextIntercepts_intervals'>intervals</a> to determine the <a href='undocumented#Size'>size</a> of the interval array. |
skia-bookmaker | 525f9a9 | 2018-05-03 06:27:39 +0000 | [diff] [blame] | 4198 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4199 | <a href='#SkPaint_getPosTextIntercepts_intervals'>intervals</a> are cached to improve performance for multiple calls. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4200 | |
| 4201 | ### Parameters |
| 4202 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4203 | <table> <tr> <td><a name='SkPaint_getPosTextIntercepts_text'><code><strong>text</strong></code></a></td> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4204 | <td>character codes or <a href='undocumented#Glyph'>glyph</a> indices</td> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4205 | </tr> |
| 4206 | <tr> <td><a name='SkPaint_getPosTextIntercepts_length'><code><strong>length</strong></code></a></td> |
| 4207 | <td>number of bytes of <a href='#SkPaint_getPosTextIntercepts_text'>text</a></td> |
| 4208 | </tr> |
| 4209 | <tr> <td><a name='SkPaint_getPosTextIntercepts_pos'><code><strong>pos</strong></code></a></td> |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 4210 | <td>positions of each <a href='undocumented#Glyph'>glyph</a></td> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4211 | </tr> |
| 4212 | <tr> <td><a name='SkPaint_getPosTextIntercepts_bounds'><code><strong>bounds</strong></code></a></td> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4213 | <td>lower and upper <a href='undocumented#Line'>line</a> parallel to the advance</td> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4214 | </tr> |
| 4215 | <tr> <td><a name='SkPaint_getPosTextIntercepts_intervals'><code><strong>intervals</strong></code></a></td> |
| 4216 | <td>returned intersections; may be nullptr</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4217 | </tr> |
| 4218 | </table> |
| 4219 | |
| 4220 | ### Return Value |
| 4221 | |
Cary Clark | a523d2d | 2017-08-30 08:58:10 -0400 | [diff] [blame] | 4222 | number of intersections; may be zero |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4223 | |
Cary Clark | e9c5a15 | 2018-11-21 11:45:57 -0500 | [diff] [blame] | 4224 | <div><a href='undocumented#Text'>Text</a> intercepts draw on either side of, but not inside, <a href='undocumented#Glyph'>Glyphs</a> in a run. |
| 4225 | </div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4226 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4227 | <a name='SkPaint_getPosTextHIntercepts'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 4228 | |
| 4229 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4230 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4231 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4232 | int <a href='#SkPaint_getPosTextHIntercepts'>getPosTextHIntercepts</a>(const void* <a href='undocumented#Text'>text</a>, size_t length, const <a href='undocumented#SkScalar'>SkScalar</a> xpos[], <a href='undocumented#SkScalar'>SkScalar</a> constY, |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 4233 | const <a href='undocumented#SkScalar'>SkScalar</a> bounds[2], <a href='undocumented#SkScalar'>SkScalar</a>* intervals)const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4234 | </pre> |
| 4235 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4236 | Returns the number of <a href='#SkPaint_getPosTextHIntercepts_intervals'>intervals</a> that intersect <a href='#SkPaint_getPosTextHIntercepts_bounds'>bounds</a>. |
| 4237 | <a href='#SkPaint_getPosTextHIntercepts_bounds'>bounds</a> describes a pair of <a href='undocumented#Line'>lines</a> parallel to the <a href='#SkPaint_getPosTextHIntercepts_text'>text</a> advance. |
| 4238 | The return count is zero or a multiple of two, and is at most twice the number of <a href='undocumented#Glyph'>glyphs</a> in |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 4239 | the <a href='undocumented#String'>string</a>. |
skia-bookmaker | fe47c2a | 2018-12-04 06:13:55 +0000 | [diff] [blame] | 4240 | Uses <a href='undocumented#SkTextEncoding'>SkTextEncoding</a> to decode <a href='#SkPaint_getPosTextHIntercepts_text'>text</a>, <a href='undocumented#SkTypeface'>SkTypeface</a> to get the <a href='undocumented#Glyph'>glyph</a> <a href='SkPath_Reference#Path'>paths</a>, |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4241 | and <a href='#Text_Size'>text size</a>, <a href='#Fake_Bold'>fake bold</a>, and <a href='undocumented#SkPathEffect'>SkPathEffect</a> to scale and modify the <a href='undocumented#Glyph'>glyph</a> <a href='SkPath_Reference#Path'>paths</a>. |
| 4242 | Uses <a href='#SkPaint_getPosTextHIntercepts_xpos'>xpos</a> array, <a href='#SkPaint_getPosTextHIntercepts_constY'>constY</a> to position <a href='#SkPaint_getPosTextHIntercepts_intervals'>intervals</a>. |
skia-bookmaker | 525f9a9 | 2018-05-03 06:27:39 +0000 | [diff] [blame] | 4243 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4244 | Pass nullptr for <a href='#SkPaint_getPosTextHIntercepts_intervals'>intervals</a> to determine the <a href='undocumented#Size'>size</a> of the interval array. |
skia-bookmaker | 525f9a9 | 2018-05-03 06:27:39 +0000 | [diff] [blame] | 4245 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4246 | <a href='#SkPaint_getPosTextHIntercepts_intervals'>intervals</a> are cached to improve performance for multiple calls. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4247 | |
| 4248 | ### Parameters |
| 4249 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4250 | <table> <tr> <td><a name='SkPaint_getPosTextHIntercepts_text'><code><strong>text</strong></code></a></td> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4251 | <td>character codes or <a href='undocumented#Glyph'>glyph</a> indices</td> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4252 | </tr> |
| 4253 | <tr> <td><a name='SkPaint_getPosTextHIntercepts_length'><code><strong>length</strong></code></a></td> |
| 4254 | <td>number of bytes of <a href='#SkPaint_getPosTextHIntercepts_text'>text</a></td> |
| 4255 | </tr> |
| 4256 | <tr> <td><a name='SkPaint_getPosTextHIntercepts_xpos'><code><strong>xpos</strong></code></a></td> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4257 | <td>positions of each <a href='undocumented#Glyph'>glyph</a> on x-axis</td> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4258 | </tr> |
| 4259 | <tr> <td><a name='SkPaint_getPosTextHIntercepts_constY'><code><strong>constY</strong></code></a></td> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4260 | <td>position of each <a href='undocumented#Glyph'>glyph</a> on y-axis</td> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4261 | </tr> |
| 4262 | <tr> <td><a name='SkPaint_getPosTextHIntercepts_bounds'><code><strong>bounds</strong></code></a></td> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4263 | <td>lower and upper <a href='undocumented#Line'>line</a> parallel to the advance</td> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4264 | </tr> |
| 4265 | <tr> <td><a name='SkPaint_getPosTextHIntercepts_intervals'><code><strong>intervals</strong></code></a></td> |
| 4266 | <td>returned intersections; may be nullptr</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4267 | </tr> |
| 4268 | </table> |
| 4269 | |
| 4270 | ### Return Value |
| 4271 | |
| 4272 | number of intersections; may be zero |
| 4273 | |
Cary Clark | e9c5a15 | 2018-11-21 11:45:57 -0500 | [diff] [blame] | 4274 | <div><a href='undocumented#Text'>Text</a> intercepts do not take stroke thickness into consideration. |
| 4275 | </div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4276 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4277 | <a name='SkPaint_getTextBlobIntercepts'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 4278 | |
| 4279 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4280 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4281 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 4282 | int <a href='#SkPaint_getTextBlobIntercepts'>getTextBlobIntercepts</a>(const <a href='SkTextBlob_Reference#SkTextBlob'>SkTextBlob</a>* blob, const <a href='undocumented#SkScalar'>SkScalar</a> bounds[2], <a href='undocumented#SkScalar'>SkScalar</a>* intervals)const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4283 | </pre> |
| 4284 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4285 | Returns the number of <a href='#SkPaint_getTextBlobIntercepts_intervals'>intervals</a> that intersect <a href='#SkPaint_getTextBlobIntercepts_bounds'>bounds</a>. |
| 4286 | <a href='#SkPaint_getTextBlobIntercepts_bounds'>bounds</a> describes a pair of <a href='undocumented#Line'>lines</a> parallel to the <a href='undocumented#Text'>text</a> advance. |
| 4287 | The return count is zero or a multiple of two, and is at most twice the number of <a href='undocumented#Glyph'>glyphs</a> in |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 4288 | the <a href='undocumented#String'>string</a>. |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4289 | Uses <a href='undocumented#SkTypeface'>SkTypeface</a> to get the <a href='undocumented#Glyph'>glyph</a> <a href='SkPath_Reference#Path'>paths</a>, |
| 4290 | and <a href='#Text_Size'>text size</a>, <a href='#Fake_Bold'>fake bold</a>, and <a href='undocumented#SkPathEffect'>SkPathEffect</a> to scale and modify the <a href='undocumented#Glyph'>glyph</a> <a href='SkPath_Reference#Path'>paths</a>. |
skia-bookmaker | f1ec391 | 2018-11-03 05:34:02 +0000 | [diff] [blame] | 4291 | Uses run array to position <a href='#SkPaint_getTextBlobIntercepts_intervals'>intervals</a>. |
skia-bookmaker | 525f9a9 | 2018-05-03 06:27:39 +0000 | [diff] [blame] | 4292 | |
Cary Clark | 3e73dcf | 2018-12-06 08:41:14 -0500 | [diff] [blame^] | 4293 | <a href='undocumented#SkTextEncoding'>SkTextEncoding</a> must be set to <a href='undocumented#kGlyphID_SkTextEncoding'>kGlyphID_SkTextEncoding</a>. |
Cary Clark | 3cd22cc | 2017-12-01 11:49:58 -0500 | [diff] [blame] | 4294 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4295 | Pass nullptr for <a href='#SkPaint_getTextBlobIntercepts_intervals'>intervals</a> to determine the <a href='undocumented#Size'>size</a> of the interval array. |
skia-bookmaker | 525f9a9 | 2018-05-03 06:27:39 +0000 | [diff] [blame] | 4296 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4297 | <a href='#SkPaint_getTextBlobIntercepts_intervals'>intervals</a> are cached to improve performance for multiple calls. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4298 | |
| 4299 | ### Parameters |
| 4300 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4301 | <table> <tr> <td><a name='SkPaint_getTextBlobIntercepts_blob'><code><strong>blob</strong></code></a></td> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4302 | <td><a href='undocumented#Glyph'>glyphs</a>, positions, and <a href='undocumented#Text'>text</a> <a href='SkPaint_Reference#Paint'>paint</a> attributes</td> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4303 | </tr> |
| 4304 | <tr> <td><a name='SkPaint_getTextBlobIntercepts_bounds'><code><strong>bounds</strong></code></a></td> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4305 | <td>lower and upper <a href='undocumented#Line'>line</a> parallel to the advance</td> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4306 | </tr> |
| 4307 | <tr> <td><a name='SkPaint_getTextBlobIntercepts_intervals'><code><strong>intervals</strong></code></a></td> |
| 4308 | <td>returned intersections; may be nullptr</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4309 | </tr> |
| 4310 | </table> |
| 4311 | |
| 4312 | ### Return Value |
| 4313 | |
| 4314 | number of intersections; may be zero |
| 4315 | |
| 4316 | ### Example |
| 4317 | |
skia-bookmaker | 53079c3 | 2018-11-25 04:03:02 +0000 | [diff] [blame] | 4318 | <div><fiddle-embed name="728ea9089f233a71a1062e364b8c73fa"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4319 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4320 | <a name='SkPaint_nothingToDraw'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 4321 | |
| 4322 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4323 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4324 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 4325 | bool <a href='#SkPaint_nothingToDraw'>nothingToDraw</a>()const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4326 | </pre> |
| 4327 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4328 | Returns true if <a href='SkPaint_Reference#SkPaint'>SkPaint</a> prevents all drawing; |
| 4329 | otherwise, the <a href='SkPaint_Reference#SkPaint'>SkPaint</a> may or may not allow drawing. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4330 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4331 | Returns true if, for example, <a href='SkBlendMode_Reference#SkBlendMode'>SkBlendMode</a> combined with <a href='SkColor_Reference#Alpha'>alpha</a> computes a |
| 4332 | new <a href='SkColor_Reference#Alpha'>alpha</a> of zero. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4333 | |
| 4334 | ### Return Value |
| 4335 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4336 | true if <a href='SkPaint_Reference#SkPaint'>SkPaint</a> prevents all drawing |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4337 | |
| 4338 | ### Example |
| 4339 | |
Cary Clark | 8364706 | 2018-07-18 16:21:51 -0400 | [diff] [blame] | 4340 | <div><fiddle-embed name="2973b05bfbb6b4c29332c8ac4fcf3995"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4341 | |
| 4342 | #### Example Output |
| 4343 | |
| 4344 | ~~~~ |
| 4345 | initial nothing to draw: false |
| 4346 | blend dst nothing to draw: true |
| 4347 | blend src over nothing to draw: false |
| 4348 | alpha 0 nothing to draw: true |
| 4349 | ~~~~ |
| 4350 | |
| 4351 | </fiddle-embed></div> |
| 4352 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 4353 | <a name='Utility'></a> |
Cary Clark | 78de751 | 2018-02-07 07:27:09 -0500 | [diff] [blame] | 4354 | |