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 | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 134 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 135 | enum <a href='#SkPaint_TextEncoding'>TextEncoding</a> : uint8_t { |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 136 | <a href='#SkPaint_kUTF8_TextEncoding'>kUTF8_TextEncoding</a>, |
| 137 | <a href='#SkPaint_kUTF16_TextEncoding'>kUTF16_TextEncoding</a>, |
| 138 | <a href='#SkPaint_kUTF32_TextEncoding'>kUTF32_TextEncoding</a>, |
| 139 | <a href='#SkPaint_kGlyphID_TextEncoding'>kGlyphID_TextEncoding</a>, |
| 140 | }; |
| 141 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 142 | <a href='#SkPaint_TextEncoding'>TextEncoding</a> <a href='#SkPaint_getTextEncoding'>getTextEncoding</a>() const; |
| 143 | void <a href='#SkPaint_setTextEncoding'>setTextEncoding</a>(<a href='#SkPaint_TextEncoding'>TextEncoding</a> encoding); |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 144 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 145 | 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] | 146 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 147 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_getFontMetrics'>getFontMetrics</a>(<a href='undocumented#SkFontMetrics'>SkFontMetrics</a>* metrics) const; |
| 148 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_getFontSpacing'>getFontSpacing</a>() const; |
skia-bookmaker | 28ce5f2 | 2018-12-03 07:11:50 +0000 | [diff] [blame] | 149 | <a href='SkRect_Reference#SkRect'>SkRect</a> <a href='#SkPaint_getFontBounds'>getFontBounds</a>() const; |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 150 | int <a href='#SkPaint_textToGlyphs'>textToGlyphs</a>(const void* <a href='undocumented#Text'>text</a>, size_t byteLength, |
| 151 | <a href='undocumented#SkGlyphID'>SkGlyphID</a> <a href='undocumented#Glyph'>glyphs</a>[]) const; |
| 152 | bool <a href='#SkPaint_containsText'>containsText</a>(const void* <a href='undocumented#Text'>text</a>, size_t byteLength) const; |
| 153 | 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; |
| 154 | int <a href='#SkPaint_countText'>countText</a>(const void* <a href='undocumented#Text'>text</a>, size_t byteLength) const; |
| 155 | <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; |
| 156 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_measureText'>measureText</a>(const void* <a href='undocumented#Text'>text</a>, size_t length) const; |
| 157 | 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, |
| 158 | <a href='undocumented#SkScalar'>SkScalar</a>* measuredWidth = nullptr) const; |
| 159 | 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[], |
| 160 | <a href='SkRect_Reference#SkRect'>SkRect</a> bounds[] = nullptr) const; |
| 161 | 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, |
| 162 | <a href='SkPath_Reference#SkPath'>SkPath</a>* <a href='SkPath_Reference#Path'>path</a>) const; |
| 163 | void <a href='#SkPaint_getPosTextPath'>getPosTextPath</a>(const void* <a href='undocumented#Text'>text</a>, size_t length, |
| 164 | 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] | 165 | 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, |
| 166 | const <a href='undocumented#SkScalar'>SkScalar</a> bounds[2], <a href='undocumented#SkScalar'>SkScalar</a>* intervals) const; |
| 167 | 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[], |
| 168 | const <a href='undocumented#SkScalar'>SkScalar</a> bounds[2], <a href='undocumented#SkScalar'>SkScalar</a>* intervals) const; |
| 169 | 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[], |
| 170 | <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] | 171 | 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], |
| 172 | <a href='undocumented#SkScalar'>SkScalar</a>* intervals) const; |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 173 | bool <a href='#SkPaint_nothingToDraw'>nothingToDraw</a>() const; |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 174 | }; |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 175 | |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 176 | </pre> |
| 177 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 178 | <a href='SkPaint_Reference#Paint'>Paint</a> controls options applied when drawing and measuring. <a href='SkPaint_Reference#Paint'>Paint</a> collects all |
| 179 | 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] | 180 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 181 | 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] | 182 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 183 | Some options may not be implemented on all platforms; in these cases, setting |
| 184 | the option has no effect. Some options are conveniences that duplicate <a href='SkCanvas_Reference#Canvas'>Canvas</a> |
| 185 | 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] | 186 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 187 | <a href='SkPaint_Reference#Paint'>Paint</a> options are rarely exclusive; each option modifies a stage of the drawing |
| 188 | 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] | 189 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 190 | <a href='SkPaint_Reference#Paint'>Paint</a> collects effects and filters that describe single-pass and multiple-pass |
| 191 | algorithms that alter the drawing geometry, <a href='SkColor_Reference#Color'>color</a>, and transparency. For instance, |
| 192 | <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] | 193 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 194 | 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> |
| 195 | to affect it. The implementation is free to defer computations associated with the |
| 196 | <a href='SkPaint_Reference#Paint'>Paint</a>, or ignore them altogether. For instance, some GPU implementations draw all |
| 197 | <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> |
| 198 | is set in <a href='SkPaint_Reference#Paint'>Paint</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 199 | |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 200 | <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] | 201 | Multiple colors are drawn either by using multiple paints or with objects like |
| 202 | <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] | 203 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 204 | <a name='SkPaint_empty_constructor'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 205 | |
| 206 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 207 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 208 | <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] | 209 | <a href='#SkPaint_empty_constructor'>SkPaint()</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 210 | </pre> |
| 211 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 212 | Constructs <a href='SkPaint_Reference#Paint'>Paint</a> with default values. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 213 | |
| 214 | | attribute | default value | |
| 215 | | --- | --- | |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 216 | | <a href='#Paint_Anti_Alias'>Anti_Alias</a> | false | |
| 217 | | <a href='#Blend_Mode'>Blend_Mode</a> | <a href='SkBlendMode_Reference#SkBlendMode'>SkBlendMode</a>::<a href='#SkBlendMode_kSrcOver'>kSrcOver</a> | |
| 218 | | <a href='SkColor_Reference#Color'>Color</a> | <a href='SkColor_Reference#SK_ColorBLACK'>SK_ColorBLACK</a> | |
| 219 | | <a href='#Color_Alpha'>Color_Alpha</a> | 255 | |
| 220 | | <a href='#Color_Filter'>Color_Filter</a> | nullptr | |
| 221 | | Dither | false | |
| 222 | | <a href='#Draw_Looper'>Draw_Looper</a> | nullptr | |
| 223 | | <a href='#Paint_Fake_Bold'>Fake_Bold</a> | false | |
| 224 | | <a href='#Filter_Quality'>Filter_Quality</a> | <a href='undocumented#kNone_SkFilterQuality'>kNone_SkFilterQuality</a> | |
| 225 | | <a href='#Paint_Font_Embedded_Bitmaps'>Font_Embedded_Bitmaps</a> | false | |
| 226 | | <a href='#Paint_Automatic_Hinting'>Automatic_Hinting</a> | false | |
| 227 | | <a href='#Paint_Full_Hinting_Spacing'>Full_Hinting_Spacing</a> | false | |
Cary Clark | abaffd8 | 2018-11-15 08:25:12 -0500 | [diff] [blame] | 228 | | Hinting | <a href='undocumented#SkFontHinting'>SkFontHinting</a>::<a href='#SkFontHinting_kNormal'>kNormal</a> | |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 229 | | <a href='#Image_Filter'>Image_Filter</a> | nullptr | |
| 230 | | <a href='#Paint_LCD_Text'>LCD_Text</a> | false | |
| 231 | | <a href='#Paint_Linear_Text'>Linear_Text</a> | false | |
| 232 | | <a href='#Paint_Miter_Limit'>Miter_Limit</a> | 4 | |
| 233 | | <a href='#Mask_Filter'>Mask_Filter</a> | nullptr | |
| 234 | | <a href='#Path_Effect'>Path_Effect</a> | nullptr | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 235 | | <a href='undocumented#Shader'>Shader</a> | nullptr | |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 236 | | <a href='#SkPaint_Style'>Style</a> | <a href='#SkPaint_kFill_Style'>kFill_Style</a> | |
| 237 | | <a href='#Paint_Text_Encoding'>Text_Encoding</a> | <a href='#SkPaint_kUTF8_TextEncoding'>kUTF8_TextEncoding</a> | |
| 238 | | <a href='#Paint_Text_Scale_X'>Text_Scale_X</a> | 1 | |
| 239 | | <a href='#Paint_Text_Size'>Text_Size</a> | 12 | |
| 240 | | <a href='#Paint_Text_Skew_X'>Text_Skew_X</a> | 0 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 241 | | <a href='undocumented#Typeface'>Typeface</a> | nullptr | |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 242 | | <a href='#Paint_Stroke_Cap'>Stroke_Cap</a> | <a href='#SkPaint_kButt_Cap'>kButt_Cap</a> | |
| 243 | | <a href='#Paint_Stroke_Join'>Stroke_Join</a> | <a href='#SkPaint_kMiter_Join'>kMiter_Join</a> | |
| 244 | | <a href='#Paint_Stroke_Width'>Stroke_Width</a> | 0 | |
| 245 | | <a href='#Paint_Subpixel_Text'>Subpixel_Text</a> | false | |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 246 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 247 | 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 |
| 248 | <a href='SkPaint_Reference#Paint'>paint</a> default values. The overrides may be included in "SkUserConfig.h" or predefined by the |
| 249 | build system. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 250 | |
| 251 | ### Return Value |
| 252 | |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 253 | default initialized <a href='SkPaint_Reference#Paint'>Paint</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 254 | |
| 255 | ### Example |
| 256 | |
| 257 | <div><fiddle-embed name="c4b2186d85c142a481298f7144295ffd"></fiddle-embed></div> |
| 258 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 259 | <a name='SkPaint_copy_const_SkPaint'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 260 | |
| 261 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 262 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 263 | <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] | 264 | <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] | 265 | </pre> |
| 266 | |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 267 | 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] | 268 | <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 |
| 269 | 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] | 270 | their references by one. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 271 | |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 272 | 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] | 273 | <a href='undocumented#SkDrawLooper'>SkDrawLooper</a>, and <a href='undocumented#SkImageFilter'>SkImageFilter</a> cannot be modified after they are created. |
| 274 | 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] | 275 | |
| 276 | ### Parameters |
| 277 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 278 | <table> <tr> <td><a name='SkPaint_copy_const_SkPaint_paint'><code><strong>paint</strong></code></a></td> |
| 279 | <td>original to copy</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 280 | </tr> |
| 281 | </table> |
| 282 | |
| 283 | ### Return Value |
| 284 | |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 285 | shallow copy of <a href='#SkPaint_copy_const_SkPaint_paint'>paint</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 286 | |
| 287 | ### Example |
| 288 | |
skia-bookmaker | 44bad2e | 2018-07-05 05:35:27 +0000 | [diff] [blame] | 289 | <div><fiddle-embed name="b99971ad0ef243d617925289d963b62d"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 290 | |
| 291 | #### Example Output |
| 292 | |
| 293 | ~~~~ |
| 294 | SK_ColorRED == paint1.getColor() |
| 295 | SK_ColorBLUE == paint2.getColor() |
| 296 | ~~~~ |
| 297 | |
| 298 | </fiddle-embed></div> |
| 299 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 300 | <a name='SkPaint_move_SkPaint'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 301 | |
| 302 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 303 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 304 | <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] | 305 | <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] | 306 | </pre> |
| 307 | |
Cary Clark | d0530ba | 2017-09-14 11:25:39 -0400 | [diff] [blame] | 308 | Implements a move constructor to avoid increasing the reference counts |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 309 | 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] | 310 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 311 | 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] | 312 | |
| 313 | ### Parameters |
| 314 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 315 | <table> <tr> <td><a name='SkPaint_move_SkPaint_paint'><code><strong>paint</strong></code></a></td> |
| 316 | <td>original to move</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 317 | </tr> |
| 318 | </table> |
| 319 | |
| 320 | ### Return Value |
| 321 | |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 322 | content of <a href='#SkPaint_move_SkPaint_paint'>paint</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 323 | |
| 324 | ### Example |
| 325 | |
Cary Clark | 8364706 | 2018-07-18 16:21:51 -0400 | [diff] [blame] | 326 | <div><fiddle-embed name="8ed1488a503cd5282b86a51614aa90b1"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 327 | |
| 328 | #### Example Output |
| 329 | |
| 330 | ~~~~ |
| 331 | path effect unique: true |
| 332 | ~~~~ |
| 333 | |
| 334 | </fiddle-embed></div> |
| 335 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 336 | <a name='SkPaint_reset'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 337 | |
| 338 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 339 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 340 | <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] | 341 | void <a href='#SkPaint_reset'>reset()</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 342 | </pre> |
| 343 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 344 | Sets all <a href='SkPaint_Reference#SkPaint'>SkPaint</a> contents to their initial values. This is equivalent to replacing |
| 345 | <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] | 346 | |
| 347 | ### Example |
| 348 | |
| 349 | <div><fiddle-embed name="ef269937ade7e7353635121d9a64f9f7"> |
| 350 | |
| 351 | #### Example Output |
| 352 | |
| 353 | ~~~~ |
| 354 | paint1 == paint2 |
| 355 | ~~~~ |
| 356 | |
| 357 | </fiddle-embed></div> |
| 358 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 359 | <a name='SkPaint_destructor'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 360 | |
| 361 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 362 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 363 | <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] | 364 | <a href='#SkPaint_destructor'>~SkPaint()</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 365 | </pre> |
| 366 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 367 | 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>, |
| 368 | <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 |
| 369 | 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] | 370 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 371 | <a name='Management'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 372 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 373 | <a name='SkPaint_copy_operator'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 374 | |
| 375 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 376 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 377 | <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] | 378 | <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] | 379 | </pre> |
| 380 | |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 381 | 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] | 382 | <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 |
| 383 | 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] | 384 | 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] | 385 | resulting count is zero. Objects containing <a href='undocumented#SkRefCnt'>SkRefCnt</a> in the parameter <a href='#SkPaint_copy_operator_paint'>paint</a> |
| 386 | 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] | 387 | |
| 388 | ### Parameters |
| 389 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 390 | <table> <tr> <td><a name='SkPaint_copy_operator_paint'><code><strong>paint</strong></code></a></td> |
| 391 | <td>original to copy</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 392 | </tr> |
| 393 | </table> |
| 394 | |
| 395 | ### Return Value |
| 396 | |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 397 | content of <a href='#SkPaint_copy_operator_paint'>paint</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 398 | |
| 399 | ### Example |
| 400 | |
| 401 | <div><fiddle-embed name="b476a9088f80dece176ed577807d3992"> |
| 402 | |
| 403 | #### Example Output |
| 404 | |
| 405 | ~~~~ |
| 406 | SK_ColorRED == paint1.getColor() |
| 407 | SK_ColorRED == paint2.getColor() |
| 408 | ~~~~ |
| 409 | |
| 410 | </fiddle-embed></div> |
| 411 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 412 | <a name='SkPaint_move_operator'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 413 | |
| 414 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 415 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 416 | <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] | 417 | <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] | 418 | </pre> |
| 419 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 420 | Moves the <a href='#SkPaint_move_operator_paint'>paint</a> to avoid increasing the reference counts |
| 421 | 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] | 422 | prior destination are decreased by one; those objects are deleted if the resulting count |
| 423 | is zero. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 424 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 425 | 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] | 426 | |
| 427 | ### Parameters |
| 428 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 429 | <table> <tr> <td><a name='SkPaint_move_operator_paint'><code><strong>paint</strong></code></a></td> |
| 430 | <td>original to move</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 431 | </tr> |
| 432 | </table> |
| 433 | |
| 434 | ### Return Value |
| 435 | |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 436 | content of <a href='#SkPaint_move_operator_paint'>paint</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 437 | |
| 438 | ### Example |
| 439 | |
Ravi Mistry | 874e22b | 2018-07-19 03:49:13 +0000 | [diff] [blame] | 440 | <div><fiddle-embed name="9fb7459b097d713f5f1fe5675afe14f5"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 441 | |
| 442 | #### Example Output |
| 443 | |
| 444 | ~~~~ |
| 445 | SK_ColorRED == paint2.getColor() |
| 446 | ~~~~ |
| 447 | |
| 448 | </fiddle-embed></div> |
| 449 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 450 | <a name='SkPaint_equal_operator'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 451 | |
| 452 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 453 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 454 | <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] | 455 | 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] | 456 | </pre> |
| 457 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 458 | 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] | 459 | 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] | 460 | <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] | 461 | |
| 462 | ### Parameters |
| 463 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 464 | <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] | 465 | <td><a href='SkPaint_Reference#SkPaint'>SkPaint</a> to compare</td> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 466 | </tr> |
| 467 | <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] | 468 | <td><a href='SkPaint_Reference#SkPaint'>SkPaint</a> to compare</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 469 | </tr> |
| 470 | </table> |
| 471 | |
| 472 | ### Return Value |
| 473 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 474 | true if <a href='SkPaint_Reference#SkPaint'>SkPaint</a> pair are equivalent |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 475 | |
| 476 | ### Example |
| 477 | |
| 478 | <div><fiddle-embed name="7481a948e34672720337a631830586dd"> |
| 479 | |
| 480 | #### Example Output |
| 481 | |
| 482 | ~~~~ |
| 483 | paint1 == paint2 |
| 484 | paint1 != paint2 |
| 485 | ~~~~ |
| 486 | |
| 487 | </fiddle-embed></div> |
| 488 | |
Cary Clark | 06c20f3 | 2018-03-20 15:53:27 -0400 | [diff] [blame] | 489 | ### See Also |
| 490 | |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 491 | <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] | 492 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 493 | <a name='SkPaint_notequal_operator'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 494 | |
| 495 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 496 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 497 | <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] | 498 | 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] | 499 | </pre> |
| 500 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 501 | 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] | 502 | 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] | 503 | <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] | 504 | |
| 505 | ### Parameters |
| 506 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 507 | <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] | 508 | <td><a href='SkPaint_Reference#SkPaint'>SkPaint</a> to compare</td> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 509 | </tr> |
| 510 | <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] | 511 | <td><a href='SkPaint_Reference#SkPaint'>SkPaint</a> to compare</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 512 | </tr> |
| 513 | </table> |
| 514 | |
| 515 | ### Return Value |
| 516 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 517 | 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] | 518 | |
| 519 | ### Example |
| 520 | |
skia-bookmaker | a717ca9 | 2018-07-08 05:32:09 +0000 | [diff] [blame] | 521 | <div><fiddle-embed name="b6c8484b1187f555b435ad5369833be4"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 522 | |
| 523 | #### Example Output |
| 524 | |
| 525 | ~~~~ |
| 526 | paint1 == paint2 |
| 527 | paint1 == paint2 |
| 528 | ~~~~ |
| 529 | |
| 530 | </fiddle-embed></div> |
| 531 | |
Cary Clark | 06c20f3 | 2018-03-20 15:53:27 -0400 | [diff] [blame] | 532 | ### See Also |
| 533 | |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 534 | <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] | 535 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 536 | <a name='SkPaint_getHash'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 537 | |
| 538 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 539 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 540 | <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] | 541 | uint32_t <a href='#SkPaint_getHash'>getHash</a>()const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 542 | </pre> |
| 543 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 544 | 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] | 545 | Identical hashes guarantee that the paints are |
| 546 | equivalent, but differing hashes do not guarantee that the paints have differing |
| 547 | contents. |
| 548 | |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 549 | 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] | 550 | their hashes are also equal. |
| 551 | |
| 552 | The hash returned is platform and implementation specific. |
| 553 | |
| 554 | ### Return Value |
| 555 | |
| 556 | a shallow hash |
| 557 | |
| 558 | ### Example |
| 559 | |
Cary Clark | 8364706 | 2018-07-18 16:21:51 -0400 | [diff] [blame] | 560 | <div><fiddle-embed name="7f7e1b701361912b344f90ae6b530393"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 561 | |
| 562 | #### Example Output |
| 563 | |
| 564 | ~~~~ |
| 565 | paint1 == paint2 |
| 566 | paint1.getHash() == paint2.getHash() |
| 567 | ~~~~ |
| 568 | |
| 569 | </fiddle-embed></div> |
| 570 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 571 | <a name='Hinting'></a> |
| 572 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 573 | <a name='SkPaint_setHinting'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 574 | |
| 575 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 576 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 577 | <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] | 578 | 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] | 579 | </pre> |
| 580 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 581 | Sets level of <a href='undocumented#Glyph'>glyph</a> outline adjustment. |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 582 | 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] | 583 | |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 584 | ### Parameters |
| 585 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 586 | <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] | 587 | <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] | 588 | </tr> |
| 589 | </table> |
| 590 | |
Cary Clark | 885f107 | 2018-11-08 13:31:39 -0500 | [diff] [blame] | 591 | <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] | 592 | |
| 593 | ### Example |
| 594 | |
skia-bookmaker | 6894f22 | 2018-12-02 05:59:00 +0000 | [diff] [blame] | 595 | <div><fiddle-embed name="bb179ec5698ec1398ff18f3657ab73f7"> |
skia-bookmaker | e6c8575 | 2018-11-06 05:32:09 +0000 | [diff] [blame] | 596 | |
| 597 | #### Example Output |
| 598 | |
| 599 | ~~~~ |
| 600 | paint1 == paint2 |
| 601 | ~~~~ |
| 602 | |
| 603 | </fiddle-embed></div> |
| 604 | |
Cary Clark | 8cc4cdc | 2018-11-09 23:16:58 -0500 | [diff] [blame] | 605 | <a name='SkPaint_getHinting'></a> |
| 606 | |
| 607 | --- |
| 608 | |
| 609 | <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] | 610 | <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] | 611 | </pre> |
| 612 | |
| 613 | Returns level of <a href='undocumented#Glyph'>glyph</a> outline adjustment. |
| 614 | |
| 615 | ### Return Value |
| 616 | |
Cary Clark | abaffd8 | 2018-11-15 08:25:12 -0500 | [diff] [blame] | 617 | 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] | 618 | |
Cary Clark | abaffd8 | 2018-11-15 08:25:12 -0500 | [diff] [blame] | 619 | <a href='undocumented#SkFontHinting'>SkFontHinting</a>::<a href='#SkFontHinting_kFull'>kFull</a> |
Cary Clark | 8cc4cdc | 2018-11-09 23:16:58 -0500 | [diff] [blame] | 620 | |
Cary Clark | abaffd8 | 2018-11-15 08:25:12 -0500 | [diff] [blame] | 621 | ### Example |
Cary Clark | 8cc4cdc | 2018-11-09 23:16:58 -0500 | [diff] [blame] | 622 | |
Cary Clark | abaffd8 | 2018-11-15 08:25:12 -0500 | [diff] [blame] | 623 | <div><fiddle-embed name="b56b70c7ea2453c41bfa58b626953bed"> |
Cary Clark | 8cc4cdc | 2018-11-09 23:16:58 -0500 | [diff] [blame] | 624 | |
Cary Clark | abaffd8 | 2018-11-15 08:25:12 -0500 | [diff] [blame] | 625 | #### Example Output |
Cary Clark | 8cc4cdc | 2018-11-09 23:16:58 -0500 | [diff] [blame] | 626 | |
Cary Clark | abaffd8 | 2018-11-15 08:25:12 -0500 | [diff] [blame] | 627 | ~~~~ |
| 628 | SkFontHinting::kNormal == paint.getHinting() |
| 629 | ~~~~ |
Cary Clark | 8cc4cdc | 2018-11-09 23:16:58 -0500 | [diff] [blame] | 630 | |
Cary Clark | abaffd8 | 2018-11-15 08:25:12 -0500 | [diff] [blame] | 631 | </fiddle-embed></div> |
Cary Clark | 8cc4cdc | 2018-11-09 23:16:58 -0500 | [diff] [blame] | 632 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 633 | <a name='Flags'></a> |
| 634 | |
| 635 | <a name='SkPaint_Flags'></a> |
| 636 | |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 637 | --- |
| 638 | |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 639 | <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] | 640 | enum <a href='#SkPaint_Flags'>Flags</a> { |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 641 | <a href='#SkPaint_kAntiAlias_Flag'>kAntiAlias_Flag</a> = 0x01, |
| 642 | <a href='#SkPaint_kDither_Flag'>kDither_Flag</a> = 0x04, |
| 643 | <a href='#SkPaint_kFakeBoldText_Flag'>kFakeBoldText_Flag</a> = 0x20, |
| 644 | <a href='#SkPaint_kLinearText_Flag'>kLinearText_Flag</a> = 0x40, |
| 645 | <a href='#SkPaint_kSubpixelText_Flag'>kSubpixelText_Flag</a> = 0x80, |
| 646 | <a href='#SkPaint_kLCDRenderText_Flag'>kLCDRenderText_Flag</a> = 0x200, |
| 647 | <a href='#SkPaint_kEmbeddedBitmapText_Flag'>kEmbeddedBitmapText_Flag</a> = 0x400, |
| 648 | <a href='#SkPaint_kAutoHinting_Flag'>kAutoHinting_Flag</a> = 0x800, |
| 649 | <a href='#SkPaint_kAllFlags'>kAllFlags</a> = 0xFFFF, |
Cary Clark | 186d08f | 2018-04-03 08:43:27 -0400 | [diff] [blame] | 650 | }; |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 651 | |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 652 | </pre> |
| 653 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 654 | The bit values stored in <a href='#SkPaint_Flags'>Flags</a>. |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 655 | The default value for <a href='#SkPaint_Flags'>Flags</a>, normally zero, can be changed at compile time |
| 656 | with a custom definition of <a href='undocumented#SkPaintDefaults_Flags'>SkPaintDefaults_Flags</a>. |
| 657 | All flags can be read and written explicitly; <a href='#SkPaint_Flags'>Flags</a> allows manipulating |
| 658 | multiple settings at once. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 659 | |
| 660 | ### Constants |
| 661 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 662 | <table style='border-collapse: collapse; width: 62.5em'> |
| 663 | <tr><th style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>Const</th> |
| 664 | <th style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>Value</th> |
| 665 | <th style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>Description</th></tr> |
| 666 | <tr style='background-color: #f0f0f0; '> |
| 667 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kAntiAlias_Flag'><code>SkPaint::kAntiAlias_Flag</code></a></td> |
| 668 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>0x0001</td> |
| 669 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
Cary Clark | ffb3d68 | 2018-05-17 12:17:28 -0400 | [diff] [blame] | 670 | mask for setting Anti_Alias</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 671 | </tr> |
| 672 | <tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 673 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kDither_Flag'><code>SkPaint::kDither_Flag</code></a></td> |
| 674 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>0x0004</td> |
| 675 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 676 | mask for setting Dither</td> |
| 677 | </tr> |
| 678 | <tr style='background-color: #f0f0f0; '> |
| 679 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kFakeBoldText_Flag'><code>SkPaint::kFakeBoldText_Flag</code></a></td> |
| 680 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>0x0020</td> |
| 681 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 682 | mask for setting Fake_Bold</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 683 | </tr> |
| 684 | <tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 685 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kLinearText_Flag'><code>SkPaint::kLinearText_Flag</code></a></td> |
| 686 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>0x0040</td> |
| 687 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 688 | mask for setting Linear_Text</td> |
| 689 | </tr> |
| 690 | <tr style='background-color: #f0f0f0; '> |
| 691 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kSubpixelText_Flag'><code>SkPaint::kSubpixelText_Flag</code></a></td> |
| 692 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>0x0080</td> |
| 693 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 694 | mask for setting Subpixel_Text</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 695 | </tr> |
| 696 | <tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 697 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kLCDRenderText_Flag'><code>SkPaint::kLCDRenderText_Flag</code></a></td> |
| 698 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>0x0200</td> |
| 699 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 700 | mask for setting LCD_Text</td> |
| 701 | </tr> |
| 702 | <tr style='background-color: #f0f0f0; '> |
| 703 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kEmbeddedBitmapText_Flag'><code>SkPaint::kEmbeddedBitmapText_Flag</code></a></td> |
| 704 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>0x0400</td> |
| 705 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 706 | mask for setting Font_Embedded_Bitmaps</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 707 | </tr> |
| 708 | <tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 709 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kAutoHinting_Flag'><code>SkPaint::kAutoHinting_Flag</code></a></td> |
| 710 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>0x0800</td> |
| 711 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 712 | mask for setting Automatic_Hinting</td> |
| 713 | </tr> |
| 714 | <tr style='background-color: #f0f0f0; '> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 715 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kAllFlags'><code>SkPaint::kAllFlags</code></a></td> |
| 716 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>0xFFFF</td> |
| 717 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 718 | 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] | 719 | </td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 720 | </tr> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 721 | <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] | 722 | </table> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 723 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 724 | <a name='SkPaint_getFlags'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 725 | |
| 726 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 727 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 728 | <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] | 729 | uint32_t <a href='#SkPaint_getFlags'>getFlags</a>()const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 730 | </pre> |
| 731 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 732 | 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 |
| 733 | 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] | 734 | |
| 735 | ### Return Value |
| 736 | |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 737 | 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] | 738 | |
| 739 | ### Example |
| 740 | |
| 741 | <div><fiddle-embed name="8a3f8c309533388b01aa66e1267f322d"> |
| 742 | |
| 743 | #### Example Output |
| 744 | |
| 745 | ~~~~ |
| 746 | (SkPaint::kAntiAlias_Flag & paint.getFlags()) != 0 |
| 747 | ~~~~ |
| 748 | |
| 749 | </fiddle-embed></div> |
| 750 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 751 | <a name='SkPaint_setFlags'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 752 | |
| 753 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 754 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 755 | <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] | 756 | void <a href='#SkPaint_setFlags'>setFlags</a>(uint32_t flags) |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 757 | </pre> |
| 758 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 759 | 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. |
| 760 | 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] | 761 | |
| 762 | ### Parameters |
| 763 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 764 | <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] | 765 | <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] | 766 | </tr> |
| 767 | </table> |
| 768 | |
| 769 | ### Example |
| 770 | |
| 771 | <div><fiddle-embed name="54baed3f6bc4b9c31ba664e27767fdc7"> |
| 772 | |
| 773 | #### Example Output |
| 774 | |
| 775 | ~~~~ |
| 776 | paint.isAntiAlias() |
| 777 | paint.isDither() |
| 778 | ~~~~ |
| 779 | |
| 780 | </fiddle-embed></div> |
| 781 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 782 | <a name='Anti_Alias'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 783 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 784 | --- |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 785 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 786 | <a href='#Paint_Anti_Alias'>Anti_Alias</a> drawing approximates partial <a href='undocumented#Pixel'>pixel</a> coverage with transparency. |
| 787 | 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. |
| 788 | 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] | 789 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 790 | The rule for <a href='undocumented#Alias'>Aliased</a> pixels is inconsistent across platforms. A shape edge |
| 791 | 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] | 792 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 793 | <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 |
| 794 | 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] | 795 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 796 | A platform may only support <a href='#Paint_Anti_Alias'>Anti_Aliased</a> drawing. Some GPU-backed platforms use |
| 797 | <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] | 798 | <a href='undocumented#Alias'>Alias</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 799 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 800 | 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] | 801 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 802 | <a href='#Paint_Anti_Alias'>Anti_Alias</a> is disabled by default. |
| 803 | <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> |
| 804 | at compile time. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 805 | |
| 806 | ### Example |
| 807 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 808 | <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. |
| 809 | A blue <a href='undocumented#Line'>line</a> draws only where the <a href='undocumented#Pixel'>pixel</a> centers are contained. |
| 810 | The <a href='undocumented#Line'>lines</a> are drawn into <a href='SkBitmap_Reference#Bitmap'>Bitmap</a>, then drawn magnified to make the |
| 811 | <a href='undocumented#Alias'>Aliasing</a> easier to see. |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 812 | </div></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 813 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 814 | <a name='SkPaint_isAntiAlias'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 815 | |
| 816 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 817 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 818 | <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] | 819 | bool <a href='#SkPaint_isAntiAlias'>isAntiAlias</a>()const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 820 | </pre> |
| 821 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 822 | 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] | 823 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 824 | 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] | 825 | |
| 826 | ### Return Value |
| 827 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 828 | <a href='#SkPaint_kAntiAlias_Flag'>kAntiAlias_Flag</a> state |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 829 | |
| 830 | ### Example |
| 831 | |
skia-bookmaker | b95bbba | 2018-07-06 05:23:23 +0000 | [diff] [blame] | 832 | <div><fiddle-embed name="d7d5f4f7da7acd5104a652f490c6f7b8"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 833 | |
| 834 | #### Example Output |
| 835 | |
| 836 | ~~~~ |
| 837 | paint.isAntiAlias() == !!(paint.getFlags() & SkPaint::kAntiAlias_Flag) |
| 838 | paint.isAntiAlias() == !!(paint.getFlags() & SkPaint::kAntiAlias_Flag) |
| 839 | ~~~~ |
| 840 | |
| 841 | </fiddle-embed></div> |
| 842 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 843 | <a name='SkPaint_setAntiAlias'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 844 | |
| 845 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 846 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 847 | <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] | 848 | void <a href='#SkPaint_setAntiAlias'>setAntiAlias</a>(bool aa) |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 849 | </pre> |
| 850 | |
skia-bookmaker | 8be4196 | 2018-11-20 05:34:36 +0000 | [diff] [blame] | 851 | Requests, but does not require, that edge pixels draw opaque or with |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 852 | partial transparency. |
| 853 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 854 | Sets <a href='#SkPaint_kAntiAlias_Flag'>kAntiAlias_Flag</a> if <a href='#SkPaint_setAntiAlias_aa'>aa</a> is true. |
| 855 | 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] | 856 | |
| 857 | ### Parameters |
| 858 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 859 | <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] | 860 | <td>setting for <a href='#SkPaint_kAntiAlias_Flag'>kAntiAlias_Flag</a></td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 861 | </tr> |
| 862 | </table> |
| 863 | |
| 864 | ### Example |
| 865 | |
skia-bookmaker | b95bbba | 2018-07-06 05:23:23 +0000 | [diff] [blame] | 866 | <div><fiddle-embed name="c2ff148374d01cbef845b223e725905c"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 867 | |
| 868 | #### Example Output |
| 869 | |
| 870 | ~~~~ |
| 871 | paint1 == paint2 |
| 872 | ~~~~ |
| 873 | |
| 874 | </fiddle-embed></div> |
| 875 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 876 | <a name='Dither'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 877 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 878 | --- |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 879 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 880 | Dither increases fidelity by adjusting the <a href='SkColor_Reference#Color'>color</a> of adjacent pixels. |
| 881 | This can help to smooth <a href='SkColor_Reference#Color'>color</a> transitions and reducing banding in gradients. |
| 882 | Dithering lessens visible banding from <a href='SkImageInfo_Reference#kRGB_565_SkColorType'>kRGB_565_SkColorType</a> |
| 883 | and <a href='SkImageInfo_Reference#kRGBA_8888_SkColorType'>kRGBA_8888_SkColorType</a> gradients, |
| 884 | 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] | 885 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 886 | Dithering is always enabled for linear gradients drawing into |
| 887 | <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>. |
| 888 | 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] | 889 | <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] | 890 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 891 | Dither is disabled by default. |
| 892 | 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> |
| 893 | at compile time. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 894 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 895 | 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] | 896 | |
| 897 | ### Example |
| 898 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 899 | <div><fiddle-embed name="8b26507690b71462f44642b911890bbf"><div>Dithering in the bottom half more closely approximates the requested <a href='SkColor_Reference#Color'>color</a> by |
| 900 | 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] | 901 | </div></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 902 | |
| 903 | ### Example |
| 904 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 905 | <div><fiddle-embed name="76d4d4a7931a48495e4d5f54e073be53"><div>Dithering introduces subtle adjustments to <a href='SkColor_Reference#Color'>color</a> to smooth gradients. |
| 906 | Drawing the gradient repeatedly with <a href='SkBlendMode_Reference#SkBlendMode'>SkBlendMode</a>::<a href='#SkBlendMode_kPlus'>kPlus</a> exaggerates the |
| 907 | dither, making it easier to see. |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 908 | </div></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 909 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 910 | ### See Also |
| 911 | |
| 912 | Gradient <a href='SkImageInfo_Reference#kRGB_565_SkColorType'>kRGB_565_SkColorType</a> |
| 913 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 914 | <a name='SkPaint_isDither'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 915 | |
| 916 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 917 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 918 | <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] | 919 | bool <a href='#SkPaint_isDither'>isDither</a>()const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 920 | </pre> |
| 921 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 922 | 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] | 923 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 924 | 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] | 925 | |
| 926 | ### Return Value |
| 927 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 928 | <a href='#SkPaint_kDither_Flag'>kDither_Flag</a> state |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 929 | |
| 930 | ### Example |
| 931 | |
| 932 | <div><fiddle-embed name="f4ce93f6c5e7335436a985377fd980c0"> |
| 933 | |
| 934 | #### Example Output |
| 935 | |
| 936 | ~~~~ |
| 937 | paint.isDither() == !!(paint.getFlags() & SkPaint::kDither_Flag) |
| 938 | paint.isDither() == !!(paint.getFlags() & SkPaint::kDither_Flag) |
| 939 | ~~~~ |
| 940 | |
| 941 | </fiddle-embed></div> |
| 942 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 943 | <a name='SkPaint_setDither'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 944 | |
| 945 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 946 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 947 | <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] | 948 | void <a href='#SkPaint_setDither'>setDither</a>(bool dither) |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 949 | </pre> |
| 950 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 951 | 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] | 952 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 953 | Sets <a href='#SkPaint_kDither_Flag'>kDither_Flag</a> if <a href='#SkPaint_setDither_dither'>dither</a> is true. |
| 954 | 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] | 955 | |
| 956 | ### Parameters |
| 957 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 958 | <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] | 959 | <td>setting for <a href='#SkPaint_kDither_Flag'>kDither_Flag</a></td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 960 | </tr> |
| 961 | </table> |
| 962 | |
| 963 | ### Example |
| 964 | |
| 965 | <div><fiddle-embed name="69b7162e8324d9239dd02dd9ada2bdff"> |
| 966 | |
| 967 | #### Example Output |
| 968 | |
| 969 | ~~~~ |
| 970 | paint1 == paint2 |
| 971 | ~~~~ |
| 972 | |
| 973 | </fiddle-embed></div> |
| 974 | |
| 975 | ### See Also |
| 976 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 977 | <a href='SkImageInfo_Reference#kRGB_565_SkColorType'>kRGB_565_SkColorType</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 978 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 979 | <a name='Device_Text'></a> |
| 980 | |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 981 | --- |
| 982 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 983 | <a href='#Paint_LCD_Text'>LCD_Text</a> and <a href='#Paint_Subpixel_Text'>Subpixel_Text</a> increase the precision of <a href='undocumented#Glyph'>glyph</a> position. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 984 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 985 | 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 |
| 986 | create a <a href='SkColor_Reference#Color'>color</a>, and relies |
| 987 | 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. |
| 988 | <a href='#Paint_LCD_Text'>LCD_Text</a> can be enabled on devices that orient stripes horizontally or vertically, and that order |
| 989 | 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] | 990 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 991 | <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. |
| 992 | As the opaqueness |
| 993 | 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] | 994 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 995 | Either or both techniques can be enabled. |
| 996 | <a href='#SkPaint_kLCDRenderText_Flag'>kLCDRenderText_Flag</a> and <a href='#SkPaint_kSubpixelText_Flag'>kSubpixelText_Flag</a> are clear by default. |
| 997 | <a href='#Paint_LCD_Text'>LCD_Text</a> or <a href='#Paint_Subpixel_Text'>Subpixel_Text</a> can be enabled by default by setting <a href='undocumented#SkPaintDefaults_Flags'>SkPaintDefaults_Flags</a> to |
| 998 | <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] | 999 | |
| 1000 | ### Example |
| 1001 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1002 | <div><fiddle-embed name="4606ae1be792d6bc46d496432f050ee9"><div>Four commas are drawn normally and with combinations of <a href='#Paint_LCD_Text'>LCD_Text</a> and <a href='#Paint_Subpixel_Text'>Subpixel_Text</a>. |
| 1003 | When <a href='#Paint_Subpixel_Text'>Subpixel_Text</a> is disabled, the comma <a href='undocumented#Glyph'>Glyphs</a> are identical, but not evenly spaced. |
| 1004 | When <a href='#Paint_Subpixel_Text'>Subpixel_Text</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] | 1005 | </div></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1006 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1007 | <a name='Linear_Text'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1008 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1009 | <a href='#Paint_Linear_Text'>Linear_Text</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>. |
Cary Clark | abaffd8 | 2018-11-15 08:25:12 -0500 | [diff] [blame] | 1010 | If <a href='#SkPaint_kLinearText_Flag'>kLinearText_Flag</a> is set, it has the same effect as setting Hinting to <a href='undocumented#SkFontHinting'>SkFontHinting</a>::<a href='#SkFontHinting_kNormal'>kNormal</a>. |
| 1011 | If <a href='#SkPaint_kLinearText_Flag'>kLinearText_Flag</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] | 1012 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1013 | <a name='SkPaint_isLinearText'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1014 | |
| 1015 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1016 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1017 | <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] | 1018 | bool <a href='#SkPaint_isLinearText'>isLinearText</a>()const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1019 | </pre> |
| 1020 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1021 | 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] | 1022 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1023 | 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] | 1024 | |
| 1025 | ### Return Value |
| 1026 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1027 | <a href='#SkPaint_kLinearText_Flag'>kLinearText_Flag</a> state |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1028 | |
| 1029 | ### Example |
| 1030 | |
| 1031 | <div><fiddle-embed name="2890ad644f980637837e6fcb386fb462"></fiddle-embed></div> |
| 1032 | |
| 1033 | ### See Also |
| 1034 | |
Cary Clark | abaffd8 | 2018-11-15 08:25:12 -0500 | [diff] [blame] | 1035 | <a href='#SkPaint_setLinearText'>setLinearText</a> Hinting |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1036 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1037 | <a name='SkPaint_setLinearText'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1038 | |
| 1039 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1040 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1041 | <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] | 1042 | void <a href='#SkPaint_setLinearText'>setLinearText</a>(bool linearText) |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1043 | </pre> |
| 1044 | |
skia-bookmaker | 8be4196 | 2018-11-20 05:34:36 +0000 | [diff] [blame] | 1045 | Requests, but does not require, that <a href='undocumented#Glyph'>glyphs</a> are converted to <a href='SkPath_Reference#SkPath'>SkPath</a> |
| 1046 | before drawing and measuring. |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1047 | By default, <a href='#SkPaint_kLinearText_Flag'>kLinearText_Flag</a> is clear. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1048 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1049 | Sets <a href='#SkPaint_kLinearText_Flag'>kLinearText_Flag</a> if <a href='#SkPaint_setLinearText_linearText'>linearText</a> is true. |
| 1050 | 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] | 1051 | |
| 1052 | ### Parameters |
| 1053 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1054 | <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] | 1055 | <td>setting for <a href='#SkPaint_kLinearText_Flag'>kLinearText_Flag</a></td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1056 | </tr> |
| 1057 | </table> |
| 1058 | |
| 1059 | ### Example |
| 1060 | |
Cary Clark | 8364706 | 2018-07-18 16:21:51 -0400 | [diff] [blame] | 1061 | <div><fiddle-embed name="c93bb912f3bddfb4d96d3ad70ada552b"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1062 | |
| 1063 | ### See Also |
| 1064 | |
Cary Clark | abaffd8 | 2018-11-15 08:25:12 -0500 | [diff] [blame] | 1065 | <a href='#SkPaint_isLinearText'>isLinearText</a> Hinting |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1066 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1067 | <a name='Subpixel_Text'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1068 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1069 | <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. |
| 1070 | As the opaqueness |
| 1071 | 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] | 1072 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1073 | <a name='SkPaint_isSubpixelText'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1074 | |
| 1075 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1076 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1077 | <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] | 1078 | bool <a href='#SkPaint_isSubpixelText'>isSubpixelText</a>()const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1079 | </pre> |
| 1080 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1081 | Returns true if <a href='undocumented#Glyph'>glyphs</a> at different sub-pixel positions may differ on <a href='undocumented#Pixel'>pixel</a> edge coverage. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1082 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1083 | 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] | 1084 | |
| 1085 | ### Return Value |
| 1086 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1087 | <a href='#SkPaint_kSubpixelText_Flag'>kSubpixelText_Flag</a> state |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1088 | |
| 1089 | ### Example |
| 1090 | |
| 1091 | <div><fiddle-embed name="abe9afc0932e2199324ae6cbb396e67c"> |
| 1092 | |
| 1093 | #### Example Output |
| 1094 | |
| 1095 | ~~~~ |
| 1096 | paint.isSubpixelText() == !!(paint.getFlags() & SkPaint::kSubpixelText_Flag) |
| 1097 | paint.isSubpixelText() == !!(paint.getFlags() & SkPaint::kSubpixelText_Flag) |
| 1098 | ~~~~ |
| 1099 | |
| 1100 | </fiddle-embed></div> |
| 1101 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1102 | <a name='SkPaint_setSubpixelText'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1103 | |
| 1104 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1105 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1106 | <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] | 1107 | void <a href='#SkPaint_setSubpixelText'>setSubpixelText</a>(bool subpixelText) |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1108 | </pre> |
| 1109 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1110 | Requests, but does not require, that <a href='undocumented#Glyph'>glyphs</a> respect sub-pixel positioning. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1111 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1112 | Sets <a href='#SkPaint_kSubpixelText_Flag'>kSubpixelText_Flag</a> if <a href='#SkPaint_setSubpixelText_subpixelText'>subpixelText</a> is true. |
| 1113 | 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] | 1114 | |
| 1115 | ### Parameters |
| 1116 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1117 | <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] | 1118 | <td>setting for <a href='#SkPaint_kSubpixelText_Flag'>kSubpixelText_Flag</a></td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1119 | </tr> |
| 1120 | </table> |
| 1121 | |
| 1122 | ### Example |
| 1123 | |
| 1124 | <div><fiddle-embed name="a77bbc1a4e3be9a8ab0f842f877c5ee4"> |
| 1125 | |
| 1126 | #### Example Output |
| 1127 | |
| 1128 | ~~~~ |
| 1129 | paint1 == paint2 |
| 1130 | ~~~~ |
| 1131 | |
| 1132 | </fiddle-embed></div> |
| 1133 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1134 | <a name='LCD_Text'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1135 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1136 | 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 |
| 1137 | create a <a href='SkColor_Reference#Color'>color</a>, and relies |
| 1138 | 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. |
| 1139 | <a href='#Paint_LCD_Text'>LCD_Text</a> can be enabled on devices that orient stripes horizontally or vertically, and that order |
| 1140 | 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] | 1141 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1142 | <a name='SkPaint_isLCDRenderText'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1143 | |
| 1144 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1145 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1146 | <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] | 1147 | bool <a href='#SkPaint_isLCDRenderText'>isLCDRenderText</a>()const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1148 | </pre> |
| 1149 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1150 | 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] | 1151 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1152 | 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] | 1153 | |
| 1154 | ### Return Value |
| 1155 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1156 | <a href='#SkPaint_kLCDRenderText_Flag'>kLCDRenderText_Flag</a> state |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1157 | |
| 1158 | ### Example |
| 1159 | |
skia-bookmaker | a391c72 | 2018-07-09 05:28:19 +0000 | [diff] [blame] | 1160 | <div><fiddle-embed name="68e1fd95dd2fd06a333899d2bd2396b9"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1161 | |
| 1162 | #### Example Output |
| 1163 | |
| 1164 | ~~~~ |
| 1165 | paint.isLCDRenderText() == !!(paint.getFlags() & SkPaint::kLCDRenderText_Flag) |
| 1166 | paint.isLCDRenderText() == !!(paint.getFlags() & SkPaint::kLCDRenderText_Flag) |
| 1167 | ~~~~ |
| 1168 | |
| 1169 | </fiddle-embed></div> |
| 1170 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1171 | <a name='SkPaint_setLCDRenderText'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1172 | |
| 1173 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1174 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1175 | <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] | 1176 | void <a href='#SkPaint_setLCDRenderText'>setLCDRenderText</a>(bool lcdText) |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1177 | </pre> |
| 1178 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1179 | 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] | 1180 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1181 | Sets <a href='#SkPaint_kLCDRenderText_Flag'>kLCDRenderText_Flag</a> if <a href='#SkPaint_setLCDRenderText_lcdText'>lcdText</a> is true. |
| 1182 | 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] | 1183 | |
| 1184 | ### Parameters |
| 1185 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1186 | <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] | 1187 | <td>setting for <a href='#SkPaint_kLCDRenderText_Flag'>kLCDRenderText_Flag</a></td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1188 | </tr> |
| 1189 | </table> |
| 1190 | |
| 1191 | ### Example |
| 1192 | |
skia-bookmaker | e0a458f | 2018-07-16 05:29:00 +0000 | [diff] [blame] | 1193 | <div><fiddle-embed name="50dedf8450159571a3edaf4f0050defe"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1194 | |
| 1195 | #### Example Output |
| 1196 | |
| 1197 | ~~~~ |
| 1198 | paint1 == paint2 |
| 1199 | ~~~~ |
| 1200 | |
| 1201 | </fiddle-embed></div> |
| 1202 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1203 | <a name='Font_Embedded_Bitmaps'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1204 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1205 | --- |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 1206 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1207 | <a href='#Paint_Font_Embedded_Bitmaps'>Font_Embedded_Bitmaps</a> allows selecting custom sized <a href='SkBitmap_Reference#Bitmap'>bitmap</a> <a href='undocumented#Glyph'>Glyphs</a>. |
| 1208 | <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] | 1209 | 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] | 1210 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1211 | 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 |
| 1212 | the outline <a href='undocumented#Glyph'>glyph</a> if <a href='#SkPaint_kEmbeddedBitmapText_Flag'>kEmbeddedBitmapText_Flag</a> is clear. |
| 1213 | Windows may select the <a href='SkBitmap_Reference#Bitmap'>bitmap</a> <a href='undocumented#Glyph'>glyph</a> but is not required to do so. |
| 1214 | <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] | 1215 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1216 | <a href='#Paint_Font_Embedded_Bitmaps'>Font_Embedded_Bitmaps</a> is disabled by default. |
| 1217 | <a href='#Paint_Font_Embedded_Bitmaps'>Font_Embedded_Bitmaps</a> can be enabled by default by setting <a href='undocumented#SkPaintDefaults_Flags'>SkPaintDefaults_Flags</a> to |
| 1218 | <a href='#SkPaint_kEmbeddedBitmapText_Flag'>kEmbeddedBitmapText_Flag</a> at compile time. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1219 | |
| 1220 | ### Example |
| 1221 | |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 1222 | <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] | 1223 | <div>The "hintgasp" TrueType font in the Skia resources/fonts directory |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 1224 | includes an embedded bitmap Glyph at odd font sizes. This example works |
| 1225 | on platforms that use FreeType as their Font_Engine. |
| 1226 | Windows may, but is not required to, return a bitmap glyph if |
| 1227 | kEmbeddedBitmapText_Flag is set.</div>SkBitmap bitmap; |
| 1228 | bitmap.allocN32Pixels(30, 15); |
| 1229 | bitmap.eraseColor(0); |
| 1230 | SkCanvas offscreen(bitmap); |
| 1231 | SkPaint paint; |
| 1232 | paint.setAntiAlias(true); |
| 1233 | paint.setTextSize(13); |
Hal Canary | 53e5e7d | 2017-12-08 14:25:14 -0500 | [diff] [blame] | 1234 | paint.setTypeface(MakeResourceAsTypeface("fonts/hintgasp.ttf")); |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 1235 | for (bool embedded : { false, true}) { |
| 1236 | paint.setEmbeddedBitmapText(embedded); |
| 1237 | offscreen.drawString("A", embedded ? 5 : 15, 15, paint); |
| 1238 | } |
| 1239 | canvas->drawBitmap(bitmap, 0, 0); |
| 1240 | canvas->scale(10, 10); |
| 1241 | canvas->drawBitmap(bitmap, -2, 1); |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 1242 | |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 1243 | </pre> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1244 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1245 | <a name='SkPaint_isEmbeddedBitmapText'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1246 | |
| 1247 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1248 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1249 | <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] | 1250 | bool <a href='#SkPaint_isEmbeddedBitmapText'>isEmbeddedBitmapText</a>()const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1251 | </pre> |
| 1252 | |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 1253 | 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] | 1254 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1255 | 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] | 1256 | |
| 1257 | ### Return Value |
| 1258 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1259 | <a href='#SkPaint_kEmbeddedBitmapText_Flag'>kEmbeddedBitmapText_Flag</a> state |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1260 | |
| 1261 | ### Example |
| 1262 | |
| 1263 | <div><fiddle-embed name="eba10b27b790e87183ae451b3fc5c4b1"> |
| 1264 | |
| 1265 | #### Example Output |
| 1266 | |
| 1267 | ~~~~ |
| 1268 | paint.isEmbeddedBitmapText() == !!(paint.getFlags() & SkPaint::kEmbeddedBitmapText_Flag) |
| 1269 | paint.isEmbeddedBitmapText() == !!(paint.getFlags() & SkPaint::kEmbeddedBitmapText_Flag) |
| 1270 | ~~~~ |
| 1271 | |
| 1272 | </fiddle-embed></div> |
| 1273 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1274 | <a name='SkPaint_setEmbeddedBitmapText'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1275 | |
| 1276 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1277 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1278 | <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] | 1279 | void <a href='#SkPaint_setEmbeddedBitmapText'>setEmbeddedBitmapText</a>(bool useEmbeddedBitmapText) |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1280 | </pre> |
| 1281 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1282 | 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] | 1283 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1284 | Sets <a href='#SkPaint_kEmbeddedBitmapText_Flag'>kEmbeddedBitmapText_Flag</a> if <a href='#SkPaint_setEmbeddedBitmapText_useEmbeddedBitmapText'>useEmbeddedBitmapText</a> is true. |
| 1285 | 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] | 1286 | |
| 1287 | ### Parameters |
| 1288 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1289 | <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] | 1290 | <td>setting for <a href='#SkPaint_kEmbeddedBitmapText_Flag'>kEmbeddedBitmapText_Flag</a></td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1291 | </tr> |
| 1292 | </table> |
| 1293 | |
| 1294 | ### Example |
| 1295 | |
| 1296 | <div><fiddle-embed name="246dffdd93a484ba4ad7ecf71198a5d4"> |
| 1297 | |
| 1298 | #### Example Output |
| 1299 | |
| 1300 | ~~~~ |
| 1301 | paint1 == paint2 |
| 1302 | ~~~~ |
| 1303 | |
| 1304 | </fiddle-embed></div> |
| 1305 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1306 | <a name='Automatic_Hinting'></a> |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 1307 | |
Cary Clark | abaffd8 | 2018-11-15 08:25:12 -0500 | [diff] [blame] | 1308 | 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='#Paint_Automatic_Hinting'>Automatic_Hinting</a> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1309 | instructs the <a href='#Font_Manager'>Font_Manager</a> to always hint <a href='undocumented#Glyph'>Glyphs</a>. |
Cary Clark | abaffd8 | 2018-11-15 08:25:12 -0500 | [diff] [blame] | 1310 | <a href='#Paint_Automatic_Hinting'>Automatic_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] | 1311 | <a href='undocumented#SkFontHinting'>SkFontHinting</a>::<a href='#SkFontHinting_kSlight'>kSlight</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1312 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1313 | <a href='#Paint_Automatic_Hinting'>Automatic_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] | 1314 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1315 | <a name='SkPaint_isAutohinted'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1316 | |
| 1317 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1318 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1319 | <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] | 1320 | bool <a href='#SkPaint_isAutohinted'>isAutohinted</a>()const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1321 | </pre> |
| 1322 | |
Cary Clark | abaffd8 | 2018-11-15 08:25:12 -0500 | [diff] [blame] | 1323 | 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] | 1324 | <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. |
| 1325 | 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] | 1326 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1327 | 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] | 1328 | |
| 1329 | ### Return Value |
| 1330 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1331 | <a href='#SkPaint_kAutoHinting_Flag'>kAutoHinting_Flag</a> state |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1332 | |
| 1333 | ### Example |
| 1334 | |
| 1335 | <div><fiddle-embed name="aa4781afbe3b90e7ef56a287e5b9ce1e"> |
| 1336 | |
| 1337 | #### Example Output |
| 1338 | |
| 1339 | ~~~~ |
| 1340 | paint.isAutohinted() == !!(paint.getFlags() & SkPaint::kAutoHinting_Flag) |
| 1341 | paint.isAutohinted() == !!(paint.getFlags() & SkPaint::kAutoHinting_Flag) |
| 1342 | ~~~~ |
| 1343 | |
| 1344 | </fiddle-embed></div> |
| 1345 | |
| 1346 | ### See Also |
| 1347 | |
Cary Clark | abaffd8 | 2018-11-15 08:25:12 -0500 | [diff] [blame] | 1348 | <a href='#SkPaint_setAutohinted'>setAutohinted</a> Hinting |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1349 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1350 | <a name='SkPaint_setAutohinted'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1351 | |
| 1352 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1353 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1354 | <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] | 1355 | void <a href='#SkPaint_setAutohinted'>setAutohinted</a>(bool useAutohinter) |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1356 | </pre> |
| 1357 | |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 1358 | Sets whether to always hint <a href='undocumented#Glyph'>glyphs</a>. |
Cary Clark | abaffd8 | 2018-11-15 08:25:12 -0500 | [diff] [blame] | 1359 | 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] | 1360 | 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 | abaffd8 | 2018-11-15 08:25:12 -0500 | [diff] [blame] | 1361 | <a href='SkPaint_Reference#Automatic_Hinting'>auto-hinting</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] | 1362 | <a href='undocumented#SkFontHinting'>SkFontHinting</a>::<a href='#SkFontHinting_kSlight'>kSlight</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1363 | |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 1364 | 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] | 1365 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1366 | Sets <a href='#SkPaint_kAutoHinting_Flag'>kAutoHinting_Flag</a> if <a href='#SkPaint_setAutohinted_useAutohinter'>useAutohinter</a> is true. |
| 1367 | 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] | 1368 | |
| 1369 | ### Parameters |
| 1370 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1371 | <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] | 1372 | <td>setting for <a href='#SkPaint_kAutoHinting_Flag'>kAutoHinting_Flag</a></td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1373 | </tr> |
| 1374 | </table> |
| 1375 | |
| 1376 | ### Example |
| 1377 | |
| 1378 | <div><fiddle-embed name="4e185306d7de9390fe8445eed0139309"></fiddle-embed></div> |
| 1379 | |
| 1380 | ### See Also |
| 1381 | |
Cary Clark | abaffd8 | 2018-11-15 08:25:12 -0500 | [diff] [blame] | 1382 | <a href='#SkPaint_isAutohinted'>isAutohinted</a> Hinting |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1383 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1384 | <a name='Fake_Bold'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1385 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1386 | --- |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 1387 | |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 1388 | <a href='#Paint_Fake_Bold'>Fake_Bold</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 |
| 1389 | is not available. Skia does not provide <a href='SkFont_Reference#Font'>font</a> substitution; it is up to the client to find the |
| 1390 | 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] | 1391 | |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 1392 | 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] | 1393 | is not available. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1394 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1395 | 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] | 1396 | 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] | 1397 | 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] | 1398 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1399 | <a href='#Paint_Fake_Bold'>Fake_Bold</a> is disabled by default. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1400 | |
| 1401 | ### Example |
| 1402 | |
| 1403 | <div><fiddle-embed name="e811f4829a2daaaeaad3795504a7e02a"></fiddle-embed></div> |
| 1404 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1405 | <a name='SkPaint_isFakeBoldText'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1406 | |
| 1407 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1408 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1409 | <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] | 1410 | bool <a href='#SkPaint_isFakeBoldText'>isFakeBoldText</a>()const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1411 | </pre> |
| 1412 | |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 1413 | 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] | 1414 | from outlines. |
| 1415 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1416 | 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] | 1417 | |
| 1418 | ### Return Value |
| 1419 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1420 | <a href='#SkPaint_kFakeBoldText_Flag'>kFakeBoldText_Flag</a> state |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1421 | |
| 1422 | ### Example |
| 1423 | |
| 1424 | <div><fiddle-embed name="f54d1f85b16073b80b9eef2e1a1d151d"> |
| 1425 | |
| 1426 | #### Example Output |
| 1427 | |
| 1428 | ~~~~ |
| 1429 | paint.isFakeBoldText() == !!(paint.getFlags() & SkPaint::kFakeBoldText_Flag) |
| 1430 | paint.isFakeBoldText() == !!(paint.getFlags() & SkPaint::kFakeBoldText_Flag) |
| 1431 | ~~~~ |
| 1432 | |
| 1433 | </fiddle-embed></div> |
| 1434 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1435 | <a name='SkPaint_setFakeBoldText'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1436 | |
| 1437 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1438 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1439 | <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] | 1440 | void <a href='#SkPaint_setFakeBoldText'>setFakeBoldText</a>(bool fakeBoldText) |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1441 | </pre> |
| 1442 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1443 | 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] | 1444 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1445 | Sets <a href='#SkPaint_kFakeBoldText_Flag'>kFakeBoldText_Flag</a> if <a href='#SkPaint_setFakeBoldText_fakeBoldText'>fakeBoldText</a> is true. |
| 1446 | 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] | 1447 | |
| 1448 | ### Parameters |
| 1449 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1450 | <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] | 1451 | <td>setting for <a href='#SkPaint_kFakeBoldText_Flag'>kFakeBoldText_Flag</a></td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1452 | </tr> |
| 1453 | </table> |
| 1454 | |
| 1455 | ### Example |
| 1456 | |
| 1457 | <div><fiddle-embed name="594d47858eb11028cb626515a520910a"> |
| 1458 | |
| 1459 | #### Example Output |
| 1460 | |
| 1461 | ~~~~ |
| 1462 | paint1 == paint2 |
| 1463 | ~~~~ |
| 1464 | |
| 1465 | </fiddle-embed></div> |
| 1466 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1467 | <a name='Full_Hinting_Spacing'></a> |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 1468 | |
Cary Clark | abaffd8 | 2018-11-15 08:25:12 -0500 | [diff] [blame] | 1469 | if Hinting is set to <a href='undocumented#SkFontHinting'>SkFontHinting</a>::<a href='#SkFontHinting_kFull'>kFull</a>, <a href='#Paint_Full_Hinting_Spacing'>Full_Hinting_Spacing</a> adjusts the character |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1470 | spacing by the difference of the hinted and unhinted <a href='#Left_Side_Bearing'>Left_Side_Bearing</a> and |
| 1471 | <a href='#Right_Side_Bearing'>Right_Side_Bearing</a>. <a href='#Paint_Full_Hinting_Spacing'>Full_Hinting_Spacing</a> only applies to platforms that use |
| 1472 | FreeType as their <a href='#Font_Engine'>Font_Engine</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1473 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1474 | <a href='#Paint_Full_Hinting_Spacing'>Full_Hinting_Spacing</a> is not related to <a href='undocumented#Text'>text</a> kerning, where the space between |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 1475 | a specific pair of characters is adjusted using <a href='undocumented#Data'>data</a> in the <a href='SkFont_Reference#Font'>font</a> kerning tables. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1476 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1477 | <a name='Filter_Quality_Methods'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1478 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1479 | --- |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 1480 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1481 | <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. |
| 1482 | A lower <a href='#Filter_Quality'>Filter_Quality</a> draws faster, but has less fidelity. |
| 1483 | A higher <a href='#Filter_Quality'>Filter_Quality</a> draws slower, but looks better. |
| 1484 | 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 |
| 1485 | in a noticeable difference. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1486 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1487 | <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] | 1488 | |
| 1489 | <table> <tr> |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 1490 | <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] | 1491 | </tr> <tr> |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 1492 | <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] | 1493 | </tr> <tr> |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 1494 | <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] | 1495 | </tr> <tr> |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 1496 | <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] | 1497 | </tr> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1498 | </table> |
| 1499 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1500 | 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] | 1501 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1502 | <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] | 1503 | |
| 1504 | ### Example |
| 1505 | |
skia-bookmaker | 525f9a9 | 2018-05-03 06:27:39 +0000 | [diff] [blame] | 1506 | <div><fiddle-embed name="69369cff2f5b145a6f616092513266a0"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1507 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1508 | <a name='SkPaint_getFilterQuality'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1509 | |
| 1510 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1511 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1512 | <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] | 1513 | <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] | 1514 | </pre> |
| 1515 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1516 | Returns <a href='undocumented#SkFilterQuality'>SkFilterQuality</a>, the <a href='SkImage_Reference#Image'>image</a> filtering level. A lower setting |
| 1517 | 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] | 1518 | |
| 1519 | ### Return Value |
| 1520 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1521 | 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] | 1522 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1523 | <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] | 1524 | |
| 1525 | ### Example |
| 1526 | |
| 1527 | <div><fiddle-embed name="d4ca1f23809b6835c4ba46ea98a86900"> |
| 1528 | |
| 1529 | #### Example Output |
| 1530 | |
| 1531 | ~~~~ |
| 1532 | kNone_SkFilterQuality == paint.getFilterQuality() |
| 1533 | ~~~~ |
| 1534 | |
| 1535 | </fiddle-embed></div> |
| 1536 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1537 | <a name='SkPaint_setFilterQuality'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1538 | |
| 1539 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1540 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1541 | <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] | 1542 | 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] | 1543 | </pre> |
| 1544 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1545 | Sets <a href='undocumented#SkFilterQuality'>SkFilterQuality</a>, the <a href='SkImage_Reference#Image'>image</a> filtering level. A lower setting |
| 1546 | draws faster; a higher setting looks better when the <a href='SkImage_Reference#Image'>image</a> is scaled. |
| 1547 | 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] | 1548 | |
| 1549 | ### Parameters |
| 1550 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1551 | <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] | 1552 | <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] | 1553 | </tr> |
| 1554 | </table> |
| 1555 | |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 1556 | <a href='undocumented#kMedium_SkFilterQuality'>kMedium_SkFilterQuality</a>, <a href='undocumented#kHigh_SkFilterQuality'>kHigh_SkFilterQuality</a> |
| 1557 | |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1558 | ### Example |
| 1559 | |
| 1560 | <div><fiddle-embed name="e4288fabf24ee60b645e8bb6ea0afadf"> |
| 1561 | |
| 1562 | #### Example Output |
| 1563 | |
| 1564 | ~~~~ |
| 1565 | kHigh_SkFilterQuality == paint.getFilterQuality() |
| 1566 | ~~~~ |
| 1567 | |
| 1568 | </fiddle-embed></div> |
| 1569 | |
| 1570 | ### See Also |
| 1571 | |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 1572 | <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] | 1573 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1574 | <a name='Color_Methods'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1575 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1576 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1577 | |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 1578 | | name | description | |
| 1579 | | --- | --- | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1580 | | <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> | |
| 1581 | | <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] | 1582 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1583 | <a href='SkColor_Reference#Color'>Color</a> specifies the red, blue, green, and <a href='#Color_Alpha'>Color_Alpha</a> |
| 1584 | values used to draw a filled or stroked shape in a 32-bit value. Each component |
| 1585 | occupies 8-bits, ranging from zero: no contribution; to 255: full intensity. |
| 1586 | All values in any combination are valid. |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 1587 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1588 | <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 |
| 1589 | RGB: red, blue, and green. |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 1590 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1591 | The bit positions of <a href='#Color_Alpha'>Color_Alpha</a> and RGB are independent of the bit |
| 1592 | positions on the output <a href='undocumented#Device'>device</a>, which may have more or fewer bits, and may have |
| 1593 | a different arrangement. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1594 | |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 1595 | | bit positions | <a href='#Color_Alpha'>Color_Alpha</a> | red | blue | green | |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1596 | | --- | --- | --- | --- | --- | |
| 1597 | | | 31 - 24 | 23 - 16 | 15 - 8 | 7 - 0 | |
| 1598 | |
| 1599 | ### Example |
| 1600 | |
Ravi Mistry | 874e22b | 2018-07-19 03:49:13 +0000 | [diff] [blame] | 1601 | <div><fiddle-embed name="214b559d75c65a7bef6ef4be1f860053"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1602 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1603 | <a name='SkPaint_getColor'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1604 | |
| 1605 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1606 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1607 | <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] | 1608 | <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] | 1609 | </pre> |
| 1610 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1611 | Retrieves <a href='SkColor_Reference#Alpha'>alpha</a> and RGB, <a href='undocumented#Unpremultiply'>unpremultiplied</a>, packed into 32 bits. |
| 1612 | 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 |
| 1613 | a <a href='SkColor_Reference#Color'>color</a> component. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1614 | |
| 1615 | ### Return Value |
| 1616 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1617 | <a href='undocumented#Unpremultiply'>unpremultiplied</a> ARGB |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1618 | |
| 1619 | ### Example |
| 1620 | |
skia-bookmaker | 61cc9fa | 2018-07-11 05:28:17 +0000 | [diff] [blame] | 1621 | <div><fiddle-embed name="72d41f890203109a41f589a7403acae9"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1622 | |
| 1623 | #### Example Output |
| 1624 | |
| 1625 | ~~~~ |
| 1626 | Yellow is 100% red, 100% green, and 0% blue. |
| 1627 | ~~~~ |
| 1628 | |
| 1629 | </fiddle-embed></div> |
| 1630 | |
| 1631 | ### See Also |
| 1632 | |
Cary Clark | bbe8ff9 | 2018-09-05 11:39:01 -0400 | [diff] [blame] | 1633 | <a href='#SkPaint_getColor4f'>getColor4f</a> <a href='SkColor_Reference#SkColor'>SkColor</a> |
| 1634 | |
Cary Clark | bbe8ff9 | 2018-09-05 11:39:01 -0400 | [diff] [blame] | 1635 | <a name='SkPaint_getColor4f'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1636 | |
| 1637 | --- |
Cary Clark | bbe8ff9 | 2018-09-05 11:39:01 -0400 | [diff] [blame] | 1638 | |
| 1639 | <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] | 1640 | <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] | 1641 | </pre> |
| 1642 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1643 | 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] | 1644 | are extended sRGB values (sRGB gamut, and encoded with the sRGB transfer function). |
| 1645 | |
| 1646 | ### Return Value |
| 1647 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1648 | <a href='undocumented#Unpremultiply'>unpremultiplied</a> RGBA |
Cary Clark | bbe8ff9 | 2018-09-05 11:39:01 -0400 | [diff] [blame] | 1649 | |
| 1650 | ### Example |
| 1651 | |
| 1652 | <div><fiddle-embed name="8512ea2176f36e8f1aeef311ff228790"> |
| 1653 | |
| 1654 | #### Example Output |
| 1655 | |
| 1656 | ~~~~ |
| 1657 | Yellow is 100% red, 100% green, and 0% blue. |
| 1658 | ~~~~ |
| 1659 | |
| 1660 | </fiddle-embed></div> |
| 1661 | |
| 1662 | ### See Also |
| 1663 | |
| 1664 | <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] | 1665 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1666 | <a name='SkPaint_setColor'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1667 | |
| 1668 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1669 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1670 | <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] | 1671 | 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] | 1672 | </pre> |
| 1673 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1674 | 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, |
| 1675 | <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] | 1676 | |
| 1677 | ### Parameters |
| 1678 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1679 | <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] | 1680 | <td><a href='undocumented#Unpremultiply'>unpremultiplied</a> ARGB</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1681 | </tr> |
| 1682 | </table> |
| 1683 | |
| 1684 | ### Example |
| 1685 | |
skia-bookmaker | 233c652 | 2018-07-04 05:33:26 +0000 | [diff] [blame] | 1686 | <div><fiddle-embed name="6e70f18300bd676a3c056ceb6b62f8df"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1687 | |
| 1688 | #### Example Output |
| 1689 | |
| 1690 | ~~~~ |
| 1691 | green1 == green2 |
| 1692 | ~~~~ |
| 1693 | |
| 1694 | </fiddle-embed></div> |
| 1695 | |
| 1696 | ### See Also |
| 1697 | |
Cary Clark | bbe8ff9 | 2018-09-05 11:39:01 -0400 | [diff] [blame] | 1698 | <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> |
| 1699 | |
Cary Clark | bbe8ff9 | 2018-09-05 11:39:01 -0400 | [diff] [blame] | 1700 | <a name='SkPaint_setColor4f'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1701 | |
| 1702 | --- |
Cary Clark | bbe8ff9 | 2018-09-05 11:39:01 -0400 | [diff] [blame] | 1703 | |
| 1704 | <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] | 1705 | 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] | 1706 | </pre> |
| 1707 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1708 | 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 |
| 1709 | <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 |
| 1710 | 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] | 1711 | sRGB <a href='undocumented#Color_Space'>color space</a>. |
Cary Clark | bbe8ff9 | 2018-09-05 11:39:01 -0400 | [diff] [blame] | 1712 | |
| 1713 | ### Parameters |
| 1714 | |
| 1715 | <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] | 1716 | <td><a href='undocumented#Unpremultiply'>unpremultiplied</a> RGBA</td> |
Cary Clark | bbe8ff9 | 2018-09-05 11:39:01 -0400 | [diff] [blame] | 1717 | </tr> |
| 1718 | <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] | 1719 | <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] | 1720 | </tr> |
| 1721 | </table> |
| 1722 | |
| 1723 | ### Example |
| 1724 | |
| 1725 | <div><fiddle-embed name="fa60859e3d03bdc117a05b32e093a8f1"> |
| 1726 | |
| 1727 | #### Example Output |
| 1728 | |
| 1729 | ~~~~ |
| 1730 | green1 == green2 |
| 1731 | ~~~~ |
| 1732 | |
| 1733 | </fiddle-embed></div> |
| 1734 | |
| 1735 | ### See Also |
| 1736 | |
| 1737 | <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] | 1738 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1739 | <a name='Alpha_Methods'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1740 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1741 | <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] | 1742 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1743 | <a name='SkPaint_getAlpha'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1744 | |
| 1745 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1746 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1747 | <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] | 1748 | uint8_t <a href='#SkPaint_getAlpha'>getAlpha</a>()const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1749 | </pre> |
| 1750 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1751 | 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] | 1752 | |
| 1753 | ### Return Value |
| 1754 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1755 | <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] | 1756 | |
| 1757 | ### Example |
| 1758 | |
Cary Clark | 8364706 | 2018-07-18 16:21:51 -0400 | [diff] [blame] | 1759 | <div><fiddle-embed name="9a85bb62fe3d877b18fb7f952c4fa7f7"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1760 | |
| 1761 | #### Example Output |
| 1762 | |
| 1763 | ~~~~ |
| 1764 | 255 == paint.getAlpha() |
| 1765 | ~~~~ |
| 1766 | |
| 1767 | </fiddle-embed></div> |
| 1768 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1769 | <a name='SkPaint_setAlpha'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1770 | |
| 1771 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1772 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1773 | <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] | 1774 | 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] | 1775 | </pre> |
| 1776 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1777 | Replaces <a href='SkColor_Reference#Alpha'>alpha</a>, leaving RGB |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1778 | unchanged. An out of range value triggers an assert in the debug |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1779 | build. <a href='#SkPaint_setAlpha_a'>a</a> is <a href='#SkPaint_setAlpha_a'>a</a> value from zero to 255. |
| 1780 | <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] | 1781 | fully opaque. |
| 1782 | |
| 1783 | ### Parameters |
| 1784 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1785 | <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] | 1786 | <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] | 1787 | </tr> |
| 1788 | </table> |
| 1789 | |
| 1790 | ### Example |
| 1791 | |
Ravi Mistry | 874e22b | 2018-07-19 03:49:13 +0000 | [diff] [blame] | 1792 | <div><fiddle-embed name="6ddc0360512dfb9947e75c17e6a8103d"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1793 | |
| 1794 | #### Example Output |
| 1795 | |
| 1796 | ~~~~ |
| 1797 | 0x44112233 == paint.getColor() |
| 1798 | ~~~~ |
| 1799 | |
| 1800 | </fiddle-embed></div> |
| 1801 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1802 | <a name='SkPaint_setARGB'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1803 | |
| 1804 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1805 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1806 | <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] | 1807 | 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] | 1808 | </pre> |
| 1809 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1810 | 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. |
| 1811 | 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] | 1812 | |
| 1813 | ### Parameters |
| 1814 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1815 | <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] | 1816 | <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] | 1817 | </tr> |
| 1818 | <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] | 1819 | <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] | 1820 | </tr> |
| 1821 | <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] | 1822 | <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] | 1823 | </tr> |
| 1824 | <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] | 1825 | <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] | 1826 | </tr> |
| 1827 | </table> |
| 1828 | |
| 1829 | ### Example |
| 1830 | |
skia-bookmaker | 61cc9fa | 2018-07-11 05:28:17 +0000 | [diff] [blame] | 1831 | <div><fiddle-embed name="cb62e4755789ed32f7120dc55984959d"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1832 | |
| 1833 | #### Example Output |
| 1834 | |
| 1835 | ~~~~ |
| 1836 | transRed1 == transRed2 |
| 1837 | ~~~~ |
| 1838 | |
| 1839 | </fiddle-embed></div> |
| 1840 | |
| 1841 | ### See Also |
| 1842 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1843 | <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] | 1844 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1845 | <a name='Style'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1846 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1847 | --- |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 1848 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1849 | <a href='#SkPaint_Style'>Style</a> specifies if the geometry is filled, stroked, or both filled and stroked. |
| 1850 | 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] | 1851 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1852 | <a name='Style_Fill'></a> |
| 1853 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1854 | Set <a href='#SkPaint_Style'>Style</a> to <a href='#SkPaint_kFill_Style'>kFill_Style</a> to fill the shape. |
| 1855 | The fill covers the area inside the geometry for most shapes. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1856 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1857 | <a name='Style_Stroke'></a> |
| 1858 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1859 | 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] | 1860 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1861 | The stroke covers the area described by following the shape edge with a pen or brush of |
| 1862 | <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>. |
| 1863 | The area covered where the shape turns a corner is described by <a href='#Paint_Stroke_Join'>Stroke_Join</a>. |
| 1864 | 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 |
| 1865 | 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] | 1866 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1867 | ### See Also |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1868 | |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 1869 | <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] | 1870 | |
| 1871 | <a name='Hairline'></a> |
| 1872 | |
| 1873 | --- |
| 1874 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1875 | <a href='#Paint_Stroke_Width'>Stroke_Width</a> of zero has a special meaning and switches drawing to use Hairline. |
| 1876 | Hairline draws the thinnest continuous frame. If <a href='#SkPaint_kAntiAlias_Flag'>kAntiAlias_Flag</a> is clear, adjacent pixels |
| 1877 | flow horizontally, vertically,or diagonally. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1878 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1879 | <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 |
| 1880 | 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 |
| 1881 | <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 |
| 1882 | GPU-backed implementations apply transparency at a later drawing stage, avoiding double hit pixels |
| 1883 | while stroking. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1884 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1885 | ### See Also |
| 1886 | |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 1887 | <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] | 1888 | |
| 1889 | <a name='SkPaint_Style'></a> |
| 1890 | |
| 1891 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1892 | |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 1893 | <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] | 1894 | enum <a href='#SkPaint_Style'>Style</a> : uint8_t { |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 1895 | <a href='#SkPaint_kFill_Style'>kFill_Style</a>, |
| 1896 | <a href='#SkPaint_kStroke_Style'>kStroke_Style</a>, |
| 1897 | <a href='#SkPaint_kStrokeAndFill_Style'>kStrokeAndFill_Style</a>, |
Cary Clark | 186d08f | 2018-04-03 08:43:27 -0400 | [diff] [blame] | 1898 | }; |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 1899 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1900 | </pre> |
Cary Clark | d98f78c | 2018-04-26 08:32:37 -0400 | [diff] [blame] | 1901 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1902 | <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] | 1903 | 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] | 1904 | </pre> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1905 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1906 | Set <a href='#SkPaint_Style'>Style</a> to fill, stroke, or both fill and stroke geometry. |
| 1907 | The stroke and fill |
| 1908 | 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] | 1909 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1910 | Use <a href='#SkPaint_kStrokeAndFill_Style'>kStrokeAndFill_Style</a> to avoid hitting the same pixels twice with a stroke draw and |
| 1911 | a fill draw. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1912 | |
| 1913 | ### Constants |
| 1914 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1915 | <table style='border-collapse: collapse; width: 62.5em'> |
| 1916 | <tr><th style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>Const</th> |
| 1917 | <th style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>Value</th> |
| 1918 | <th style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>Description</th></tr> |
| 1919 | <tr style='background-color: #f0f0f0; '> |
| 1920 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kFill_Style'><code>SkPaint::kFill_Style</code></a></td> |
| 1921 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>0</td> |
| 1922 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1923 | 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>. |
| 1924 | <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 |
| 1925 | <a href='#SkPaint_kFill_Style'>kFill_Style</a> is set, and ignore the set <a href='#SkPaint_Style'>Style</a>. |
| 1926 | 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, |
| 1927 | and to create an unfilled hole inside the shape. |
| 1928 | <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] | 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_kStroke_Style'><code>SkPaint::kStroke_Style</code></a></td> |
| 1933 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>1</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 | 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>. |
| 1936 | <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, |
| 1937 | and ignore the set <a href='#SkPaint_Style'>Style</a>. |
| 1938 | 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] | 1939 | </td> |
| 1940 | </tr> |
| 1941 | <tr style='background-color: #f0f0f0; '> |
| 1942 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kStrokeAndFill_Style'><code>SkPaint::kStrokeAndFill_Style</code></a></td> |
| 1943 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>2</td> |
| 1944 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1945 | 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>. |
| 1946 | <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>, |
| 1947 | 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] | 1948 | </td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1949 | </tr> |
| 1950 | <tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1951 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kStyleCount'><code>SkPaint::kStyleCount</code></a></td> |
| 1952 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>3</td> |
| 1953 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1954 | 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] | 1955 | </td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1956 | </tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1957 | </table> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1958 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1959 | <a name='SkPaint_getStyle'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1960 | |
| 1961 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1962 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1963 | <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] | 1964 | <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] | 1965 | </pre> |
| 1966 | |
Cary Clark | 80247e5 | 2018-07-11 16:18:41 -0400 | [diff] [blame] | 1967 | Returns whether the geometry is filled, stroked, or filled and stroked. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1968 | |
| 1969 | ### Return Value |
| 1970 | |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 1971 | 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] | 1972 | |
| 1973 | ### Example |
| 1974 | |
| 1975 | <div><fiddle-embed name="1c5e18c3c0102d2dac86a78ba8c8ce01"> |
| 1976 | |
| 1977 | #### Example Output |
| 1978 | |
| 1979 | ~~~~ |
| 1980 | SkPaint::kFill_Style == paint.getStyle() |
| 1981 | ~~~~ |
| 1982 | |
| 1983 | </fiddle-embed></div> |
| 1984 | |
| 1985 | ### See Also |
| 1986 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1987 | <a href='#SkPaint_Style'>Style</a> <a href='#SkPaint_setStyle'>setStyle</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1988 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1989 | <a name='SkPaint_setStyle'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1990 | |
| 1991 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1992 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1993 | <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] | 1994 | 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] | 1995 | </pre> |
| 1996 | |
| 1997 | Sets whether the geometry is filled, stroked, or filled and stroked. |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1998 | 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] | 1999 | |
| 2000 | ### Parameters |
| 2001 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2002 | <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] | 2003 | <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] | 2004 | </tr> |
| 2005 | </table> |
| 2006 | |
| 2007 | ### Example |
| 2008 | |
| 2009 | <div><fiddle-embed name="c7bb6248e4735b8d1a32d02fba40d344"></fiddle-embed></div> |
| 2010 | |
| 2011 | ### See Also |
| 2012 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2013 | <a href='#SkPaint_Style'>Style</a> <a href='#SkPaint_getStyle'>getStyle</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2014 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2015 | <a name='Stroke_Width'></a> |
| 2016 | |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2017 | --- |
| 2018 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2019 | <a href='#Paint_Stroke_Width'>Stroke_Width</a> sets the width for stroking. The width is the thickness |
| 2020 | 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 |
| 2021 | 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] | 2022 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2023 | When width is greater than zero, the stroke encompasses as many pixels partially |
| 2024 | or fully as needed. When the width equals zero, the <a href='SkPaint_Reference#Paint'>paint</a> enables hairlines; |
| 2025 | the stroke is always one <a href='undocumented#Pixel'>pixel</a> wide. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2026 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2027 | The stroke dimensions are scaled by the <a href='SkCanvas_Reference#Canvas_Matrix'>canvas matrix</a>, but Hairline stroke |
| 2028 | remains one <a href='undocumented#Pixel'>pixel</a> wide regardless of scaling. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2029 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2030 | 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] | 2031 | |
| 2032 | ### Example |
| 2033 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2034 | <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 |
| 2035 | <a href='undocumented#Line'>line</a> and the platform implementation. |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 2036 | </div></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2037 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2038 | <a name='SkPaint_getStrokeWidth'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2039 | |
| 2040 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2041 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2042 | <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] | 2043 | <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] | 2044 | </pre> |
| 2045 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2046 | 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] | 2047 | outline the shape. |
| 2048 | |
| 2049 | ### Return Value |
| 2050 | |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 2051 | zero for hairline, greater than zero for pen thickness |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2052 | |
| 2053 | ### Example |
| 2054 | |
skia-bookmaker | b95bbba | 2018-07-06 05:23:23 +0000 | [diff] [blame] | 2055 | <div><fiddle-embed name="99aa73f64df8bbf06e656cd891a81b9e"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2056 | |
| 2057 | #### Example Output |
| 2058 | |
| 2059 | ~~~~ |
| 2060 | 0 == paint.getStrokeWidth() |
| 2061 | ~~~~ |
| 2062 | |
| 2063 | </fiddle-embed></div> |
| 2064 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2065 | <a name='SkPaint_setStrokeWidth'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2066 | |
| 2067 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2068 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2069 | <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] | 2070 | 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] | 2071 | </pre> |
| 2072 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2073 | 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] | 2074 | outline the shape. |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2075 | 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] | 2076 | |
| 2077 | ### Parameters |
| 2078 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2079 | <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] | 2080 | <td>zero thickness for hairline; greater than zero for pen thickness</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2081 | </tr> |
| 2082 | </table> |
| 2083 | |
| 2084 | ### Example |
| 2085 | |
| 2086 | <div><fiddle-embed name="0c4446c0870b5c7b5a2efe77ff92afb8"> |
| 2087 | |
| 2088 | #### Example Output |
| 2089 | |
| 2090 | ~~~~ |
| 2091 | 5 == paint.getStrokeWidth() |
| 2092 | ~~~~ |
| 2093 | |
| 2094 | </fiddle-embed></div> |
| 2095 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2096 | <a name='Miter_Limit'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2097 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2098 | --- |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 2099 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2100 | <a href='#Paint_Miter_Limit'>Miter_Limit</a> specifies the maximum miter length, |
| 2101 | relative to the <a href='#Stroke_Width'>stroke width</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2102 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2103 | <a href='#Paint_Miter_Limit'>Miter_Limit</a> is used when the <a href='#Paint_Stroke_Join'>Stroke_Join</a> |
| 2104 | 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> |
| 2105 | or <a href='#SkPaint_kStrokeAndFill_Style'>kStrokeAndFill_Style</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2106 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2107 | If the miter at a corner exceeds this limit, <a href='#SkPaint_kMiter_Join'>kMiter_Join</a> |
| 2108 | is replaced with <a href='#SkPaint_kBevel_Join'>kBevel_Join</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2109 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2110 | <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] | 2111 | <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] | 2112 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2113 | <a href='#Paint_Miter_Limit'>Miter_Limit</a> default value is 4. |
| 2114 | The default may be changed at compile time by setting <a href='undocumented#SkPaintDefaults_MiterLimit'>SkPaintDefaults_MiterLimit</a> |
| 2115 | in "SkUserConfig.h" or as a define supplied by the build environment. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2116 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2117 | Here are some miter limits and the angles that triggers them. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2118 | |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 2119 | | <a href='#Miter_Limit'>miter limit</a> | angle in degrees | |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2120 | | --- | --- | |
| 2121 | | 10 | 11.48 | |
| 2122 | | 9 | 12.76 | |
| 2123 | | 8 | 14.36 | |
| 2124 | | 7 | 16.43 | |
| 2125 | | 6 | 19.19 | |
| 2126 | | 5 | 23.07 | |
| 2127 | | 4 | 28.96 | |
| 2128 | | 3 | 38.94 | |
| 2129 | | 2 | 60 | |
| 2130 | | 1 | 180 | |
| 2131 | |
| 2132 | ### Example |
| 2133 | |
Cary Clark | a619d45 | 2018-07-16 08:12:01 -0400 | [diff] [blame] | 2134 | <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] | 2135 | 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] | 2136 | by a bevel join. |
| 2137 | </div></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2138 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2139 | <a name='SkPaint_getStrokeMiter'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2140 | |
| 2141 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2142 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2143 | <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] | 2144 | <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] | 2145 | </pre> |
| 2146 | |
Cary Clark | 80247e5 | 2018-07-11 16:18:41 -0400 | [diff] [blame] | 2147 | Returns the limit at which a sharp corner is drawn beveled. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2148 | |
| 2149 | ### Return Value |
| 2150 | |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 2151 | zero and greater miter limit |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2152 | |
| 2153 | ### Example |
| 2154 | |
| 2155 | <div><fiddle-embed name="50da74a43b725f07a914df588c867d36"> |
| 2156 | |
| 2157 | #### Example Output |
| 2158 | |
| 2159 | ~~~~ |
| 2160 | default miter limit == 4 |
| 2161 | ~~~~ |
| 2162 | |
| 2163 | </fiddle-embed></div> |
| 2164 | |
| 2165 | ### See Also |
| 2166 | |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 2167 | <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] | 2168 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2169 | <a name='SkPaint_setStrokeMiter'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2170 | |
| 2171 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2172 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2173 | <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] | 2174 | 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] | 2175 | </pre> |
| 2176 | |
Cary Clark | 80247e5 | 2018-07-11 16:18:41 -0400 | [diff] [blame] | 2177 | Sets the limit at which a sharp corner is drawn beveled. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2178 | Valid values are zero and greater. |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2179 | 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] | 2180 | |
| 2181 | ### Parameters |
| 2182 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2183 | <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] | 2184 | <td>zero and greater <a href='#Miter_Limit'>miter limit</a></td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2185 | </tr> |
| 2186 | </table> |
| 2187 | |
| 2188 | ### Example |
| 2189 | |
skia-bookmaker | a717ca9 | 2018-07-08 05:32:09 +0000 | [diff] [blame] | 2190 | <div><fiddle-embed name="700b284dbc97785c6a9c9636088713ad"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2191 | |
| 2192 | #### Example Output |
| 2193 | |
| 2194 | ~~~~ |
| 2195 | default miter limit == 8 |
| 2196 | ~~~~ |
| 2197 | |
| 2198 | </fiddle-embed></div> |
| 2199 | |
| 2200 | ### See Also |
| 2201 | |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 2202 | <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] | 2203 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2204 | <a name='Stroke_Cap'></a> |
| 2205 | |
| 2206 | <a name='SkPaint_Cap'></a> |
| 2207 | |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2208 | --- |
| 2209 | |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 2210 | <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] | 2211 | enum <a href='#SkPaint_Cap'>Cap</a> { |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 2212 | <a href='#SkPaint_kButt_Cap'>kButt_Cap</a>, |
| 2213 | <a href='#SkPaint_kRound_Cap'>kRound_Cap</a>, |
| 2214 | <a href='#SkPaint_kSquare_Cap'>kSquare_Cap</a>, |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 2215 | <a href='#SkPaint_kLast_Cap'>kLast_Cap</a> = <a href='#SkPaint_kSquare_Cap'>kSquare_Cap</a>, |
| 2216 | <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] | 2217 | }; |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 2218 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2219 | </pre> |
Cary Clark | 6fc5041 | 2017-09-21 12:31:06 -0400 | [diff] [blame] | 2220 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2221 | <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] | 2222 | 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] | 2223 | </pre> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2224 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2225 | <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] | 2226 | |
| 2227 | ### Constants |
| 2228 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2229 | <table style='border-collapse: collapse; width: 62.5em'> |
| 2230 | <tr><th style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>Const</th> |
| 2231 | <th style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>Value</th> |
| 2232 | <th style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>Description</th></tr> |
| 2233 | <tr style='background-color: #f0f0f0; '> |
| 2234 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kButt_Cap'><code>SkPaint::kButt_Cap</code></a></td> |
| 2235 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>0</td> |
| 2236 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 2237 | Does not extend the stroke past the beginning or the end. |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 2238 | </td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2239 | </tr> |
| 2240 | <tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2241 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kRound_Cap'><code>SkPaint::kRound_Cap</code></a></td> |
| 2242 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>1</td> |
| 2243 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2244 | Adds a <a href='undocumented#Circle'>circle</a> with a diameter equal to <a href='#Paint_Stroke_Width'>Stroke_Width</a> at the beginning |
| 2245 | and end. |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 2246 | </td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2247 | </tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2248 | <tr style='background-color: #f0f0f0; '> |
| 2249 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kSquare_Cap'><code>SkPaint::kSquare_Cap</code></a></td> |
| 2250 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>2</td> |
| 2251 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2252 | Adds a square with sides equal to <a href='#Paint_Stroke_Width'>Stroke_Width</a> at the beginning |
| 2253 | and end. The square sides are parallel to the initial and final direction |
| 2254 | of the stroke. |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 2255 | </td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2256 | </tr> |
| 2257 | <tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2258 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kLast_Cap'><code>SkPaint::kLast_Cap</code></a></td> |
| 2259 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>2</td> |
| 2260 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 2261 | 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] | 2262 | </td> |
| 2263 | </tr> |
| 2264 | <tr style='background-color: #f0f0f0; '> |
| 2265 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kDefault_Cap'><code>SkPaint::kDefault_Cap</code></a></td> |
| 2266 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>0</td> |
| 2267 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2268 | <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] | 2269 | </td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2270 | </tr> |
| 2271 | <tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2272 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kCapCount'><code>SkPaint::kCapCount</code></a></td> |
| 2273 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>3</td> |
| 2274 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2275 | 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] | 2276 | </td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2277 | </tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2278 | </table> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2279 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2280 | Stroke describes the area covered by a pen of <a href='#Paint_Stroke_Width'>Stroke_Width</a> as it |
| 2281 | 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] | 2282 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2283 | 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 |
| 2284 | visible beginning and end. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2285 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2286 | <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] | 2287 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2288 | <a href='#SkPaint_kButt_Cap'>kButt_Cap</a> and <a href='#Path_Overview_Contour_Zero_Length'>Zero_Length_Contour</a> is not drawn. |
| 2289 | <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> |
| 2290 | at the <a href='SkPath_Overview#Contour'>contour</a> <a href='SkPoint_Reference#Point'>point</a>. |
| 2291 | <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 |
| 2292 | <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] | 2293 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2294 | <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] | 2295 | |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2296 | ### Example |
| 2297 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 2298 | <div><fiddle-embed name="2bffb6384cc20077e632e7d01da045ca"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2299 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2300 | <a name='SkPaint_getStrokeCap'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2301 | |
| 2302 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2303 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2304 | <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] | 2305 | <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] | 2306 | </pre> |
| 2307 | |
Cary Clark | 80247e5 | 2018-07-11 16:18:41 -0400 | [diff] [blame] | 2308 | Returns the geometry drawn at the beginning and end of strokes. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2309 | |
| 2310 | ### Return Value |
| 2311 | |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 2312 | 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] | 2313 | |
| 2314 | ### Example |
| 2315 | |
| 2316 | <div><fiddle-embed name="aabf9baee8e026fae36fca30e955512b"> |
| 2317 | |
| 2318 | #### Example Output |
| 2319 | |
| 2320 | ~~~~ |
| 2321 | kButt_Cap == default stroke cap |
| 2322 | ~~~~ |
| 2323 | |
| 2324 | </fiddle-embed></div> |
| 2325 | |
| 2326 | ### See Also |
| 2327 | |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 2328 | <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] | 2329 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2330 | <a name='SkPaint_setStrokeCap'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2331 | |
| 2332 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2333 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2334 | <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] | 2335 | 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] | 2336 | </pre> |
| 2337 | |
Cary Clark | 80247e5 | 2018-07-11 16:18:41 -0400 | [diff] [blame] | 2338 | Sets the geometry drawn at the beginning and end of strokes. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2339 | |
| 2340 | ### Parameters |
| 2341 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2342 | <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] | 2343 | <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] | 2344 | </tr> |
| 2345 | </table> |
| 2346 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2347 | 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] | 2348 | |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2349 | ### Example |
| 2350 | |
| 2351 | <div><fiddle-embed name="de83fbd848a4625345b4b87a6e55d98a"> |
| 2352 | |
| 2353 | #### Example Output |
| 2354 | |
| 2355 | ~~~~ |
| 2356 | kRound_Cap == paint.getStrokeCap() |
| 2357 | ~~~~ |
| 2358 | |
| 2359 | </fiddle-embed></div> |
| 2360 | |
| 2361 | ### See Also |
| 2362 | |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 2363 | <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] | 2364 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2365 | <a name='Stroke_Join'></a> |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 2366 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2367 | <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] | 2368 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2369 | Stroke describes the area covered by a pen of <a href='#Paint_Stroke_Width'>Stroke_Width</a> as it |
| 2370 | 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] | 2371 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2372 | If the <a href='SkPath_Overview#Contour'>contour</a> direction changes abruptly, because the tangent direction leading |
| 2373 | 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 |
| 2374 | 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] | 2375 | |
| 2376 | ### Example |
| 2377 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 2378 | <div><fiddle-embed name="917c44b504d3f9308571fd3835d90a0d"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2379 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2380 | <a name='SkPaint_Join'></a> |
| 2381 | |
| 2382 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2383 | |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 2384 | <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] | 2385 | enum <a href='#SkPaint_Join'>Join</a> : uint8_t { |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 2386 | <a href='#SkPaint_kMiter_Join'>kMiter_Join</a>, |
| 2387 | <a href='#SkPaint_kRound_Join'>kRound_Join</a>, |
| 2388 | <a href='#SkPaint_kBevel_Join'>kBevel_Join</a>, |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 2389 | <a href='#SkPaint_kLast_Join'>kLast_Join</a> = <a href='#SkPaint_kBevel_Join'>kBevel_Join</a>, |
| 2390 | <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] | 2391 | }; |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 2392 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2393 | </pre> |
Cary Clark | 6fc5041 | 2017-09-21 12:31:06 -0400 | [diff] [blame] | 2394 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2395 | <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] | 2396 | 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] | 2397 | </pre> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2398 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2399 | <a href='#SkPaint_Join'>Join</a> specifies how corners are drawn when a shape is stroked. <a href='#SkPaint_Join'>Join</a> |
| 2400 | affects the four corners of a stroked rectangle, and the connected segments in a |
| 2401 | stroked <a href='SkPath_Reference#Path'>path</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2402 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2403 | Choose miter join to draw sharp corners. Choose round join to draw a <a href='undocumented#Circle'>circle</a> with a |
| 2404 | radius equal to the <a href='#Stroke_Width'>stroke width</a> on top of the corner. Choose bevel join to minimally |
| 2405 | connect the thick strokes. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2406 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2407 | 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 |
| 2408 | not contain the actual join. For instance, a <a href='#Fill_Path'>fill path</a> constructed with round joins does |
| 2409 | 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] | 2410 | |
| 2411 | ### Constants |
| 2412 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2413 | <table style='border-collapse: collapse; width: 62.5em'> |
| 2414 | <tr><th style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>Const</th> |
| 2415 | <th style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>Value</th> |
| 2416 | <th style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>Description</th></tr> |
| 2417 | <tr style='background-color: #f0f0f0; '> |
| 2418 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kMiter_Join'><code>SkPaint::kMiter_Join</code></a></td> |
| 2419 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>0</td> |
| 2420 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 2421 | 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] | 2422 | 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] | 2423 | </td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2424 | </tr> |
| 2425 | <tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2426 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kRound_Join'><code>SkPaint::kRound_Join</code></a></td> |
| 2427 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>1</td> |
| 2428 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2429 | 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] | 2430 | </td> |
| 2431 | </tr> |
| 2432 | <tr style='background-color: #f0f0f0; '> |
| 2433 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kBevel_Join'><code>SkPaint::kBevel_Join</code></a></td> |
| 2434 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>2</td> |
| 2435 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 2436 | Connects the outside edges of the sharp corner. |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 2437 | </td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2438 | </tr> |
| 2439 | <tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2440 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kLast_Join'><code>SkPaint::kLast_Join</code></a></td> |
| 2441 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>2</td> |
| 2442 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 2443 | equivalent to the largest value for Stroke_Join</td> |
| 2444 | </tr> |
| 2445 | <tr style='background-color: #f0f0f0; '> |
| 2446 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kDefault_Join'><code>SkPaint::kDefault_Join</code></a></td> |
| 2447 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>1</td> |
| 2448 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2449 | <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] | 2450 | </td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2451 | </tr> |
| 2452 | <tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2453 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kJoinCount'><code>SkPaint::kJoinCount</code></a></td> |
| 2454 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>3</td> |
| 2455 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2456 | 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] | 2457 | </td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2458 | </tr> |
| 2459 | </table> |
| 2460 | |
| 2461 | ### Example |
| 2462 | |
| 2463 | <div><fiddle-embed name="3b1aebacc21c1836a52876b9b0b3905e"></fiddle-embed></div> |
| 2464 | |
| 2465 | ### See Also |
| 2466 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2467 | <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] | 2468 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2469 | <a name='SkPaint_getStrokeJoin'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2470 | |
| 2471 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2472 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2473 | <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] | 2474 | <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] | 2475 | </pre> |
| 2476 | |
Cary Clark | 80247e5 | 2018-07-11 16:18:41 -0400 | [diff] [blame] | 2477 | Returns the geometry drawn at the corners of strokes. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2478 | |
| 2479 | ### Return Value |
| 2480 | |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 2481 | 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] | 2482 | |
| 2483 | ### Example |
| 2484 | |
Cary Clark | 7f644ec | 2018-07-19 10:50:44 -0400 | [diff] [blame] | 2485 | <div><fiddle-embed name="31bf751d0a8ddf176b871810820d8199"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2486 | |
| 2487 | #### Example Output |
| 2488 | |
| 2489 | ~~~~ |
| 2490 | kMiter_Join == default stroke join |
| 2491 | ~~~~ |
| 2492 | |
| 2493 | </fiddle-embed></div> |
| 2494 | |
| 2495 | ### See Also |
| 2496 | |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 2497 | <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] | 2498 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2499 | <a name='SkPaint_setStrokeJoin'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2500 | |
| 2501 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2502 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2503 | <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] | 2504 | 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] | 2505 | </pre> |
| 2506 | |
Cary Clark | 80247e5 | 2018-07-11 16:18:41 -0400 | [diff] [blame] | 2507 | Sets the geometry drawn at the corners of strokes. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2508 | |
| 2509 | ### Parameters |
| 2510 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2511 | <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] | 2512 | <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] | 2513 | </tr> |
| 2514 | </table> |
| 2515 | |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 2516 | otherwise, has no effect |
| 2517 | |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2518 | ### Example |
| 2519 | |
| 2520 | <div><fiddle-embed name="48d963ad4286eddf680f9c511eb6da91"> |
| 2521 | |
| 2522 | #### Example Output |
| 2523 | |
| 2524 | ~~~~ |
| 2525 | kMiter_Join == paint.getStrokeJoin() |
| 2526 | ~~~~ |
| 2527 | |
| 2528 | </fiddle-embed></div> |
| 2529 | |
| 2530 | ### See Also |
| 2531 | |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 2532 | <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] | 2533 | |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2534 | ### See Also |
| 2535 | |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 2536 | <a href='#Paint_Miter_Limit'>Miter_Limit</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2537 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2538 | <a name='Fill_Path'></a> |
| 2539 | |
| 2540 | --- |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 2541 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2542 | <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] | 2543 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2544 | 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 |
| 2545 | replaces the destination <a href='SkPath_Reference#Path'>Path</a>. Otherwise, the source <a href='SkPath_Reference#Path'>Path</a> is replaces the |
| 2546 | destination <a href='SkPath_Reference#Path'>Path</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2547 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2548 | 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 |
| 2549 | 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] | 2550 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2551 | 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>, |
| 2552 | 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>, |
| 2553 | 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] | 2554 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2555 | 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] | 2556 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2557 | 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> |
| 2558 | returns false since Hairline has no filled equivalent. |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2559 | |
| 2560 | ### See Also |
| 2561 | |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 2562 | <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] | 2563 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2564 | <a name='SkPaint_getFillPath'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2565 | |
| 2566 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2567 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2568 | <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] | 2569 | 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] | 2570 | </pre> |
| 2571 | |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 2572 | 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] | 2573 | |
| 2574 | ### Parameters |
| 2575 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2576 | <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] | 2577 | <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] | 2578 | </tr> |
| 2579 | <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] | 2580 | <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] | 2581 | </tr> |
| 2582 | <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] | 2583 | <td>optional limit passed to <a href='undocumented#SkPathEffect'>SkPathEffect</a></td> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2584 | </tr> |
| 2585 | <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] | 2586 | <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] | 2587 | </tr> |
| 2588 | </table> |
| 2589 | |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 2590 | to favor speed and <a href='undocumented#Size'>size</a> |
| 2591 | |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2592 | ### Return Value |
| 2593 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2594 | 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] | 2595 | |
| 2596 | ### Example |
| 2597 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2598 | <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. |
| 2599 | At the lowest precision, the <a href='SkPath_Reference#Quad'>Quad</a> stroke is approximated by a rectangle. |
| 2600 | 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] | 2601 | </div></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2602 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2603 | <a name='SkPaint_getFillPath_2'></a> |
Cary Clark | 2dc84ad | 2018-01-26 12:56:22 -0500 | [diff] [blame] | 2604 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2605 | --- |
| 2606 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2607 | <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] | 2608 | 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] | 2609 | </pre> |
| 2610 | |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 2611 | 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] | 2612 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2613 | 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>. |
| 2614 | <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] | 2615 | |
| 2616 | ### Parameters |
| 2617 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2618 | <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] | 2619 | <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] | 2620 | </tr> |
| 2621 | <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] | 2622 | <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] | 2623 | </tr> |
| 2624 | </table> |
| 2625 | |
| 2626 | ### Return Value |
| 2627 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2628 | 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] | 2629 | |
| 2630 | ### Example |
| 2631 | |
| 2632 | <div><fiddle-embed name="e6d8ca0cc17e0b475bd54dd995825468"></fiddle-embed></div> |
| 2633 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2634 | <a name='Shader_Methods'></a> |
| 2635 | |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2636 | --- |
| 2637 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2638 | <a href='undocumented#Shader'>Shader</a> defines the colors used when drawing a shape. |
| 2639 | <a href='undocumented#Shader'>Shader</a> may be an <a href='SkImage_Reference#Image'>image</a>, a gradient, or a computed fill. |
| 2640 | 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] | 2641 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2642 | <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>. |
| 2643 | 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 |
| 2644 | the fill. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2645 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2646 | 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] | 2647 | |
| 2648 | ### Example |
| 2649 | |
| 2650 | <div><fiddle-embed name="c015dc2010c15e1c00b4f7330232b0f7"></fiddle-embed></div> |
| 2651 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2652 | 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] | 2653 | |
| 2654 | ### Example |
| 2655 | |
skia-bookmaker | 525f9a9 | 2018-05-03 06:27:39 +0000 | [diff] [blame] | 2656 | <div><fiddle-embed name="fe80fd80b98a20823db7fb9a077243c7"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2657 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2658 | <a name='SkPaint_getShader'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2659 | |
| 2660 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2661 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2662 | <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] | 2663 | <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] | 2664 | </pre> |
| 2665 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2666 | 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] | 2667 | |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 2668 | 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] | 2669 | |
| 2670 | ### Return Value |
| 2671 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2672 | <a href='undocumented#SkShader'>SkShader</a> if previously set, nullptr otherwise |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2673 | |
| 2674 | ### Example |
| 2675 | |
| 2676 | <div><fiddle-embed name="09f15b9fd88882850da2d235eb86292f"> |
| 2677 | |
| 2678 | #### Example Output |
| 2679 | |
| 2680 | ~~~~ |
| 2681 | nullptr == shader |
| 2682 | nullptr != shader |
| 2683 | ~~~~ |
| 2684 | |
| 2685 | </fiddle-embed></div> |
| 2686 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2687 | <a name='SkPaint_refShader'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2688 | |
| 2689 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2690 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2691 | <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] | 2692 | <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] | 2693 | </pre> |
| 2694 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2695 | 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] | 2696 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2697 | 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] | 2698 | |
| 2699 | ### Return Value |
| 2700 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2701 | <a href='undocumented#SkShader'>SkShader</a> if previously set, nullptr otherwise |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2702 | |
| 2703 | ### Example |
| 2704 | |
| 2705 | <div><fiddle-embed name="53da0295972a418cbc9607bbb17feaa8"> |
| 2706 | |
| 2707 | #### Example Output |
| 2708 | |
| 2709 | ~~~~ |
| 2710 | shader unique: true |
| 2711 | shader unique: false |
| 2712 | ~~~~ |
| 2713 | |
| 2714 | </fiddle-embed></div> |
| 2715 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2716 | <a name='SkPaint_setShader'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2717 | |
| 2718 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2719 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2720 | <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] | 2721 | 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] | 2722 | </pre> |
| 2723 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2724 | 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] | 2725 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2726 | 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>. |
| 2727 | 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] | 2728 | |
| 2729 | ### Parameters |
| 2730 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2731 | <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] | 2732 | <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] | 2733 | </tr> |
| 2734 | </table> |
| 2735 | |
| 2736 | ### Example |
| 2737 | |
skia-bookmaker | e0a458f | 2018-07-16 05:29:00 +0000 | [diff] [blame] | 2738 | <div><fiddle-embed name="77e64d5bae9b1ba037fd99252bb4aa58"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2739 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2740 | <a name='Color_Filter_Methods'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2741 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2742 | --- |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 2743 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2744 | <a href='#Color_Filter'>Color_Filter</a> alters the <a href='SkColor_Reference#Color'>color</a> used when drawing a shape. |
| 2745 | <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. |
| 2746 | 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] | 2747 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2748 | 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] | 2749 | |
| 2750 | ### Example |
| 2751 | |
| 2752 | <div><fiddle-embed name="5abde56ca2f89a18b8e231abd1b57c56"></fiddle-embed></div> |
| 2753 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2754 | <a name='SkPaint_getColorFilter'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2755 | |
| 2756 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2757 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2758 | <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] | 2759 | <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] | 2760 | </pre> |
| 2761 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2762 | Returns <a href='undocumented#SkColorFilter'>SkColorFilter</a> if set, or nullptr. |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 2763 | 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] | 2764 | |
| 2765 | ### Return Value |
| 2766 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2767 | <a href='undocumented#SkColorFilter'>SkColorFilter</a> if previously set, nullptr otherwise |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2768 | |
| 2769 | ### Example |
| 2770 | |
| 2771 | <div><fiddle-embed name="093bdc627d6b59002670fd290931f6c9"> |
| 2772 | |
| 2773 | #### Example Output |
| 2774 | |
| 2775 | ~~~~ |
| 2776 | nullptr == color filter |
| 2777 | nullptr != color filter |
| 2778 | ~~~~ |
| 2779 | |
| 2780 | </fiddle-embed></div> |
| 2781 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2782 | <a name='SkPaint_refColorFilter'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2783 | |
| 2784 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2785 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2786 | <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] | 2787 | <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] | 2788 | </pre> |
| 2789 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2790 | Returns <a href='undocumented#SkColorFilter'>SkColorFilter</a> if set, or nullptr. |
| 2791 | 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] | 2792 | |
| 2793 | ### Return Value |
| 2794 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2795 | <a href='undocumented#SkColorFilter'>SkColorFilter</a> if set, or nullptr |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2796 | |
| 2797 | ### Example |
| 2798 | |
| 2799 | <div><fiddle-embed name="b588c95fa4c86ddbc4b0546762f08297"> |
| 2800 | |
| 2801 | #### Example Output |
| 2802 | |
| 2803 | ~~~~ |
| 2804 | color filter unique: true |
| 2805 | color filter unique: false |
| 2806 | ~~~~ |
| 2807 | |
| 2808 | </fiddle-embed></div> |
| 2809 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2810 | <a name='SkPaint_setColorFilter'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2811 | |
| 2812 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2813 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2814 | <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] | 2815 | 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] | 2816 | </pre> |
| 2817 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2818 | Sets <a href='undocumented#SkColorFilter'>SkColorFilter</a> to filter, decreasing <a href='undocumented#SkRefCnt'>SkRefCnt</a> of the previous |
| 2819 | <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] | 2820 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2821 | Increments filter <a href='undocumented#SkRefCnt'>SkRefCnt</a> by one. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2822 | |
| 2823 | ### Parameters |
| 2824 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2825 | <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] | 2826 | <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] | 2827 | </tr> |
| 2828 | </table> |
| 2829 | |
| 2830 | ### Example |
| 2831 | |
skia-bookmaker | 61cc9fa | 2018-07-11 05:28:17 +0000 | [diff] [blame] | 2832 | <div><fiddle-embed name="c7b786dc9b3501cd0eaba47494b6fa31"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2833 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2834 | <a name='Blend_Mode_Methods'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2835 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2836 | --- |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 2837 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2838 | <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>. |
| 2839 | 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> |
| 2840 | over the destination <a href='SkColor_Reference#Color'>color</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2841 | |
| 2842 | ### Example |
| 2843 | |
Cary Clark | 8364706 | 2018-07-18 16:21:51 -0400 | [diff] [blame] | 2844 | <div><fiddle-embed name="73092d4d06faecea3c204d852a4dd8a8"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2845 | |
| 2846 | ### See Also |
| 2847 | |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 2848 | <a href='#Blend_Mode'>Blend_Mode</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2849 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2850 | <a name='SkPaint_getBlendMode'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2851 | |
| 2852 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2853 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2854 | <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] | 2855 | <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] | 2856 | </pre> |
| 2857 | |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 2858 | Returns <a href='SkBlendMode_Reference#SkBlendMode'>SkBlendMode</a>. |
| 2859 | 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] | 2860 | |
| 2861 | ### Return Value |
| 2862 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2863 | 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] | 2864 | |
| 2865 | ### Example |
| 2866 | |
skia-bookmaker | 525f9a9 | 2018-05-03 06:27:39 +0000 | [diff] [blame] | 2867 | <div><fiddle-embed name="a1e059c8f6740fa2044cc64152b39dda"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2868 | |
| 2869 | #### Example Output |
| 2870 | |
| 2871 | ~~~~ |
| 2872 | kSrcOver == getBlendMode |
| 2873 | kSrcOver != getBlendMode |
| 2874 | ~~~~ |
| 2875 | |
| 2876 | </fiddle-embed></div> |
| 2877 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2878 | <a name='SkPaint_isSrcOver'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2879 | |
| 2880 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2881 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2882 | <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] | 2883 | bool <a href='#SkPaint_isSrcOver'>isSrcOver</a>()const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2884 | </pre> |
| 2885 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2886 | 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] | 2887 | |
| 2888 | ### Return Value |
| 2889 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2890 | 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] | 2891 | |
| 2892 | ### Example |
| 2893 | |
| 2894 | <div><fiddle-embed name="257c9473db7a2b3a0fb2b9e2431e59a6"> |
| 2895 | |
| 2896 | #### Example Output |
| 2897 | |
| 2898 | ~~~~ |
| 2899 | isSrcOver == true |
| 2900 | isSrcOver != true |
| 2901 | ~~~~ |
| 2902 | |
| 2903 | </fiddle-embed></div> |
| 2904 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2905 | <a name='SkPaint_setBlendMode'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2906 | |
| 2907 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2908 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2909 | <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] | 2910 | 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] | 2911 | </pre> |
| 2912 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2913 | 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] | 2914 | Does not check for valid input. |
| 2915 | |
| 2916 | ### Parameters |
| 2917 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2918 | <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] | 2919 | <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] | 2920 | </tr> |
| 2921 | </table> |
| 2922 | |
| 2923 | ### Example |
| 2924 | |
| 2925 | <div><fiddle-embed name="257c9473db7a2b3a0fb2b9e2431e59a6"> |
| 2926 | |
| 2927 | #### Example Output |
| 2928 | |
| 2929 | ~~~~ |
| 2930 | isSrcOver == true |
| 2931 | isSrcOver != true |
| 2932 | ~~~~ |
| 2933 | |
| 2934 | </fiddle-embed></div> |
| 2935 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2936 | <a name='Path_Effect_Methods'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2937 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2938 | --- |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 2939 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2940 | <a href='#Path_Effect'>Path_Effect</a> modifies the <a href='SkPath_Reference#Path'>path</a> geometry before drawing it. |
| 2941 | <a href='#Path_Effect'>Path_Effect</a> may implement dashing, custom fill effects and custom stroke effects. |
| 2942 | 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] | 2943 | |
| 2944 | ### Example |
| 2945 | |
| 2946 | <div><fiddle-embed name="8cf5684b187d60f09e11c4a48993ea39"></fiddle-embed></div> |
| 2947 | |
| 2948 | ### See Also |
| 2949 | |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 2950 | <a href='#Path_Effect'>Path_Effect</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2951 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2952 | <a name='SkPaint_getPathEffect'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2953 | |
| 2954 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2955 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2956 | <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] | 2957 | <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] | 2958 | </pre> |
| 2959 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2960 | Returns <a href='undocumented#SkPathEffect'>SkPathEffect</a> if set, or nullptr. |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 2961 | 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] | 2962 | |
| 2963 | ### Return Value |
| 2964 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2965 | <a href='undocumented#SkPathEffect'>SkPathEffect</a> if previously set, nullptr otherwise |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2966 | |
| 2967 | ### Example |
| 2968 | |
skia-bookmaker | b95bbba | 2018-07-06 05:23:23 +0000 | [diff] [blame] | 2969 | <div><fiddle-embed name="211a1b14bfa6c4332082c8eab4fbc5fd"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2970 | |
| 2971 | #### Example Output |
| 2972 | |
| 2973 | ~~~~ |
| 2974 | nullptr == path effect |
| 2975 | nullptr != path effect |
| 2976 | ~~~~ |
| 2977 | |
| 2978 | </fiddle-embed></div> |
| 2979 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2980 | <a name='SkPaint_refPathEffect'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2981 | |
| 2982 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2983 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2984 | <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] | 2985 | <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] | 2986 | </pre> |
| 2987 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2988 | Returns <a href='undocumented#SkPathEffect'>SkPathEffect</a> if set, or nullptr. |
| 2989 | 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] | 2990 | |
| 2991 | ### Return Value |
| 2992 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2993 | <a href='undocumented#SkPathEffect'>SkPathEffect</a> if previously set, nullptr otherwise |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2994 | |
| 2995 | ### Example |
| 2996 | |
Cary Clark | 8364706 | 2018-07-18 16:21:51 -0400 | [diff] [blame] | 2997 | <div><fiddle-embed name="f56039b94c702c2704c8c5100e623aca"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2998 | |
| 2999 | #### Example Output |
| 3000 | |
| 3001 | ~~~~ |
| 3002 | path effect unique: true |
| 3003 | path effect unique: false |
| 3004 | ~~~~ |
| 3005 | |
| 3006 | </fiddle-embed></div> |
| 3007 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3008 | <a name='SkPaint_setPathEffect'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3009 | |
| 3010 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3011 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3012 | <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] | 3013 | 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] | 3014 | </pre> |
| 3015 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3016 | 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 |
| 3017 | <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] | 3018 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3019 | 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] | 3020 | |
| 3021 | ### Parameters |
| 3022 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3023 | <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] | 3024 | <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] | 3025 | </tr> |
| 3026 | </table> |
| 3027 | |
| 3028 | ### Example |
| 3029 | |
| 3030 | <div><fiddle-embed name="52dd55074ca0b7d520d04e750ca2a0d7"></fiddle-embed></div> |
| 3031 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3032 | <a name='Mask_Filter_Methods'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3033 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3034 | --- |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 3035 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3036 | <a href='#Mask_Filter'>Mask_Filter</a> uses coverage of the shape drawn to create <a href='#Mask_Alpha'>Mask_Alpha</a>. |
| 3037 | <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] | 3038 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3039 | <a href='#Mask_Filter'>Mask_Filter</a> may change the geometry and transparency of the shape, such as |
| 3040 | creating a blur effect. Set <a href='#Mask_Filter'>Mask_Filter</a> to nullptr to prevent <a href='#Mask_Filter'>Mask_Filter</a> from |
| 3041 | modifying the draw. |
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="55d7b9d482ac8e17a6153f555a8adb8d"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3046 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3047 | <a name='SkPaint_getMaskFilter'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3048 | |
| 3049 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3050 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3051 | <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] | 3052 | <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] | 3053 | </pre> |
| 3054 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3055 | Returns <a href='undocumented#SkMaskFilter'>SkMaskFilter</a> if set, or nullptr. |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 3056 | 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] | 3057 | |
| 3058 | ### Return Value |
| 3059 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3060 | <a href='undocumented#SkMaskFilter'>SkMaskFilter</a> if previously set, nullptr otherwise |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3061 | |
| 3062 | ### Example |
| 3063 | |
Cary Clark | 681287e | 2018-03-16 11:34:15 -0400 | [diff] [blame] | 3064 | <div><fiddle-embed name="5ac4b31371726da87bb7390b385e9fee"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3065 | |
| 3066 | #### Example Output |
| 3067 | |
| 3068 | ~~~~ |
| 3069 | nullptr == mask filter |
| 3070 | nullptr != mask filter |
| 3071 | ~~~~ |
| 3072 | |
| 3073 | </fiddle-embed></div> |
| 3074 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3075 | <a name='SkPaint_refMaskFilter'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3076 | |
| 3077 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3078 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3079 | <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] | 3080 | <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] | 3081 | </pre> |
| 3082 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3083 | Returns <a href='undocumented#SkMaskFilter'>SkMaskFilter</a> if set, or nullptr. |
Cary Clark | 6fc5041 | 2017-09-21 12:31:06 -0400 | [diff] [blame] | 3084 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3085 | 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] | 3086 | |
| 3087 | ### Return Value |
| 3088 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3089 | <a href='undocumented#SkMaskFilter'>SkMaskFilter</a> if previously set, nullptr otherwise |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3090 | |
| 3091 | ### Example |
| 3092 | |
Cary Clark | 8364706 | 2018-07-18 16:21:51 -0400 | [diff] [blame] | 3093 | <div><fiddle-embed name="084b0dc3cebd78718c651d58f257f799"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3094 | |
| 3095 | #### Example Output |
| 3096 | |
| 3097 | ~~~~ |
| 3098 | mask filter unique: true |
| 3099 | mask filter unique: false |
| 3100 | ~~~~ |
| 3101 | |
| 3102 | </fiddle-embed></div> |
| 3103 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3104 | <a name='SkPaint_setMaskFilter'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3105 | |
| 3106 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3107 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3108 | <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] | 3109 | 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] | 3110 | </pre> |
| 3111 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3112 | 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 |
| 3113 | <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] | 3114 | <a href='undocumented#Mask_Alpha'>mask alpha</a> unaltered. |
Cary Clark | 6fc5041 | 2017-09-21 12:31:06 -0400 | [diff] [blame] | 3115 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3116 | 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] | 3117 | |
| 3118 | ### Parameters |
| 3119 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3120 | <table> <tr> <td><a name='SkPaint_setMaskFilter_maskFilter'><code><strong>maskFilter</strong></code></a></td> |
| 3121 | <td>modifies clipping mask generated from drawn geometry</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3122 | </tr> |
| 3123 | </table> |
| 3124 | |
| 3125 | ### Example |
| 3126 | |
Cary Clark | 681287e | 2018-03-16 11:34:15 -0400 | [diff] [blame] | 3127 | <div><fiddle-embed name="a993831c40f3e134f809134e3b74e4a6"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3128 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3129 | <a name='Typeface_Methods'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3130 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3131 | --- |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 3132 | |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 3133 | <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] | 3134 | <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] | 3135 | 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] | 3136 | implementation. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3137 | |
| 3138 | ### Example |
| 3139 | |
skia-bookmaker | 61cc9fa | 2018-07-11 05:28:17 +0000 | [diff] [blame] | 3140 | <div><fiddle-embed name="1a7a5062725139760962582f599f1b97"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3141 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3142 | <a name='SkPaint_getTypeface'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3143 | |
| 3144 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3145 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3146 | <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] | 3147 | <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] | 3148 | </pre> |
| 3149 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3150 | Returns <a href='undocumented#SkTypeface'>SkTypeface</a> if set, or nullptr. |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 3151 | 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] | 3152 | |
| 3153 | ### Return Value |
| 3154 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3155 | <a href='undocumented#SkTypeface'>SkTypeface</a> if previously set, nullptr otherwise |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3156 | |
| 3157 | ### Example |
| 3158 | |
Cary Clark | f960398 | 2018-07-17 08:20:27 -0400 | [diff] [blame] | 3159 | <div><fiddle-embed name="5ce718e5a184baaac80e7098d7dad67b"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3160 | |
| 3161 | #### Example Output |
| 3162 | |
| 3163 | ~~~~ |
| 3164 | nullptr == typeface |
| 3165 | nullptr != typeface |
| 3166 | ~~~~ |
| 3167 | |
| 3168 | </fiddle-embed></div> |
| 3169 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3170 | <a name='SkPaint_refTypeface'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3171 | |
| 3172 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3173 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3174 | <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] | 3175 | <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] | 3176 | </pre> |
| 3177 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3178 | 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] | 3179 | |
| 3180 | ### Return Value |
| 3181 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3182 | <a href='undocumented#SkTypeface'>SkTypeface</a> if previously set, nullptr otherwise |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3183 | |
| 3184 | ### Example |
| 3185 | |
Cary Clark | 8364706 | 2018-07-18 16:21:51 -0400 | [diff] [blame] | 3186 | <div><fiddle-embed name="8b5aa7e555a0dc31be69db7cadf471a1"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3187 | |
| 3188 | #### Example Output |
| 3189 | |
| 3190 | ~~~~ |
| 3191 | typeface1 != typeface2 |
| 3192 | typeface1 == typeface2 |
| 3193 | ~~~~ |
| 3194 | |
| 3195 | </fiddle-embed></div> |
| 3196 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3197 | <a name='SkPaint_setTypeface'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3198 | |
| 3199 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3200 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3201 | <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] | 3202 | 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] | 3203 | </pre> |
| 3204 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3205 | 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>. |
| 3206 | Pass nullptr to clear <a href='undocumented#SkTypeface'>SkTypeface</a> and use the default <a href='#SkPaint_setTypeface_typeface'>typeface</a>. Increments |
| 3207 | <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] | 3208 | |
| 3209 | ### Parameters |
| 3210 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3211 | <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] | 3212 | <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] | 3213 | </tr> |
| 3214 | </table> |
| 3215 | |
| 3216 | ### Example |
| 3217 | |
Cary Clark | 71961fb | 2018-01-05 14:21:59 -0500 | [diff] [blame] | 3218 | <div><fiddle-embed name="0e6fbb7773cd925b274552f4cd1abef2"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3219 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3220 | <a name='Image_Filter_Methods'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3221 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3222 | --- |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 3223 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3224 | <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> |
| 3225 | 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>, |
| 3226 | 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] | 3227 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3228 | <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> |
| 3229 | 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. |
| 3230 | <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] | 3231 | <a href='#Mask_Filter'>Mask_Filter</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3232 | |
| 3233 | ### Example |
| 3234 | |
skia-bookmaker | 44bad2e | 2018-07-05 05:35:27 +0000 | [diff] [blame] | 3235 | <div><fiddle-embed name="ece04ee3d3761e3425f37c8f06f054c1"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3236 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3237 | <a name='SkPaint_getImageFilter'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3238 | |
| 3239 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3240 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3241 | <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] | 3242 | <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] | 3243 | </pre> |
| 3244 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3245 | Returns <a href='undocumented#SkImageFilter'>SkImageFilter</a> if set, or nullptr. |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 3246 | 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] | 3247 | |
| 3248 | ### Return Value |
| 3249 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3250 | <a href='undocumented#SkImageFilter'>SkImageFilter</a> if previously set, nullptr otherwise |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3251 | |
| 3252 | ### Example |
| 3253 | |
skia-bookmaker | b95bbba | 2018-07-06 05:23:23 +0000 | [diff] [blame] | 3254 | <div><fiddle-embed name="c11f8eaa1dd149bc18db21e23ce26904"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3255 | |
| 3256 | #### Example Output |
| 3257 | |
| 3258 | ~~~~ |
| 3259 | nullptr == image filter |
| 3260 | nullptr != image filter |
| 3261 | ~~~~ |
| 3262 | |
| 3263 | </fiddle-embed></div> |
| 3264 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3265 | <a name='SkPaint_refImageFilter'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3266 | |
| 3267 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3268 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3269 | <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] | 3270 | <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] | 3271 | </pre> |
| 3272 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3273 | Returns <a href='undocumented#SkImageFilter'>SkImageFilter</a> if set, or nullptr. |
| 3274 | 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] | 3275 | |
| 3276 | ### Return Value |
| 3277 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3278 | <a href='undocumented#SkImageFilter'>SkImageFilter</a> if previously set, nullptr otherwise |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3279 | |
| 3280 | ### Example |
| 3281 | |
| 3282 | <div><fiddle-embed name="13f09088b569251547107d14ae989dc1"> |
| 3283 | |
| 3284 | #### Example Output |
| 3285 | |
| 3286 | ~~~~ |
| 3287 | image filter unique: true |
| 3288 | image filter unique: false |
| 3289 | ~~~~ |
| 3290 | |
| 3291 | </fiddle-embed></div> |
| 3292 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3293 | <a name='SkPaint_setImageFilter'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3294 | |
| 3295 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3296 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3297 | <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] | 3298 | 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] | 3299 | </pre> |
| 3300 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3301 | 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 |
| 3302 | <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] | 3303 | on drawing. |
Cary Clark | 6fc5041 | 2017-09-21 12:31:06 -0400 | [diff] [blame] | 3304 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3305 | 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] | 3306 | |
| 3307 | ### Parameters |
| 3308 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3309 | <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] | 3310 | <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] | 3311 | </tr> |
| 3312 | </table> |
| 3313 | |
| 3314 | ### Example |
| 3315 | |
| 3316 | <div><fiddle-embed name="6679d6e4ec632715ee03e68391bd7f9a"></fiddle-embed></div> |
| 3317 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3318 | <a name='Draw_Looper_Methods'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3319 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3320 | --- |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 3321 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3322 | <a href='#Draw_Looper'>Draw_Looper</a> sets a modifier that communicates state from one <a href='#Draw_Layer'>Draw_Layer</a> |
| 3323 | to another to construct the draw. |
Cary Clark | 6fc5041 | 2017-09-21 12:31:06 -0400 | [diff] [blame] | 3324 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3325 | <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. |
| 3326 | <a href='#Draw_Looper'>Draw_Looper</a> may be used to draw multiple colors or create a colored shadow. |
| 3327 | 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] | 3328 | |
| 3329 | ### Example |
| 3330 | |
| 3331 | <div><fiddle-embed name="84ec12a36e50df5ac565cc7a75ffbe9f"></fiddle-embed></div> |
| 3332 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3333 | <a name='SkPaint_getDrawLooper'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3334 | |
| 3335 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3336 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3337 | <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] | 3338 | <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] | 3339 | </pre> |
| 3340 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3341 | Returns <a href='undocumented#SkDrawLooper'>SkDrawLooper</a> if set, or nullptr. |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 3342 | 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] | 3343 | |
| 3344 | ### Return Value |
| 3345 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3346 | <a href='undocumented#SkDrawLooper'>SkDrawLooper</a> if previously set, nullptr otherwise |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3347 | |
| 3348 | ### Example |
| 3349 | |
| 3350 | <div><fiddle-embed name="af4c5acc7a91e7f23c2af48018903ad4"> |
| 3351 | |
| 3352 | #### Example Output |
| 3353 | |
| 3354 | ~~~~ |
| 3355 | nullptr == draw looper |
| 3356 | nullptr != draw looper |
| 3357 | ~~~~ |
| 3358 | |
| 3359 | </fiddle-embed></div> |
| 3360 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3361 | <a name='SkPaint_refDrawLooper'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3362 | |
| 3363 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3364 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3365 | <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] | 3366 | <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] | 3367 | </pre> |
| 3368 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3369 | Returns <a href='undocumented#SkDrawLooper'>SkDrawLooper</a> if set, or nullptr. |
| 3370 | 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] | 3371 | |
| 3372 | ### Return Value |
| 3373 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3374 | <a href='undocumented#SkDrawLooper'>SkDrawLooper</a> if previously set, nullptr otherwise |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3375 | |
| 3376 | ### Example |
| 3377 | |
| 3378 | <div><fiddle-embed name="2a3782c33f04ed17a725d0e449c6f7c3"> |
| 3379 | |
| 3380 | #### Example Output |
| 3381 | |
| 3382 | ~~~~ |
| 3383 | draw looper unique: true |
| 3384 | draw looper unique: false |
| 3385 | ~~~~ |
| 3386 | |
| 3387 | </fiddle-embed></div> |
| 3388 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3389 | <a name='SkPaint_setDrawLooper'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3390 | |
| 3391 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3392 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3393 | <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] | 3394 | 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] | 3395 | </pre> |
| 3396 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3397 | 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 |
| 3398 | <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] | 3399 | drawing unaltered. |
| 3400 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3401 | 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] | 3402 | |
| 3403 | ### Parameters |
| 3404 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3405 | <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] | 3406 | <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] | 3407 | </tr> |
| 3408 | </table> |
| 3409 | |
| 3410 | ### Example |
| 3411 | |
| 3412 | <div><fiddle-embed name="bf10f838b330f0a3a3266d42ea68a638"></fiddle-embed></div> |
| 3413 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3414 | <a name='Text_Size'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3415 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3416 | --- |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 3417 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3418 | <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>. |
| 3419 | <a href='#Paint_Text_Size'>Text_Size</a> can be set to any positive value or zero. |
| 3420 | <a href='#Paint_Text_Size'>Text_Size</a> defaults to 12. |
| 3421 | 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] | 3422 | |
| 3423 | ### Example |
| 3424 | |
| 3425 | <div><fiddle-embed name="91c9a3e498bb9412e4522a95d076ed5f"></fiddle-embed></div> |
| 3426 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3427 | <a name='SkPaint_getTextSize'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3428 | |
| 3429 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3430 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3431 | <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] | 3432 | <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] | 3433 | </pre> |
| 3434 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3435 | 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] | 3436 | |
| 3437 | ### Return Value |
| 3438 | |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 3439 | typographic height of <a href='undocumented#Text'>text</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3440 | |
| 3441 | ### Example |
| 3442 | |
skia-bookmaker | 233c652 | 2018-07-04 05:33:26 +0000 | [diff] [blame] | 3443 | <div><fiddle-embed name="983e2a71ba72d4ba8c945420040b8f1c"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3444 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3445 | <a name='SkPaint_setTextSize'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3446 | |
| 3447 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3448 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3449 | <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] | 3450 | 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] | 3451 | </pre> |
| 3452 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3453 | Sets <a href='#Text_Size'>text size</a> in <a href='SkPoint_Reference#Point'>points</a>. |
| 3454 | 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] | 3455 | |
| 3456 | ### Parameters |
| 3457 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3458 | <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] | 3459 | <td>typographic height of <a href='undocumented#Text'>text</a></td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3460 | </tr> |
| 3461 | </table> |
| 3462 | |
| 3463 | ### Example |
| 3464 | |
skia-bookmaker | 44bad2e | 2018-07-05 05:35:27 +0000 | [diff] [blame] | 3465 | <div><fiddle-embed name="6510c9e2f57b83c47e67829e7a68d493"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3466 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3467 | <a name='Text_Scale_X'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3468 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3469 | --- |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 3470 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3471 | <a href='#Paint_Text_Scale_X'>Text_Scale_X</a> adjusts the <a href='undocumented#Text'>text</a> horizontal scale. |
| 3472 | <a href='undocumented#Text'>Text</a> scaling approximates condensed and expanded type faces when the actual face |
| 3473 | is not available. |
| 3474 | <a href='#Paint_Text_Scale_X'>Text_Scale_X</a> can be set to any value. |
| 3475 | <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] | 3476 | |
| 3477 | ### Example |
| 3478 | |
skia-bookmaker | 44bad2e | 2018-07-05 05:35:27 +0000 | [diff] [blame] | 3479 | <div><fiddle-embed name="d13d787c1e36f515319fc998411c1d91"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3480 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3481 | <a name='SkPaint_getTextScaleX'></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 | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 3486 | <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] | 3487 | </pre> |
| 3488 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3489 | Returns <a href='undocumented#Text'>text</a> scale on x-axis. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3490 | Default value is 1. |
| 3491 | |
| 3492 | ### Return Value |
| 3493 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3494 | <a href='undocumented#Text'>text</a> horizontal scale |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3495 | |
| 3496 | ### Example |
| 3497 | |
| 3498 | <div><fiddle-embed name="5dc8e58f6910cb8e4de9ed60f888188b"></fiddle-embed></div> |
| 3499 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3500 | <a name='SkPaint_setTextScaleX'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3501 | |
| 3502 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3503 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3504 | <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] | 3505 | 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] | 3506 | </pre> |
| 3507 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3508 | Sets <a href='undocumented#Text'>text scale</a> on x-axis. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3509 | Default value is 1. |
| 3510 | |
| 3511 | ### Parameters |
| 3512 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3513 | <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] | 3514 | <td><a href='undocumented#Text'>text</a> horizontal scale</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3515 | </tr> |
| 3516 | </table> |
| 3517 | |
| 3518 | ### Example |
| 3519 | |
| 3520 | <div><fiddle-embed name="a75bbdb8bb866b125c4c1dd5e967d470"></fiddle-embed></div> |
| 3521 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3522 | <a name='Text_Skew_X'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3523 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3524 | --- |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 3525 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3526 | <a href='#Paint_Text_Skew_X'>Text_Skew_X</a> adjusts the <a href='undocumented#Text'>text</a> horizontal slant. |
| 3527 | <a href='undocumented#Text'>Text</a> skewing approximates italic and oblique type faces when the actual face |
| 3528 | is not available. |
| 3529 | <a href='#Paint_Text_Skew_X'>Text_Skew_X</a> can be set to any value. |
| 3530 | <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] | 3531 | |
| 3532 | ### Example |
| 3533 | |
| 3534 | <div><fiddle-embed name="aff208b0aab265f273045b27e683c17c"></fiddle-embed></div> |
| 3535 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3536 | <a name='SkPaint_getTextSkewX'></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 | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 3541 | <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] | 3542 | </pre> |
| 3543 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3544 | Returns <a href='undocumented#Text'>text</a> skew on x-axis. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3545 | Default value is zero. |
| 3546 | |
| 3547 | ### Return Value |
| 3548 | |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 3549 | additional shear on x-axis relative to y-axis |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3550 | |
| 3551 | ### Example |
| 3552 | |
Cary Clark | 7f644ec | 2018-07-19 10:50:44 -0400 | [diff] [blame] | 3553 | <div><fiddle-embed name="11c10f466dae0d1639dbb9f6a0040218"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3554 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3555 | <a name='SkPaint_setTextSkewX'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3556 | |
| 3557 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3558 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3559 | <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] | 3560 | 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] | 3561 | </pre> |
| 3562 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3563 | Sets <a href='undocumented#Text'>text skew</a> on x-axis. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3564 | Default value is zero. |
| 3565 | |
| 3566 | ### Parameters |
| 3567 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3568 | <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] | 3569 | <td>additional shear on x-axis relative to y-axis</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3570 | </tr> |
| 3571 | </table> |
| 3572 | |
| 3573 | ### Example |
| 3574 | |
skia-bookmaker | 61cc9fa | 2018-07-11 05:28:17 +0000 | [diff] [blame] | 3575 | <div><fiddle-embed name="6bd705a6e0c5f8ee24f302fe531bfabc"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3576 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3577 | <a name='Text_Encoding'></a> |
| 3578 | |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3579 | --- |
| 3580 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3581 | <a name='SkPaint_TextEncoding'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3582 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3583 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3584 | |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 3585 | <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] | 3586 | enum <a href='#SkPaint_TextEncoding'>TextEncoding</a> : uint8_t { |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 3587 | <a href='#SkPaint_kUTF8_TextEncoding'>kUTF8_TextEncoding</a>, |
| 3588 | <a href='#SkPaint_kUTF16_TextEncoding'>kUTF16_TextEncoding</a>, |
| 3589 | <a href='#SkPaint_kUTF32_TextEncoding'>kUTF32_TextEncoding</a>, |
| 3590 | <a href='#SkPaint_kGlyphID_TextEncoding'>kGlyphID_TextEncoding</a>, |
Cary Clark | 186d08f | 2018-04-03 08:43:27 -0400 | [diff] [blame] | 3591 | }; |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 3592 | |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 3593 | </pre> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3594 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3595 | <a href='#SkPaint_TextEncoding'>TextEncoding</a> determines whether <a href='undocumented#Text'>text</a> specifies character codes and their encoded |
| 3596 | <a href='undocumented#Size'>size</a>, or <a href='undocumented#Glyph'>glyph</a> indices. Characters are encoded as specified by the |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 3597 | <a href='https://unicode.org/standard/standard.html'>Unicode standard</a></a> . |
Cary Clark | 6fc5041 | 2017-09-21 12:31:06 -0400 | [diff] [blame] | 3598 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3599 | Character codes encoded <a href='undocumented#Size'>size</a> are specified by UTF-8, UTF-16, or UTF-32. |
| 3600 | All character code formats are able to represent all of Unicode, differing only |
| 3601 | in the total storage required. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3602 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3603 | <a href='https://tools.ietf.org/html/rfc3629'>UTF-8 (RFC 3629)</a></a> encodes each character as one or more 8-bit bytes. |
Cary Clark | 6fc5041 | 2017-09-21 12:31:06 -0400 | [diff] [blame] | 3604 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3605 | <a href='https://tools.ietf.org/html/rfc2781'>UTF-16 (RFC 2781)</a></a> encodes each character as one or two 16-bit words. |
Cary Clark | 6fc5041 | 2017-09-21 12:31:06 -0400 | [diff] [blame] | 3606 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3607 | <a href='https://www.unicode.org/versions/Unicode5.0.0/ch03.pdf'>UTF-32</a></a> encodes each character as one 32-bit word. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3608 | |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 3609 | <a href='#Font_Manager'>Font_Manager</a> uses <a href='SkFont_Reference#Font'>font</a> <a href='undocumented#Data'>data</a> to convert character code <a href='SkPoint_Reference#Point'>points</a> into <a href='undocumented#Glyph'>glyph</a> indices. |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3610 | A <a href='undocumented#Glyph'>glyph</a> index is a 16-bit word. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3611 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3612 | <a href='#SkPaint_TextEncoding'>TextEncoding</a> is set to <a href='#SkPaint_kUTF8_TextEncoding'>kUTF8_TextEncoding</a> by default. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3613 | |
| 3614 | ### Constants |
| 3615 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3616 | <table style='border-collapse: collapse; width: 62.5em'> |
| 3617 | <tr><th style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>Const</th> |
| 3618 | <th style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>Value</th> |
| 3619 | <th style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>Description</th></tr> |
| 3620 | <tr style='background-color: #f0f0f0; '> |
| 3621 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kUTF8_TextEncoding'><code>SkPaint::kUTF8_TextEncoding</code></a></td> |
| 3622 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>0</td> |
| 3623 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 3624 | uses bytes to represent UTF-8 or ASCII</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3625 | </tr> |
| 3626 | <tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3627 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kUTF16_TextEncoding'><code>SkPaint::kUTF16_TextEncoding</code></a></td> |
| 3628 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>1</td> |
| 3629 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 3630 | uses two byte words to represent most of Unicode</td> |
| 3631 | </tr> |
| 3632 | <tr style='background-color: #f0f0f0; '> |
| 3633 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kUTF32_TextEncoding'><code>SkPaint::kUTF32_TextEncoding</code></a></td> |
| 3634 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>2</td> |
| 3635 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 3636 | uses four byte words to represent all of Unicode</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3637 | </tr> |
| 3638 | <tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3639 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kGlyphID_TextEncoding'><code>SkPaint::kGlyphID_TextEncoding</code></a></td> |
| 3640 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>3</td> |
| 3641 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 3642 | uses two byte words to represent glyph indices</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3643 | </tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3644 | </table> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3645 | |
| 3646 | ### Example |
| 3647 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3648 | <div><fiddle-embed name="b29294e7f29d160a1b46abf2dcec9d2a"><div>First <a href='undocumented#Line'>line</a> is encoded in UTF-8. |
| 3649 | Second <a href='undocumented#Line'>line</a> is encoded in UTF-16. |
| 3650 | Third <a href='undocumented#Line'>line</a> is encoded in UTF-32. |
| 3651 | 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] | 3652 | </div></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3653 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3654 | <a name='SkPaint_getTextEncoding'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3655 | |
| 3656 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3657 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3658 | <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] | 3659 | <a href='#SkPaint_TextEncoding'>TextEncoding</a> <a href='#SkPaint_getTextEncoding'>getTextEncoding</a>()const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3660 | </pre> |
| 3661 | |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 3662 | Returns <a href='SkPaint_Reference#SkPaint'>SkPaint</a>::<a href='#SkPaint_TextEncoding'>TextEncoding</a>. |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 3663 | <a href='SkPaint_Reference#SkPaint'>SkPaint</a>::<a href='#SkPaint_TextEncoding'>TextEncoding</a> determines how character code <a href='SkPoint_Reference#Point'>points</a> are mapped to <a href='SkFont_Reference#Font'>font</a> <a href='undocumented#Glyph'>glyph</a> indices. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3664 | |
| 3665 | ### Return Value |
| 3666 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3667 | one of: <a href='#SkPaint_kUTF8_TextEncoding'>kUTF8_TextEncoding</a>, <a href='#SkPaint_kUTF16_TextEncoding'>kUTF16_TextEncoding</a>, <a href='#SkPaint_kUTF32_TextEncoding'>kUTF32_TextEncoding</a>, or |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 3668 | |
| 3669 | <a href='#SkPaint_kGlyphID_TextEncoding'>kGlyphID_TextEncoding</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3670 | |
| 3671 | ### Example |
| 3672 | |
skia-bookmaker | 525f9a9 | 2018-05-03 06:27:39 +0000 | [diff] [blame] | 3673 | <div><fiddle-embed name="c6cc2780a9828b3af8c4621c12b29a1b"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3674 | |
| 3675 | #### Example Output |
| 3676 | |
| 3677 | ~~~~ |
| 3678 | kUTF8_TextEncoding == text encoding |
| 3679 | kGlyphID_TextEncoding == text encoding |
| 3680 | ~~~~ |
| 3681 | |
| 3682 | </fiddle-embed></div> |
| 3683 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3684 | <a name='SkPaint_setTextEncoding'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3685 | |
| 3686 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3687 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3688 | <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] | 3689 | void <a href='#SkPaint_setTextEncoding'>setTextEncoding</a>(<a href='#SkPaint_TextEncoding'>TextEncoding</a> encoding) |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3690 | </pre> |
| 3691 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3692 | Sets <a href='SkPaint_Reference#SkPaint'>SkPaint</a>::<a href='#SkPaint_TextEncoding'>TextEncoding</a> to <a href='#SkPaint_setTextEncoding_encoding'>encoding</a>. |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 3693 | <a href='SkPaint_Reference#SkPaint'>SkPaint</a>::<a href='#SkPaint_TextEncoding'>TextEncoding</a> determines how character code <a href='SkPoint_Reference#Point'>points</a> are mapped to <a href='SkFont_Reference#Font'>font</a> <a href='undocumented#Glyph'>glyph</a> indices. |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3694 | Invalid values for <a href='#SkPaint_setTextEncoding_encoding'>encoding</a> are ignored. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3695 | |
| 3696 | ### Parameters |
| 3697 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3698 | <table> <tr> <td><a name='SkPaint_setTextEncoding_encoding'><code><strong>encoding</strong></code></a></td> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3699 | <td>one of: <a href='#SkPaint_kUTF8_TextEncoding'>kUTF8_TextEncoding</a>, <a href='#SkPaint_kUTF16_TextEncoding'>kUTF16_TextEncoding</a>, <a href='#SkPaint_kUTF32_TextEncoding'>kUTF32_TextEncoding</a>, or</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3700 | </tr> |
| 3701 | </table> |
| 3702 | |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 3703 | <a href='#SkPaint_kGlyphID_TextEncoding'>kGlyphID_TextEncoding</a> |
| 3704 | |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3705 | ### Example |
| 3706 | |
Cary Clark | 75fd449 | 2018-06-20 12:45:16 -0400 | [diff] [blame] | 3707 | <div><fiddle-embed name="6d9ffdd3c5543e9f12972a06dd4a0ce5"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3708 | |
| 3709 | #### Example Output |
| 3710 | |
| 3711 | ~~~~ |
| 3712 | 4 != text encoding |
| 3713 | ~~~~ |
| 3714 | |
| 3715 | </fiddle-embed></div> |
| 3716 | |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 3717 | <a name='SkPaint_FontMetrics'></a> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3718 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3719 | --- |
| 3720 | |
Cary Clark | 7e69c8f | 2018-11-06 20:40:45 -0500 | [diff] [blame] | 3721 | <a name='Font_Metrics'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3722 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3723 | <a name='SkPaint_getFontMetrics'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3724 | |
| 3725 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3726 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3727 | <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] | 3728 | <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] | 3729 | </pre> |
| 3730 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3731 | Returns <a href='undocumented#SkFontMetrics'>SkFontMetrics</a> associated with <a href='undocumented#SkTypeface'>SkTypeface</a>. |
| 3732 | 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] | 3733 | descent, ascent, and leading. |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3734 | 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>. |
| 3735 | 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] | 3736 | 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>, |
| 3737 | <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] | 3738 | |
| 3739 | ### Parameters |
| 3740 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3741 | <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] | 3742 | <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] | 3743 | </tr> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3744 | </table> |
| 3745 | |
| 3746 | ### Return Value |
| 3747 | |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 3748 | recommended spacing between <a href='undocumented#Line'>lines</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3749 | |
| 3750 | ### Example |
| 3751 | |
skia-bookmaker | 2dc1e34 | 2018-11-02 05:33:11 +0000 | [diff] [blame] | 3752 | <div><fiddle-embed name="59d9b8249afa1c2af6186711250ce240"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3753 | |
| 3754 | ### See Also |
| 3755 | |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 3756 | <a href='#Paint_Text_Size'>Text_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] | 3757 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3758 | <a name='SkPaint_getFontSpacing'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3759 | |
| 3760 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3761 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3762 | <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] | 3763 | <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] | 3764 | </pre> |
| 3765 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3766 | 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] | 3767 | descent, ascent, and leading. |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3768 | 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] | 3769 | dimensions required by stroking and <a href='undocumented#SkPathEffect'>SkPathEffect</a>. |
| 3770 | Returns the same result as <a href='#SkPaint_getFontMetrics'>getFontMetrics</a>(). |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3771 | |
| 3772 | ### Return Value |
| 3773 | |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 3774 | recommended spacing between <a href='undocumented#Line'>lines</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3775 | |
| 3776 | ### Example |
| 3777 | |
| 3778 | <div><fiddle-embed name="424741e26e1b174e43087d67422ce14f"> |
| 3779 | |
| 3780 | #### Example Output |
| 3781 | |
| 3782 | ~~~~ |
| 3783 | textSize: 12 fontSpacing: 13.9688 |
| 3784 | textSize: 18 fontSpacing: 20.9531 |
| 3785 | textSize: 24 fontSpacing: 27.9375 |
| 3786 | textSize: 32 fontSpacing: 37.25 |
| 3787 | ~~~~ |
| 3788 | |
| 3789 | </fiddle-embed></div> |
| 3790 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3791 | <a name='SkPaint_textToGlyphs'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3792 | |
| 3793 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3794 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3795 | <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] | 3796 | 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] | 3797 | </pre> |
| 3798 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3799 | Converts <a href='#SkPaint_textToGlyphs_text'>text</a> into <a href='undocumented#Glyph'>glyph</a> indices. |
| 3800 | 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^] | 3801 | <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] | 3802 | <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] | 3803 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3804 | 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] | 3805 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3806 | If <a href='#SkPaint_textToGlyphs_byteLength'>byteLength</a> equals zero, returns zero. |
| 3807 | 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] | 3808 | |
skia-bookmaker | fe47c2a | 2018-12-04 06:13:55 +0000 | [diff] [blame^] | 3809 | 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] | 3810 | <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] | 3811 | |
| 3812 | ### Parameters |
| 3813 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3814 | <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^] | 3815 | <td>character storage encoded with <a href='undocumented#SkTextEncoding'>SkTextEncoding</a></td> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3816 | </tr> |
| 3817 | <tr> <td><a name='SkPaint_textToGlyphs_byteLength'><code><strong>byteLength</strong></code></a></td> |
| 3818 | <td>length of character storage in bytes</td> |
| 3819 | </tr> |
| 3820 | <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] | 3821 | <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] | 3822 | </tr> |
| 3823 | </table> |
| 3824 | |
| 3825 | ### Return Value |
| 3826 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3827 | 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] | 3828 | |
| 3829 | ### Example |
| 3830 | |
| 3831 | <div><fiddle-embed name="343e9471a7f7b5f09abdc3b44983433b"></fiddle-embed></div> |
| 3832 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3833 | <a name='SkPaint_countText'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3834 | |
| 3835 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3836 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3837 | <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] | 3838 | 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] | 3839 | </pre> |
| 3840 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3841 | 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^] | 3842 | 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] | 3843 | Returns the same result as <a href='#SkPaint_textToGlyphs'>textToGlyphs</a>(). |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3844 | |
| 3845 | ### Parameters |
| 3846 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3847 | <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^] | 3848 | <td>character storage encoded with <a href='undocumented#SkTextEncoding'>SkTextEncoding</a></td> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3849 | </tr> |
| 3850 | <tr> <td><a name='SkPaint_countText_byteLength'><code><strong>byteLength</strong></code></a></td> |
| 3851 | <td>length of character storage in bytes</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3852 | </tr> |
| 3853 | </table> |
| 3854 | |
| 3855 | ### Return Value |
| 3856 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3857 | 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] | 3858 | |
| 3859 | ### Example |
| 3860 | |
Cary Clark | f960398 | 2018-07-17 08:20:27 -0400 | [diff] [blame] | 3861 | <div><fiddle-embed name="85436c71aab5410767fc688ab0573e09"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3862 | |
| 3863 | #### Example Output |
| 3864 | |
| 3865 | ~~~~ |
| 3866 | count = 5 |
| 3867 | ~~~~ |
| 3868 | |
| 3869 | </fiddle-embed></div> |
| 3870 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3871 | <a name='SkPaint_containsText'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3872 | |
| 3873 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3874 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3875 | <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] | 3876 | 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] | 3877 | </pre> |
| 3878 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3879 | Returns true if all <a href='#SkPaint_containsText_text'>text</a> corresponds to a non-zero <a href='undocumented#Glyph'>glyph</a> index. |
| 3880 | 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] | 3881 | <a href='undocumented#SkTypeface'>SkTypeface</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3882 | |
skia-bookmaker | fe47c2a | 2018-12-04 06:13:55 +0000 | [diff] [blame^] | 3883 | 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] | 3884 | returns true if all <a href='undocumented#Glyph'>glyph</a> indices in <a href='#SkPaint_containsText_text'>text</a> are non-zero; |
| 3885 | 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] | 3886 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3887 | Returns true if <a href='#SkPaint_containsText_byteLength'>byteLength</a> is zero. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3888 | |
| 3889 | ### Parameters |
| 3890 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3891 | <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] | 3892 | <td>array of characters or <a href='undocumented#Glyph'>glyphs</a></td> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3893 | </tr> |
| 3894 | <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] | 3895 | <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] | 3896 | </tr> |
| 3897 | </table> |
| 3898 | |
| 3899 | ### Return Value |
| 3900 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3901 | 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] | 3902 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3903 | <div><a href='#SkPaint_containsText'>containsText</a> succeeds for degree symbol, but cannot find a <a href='undocumented#Glyph'>glyph</a> index |
| 3904 | 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] | 3905 | </div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3906 | |
| 3907 | #### Example Output |
| 3908 | |
| 3909 | ~~~~ |
| 3910 | 0x00b0 == has char |
| 3911 | 0xd800 != has char |
| 3912 | ~~~~ |
| 3913 | |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3914 | ### Example |
| 3915 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3916 | <div><fiddle-embed name="083557b6f653d6fc00a34e01f87b74ff"><div><a href='#SkPaint_containsText'>containsText</a> returns true that <a href='undocumented#Glyph'>glyph</a> index is greater than zero, not |
| 3917 | 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] | 3918 | </div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3919 | |
| 3920 | #### Example Output |
| 3921 | |
| 3922 | ~~~~ |
| 3923 | 0x01ff == has glyph |
| 3924 | 0x0000 != has glyph |
| 3925 | 0xffff == has glyph |
| 3926 | ~~~~ |
| 3927 | |
| 3928 | </fiddle-embed></div> |
| 3929 | |
| 3930 | ### See Also |
| 3931 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3932 | <a href='#SkPaint_setTextEncoding'>setTextEncoding</a> <a href='undocumented#Typeface'>Typeface</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3933 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3934 | <a name='SkPaint_glyphsToUnichars'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3935 | |
| 3936 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3937 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3938 | <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] | 3939 | 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] | 3940 | </pre> |
| 3941 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3942 | Converts <a href='#SkPaint_glyphsToUnichars_glyphs'>glyphs</a> into <a href='#SkPaint_glyphsToUnichars_text'>text</a> if possible. |
| 3943 | <a href='undocumented#Glyph'>Glyph</a> values without direct Unicode equivalents are mapped to zero. |
| 3944 | Uses the <a href='undocumented#SkTypeface'>SkTypeface</a>, but is unaffected |
skia-bookmaker | fe47c2a | 2018-12-04 06:13:55 +0000 | [diff] [blame^] | 3945 | 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] | 3946 | |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 3947 | 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] | 3948 | |
| 3949 | ### Parameters |
| 3950 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3951 | <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] | 3952 | <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] | 3953 | </tr> |
| 3954 | <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] | 3955 | <td>length of <a href='undocumented#Glyph'>glyph</a> array</td> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3956 | </tr> |
| 3957 | <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] | 3958 | <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] | 3959 | </tr> |
| 3960 | </table> |
| 3961 | |
| 3962 | ### Example |
| 3963 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3964 | <div><fiddle-embed name="c12686b0b3e0a87d0a248bbfc57e9492"><div>Convert UTF-8 <a href='#SkPaint_glyphsToUnichars_text'>text</a> to <a href='#SkPaint_glyphsToUnichars_glyphs'>glyphs</a>; then convert <a href='#SkPaint_glyphsToUnichars_glyphs'>glyphs</a> to Unichar code <a href='SkPoint_Reference#Point'>points</a>. |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 3965 | </div></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3966 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3967 | <a name='Measure_Text'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3968 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3969 | <a name='SkPaint_measureText'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3970 | |
| 3971 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3972 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3973 | <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] | 3974 | <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] | 3975 | </pre> |
| 3976 | |
Cary Clark | 3aca39d | 2018-10-23 14:44:05 -0400 | [diff] [blame] | 3977 | Returns the advance width of <a href='#SkPaint_measureText_text'>text</a>. |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3978 | 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^] | 3979 | 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] | 3980 | 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 |
| 3981 | <a href='undocumented#SkPathEffect'>SkPathEffect</a> to scale the metrics and <a href='#SkPaint_measureText_bounds'>bounds</a>. |
| 3982 | Returns the bounding box of <a href='#SkPaint_measureText_text'>text</a> if <a href='#SkPaint_measureText_bounds'>bounds</a> is not nullptr. |
| 3983 | 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] | 3984 | |
| 3985 | ### Parameters |
| 3986 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3987 | <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] | 3988 | <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] | 3989 | </tr> |
| 3990 | <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] | 3991 | <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] | 3992 | </tr> |
| 3993 | <tr> <td><a name='SkPaint_measureText_bounds'><code><strong>bounds</strong></code></a></td> |
| 3994 | <td>returns bounding box relative to (0, 0) if not nullptr</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3995 | </tr> |
| 3996 | </table> |
| 3997 | |
| 3998 | ### Return Value |
| 3999 | |
| 4000 | advance width or height |
| 4001 | |
| 4002 | ### Example |
| 4003 | |
Cary Clark | 8364706 | 2018-07-18 16:21:51 -0400 | [diff] [blame] | 4004 | <div><fiddle-embed name="06084f609184470135a9cd9ebc5af149"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4005 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4006 | <a name='SkPaint_measureText_2'></a> |
Cary Clark | 2dc84ad | 2018-01-26 12:56:22 -0500 | [diff] [blame] | 4007 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 4008 | --- |
| 4009 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4010 | <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] | 4011 | <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] | 4012 | </pre> |
| 4013 | |
Cary Clark | 3aca39d | 2018-10-23 14:44:05 -0400 | [diff] [blame] | 4014 | 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] | 4015 | 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^] | 4016 | 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] | 4017 | and <a href='#Text_Size'>text size</a> to scale the metrics. |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 4018 | 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] | 4019 | |
| 4020 | ### Parameters |
| 4021 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4022 | <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] | 4023 | <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] | 4024 | </tr> |
| 4025 | <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] | 4026 | <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] | 4027 | </tr> |
| 4028 | </table> |
| 4029 | |
| 4030 | ### Return Value |
| 4031 | |
| 4032 | advance width or height |
| 4033 | |
| 4034 | ### Example |
| 4035 | |
| 4036 | <div><fiddle-embed name="f1139a5ddd17fd47c2f45f6e642cac76"> |
| 4037 | |
| 4038 | #### Example Output |
| 4039 | |
| 4040 | ~~~~ |
| 4041 | default width = 5 |
| 4042 | double width = 10 |
| 4043 | ~~~~ |
| 4044 | |
| 4045 | </fiddle-embed></div> |
| 4046 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4047 | <a name='SkPaint_breakText'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 4048 | |
| 4049 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4050 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4051 | <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] | 4052 | 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] | 4053 | <a href='undocumented#SkScalar'>SkScalar</a>* measuredWidth = nullptr)const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4054 | </pre> |
| 4055 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4056 | Returns the bytes of <a href='#SkPaint_breakText_text'>text</a> that fit within <a href='#SkPaint_breakText_maxWidth'>maxWidth</a>. |
| 4057 | 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] | 4058 | 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] | 4059 | 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^] | 4060 | 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] | 4061 | and <a href='#Text_Size'>text size</a> to scale the metrics. |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 4062 | 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] | 4063 | |
| 4064 | ### Parameters |
| 4065 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4066 | <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] | 4067 | <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] | 4068 | </tr> |
| 4069 | <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] | 4070 | <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] | 4071 | </tr> |
| 4072 | <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] | 4073 | <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] | 4074 | </tr> |
| 4075 | <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] | 4076 | <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] | 4077 | </tr> |
| 4078 | </table> |
| 4079 | |
| 4080 | ### Return Value |
| 4081 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4082 | 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] | 4083 | |
| 4084 | ### Example |
| 4085 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4086 | <div><fiddle-embed name="fd0033470ccbd5c7059670fdbf96cffc"><div><a href='undocumented#Line'>Line</a> under "Breakfast" shows desired width, shorter than available characters. |
| 4087 | <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] | 4088 | </div></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4089 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4090 | <a name='SkPaint_getTextWidths'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 4091 | |
| 4092 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4093 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4094 | <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] | 4095 | 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] | 4096 | </pre> |
| 4097 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4098 | 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 |
| 4099 | the <a href='undocumented#Glyph'>glyph</a> count in <a href='#SkPaint_getTextWidths_text'>text</a>. |
| 4100 | Both <a href='#SkPaint_getTextWidths_widths'>widths</a> and <a href='#SkPaint_getTextWidths_bounds'>bounds</a> may be nullptr. |
| 4101 | 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. |
| 4102 | 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^] | 4103 | 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] | 4104 | 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] | 4105 | 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] | 4106 | 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] | 4107 | |
| 4108 | ### Parameters |
| 4109 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4110 | <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] | 4111 | <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] | 4112 | </tr> |
| 4113 | <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] | 4114 | <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] | 4115 | </tr> |
| 4116 | <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] | 4117 | <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] | 4118 | </tr> |
| 4119 | <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] | 4120 | <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] | 4121 | </tr> |
| 4122 | </table> |
| 4123 | |
| 4124 | ### Return Value |
| 4125 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4126 | <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] | 4127 | |
| 4128 | ### Example |
| 4129 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4130 | <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. |
| 4131 | 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] | 4132 | </div></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4133 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 4134 | <a name='Text_Path'></a> |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 4135 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4136 | <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] | 4137 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4138 | <a name='SkPaint_getTextPath'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 4139 | |
| 4140 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4141 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4142 | <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] | 4143 | 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] | 4144 | </pre> |
| 4145 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4146 | 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^] | 4147 | 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] | 4148 | 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>. |
| 4149 | 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>. |
| 4150 | 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] | 4151 | |
| 4152 | ### Parameters |
| 4153 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4154 | <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] | 4155 | <td>character codes or <a href='undocumented#Glyph'>glyph</a> indices</td> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4156 | </tr> |
| 4157 | <tr> <td><a name='SkPaint_getTextPath_length'><code><strong>length</strong></code></a></td> |
| 4158 | <td>number of bytes of <a href='#SkPaint_getTextPath_text'>text</a></td> |
| 4159 | </tr> |
| 4160 | <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] | 4161 | <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] | 4162 | </tr> |
| 4163 | <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] | 4164 | <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] | 4165 | </tr> |
| 4166 | <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] | 4167 | <td>geometry of the <a href='undocumented#Glyph'>glyphs</a></td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4168 | </tr> |
| 4169 | </table> |
| 4170 | |
| 4171 | ### Example |
| 4172 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4173 | <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 |
| 4174 | the offset location. The result is rendered with one draw call. |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 4175 | </div></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4176 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4177 | <a name='SkPaint_getPosTextPath'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 4178 | |
| 4179 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4180 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4181 | <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] | 4182 | 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] | 4183 | </pre> |
| 4184 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4185 | 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^] | 4186 | 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] | 4187 | 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>. |
| 4188 | 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>. |
| 4189 | Uses <a href='#SkPaint_getPosTextPath_pos'>pos</a> array to position <a href='#SkPaint_getPosTextPath_path'>path</a>. |
| 4190 | <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] | 4191 | |
| 4192 | ### Parameters |
| 4193 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4194 | <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] | 4195 | <td>character codes or <a href='undocumented#Glyph'>glyph</a> indices</td> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4196 | </tr> |
| 4197 | <tr> <td><a name='SkPaint_getPosTextPath_length'><code><strong>length</strong></code></a></td> |
| 4198 | <td>number of bytes of <a href='#SkPaint_getPosTextPath_text'>text</a></td> |
| 4199 | </tr> |
| 4200 | <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] | 4201 | <td>positions of each <a href='undocumented#Glyph'>glyph</a></td> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4202 | </tr> |
| 4203 | <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] | 4204 | <td>geometry of the <a href='undocumented#Glyph'>glyphs</a></td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4205 | </tr> |
| 4206 | </table> |
| 4207 | |
| 4208 | ### Example |
| 4209 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4210 | <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] | 4211 | </div></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4212 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 4213 | <a name='Text_Intercepts'></a> |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 4214 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4215 | <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 |
| 4216 | 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 |
| 4217 | underline that skips Descenders. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4218 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4219 | <a name='SkPaint_getTextIntercepts'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 4220 | |
| 4221 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4222 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4223 | <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] | 4224 | 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] | 4225 | 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] | 4226 | </pre> |
| 4227 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4228 | Returns the number of <a href='#SkPaint_getTextIntercepts_intervals'>intervals</a> that intersect <a href='#SkPaint_getTextIntercepts_bounds'>bounds</a>. |
| 4229 | <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. |
| 4230 | 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] | 4231 | the <a href='undocumented#String'>string</a>. |
skia-bookmaker | fe47c2a | 2018-12-04 06:13:55 +0000 | [diff] [blame^] | 4232 | 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] | 4233 | 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>. |
| 4234 | 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] | 4235 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4236 | 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] | 4237 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4238 | <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] | 4239 | |
| 4240 | ### Parameters |
| 4241 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4242 | <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] | 4243 | <td>character codes or <a href='undocumented#Glyph'>glyph</a> indices</td> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4244 | </tr> |
| 4245 | <tr> <td><a name='SkPaint_getTextIntercepts_length'><code><strong>length</strong></code></a></td> |
| 4246 | <td>number of bytes of <a href='#SkPaint_getTextIntercepts_text'>text</a></td> |
| 4247 | </tr> |
| 4248 | <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] | 4249 | <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] | 4250 | </tr> |
| 4251 | <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] | 4252 | <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] | 4253 | </tr> |
| 4254 | <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] | 4255 | <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] | 4256 | </tr> |
| 4257 | <tr> <td><a name='SkPaint_getTextIntercepts_intervals'><code><strong>intervals</strong></code></a></td> |
| 4258 | <td>returned intersections; may be nullptr</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4259 | </tr> |
| 4260 | </table> |
| 4261 | |
| 4262 | ### Return Value |
| 4263 | |
| 4264 | number of intersections; may be zero |
| 4265 | |
Cary Clark | e9c5a15 | 2018-11-21 11:45:57 -0500 | [diff] [blame] | 4266 | <div>Underline uses intercepts to draw on either side of the <a href='undocumented#Glyph'>glyph</a> Descender. |
| 4267 | </div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4268 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4269 | <a name='SkPaint_getPosTextIntercepts'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 4270 | |
| 4271 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4272 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4273 | <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] | 4274 | 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] | 4275 | 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] | 4276 | </pre> |
| 4277 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4278 | Returns the number of <a href='#SkPaint_getPosTextIntercepts_intervals'>intervals</a> that intersect <a href='#SkPaint_getPosTextIntercepts_bounds'>bounds</a>. |
| 4279 | <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. |
| 4280 | 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] | 4281 | the <a href='undocumented#String'>string</a>. |
skia-bookmaker | fe47c2a | 2018-12-04 06:13:55 +0000 | [diff] [blame^] | 4282 | 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] | 4283 | 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>. |
| 4284 | 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] | 4285 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4286 | 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] | 4287 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4288 | <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] | 4289 | |
| 4290 | ### Parameters |
| 4291 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4292 | <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] | 4293 | <td>character codes or <a href='undocumented#Glyph'>glyph</a> indices</td> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4294 | </tr> |
| 4295 | <tr> <td><a name='SkPaint_getPosTextIntercepts_length'><code><strong>length</strong></code></a></td> |
| 4296 | <td>number of bytes of <a href='#SkPaint_getPosTextIntercepts_text'>text</a></td> |
| 4297 | </tr> |
| 4298 | <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] | 4299 | <td>positions of each <a href='undocumented#Glyph'>glyph</a></td> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4300 | </tr> |
| 4301 | <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] | 4302 | <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] | 4303 | </tr> |
| 4304 | <tr> <td><a name='SkPaint_getPosTextIntercepts_intervals'><code><strong>intervals</strong></code></a></td> |
| 4305 | <td>returned intersections; may be nullptr</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4306 | </tr> |
| 4307 | </table> |
| 4308 | |
| 4309 | ### Return Value |
| 4310 | |
Cary Clark | a523d2d | 2017-08-30 08:58:10 -0400 | [diff] [blame] | 4311 | number of intersections; may be zero |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4312 | |
Cary Clark | e9c5a15 | 2018-11-21 11:45:57 -0500 | [diff] [blame] | 4313 | <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. |
| 4314 | </div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4315 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4316 | <a name='SkPaint_getPosTextHIntercepts'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 4317 | |
| 4318 | --- |
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 | <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] | 4321 | 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] | 4322 | 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] | 4323 | </pre> |
| 4324 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4325 | Returns the number of <a href='#SkPaint_getPosTextHIntercepts_intervals'>intervals</a> that intersect <a href='#SkPaint_getPosTextHIntercepts_bounds'>bounds</a>. |
| 4326 | <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. |
| 4327 | 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] | 4328 | the <a href='undocumented#String'>string</a>. |
skia-bookmaker | fe47c2a | 2018-12-04 06:13:55 +0000 | [diff] [blame^] | 4329 | 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] | 4330 | 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>. |
| 4331 | 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] | 4332 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4333 | 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] | 4334 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4335 | <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] | 4336 | |
| 4337 | ### Parameters |
| 4338 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4339 | <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] | 4340 | <td>character codes or <a href='undocumented#Glyph'>glyph</a> indices</td> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4341 | </tr> |
| 4342 | <tr> <td><a name='SkPaint_getPosTextHIntercepts_length'><code><strong>length</strong></code></a></td> |
| 4343 | <td>number of bytes of <a href='#SkPaint_getPosTextHIntercepts_text'>text</a></td> |
| 4344 | </tr> |
| 4345 | <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] | 4346 | <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] | 4347 | </tr> |
| 4348 | <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] | 4349 | <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] | 4350 | </tr> |
| 4351 | <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] | 4352 | <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] | 4353 | </tr> |
| 4354 | <tr> <td><a name='SkPaint_getPosTextHIntercepts_intervals'><code><strong>intervals</strong></code></a></td> |
| 4355 | <td>returned intersections; may be nullptr</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4356 | </tr> |
| 4357 | </table> |
| 4358 | |
| 4359 | ### Return Value |
| 4360 | |
| 4361 | number of intersections; may be zero |
| 4362 | |
Cary Clark | e9c5a15 | 2018-11-21 11:45:57 -0500 | [diff] [blame] | 4363 | <div><a href='undocumented#Text'>Text</a> intercepts do not take stroke thickness into consideration. |
| 4364 | </div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4365 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4366 | <a name='SkPaint_getTextBlobIntercepts'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 4367 | |
| 4368 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4369 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4370 | <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] | 4371 | 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] | 4372 | </pre> |
| 4373 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4374 | Returns the number of <a href='#SkPaint_getTextBlobIntercepts_intervals'>intervals</a> that intersect <a href='#SkPaint_getTextBlobIntercepts_bounds'>bounds</a>. |
| 4375 | <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. |
| 4376 | 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] | 4377 | the <a href='undocumented#String'>string</a>. |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4378 | Uses <a href='undocumented#SkTypeface'>SkTypeface</a> to get the <a href='undocumented#Glyph'>glyph</a> <a href='SkPath_Reference#Path'>paths</a>, |
| 4379 | 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] | 4380 | Uses run array to position <a href='#SkPaint_getTextBlobIntercepts_intervals'>intervals</a>. |
skia-bookmaker | 525f9a9 | 2018-05-03 06:27:39 +0000 | [diff] [blame] | 4381 | |
skia-bookmaker | fe47c2a | 2018-12-04 06:13:55 +0000 | [diff] [blame^] | 4382 | <a href='undocumented#SkTextEncoding'>SkTextEncoding</a> must be set to <a href='SkPaint_Reference#SkPaint'>SkPaint</a>::<a href='#SkPaint_kGlyphID_TextEncoding'>kGlyphID_TextEncoding</a>. |
Cary Clark | 3cd22cc | 2017-12-01 11:49:58 -0500 | [diff] [blame] | 4383 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4384 | 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] | 4385 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4386 | <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] | 4387 | |
| 4388 | ### Parameters |
| 4389 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4390 | <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] | 4391 | <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] | 4392 | </tr> |
| 4393 | <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] | 4394 | <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] | 4395 | </tr> |
| 4396 | <tr> <td><a name='SkPaint_getTextBlobIntercepts_intervals'><code><strong>intervals</strong></code></a></td> |
| 4397 | <td>returned intersections; may be nullptr</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4398 | </tr> |
| 4399 | </table> |
| 4400 | |
| 4401 | ### Return Value |
| 4402 | |
| 4403 | number of intersections; may be zero |
| 4404 | |
| 4405 | ### Example |
| 4406 | |
skia-bookmaker | 53079c3 | 2018-11-25 04:03:02 +0000 | [diff] [blame] | 4407 | <div><fiddle-embed name="728ea9089f233a71a1062e364b8c73fa"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4408 | |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 4409 | <a name='SkPaint_getFontBounds'></a> |
| 4410 | |
| 4411 | --- |
| 4412 | |
| 4413 | <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] | 4414 | <a href='SkRect_Reference#SkRect'>SkRect</a> <a href='#SkPaint_getFontBounds'>getFontBounds</a>()const |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 4415 | </pre> |
| 4416 | |
| 4417 | Returns the union of bounds of all <a href='undocumented#Glyph'>glyphs</a>. |
Cary Clark | cb6bef0 | 2018-11-29 12:05:25 -0500 | [diff] [blame] | 4418 | Returned dimensions are computed by <a href='SkFont_Reference#Font'>font</a> manager from <a href='SkFont_Reference#Font'>font</a> <a href='undocumented#Data'>data</a>, |
| 4419 | ignoring <a href='SkPaint_Reference#SkPaint'>SkPaint</a>::Hinting. Includes <a href='SkFont_Reference#Font'>font</a> metrics, but not fake bold or <a href='undocumented#SkPathEffect'>SkPathEffect</a>. |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 4420 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4421 | If <a href='undocumented#Text'>text</a> <a href='undocumented#Size'>size</a> is large, <a href='undocumented#Text'>text</a> scale is one, and <a href='undocumented#Text'>text</a> skew is zero, |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 4422 | returns the bounds as: |
| 4423 | { <a href='undocumented#SkFontMetrics'>SkFontMetrics</a>::<a href='#SkFontMetrics_fXMin'>fXMin</a>, <a href='undocumented#SkFontMetrics'>SkFontMetrics</a>::<a href='#SkFontMetrics_fTop'>fTop</a>, <a href='undocumented#SkFontMetrics'>SkFontMetrics</a>::<a href='#SkFontMetrics_fXMax'>fXMax</a>, <a href='undocumented#SkFontMetrics'>SkFontMetrics</a>::<a href='#SkFontMetrics_fBottom'>fBottom</a> }. |
| 4424 | |
| 4425 | ### Return Value |
| 4426 | |
| 4427 | union of bounds of all <a href='undocumented#Glyph'>glyphs</a> |
| 4428 | |
| 4429 | ### Example |
| 4430 | |
skia-bookmaker | 1e1ba0e | 2018-11-13 05:36:58 +0000 | [diff] [blame] | 4431 | <div><fiddle-embed name="f29d005a75efd4746c6744004a0cb421"> |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 4432 | |
| 4433 | #### Example Output |
| 4434 | |
| 4435 | ~~~~ |
| 4436 | metrics bounds = { -12.2461, -14.7891, 21.5215, 5.55469 } |
| 4437 | font bounds = { -12.2461, -14.7891, 21.5215, 5.55469 } |
| 4438 | ~~~~ |
| 4439 | |
| 4440 | </fiddle-embed></div> |
| 4441 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4442 | <a name='SkPaint_nothingToDraw'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 4443 | |
| 4444 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4445 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4446 | <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] | 4447 | bool <a href='#SkPaint_nothingToDraw'>nothingToDraw</a>()const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4448 | </pre> |
| 4449 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4450 | Returns true if <a href='SkPaint_Reference#SkPaint'>SkPaint</a> prevents all drawing; |
| 4451 | 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] | 4452 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4453 | Returns true if, for example, <a href='SkBlendMode_Reference#SkBlendMode'>SkBlendMode</a> combined with <a href='SkColor_Reference#Alpha'>alpha</a> computes a |
| 4454 | new <a href='SkColor_Reference#Alpha'>alpha</a> of zero. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4455 | |
| 4456 | ### Return Value |
| 4457 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4458 | true if <a href='SkPaint_Reference#SkPaint'>SkPaint</a> prevents all drawing |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4459 | |
| 4460 | ### Example |
| 4461 | |
Cary Clark | 8364706 | 2018-07-18 16:21:51 -0400 | [diff] [blame] | 4462 | <div><fiddle-embed name="2973b05bfbb6b4c29332c8ac4fcf3995"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4463 | |
| 4464 | #### Example Output |
| 4465 | |
| 4466 | ~~~~ |
| 4467 | initial nothing to draw: false |
| 4468 | blend dst nothing to draw: true |
| 4469 | blend src over nothing to draw: false |
| 4470 | alpha 0 nothing to draw: true |
| 4471 | ~~~~ |
| 4472 | |
| 4473 | </fiddle-embed></div> |
| 4474 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 4475 | <a name='Utility'></a> |
Cary Clark | 78de751 | 2018-02-07 07:27:09 -0500 | [diff] [blame] | 4476 | |