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 | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 11 | public: |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 12 | <a href='#SkPaint_empty_constructor'>SkPaint()</a>; |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 13 | <a href='SkPaint_Reference#SkPaint'>SkPaint</a>(const <a href='SkPaint_Reference#SkPaint'>SkPaint</a>& <a href='SkPaint_Reference#Paint'>paint</a>); |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 14 | <a href='SkPaint_Reference#SkPaint'>SkPaint</a>(<a href='SkPaint_Reference#SkPaint'>SkPaint</a>&& <a href='SkPaint_Reference#Paint'>paint</a>); |
| 15 | ~<a href='#SkPaint_empty_constructor'>SkPaint()</a>; |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 16 | <a href='SkPaint_Reference#SkPaint'>SkPaint</a>& operator=(const <a href='SkPaint_Reference#SkPaint'>SkPaint</a>& <a href='SkPaint_Reference#Paint'>paint</a>); |
| 17 | <a href='SkPaint_Reference#SkPaint'>SkPaint</a>& operator=(<a href='SkPaint_Reference#SkPaint'>SkPaint</a>&& <a href='SkPaint_Reference#Paint'>paint</a>); |
| 18 | friend bool operator==(const <a href='SkPaint_Reference#SkPaint'>SkPaint</a>& a, const <a href='SkPaint_Reference#SkPaint'>SkPaint</a>& b); |
| 19 | friend bool operator!=(const <a href='SkPaint_Reference#SkPaint'>SkPaint</a>& a, const <a href='SkPaint_Reference#SkPaint'>SkPaint</a>& b); |
| 20 | uint32_t <a href='#SkPaint_getHash'>getHash</a>() const; |
| 21 | void <a href='#SkPaint_reset'>reset()</a>; |
Cary Clark | 8cc4cdc | 2018-11-09 23:16:58 -0500 | [diff] [blame] | 22 | |
| 23 | enum <a href='#SkPaint_Hinting'>Hinting</a> : uint8_t { |
| 24 | <a href='#SkPaint_kNo_Hinting'>kNo_Hinting</a> = 0, |
| 25 | <a href='#SkPaint_kSlight_Hinting'>kSlight_Hinting</a> = 1, |
| 26 | <a href='#SkPaint_kNormal_Hinting'>kNormal_Hinting</a> = 2, |
| 27 | <a href='#SkPaint_kFull_Hinting'>kFull_Hinting</a> = 3, |
| 28 | }; |
| 29 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 30 | 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] | 31 | <a href='#SkPaint_Hinting'>Hinting</a> <a href='#SkPaint_getHinting'>getHinting</a>() const; |
| 32 | void <a href='#SkPaint_setHinting'>setHinting</a>(<a href='#SkPaint_Hinting'>Hinting</a> h); |
| 33 | <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] | 34 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 35 | enum <a href='#SkPaint_Flags'>Flags</a> { |
| 36 | <a href='#SkPaint_kAntiAlias_Flag'>kAntiAlias_Flag</a> = 0x01, |
| 37 | <a href='#SkPaint_kDither_Flag'>kDither_Flag</a> = 0x04, |
| 38 | <a href='#SkPaint_kFakeBoldText_Flag'>kFakeBoldText_Flag</a> = 0x20, |
| 39 | <a href='#SkPaint_kLinearText_Flag'>kLinearText_Flag</a> = 0x40, |
| 40 | <a href='#SkPaint_kSubpixelText_Flag'>kSubpixelText_Flag</a> = 0x80, |
| 41 | <a href='#SkPaint_kLCDRenderText_Flag'>kLCDRenderText_Flag</a> = 0x200, |
| 42 | <a href='#SkPaint_kEmbeddedBitmapText_Flag'>kEmbeddedBitmapText_Flag</a> = 0x400, |
| 43 | <a href='#SkPaint_kAutoHinting_Flag'>kAutoHinting_Flag</a> = 0x800, |
| 44 | <a href='#SkPaint_kAllFlags'>kAllFlags</a> = 0xFFFF, |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 45 | }; |
| 46 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 47 | enum <a href='#SkPaint_ReserveFlags'>ReserveFlags</a> { |
| 48 | <a href='#SkPaint_kUnderlineText_ReserveFlag'>kUnderlineText_ReserveFlag</a> = 0x08, |
| 49 | <a href='#SkPaint_kStrikeThruText_ReserveFlag'>kStrikeThruText_ReserveFlag</a> = 0x10, |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 50 | }; |
| 51 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 52 | uint32_t <a href='#SkPaint_getFlags'>getFlags</a>() const; |
| 53 | void <a href='#SkPaint_setFlags'>setFlags</a>(uint32_t flags); |
| 54 | bool <a href='#SkPaint_isAntiAlias'>isAntiAlias</a>() const; |
| 55 | void <a href='#SkPaint_setAntiAlias'>setAntiAlias</a>(bool aa); |
| 56 | bool <a href='#SkPaint_isDither'>isDither</a>() const; |
| 57 | void <a href='#SkPaint_setDither'>setDither</a>(bool dither); |
| 58 | bool <a href='#SkPaint_isLinearText'>isLinearText</a>() const; |
| 59 | void <a href='#SkPaint_setLinearText'>setLinearText</a>(bool linearText); |
| 60 | bool <a href='#SkPaint_isSubpixelText'>isSubpixelText</a>() const; |
| 61 | void <a href='#SkPaint_setSubpixelText'>setSubpixelText</a>(bool subpixelText); |
| 62 | bool <a href='#SkPaint_isLCDRenderText'>isLCDRenderText</a>() const; |
| 63 | void <a href='#SkPaint_setLCDRenderText'>setLCDRenderText</a>(bool lcdText); |
| 64 | bool <a href='#SkPaint_isEmbeddedBitmapText'>isEmbeddedBitmapText</a>() const; |
| 65 | void <a href='#SkPaint_setEmbeddedBitmapText'>setEmbeddedBitmapText</a>(bool useEmbeddedBitmapText); |
| 66 | bool <a href='#SkPaint_isAutohinted'>isAutohinted</a>() const; |
| 67 | void <a href='#SkPaint_setAutohinted'>setAutohinted</a>(bool useAutohinter); |
| 68 | bool <a href='#SkPaint_isFakeBoldText'>isFakeBoldText</a>() const; |
| 69 | void <a href='#SkPaint_setFakeBoldText'>setFakeBoldText</a>(bool fakeBoldText); |
| 70 | <a href='undocumented#SkFilterQuality'>SkFilterQuality</a> <a href='#SkPaint_getFilterQuality'>getFilterQuality</a>() const; |
| 71 | 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] | 72 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 73 | enum <a href='#SkPaint_Style'>Style</a> : uint8_t { |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 74 | <a href='#SkPaint_kFill_Style'>kFill_Style</a>, |
| 75 | <a href='#SkPaint_kStroke_Style'>kStroke_Style</a>, |
| 76 | <a href='#SkPaint_kStrokeAndFill_Style'>kStrokeAndFill_Style</a>, |
| 77 | }; |
| 78 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 79 | static constexpr int <a href='#SkPaint_kStyleCount'>kStyleCount</a> = <a href='#SkPaint_kStrokeAndFill_Style'>kStrokeAndFill_Style</a> + 1; |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 80 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 81 | <a href='#SkPaint_Style'>Style</a> <a href='#SkPaint_getStyle'>getStyle</a>() const; |
| 82 | void <a href='#SkPaint_setStyle'>setStyle</a>(<a href='#SkPaint_Style'>Style</a> style); |
| 83 | <a href='SkColor_Reference#SkColor'>SkColor</a> <a href='#SkPaint_getColor'>getColor</a>() const; |
| 84 | <a href='SkColor4f_Reference#SkColor4f'>SkColor4f</a> <a href='#SkPaint_getColor4f'>getColor4f</a>() const; |
| 85 | void <a href='#SkPaint_setColor'>setColor</a>(<a href='SkColor_Reference#SkColor'>SkColor</a> <a href='SkColor_Reference#Color'>color</a>); |
| 86 | 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); |
| 87 | uint8_t <a href='#SkPaint_getAlpha'>getAlpha</a>() const; |
| 88 | void <a href='#SkPaint_setAlpha'>setAlpha</a>(<a href='undocumented#U8CPU'>U8CPU</a> a); |
| 89 | 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); |
| 90 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_getStrokeWidth'>getStrokeWidth</a>() const; |
| 91 | void <a href='#SkPaint_setStrokeWidth'>setStrokeWidth</a>(<a href='undocumented#SkScalar'>SkScalar</a> width); |
| 92 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_getStrokeMiter'>getStrokeMiter</a>() const; |
| 93 | 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] | 94 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 95 | enum <a href='#SkPaint_Cap'>Cap</a> { |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 96 | <a href='#SkPaint_kButt_Cap'>kButt_Cap</a>, |
| 97 | <a href='#SkPaint_kRound_Cap'>kRound_Cap</a>, |
| 98 | <a href='#SkPaint_kSquare_Cap'>kSquare_Cap</a>, |
| 99 | <a href='#SkPaint_kLast_Cap'>kLast_Cap</a> = <a href='#SkPaint_kSquare_Cap'>kSquare_Cap</a>, |
| 100 | <a href='#SkPaint_kDefault_Cap'>kDefault_Cap</a> = <a href='#SkPaint_kButt_Cap'>kButt_Cap</a>, |
| 101 | }; |
| 102 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 103 | static constexpr int <a href='#SkPaint_kCapCount'>kCapCount</a> = <a href='#SkPaint_kLast_Cap'>kLast_Cap</a> + 1; |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 104 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 105 | enum <a href='#SkPaint_Join'>Join</a> : uint8_t { |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 106 | <a href='#SkPaint_kMiter_Join'>kMiter_Join</a>, |
| 107 | <a href='#SkPaint_kRound_Join'>kRound_Join</a>, |
| 108 | <a href='#SkPaint_kBevel_Join'>kBevel_Join</a>, |
| 109 | <a href='#SkPaint_kLast_Join'>kLast_Join</a> = <a href='#SkPaint_kBevel_Join'>kBevel_Join</a>, |
| 110 | <a href='#SkPaint_kDefault_Join'>kDefault_Join</a> = <a href='#SkPaint_kMiter_Join'>kMiter_Join</a>, |
| 111 | }; |
| 112 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 113 | static constexpr int <a href='#SkPaint_kJoinCount'>kJoinCount</a> = <a href='#SkPaint_kLast_Join'>kLast_Join</a> + 1; |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 114 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 115 | <a href='#SkPaint_Cap'>Cap</a> <a href='#SkPaint_getStrokeCap'>getStrokeCap</a>() const; |
| 116 | void <a href='#SkPaint_setStrokeCap'>setStrokeCap</a>(<a href='#SkPaint_Cap'>Cap</a> cap); |
| 117 | <a href='#SkPaint_Join'>Join</a> <a href='#SkPaint_getStrokeJoin'>getStrokeJoin</a>() const; |
| 118 | void <a href='#SkPaint_setStrokeJoin'>setStrokeJoin</a>(<a href='#SkPaint_Join'>Join</a> join); |
| 119 | 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, |
| 120 | <a href='undocumented#SkScalar'>SkScalar</a> resScale = 1) const; |
| 121 | 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; |
| 122 | <a href='undocumented#SkShader'>SkShader</a>* <a href='#SkPaint_getShader'>getShader</a>() const; |
| 123 | <a href='undocumented#sk_sp'>sk_sp</a><<a href='undocumented#SkShader'>SkShader</a>> <a href='#SkPaint_refShader'>refShader</a>() const; |
| 124 | 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>); |
| 125 | <a href='undocumented#SkColorFilter'>SkColorFilter</a>* <a href='#SkPaint_getColorFilter'>getColorFilter</a>() const; |
| 126 | <a href='undocumented#sk_sp'>sk_sp</a><<a href='undocumented#SkColorFilter'>SkColorFilter</a>> <a href='#SkPaint_refColorFilter'>refColorFilter</a>() const; |
| 127 | void <a href='#SkPaint_setColorFilter'>setColorFilter</a>(<a href='undocumented#sk_sp'>sk_sp</a><<a href='undocumented#SkColorFilter'>SkColorFilter</a>> colorFilter); |
| 128 | <a href='SkBlendMode_Reference#SkBlendMode'>SkBlendMode</a> <a href='#SkPaint_getBlendMode'>getBlendMode</a>() const; |
| 129 | bool <a href='#SkPaint_isSrcOver'>isSrcOver</a>() const; |
| 130 | void <a href='#SkPaint_setBlendMode'>setBlendMode</a>(<a href='SkBlendMode_Reference#SkBlendMode'>SkBlendMode</a> mode); |
| 131 | <a href='undocumented#SkPathEffect'>SkPathEffect</a>* <a href='#SkPaint_getPathEffect'>getPathEffect</a>() const; |
| 132 | <a href='undocumented#sk_sp'>sk_sp</a><<a href='undocumented#SkPathEffect'>SkPathEffect</a>> <a href='#SkPaint_refPathEffect'>refPathEffect</a>() const; |
| 133 | void <a href='#SkPaint_setPathEffect'>setPathEffect</a>(<a href='undocumented#sk_sp'>sk_sp</a><<a href='undocumented#SkPathEffect'>SkPathEffect</a>> pathEffect); |
| 134 | <a href='undocumented#SkMaskFilter'>SkMaskFilter</a>* <a href='#SkPaint_getMaskFilter'>getMaskFilter</a>() const; |
| 135 | <a href='undocumented#sk_sp'>sk_sp</a><<a href='undocumented#SkMaskFilter'>SkMaskFilter</a>> <a href='#SkPaint_refMaskFilter'>refMaskFilter</a>() const; |
| 136 | void <a href='#SkPaint_setMaskFilter'>setMaskFilter</a>(<a href='undocumented#sk_sp'>sk_sp</a><<a href='undocumented#SkMaskFilter'>SkMaskFilter</a>> maskFilter); |
| 137 | <a href='undocumented#SkTypeface'>SkTypeface</a>* <a href='#SkPaint_getTypeface'>getTypeface</a>() const; |
| 138 | <a href='undocumented#sk_sp'>sk_sp</a><<a href='undocumented#SkTypeface'>SkTypeface</a>> <a href='#SkPaint_refTypeface'>refTypeface</a>() const; |
| 139 | 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>); |
| 140 | <a href='undocumented#SkImageFilter'>SkImageFilter</a>* <a href='#SkPaint_getImageFilter'>getImageFilter</a>() const; |
| 141 | <a href='undocumented#sk_sp'>sk_sp</a><<a href='undocumented#SkImageFilter'>SkImageFilter</a>> <a href='#SkPaint_refImageFilter'>refImageFilter</a>() const; |
| 142 | void <a href='#SkPaint_setImageFilter'>setImageFilter</a>(<a href='undocumented#sk_sp'>sk_sp</a><<a href='undocumented#SkImageFilter'>SkImageFilter</a>> imageFilter); |
| 143 | <a href='undocumented#SkDrawLooper'>SkDrawLooper</a>* <a href='#SkPaint_getDrawLooper'>getDrawLooper</a>() const; |
| 144 | <a href='undocumented#sk_sp'>sk_sp</a><<a href='undocumented#SkDrawLooper'>SkDrawLooper</a>> <a href='#SkPaint_refDrawLooper'>refDrawLooper</a>() const; |
| 145 | <a href='undocumented#SkDrawLooper'>SkDrawLooper</a>* <a href='#SkPaint_getLooper'>getLooper</a>() const; |
| 146 | void <a href='#SkPaint_setDrawLooper'>setDrawLooper</a>(<a href='undocumented#sk_sp'>sk_sp</a><<a href='undocumented#SkDrawLooper'>SkDrawLooper</a>> drawLooper); |
| 147 | void <a href='#SkPaint_setLooper'>setLooper</a>(<a href='undocumented#sk_sp'>sk_sp</a><<a href='undocumented#SkDrawLooper'>SkDrawLooper</a>> drawLooper); |
| 148 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_getTextSize'>getTextSize</a>() const; |
| 149 | void <a href='#SkPaint_setTextSize'>setTextSize</a>(<a href='undocumented#SkScalar'>SkScalar</a> textSize); |
| 150 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_getTextScaleX'>getTextScaleX</a>() const; |
| 151 | void <a href='#SkPaint_setTextScaleX'>setTextScaleX</a>(<a href='undocumented#SkScalar'>SkScalar</a> scaleX); |
| 152 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_getTextSkewX'>getTextSkewX</a>() const; |
| 153 | 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] | 154 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 155 | enum <a href='#SkPaint_TextEncoding'>TextEncoding</a> : uint8_t { |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 156 | <a href='#SkPaint_kUTF8_TextEncoding'>kUTF8_TextEncoding</a>, |
| 157 | <a href='#SkPaint_kUTF16_TextEncoding'>kUTF16_TextEncoding</a>, |
| 158 | <a href='#SkPaint_kUTF32_TextEncoding'>kUTF32_TextEncoding</a>, |
| 159 | <a href='#SkPaint_kGlyphID_TextEncoding'>kGlyphID_TextEncoding</a>, |
| 160 | }; |
| 161 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 162 | <a href='#SkPaint_TextEncoding'>TextEncoding</a> <a href='#SkPaint_getTextEncoding'>getTextEncoding</a>() const; |
| 163 | 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] | 164 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 165 | 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] | 166 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 167 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_getFontMetrics'>getFontMetrics</a>(<a href='undocumented#SkFontMetrics'>SkFontMetrics</a>* metrics) const; |
| 168 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_getFontSpacing'>getFontSpacing</a>() const; |
| 169 | int <a href='#SkPaint_textToGlyphs'>textToGlyphs</a>(const void* <a href='undocumented#Text'>text</a>, size_t byteLength, |
| 170 | <a href='undocumented#SkGlyphID'>SkGlyphID</a> <a href='undocumented#Glyph'>glyphs</a>[]) const; |
| 171 | bool <a href='#SkPaint_containsText'>containsText</a>(const void* <a href='undocumented#Text'>text</a>, size_t byteLength) const; |
| 172 | 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; |
| 173 | int <a href='#SkPaint_countText'>countText</a>(const void* <a href='undocumented#Text'>text</a>, size_t byteLength) const; |
| 174 | <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; |
| 175 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_measureText'>measureText</a>(const void* <a href='undocumented#Text'>text</a>, size_t length) const; |
| 176 | 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, |
| 177 | <a href='undocumented#SkScalar'>SkScalar</a>* measuredWidth = nullptr) const; |
| 178 | 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[], |
| 179 | <a href='SkRect_Reference#SkRect'>SkRect</a> bounds[] = nullptr) const; |
| 180 | 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, |
| 181 | <a href='SkPath_Reference#SkPath'>SkPath</a>* <a href='SkPath_Reference#Path'>path</a>) const; |
| 182 | void <a href='#SkPaint_getPosTextPath'>getPosTextPath</a>(const void* <a href='undocumented#Text'>text</a>, size_t length, |
| 183 | const <a href='SkPoint_Reference#SkPoint'>SkPoint</a> pos[], <a href='SkPath_Reference#SkPath'>SkPath</a>* <a href='SkPath_Reference#Path'>path</a>) const; |
| 184 | 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, |
| 185 | const <a href='undocumented#SkScalar'>SkScalar</a> bounds[2], <a href='undocumented#SkScalar'>SkScalar</a>* intervals) const; |
| 186 | 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[], |
| 187 | const <a href='undocumented#SkScalar'>SkScalar</a> bounds[2], <a href='undocumented#SkScalar'>SkScalar</a>* intervals) const; |
| 188 | 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[], |
| 189 | <a href='undocumented#SkScalar'>SkScalar</a> constY, const <a href='undocumented#SkScalar'>SkScalar</a> bounds[2], <a href='undocumented#SkScalar'>SkScalar</a>* intervals) const; |
| 190 | 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], |
| 191 | <a href='undocumented#SkScalar'>SkScalar</a>* intervals) const; |
| 192 | <a href='SkRect_Reference#SkRect'>SkRect</a> <a href='#SkPaint_getFontBounds'>getFontBounds</a>() const; |
| 193 | bool <a href='#SkPaint_nothingToDraw'>nothingToDraw</a>() const; |
| 194 | bool <a href='#SkPaint_canComputeFastBounds'>canComputeFastBounds</a>() const; |
| 195 | const <a href='SkRect_Reference#SkRect'>SkRect</a>& <a href='#SkPaint_computeFastBounds'>computeFastBounds</a>(const <a href='SkRect_Reference#SkRect'>SkRect</a>& orig, <a href='SkRect_Reference#SkRect'>SkRect</a>* storage) const; |
| 196 | const <a href='SkRect_Reference#SkRect'>SkRect</a>& <a href='#SkPaint_computeFastStrokeBounds'>computeFastStrokeBounds</a>(const <a href='SkRect_Reference#SkRect'>SkRect</a>& orig, |
| 197 | <a href='SkRect_Reference#SkRect'>SkRect</a>* storage) const; |
| 198 | const <a href='SkRect_Reference#SkRect'>SkRect</a>& <a href='#SkPaint_doComputeFastBounds'>doComputeFastBounds</a>(const <a href='SkRect_Reference#SkRect'>SkRect</a>& orig, <a href='SkRect_Reference#SkRect'>SkRect</a>* storage, |
| 199 | <a href='#SkPaint_Style'>Style</a> style) const; |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 200 | }; |
| 201 | </pre> |
| 202 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 203 | <a href='SkPaint_Reference#Paint'>Paint</a> controls options applied when drawing and measuring. <a href='SkPaint_Reference#Paint'>Paint</a> collects all |
| 204 | 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] | 205 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 206 | 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] | 207 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 208 | Some options may not be implemented on all platforms; in these cases, setting |
| 209 | the option has no effect. Some options are conveniences that duplicate <a href='SkCanvas_Reference#Canvas'>Canvas</a> |
| 210 | 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] | 211 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 212 | <a href='SkPaint_Reference#Paint'>Paint</a> options are rarely exclusive; each option modifies a stage of the drawing |
| 213 | 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] | 214 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 215 | <a href='SkPaint_Reference#Paint'>Paint</a> collects effects and filters that describe single-pass and multiple-pass |
| 216 | algorithms that alter the drawing geometry, <a href='SkColor_Reference#Color'>color</a>, and transparency. For instance, |
| 217 | <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] | 218 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 219 | 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> |
| 220 | to affect it. The implementation is free to defer computations associated with the |
| 221 | <a href='SkPaint_Reference#Paint'>Paint</a>, or ignore them altogether. For instance, some GPU implementations draw all |
| 222 | <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> |
| 223 | is set in <a href='SkPaint_Reference#Paint'>Paint</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 224 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 225 | <a href='SkPaint_Reference#Paint'>Paint</a> describes a single <a href='SkColor_Reference#Color'>color</a>, a single <a href='undocumented#Font'>font</a>, a single <a href='SkImage_Reference#Image'>image</a> quality, and so on. |
| 226 | Multiple colors are drawn either by using multiple paints or with objects like |
| 227 | <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] | 228 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 229 | <a name='SkPaint_empty_constructor'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 230 | |
| 231 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 232 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 233 | <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] | 234 | <a href='#SkPaint_empty_constructor'>SkPaint()</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 235 | </pre> |
| 236 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 237 | Constructs <a href='SkPaint_Reference#Paint'>Paint</a> with default values. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 238 | |
| 239 | | attribute | default value | |
| 240 | | --- | --- | |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 241 | | <a href='#Paint_Anti_Alias'>Anti_Alias</a> | false | |
| 242 | | <a href='#Blend_Mode'>Blend_Mode</a> | <a href='SkBlendMode_Reference#SkBlendMode'>SkBlendMode</a>::<a href='#SkBlendMode_kSrcOver'>kSrcOver</a> | |
| 243 | | <a href='SkColor_Reference#Color'>Color</a> | <a href='SkColor_Reference#SK_ColorBLACK'>SK_ColorBLACK</a> | |
| 244 | | <a href='#Color_Alpha'>Color_Alpha</a> | 255 | |
| 245 | | <a href='#Color_Filter'>Color_Filter</a> | nullptr | |
| 246 | | Dither | false | |
| 247 | | <a href='#Draw_Looper'>Draw_Looper</a> | nullptr | |
| 248 | | <a href='#Paint_Fake_Bold'>Fake_Bold</a> | false | |
| 249 | | <a href='#Filter_Quality'>Filter_Quality</a> | <a href='undocumented#kNone_SkFilterQuality'>kNone_SkFilterQuality</a> | |
| 250 | | <a href='#Paint_Font_Embedded_Bitmaps'>Font_Embedded_Bitmaps</a> | false | |
| 251 | | <a href='#Paint_Automatic_Hinting'>Automatic_Hinting</a> | false | |
| 252 | | <a href='#Paint_Full_Hinting_Spacing'>Full_Hinting_Spacing</a> | false | |
Cary Clark | 8cc4cdc | 2018-11-09 23:16:58 -0500 | [diff] [blame] | 253 | | <a href='#SkPaint_Hinting'>Hinting</a> | <a href='undocumented#SkFontHinting'>SkFontHinting</a>::<a href='#SkFontHinting_kNormal'>kNormal</a> | |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 254 | | <a href='#Image_Filter'>Image_Filter</a> | nullptr | |
| 255 | | <a href='#Paint_LCD_Text'>LCD_Text</a> | false | |
| 256 | | <a href='#Paint_Linear_Text'>Linear_Text</a> | false | |
| 257 | | <a href='#Paint_Miter_Limit'>Miter_Limit</a> | 4 | |
| 258 | | <a href='#Mask_Filter'>Mask_Filter</a> | nullptr | |
| 259 | | <a href='#Path_Effect'>Path_Effect</a> | nullptr | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 260 | | <a href='undocumented#Shader'>Shader</a> | nullptr | |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 261 | | <a href='#SkPaint_Style'>Style</a> | <a href='#SkPaint_kFill_Style'>kFill_Style</a> | |
| 262 | | <a href='#Paint_Text_Encoding'>Text_Encoding</a> | <a href='#SkPaint_kUTF8_TextEncoding'>kUTF8_TextEncoding</a> | |
| 263 | | <a href='#Paint_Text_Scale_X'>Text_Scale_X</a> | 1 | |
| 264 | | <a href='#Paint_Text_Size'>Text_Size</a> | 12 | |
| 265 | | <a href='#Paint_Text_Skew_X'>Text_Skew_X</a> | 0 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 266 | | <a href='undocumented#Typeface'>Typeface</a> | nullptr | |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 267 | | <a href='#Paint_Stroke_Cap'>Stroke_Cap</a> | <a href='#SkPaint_kButt_Cap'>kButt_Cap</a> | |
| 268 | | <a href='#Paint_Stroke_Join'>Stroke_Join</a> | <a href='#SkPaint_kMiter_Join'>kMiter_Join</a> | |
| 269 | | <a href='#Paint_Stroke_Width'>Stroke_Width</a> | 0 | |
| 270 | | <a href='#Paint_Subpixel_Text'>Subpixel_Text</a> | false | |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 271 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 272 | 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 |
| 273 | <a href='SkPaint_Reference#Paint'>paint</a> default values. The overrides may be included in "SkUserConfig.h" or predefined by the |
| 274 | build system. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 275 | |
| 276 | ### Return Value |
| 277 | |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 278 | default initialized <a href='SkPaint_Reference#Paint'>Paint</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 279 | |
| 280 | ### Example |
| 281 | |
| 282 | <div><fiddle-embed name="c4b2186d85c142a481298f7144295ffd"></fiddle-embed></div> |
| 283 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 284 | <a name='SkPaint_copy_const_SkPaint'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 285 | |
| 286 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 287 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 288 | <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] | 289 | <a href='SkPaint_Reference#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] | 290 | </pre> |
| 291 | |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 292 | 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] | 293 | <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 |
| 294 | 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] | 295 | their references by one. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 296 | |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 297 | 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] | 298 | <a href='undocumented#SkDrawLooper'>SkDrawLooper</a>, and <a href='undocumented#SkImageFilter'>SkImageFilter</a> cannot be modified after they are created. |
| 299 | 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] | 300 | |
| 301 | ### Parameters |
| 302 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 303 | <table> <tr> <td><a name='SkPaint_copy_const_SkPaint_paint'><code><strong>paint</strong></code></a></td> |
| 304 | <td>original to copy</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 305 | </tr> |
| 306 | </table> |
| 307 | |
| 308 | ### Return Value |
| 309 | |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 310 | shallow copy of <a href='#SkPaint_copy_const_SkPaint_paint'>paint</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 311 | |
| 312 | ### Example |
| 313 | |
skia-bookmaker | 44bad2e | 2018-07-05 05:35:27 +0000 | [diff] [blame] | 314 | <div><fiddle-embed name="b99971ad0ef243d617925289d963b62d"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 315 | |
| 316 | #### Example Output |
| 317 | |
| 318 | ~~~~ |
| 319 | SK_ColorRED == paint1.getColor() |
| 320 | SK_ColorBLUE == paint2.getColor() |
| 321 | ~~~~ |
| 322 | |
| 323 | </fiddle-embed></div> |
| 324 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 325 | <a name='SkPaint_move_SkPaint'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 326 | |
| 327 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 328 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 329 | <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] | 330 | <a href='SkPaint_Reference#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] | 331 | </pre> |
| 332 | |
Cary Clark | d0530ba | 2017-09-14 11:25:39 -0400 | [diff] [blame] | 333 | Implements a move constructor to avoid increasing the reference counts |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 334 | 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] | 335 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 336 | 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] | 337 | |
| 338 | ### Parameters |
| 339 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 340 | <table> <tr> <td><a name='SkPaint_move_SkPaint_paint'><code><strong>paint</strong></code></a></td> |
| 341 | <td>original to move</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 342 | </tr> |
| 343 | </table> |
| 344 | |
| 345 | ### Return Value |
| 346 | |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 347 | content of <a href='#SkPaint_move_SkPaint_paint'>paint</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 348 | |
| 349 | ### Example |
| 350 | |
Cary Clark | 8364706 | 2018-07-18 16:21:51 -0400 | [diff] [blame] | 351 | <div><fiddle-embed name="8ed1488a503cd5282b86a51614aa90b1"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 352 | |
| 353 | #### Example Output |
| 354 | |
| 355 | ~~~~ |
| 356 | path effect unique: true |
| 357 | ~~~~ |
| 358 | |
| 359 | </fiddle-embed></div> |
| 360 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 361 | <a name='SkPaint_reset'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 362 | |
| 363 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 364 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 365 | <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] | 366 | void <a href='#SkPaint_reset'>reset()</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 367 | </pre> |
| 368 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 369 | Sets all <a href='SkPaint_Reference#SkPaint'>SkPaint</a> contents to their initial values. This is equivalent to replacing |
| 370 | <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] | 371 | |
| 372 | ### Example |
| 373 | |
| 374 | <div><fiddle-embed name="ef269937ade7e7353635121d9a64f9f7"> |
| 375 | |
| 376 | #### Example Output |
| 377 | |
| 378 | ~~~~ |
| 379 | paint1 == paint2 |
| 380 | ~~~~ |
| 381 | |
| 382 | </fiddle-embed></div> |
| 383 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 384 | <a name='SkPaint_destructor'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 385 | |
| 386 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 387 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 388 | <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] | 389 | ~<a href='#SkPaint_empty_constructor'>SkPaint()</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 390 | </pre> |
| 391 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 392 | 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>, |
| 393 | <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 |
| 394 | 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] | 395 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 396 | <a name='Management'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 397 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 398 | <a name='SkPaint_copy_operator'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 399 | |
| 400 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 401 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 402 | <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] | 403 | <a href='SkPaint_Reference#SkPaint'>SkPaint</a>& operator=(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] | 404 | </pre> |
| 405 | |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 406 | 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] | 407 | <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 |
| 408 | 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] | 409 | 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] | 410 | resulting count is zero. Objects containing <a href='undocumented#SkRefCnt'>SkRefCnt</a> in the parameter <a href='#SkPaint_copy_operator_paint'>paint</a> |
| 411 | 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] | 412 | |
| 413 | ### Parameters |
| 414 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 415 | <table> <tr> <td><a name='SkPaint_copy_operator_paint'><code><strong>paint</strong></code></a></td> |
| 416 | <td>original to copy</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 417 | </tr> |
| 418 | </table> |
| 419 | |
| 420 | ### Return Value |
| 421 | |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 422 | content of <a href='#SkPaint_copy_operator_paint'>paint</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 423 | |
| 424 | ### Example |
| 425 | |
| 426 | <div><fiddle-embed name="b476a9088f80dece176ed577807d3992"> |
| 427 | |
| 428 | #### Example Output |
| 429 | |
| 430 | ~~~~ |
| 431 | SK_ColorRED == paint1.getColor() |
| 432 | SK_ColorRED == paint2.getColor() |
| 433 | ~~~~ |
| 434 | |
| 435 | </fiddle-embed></div> |
| 436 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 437 | <a name='SkPaint_move_operator'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 438 | |
| 439 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 440 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 441 | <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] | 442 | <a href='SkPaint_Reference#SkPaint'>SkPaint</a>& operator=(<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] | 443 | </pre> |
| 444 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 445 | Moves the <a href='#SkPaint_move_operator_paint'>paint</a> to avoid increasing the reference counts |
| 446 | 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] | 447 | prior destination are decreased by one; those objects are deleted if the resulting count |
| 448 | is zero. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 449 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 450 | 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] | 451 | |
| 452 | ### Parameters |
| 453 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 454 | <table> <tr> <td><a name='SkPaint_move_operator_paint'><code><strong>paint</strong></code></a></td> |
| 455 | <td>original to move</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 456 | </tr> |
| 457 | </table> |
| 458 | |
| 459 | ### Return Value |
| 460 | |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 461 | content of <a href='#SkPaint_move_operator_paint'>paint</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 462 | |
| 463 | ### Example |
| 464 | |
Ravi Mistry | 874e22b | 2018-07-19 03:49:13 +0000 | [diff] [blame] | 465 | <div><fiddle-embed name="9fb7459b097d713f5f1fe5675afe14f5"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 466 | |
| 467 | #### Example Output |
| 468 | |
| 469 | ~~~~ |
| 470 | SK_ColorRED == paint2.getColor() |
| 471 | ~~~~ |
| 472 | |
| 473 | </fiddle-embed></div> |
| 474 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 475 | <a name='SkPaint_equal_operator'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 476 | |
| 477 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 478 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 479 | <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] | 480 | bool operator==(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] | 481 | </pre> |
| 482 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 483 | 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] | 484 | 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] | 485 | <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] | 486 | |
| 487 | ### Parameters |
| 488 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 489 | <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] | 490 | <td><a href='SkPaint_Reference#SkPaint'>SkPaint</a> to compare</td> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 491 | </tr> |
| 492 | <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] | 493 | <td><a href='SkPaint_Reference#SkPaint'>SkPaint</a> to compare</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 494 | </tr> |
| 495 | </table> |
| 496 | |
| 497 | ### Return Value |
| 498 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 499 | true if <a href='SkPaint_Reference#SkPaint'>SkPaint</a> pair are equivalent |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 500 | |
| 501 | ### Example |
| 502 | |
| 503 | <div><fiddle-embed name="7481a948e34672720337a631830586dd"> |
| 504 | |
| 505 | #### Example Output |
| 506 | |
| 507 | ~~~~ |
| 508 | paint1 == paint2 |
| 509 | paint1 != paint2 |
| 510 | ~~~~ |
| 511 | |
| 512 | </fiddle-embed></div> |
| 513 | |
Cary Clark | 06c20f3 | 2018-03-20 15:53:27 -0400 | [diff] [blame] | 514 | ### See Also |
| 515 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 516 | <a href='#SkPaint_notequal_operator'>operator!=(const SkPaint& a, const SkPaint& b)</a> |
Cary Clark | 06c20f3 | 2018-03-20 15:53:27 -0400 | [diff] [blame] | 517 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 518 | <a name='SkPaint_notequal_operator'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 519 | |
| 520 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 521 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 522 | <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] | 523 | bool operator!=(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] | 524 | </pre> |
| 525 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 526 | 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] | 527 | 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] | 528 | <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] | 529 | |
| 530 | ### Parameters |
| 531 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 532 | <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] | 533 | <td><a href='SkPaint_Reference#SkPaint'>SkPaint</a> to compare</td> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 534 | </tr> |
| 535 | <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] | 536 | <td><a href='SkPaint_Reference#SkPaint'>SkPaint</a> to compare</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 537 | </tr> |
| 538 | </table> |
| 539 | |
| 540 | ### Return Value |
| 541 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 542 | 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] | 543 | |
| 544 | ### Example |
| 545 | |
skia-bookmaker | a717ca9 | 2018-07-08 05:32:09 +0000 | [diff] [blame] | 546 | <div><fiddle-embed name="b6c8484b1187f555b435ad5369833be4"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 547 | |
| 548 | #### Example Output |
| 549 | |
| 550 | ~~~~ |
| 551 | paint1 == paint2 |
| 552 | paint1 == paint2 |
| 553 | ~~~~ |
| 554 | |
| 555 | </fiddle-embed></div> |
| 556 | |
Cary Clark | 06c20f3 | 2018-03-20 15:53:27 -0400 | [diff] [blame] | 557 | ### See Also |
| 558 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 559 | <a href='#SkPaint_equal_operator'>operator==(const SkPaint& a, const SkPaint& b)</a> |
Cary Clark | 06c20f3 | 2018-03-20 15:53:27 -0400 | [diff] [blame] | 560 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 561 | <a name='SkPaint_getHash'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 562 | |
| 563 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 564 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 565 | <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] | 566 | uint32_t <a href='#SkPaint_getHash'>getHash</a>() const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 567 | </pre> |
| 568 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 569 | 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] | 570 | Identical hashes guarantee that the paints are |
| 571 | equivalent, but differing hashes do not guarantee that the paints have differing |
| 572 | contents. |
| 573 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 574 | If If<a href='#SkPaint_equal_operator'>operator==(const SkPaint& a, const SkPaint& b)</a> returns true for two paints, |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 575 | their hashes are also equal. |
| 576 | |
| 577 | The hash returned is platform and implementation specific. |
| 578 | |
| 579 | ### Return Value |
| 580 | |
| 581 | a shallow hash |
| 582 | |
| 583 | ### Example |
| 584 | |
Cary Clark | 8364706 | 2018-07-18 16:21:51 -0400 | [diff] [blame] | 585 | <div><fiddle-embed name="7f7e1b701361912b344f90ae6b530393"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 586 | |
| 587 | #### Example Output |
| 588 | |
| 589 | ~~~~ |
| 590 | paint1 == paint2 |
| 591 | paint1.getHash() == paint2.getHash() |
| 592 | ~~~~ |
| 593 | |
| 594 | </fiddle-embed></div> |
| 595 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 596 | <a name='Hinting'></a> |
| 597 | |
Cary Clark | 8cc4cdc | 2018-11-09 23:16:58 -0500 | [diff] [blame] | 598 | <a name='SkPaint_Hinting'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 599 | |
| 600 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 601 | |
Cary Clark | 8cc4cdc | 2018-11-09 23:16:58 -0500 | [diff] [blame] | 602 | <pre style="padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0"> |
| 603 | enum <a href='#SkPaint_Hinting'>Hinting</a> : uint8_t { |
| 604 | <a href='#SkPaint_kNo_Hinting'>kNo_Hinting</a> = 0, |
| 605 | <a href='#SkPaint_kSlight_Hinting'>kSlight_Hinting</a> = 1, |
| 606 | <a href='#SkPaint_kNormal_Hinting'>kNormal_Hinting</a> = 2, |
| 607 | <a href='#SkPaint_kFull_Hinting'>kFull_Hinting</a> = 3, |
| 608 | }; |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 609 | </pre> |
| 610 | |
Cary Clark | 8cc4cdc | 2018-11-09 23:16:58 -0500 | [diff] [blame] | 611 | ### Constants |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 612 | |
Cary Clark | 8cc4cdc | 2018-11-09 23:16:58 -0500 | [diff] [blame] | 613 | <table style='border-collapse: collapse; width: 62.5em'> |
| 614 | <tr><th style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>Const</th> |
| 615 | <th style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>Value</th> |
| 616 | <th style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>Description</th></tr> |
| 617 | <tr style='background-color: #f0f0f0; '> |
| 618 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kNo_Hinting'><code>SkPaint::kNo_Hinting</code></a></td> |
| 619 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>0</td> |
| 620 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 621 | Deprecated. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 622 | |
Cary Clark | 8cc4cdc | 2018-11-09 23:16:58 -0500 | [diff] [blame] | 623 | </td> |
| 624 | </tr> |
| 625 | <tr> |
| 626 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kSlight_Hinting'><code>SkPaint::kSlight_Hinting</code></a></td> |
| 627 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>1</td> |
| 628 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 629 | Deprecated. |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 630 | |
Cary Clark | 8cc4cdc | 2018-11-09 23:16:58 -0500 | [diff] [blame] | 631 | </td> |
| 632 | </tr> |
| 633 | <tr style='background-color: #f0f0f0; '> |
| 634 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kNormal_Hinting'><code>SkPaint::kNormal_Hinting</code></a></td> |
| 635 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>2</td> |
| 636 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 637 | Deprecated. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 638 | |
Cary Clark | 8cc4cdc | 2018-11-09 23:16:58 -0500 | [diff] [blame] | 639 | </td> |
| 640 | </tr> |
| 641 | <tr> |
| 642 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kFull_Hinting'><code>SkPaint::kFull_Hinting</code></a></td> |
| 643 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>3</td> |
| 644 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 645 | Deprecated. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 646 | |
Cary Clark | 8cc4cdc | 2018-11-09 23:16:58 -0500 | [diff] [blame] | 647 | </td> |
| 648 | </tr> |
| 649 | </table> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 650 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 651 | <a name='SkPaint_setHinting'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 652 | |
| 653 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 654 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 655 | <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] | 656 | 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] | 657 | </pre> |
| 658 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 659 | Sets level of <a href='undocumented#Glyph'>glyph</a> outline adjustment. |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 660 | 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] | 661 | |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 662 | ### Parameters |
| 663 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 664 | <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] | 665 | <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] | 666 | </tr> |
| 667 | </table> |
| 668 | |
Cary Clark | 885f107 | 2018-11-08 13:31:39 -0500 | [diff] [blame] | 669 | <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] | 670 | |
| 671 | ### Example |
| 672 | |
| 673 | <div><fiddle-embed name="197268a89c3343f600b9bade61c513ae"> |
| 674 | |
| 675 | #### Example Output |
| 676 | |
| 677 | ~~~~ |
| 678 | paint1 == paint2 |
| 679 | ~~~~ |
| 680 | |
| 681 | </fiddle-embed></div> |
| 682 | |
Cary Clark | 8cc4cdc | 2018-11-09 23:16:58 -0500 | [diff] [blame] | 683 | <a name='SkPaint_getHinting'></a> |
| 684 | |
| 685 | --- |
| 686 | |
| 687 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 688 | <a href='#SkPaint_Hinting'>Hinting</a> <a href='#SkPaint_getHinting'>getHinting</a>() const |
| 689 | </pre> |
| 690 | |
| 691 | Returns level of <a href='undocumented#Glyph'>glyph</a> outline adjustment. |
| 692 | |
| 693 | ### Return Value |
| 694 | |
| 695 | one of: <a href='#SkPaint_kNo_Hinting'>kNo_Hinting</a>, <a href='#SkPaint_kSlight_Hinting'>kSlight_Hinting</a>, <a href='#SkPaint_kNormal_Hinting'>kNormal_Hinting</a>, <a href='#SkPaint_kFull_Hinting'>kFull_Hinting</a> |
| 696 | |
| 697 | <a name='SkPaint_setHinting_2'></a> |
| 698 | |
| 699 | --- |
| 700 | |
| 701 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 702 | void <a href='#SkPaint_setHinting'>setHinting</a>(<a href='#SkPaint_Hinting'>Hinting</a> h) |
| 703 | </pre> |
| 704 | |
| 705 | Sets level of <a href='undocumented#Glyph'>glyph</a> outline adjustment. |
| 706 | Does not check for valid values of <a href='#SkPaint_setHinting_2_h'>h</a>. |
| 707 | |
| 708 | ### Parameters |
| 709 | |
| 710 | <table> <tr> <td><a name='SkPaint_setHinting_2_h'><code><strong>h</strong></code></a></td> |
| 711 | <td>one of: <a href='#SkPaint_kNo_Hinting'>kNo_Hinting</a>, <a href='#SkPaint_kSlight_Hinting'>kSlight_Hinting</a>, <a href='#SkPaint_kNormal_Hinting'>kNormal_Hinting</a>, <a href='#SkPaint_kFull_Hinting'>kFull_Hinting</a></td> |
| 712 | </tr> |
| 713 | </table> |
| 714 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 715 | <a name='Flags'></a> |
| 716 | |
| 717 | <a name='SkPaint_Flags'></a> |
| 718 | |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 719 | --- |
| 720 | |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 721 | <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] | 722 | enum <a href='#SkPaint_Flags'>Flags</a> { |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 723 | <a href='#SkPaint_kAntiAlias_Flag'>kAntiAlias_Flag</a> = 0x01, |
| 724 | <a href='#SkPaint_kDither_Flag'>kDither_Flag</a> = 0x04, |
| 725 | <a href='#SkPaint_kFakeBoldText_Flag'>kFakeBoldText_Flag</a> = 0x20, |
| 726 | <a href='#SkPaint_kLinearText_Flag'>kLinearText_Flag</a> = 0x40, |
| 727 | <a href='#SkPaint_kSubpixelText_Flag'>kSubpixelText_Flag</a> = 0x80, |
| 728 | <a href='#SkPaint_kLCDRenderText_Flag'>kLCDRenderText_Flag</a> = 0x200, |
| 729 | <a href='#SkPaint_kEmbeddedBitmapText_Flag'>kEmbeddedBitmapText_Flag</a> = 0x400, |
| 730 | <a href='#SkPaint_kAutoHinting_Flag'>kAutoHinting_Flag</a> = 0x800, |
| 731 | <a href='#SkPaint_kAllFlags'>kAllFlags</a> = 0xFFFF, |
Cary Clark | 186d08f | 2018-04-03 08:43:27 -0400 | [diff] [blame] | 732 | }; |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 733 | </pre> |
| 734 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 735 | The bit values stored in <a href='#SkPaint_Flags'>Flags</a>. |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 736 | The default value for <a href='#SkPaint_Flags'>Flags</a>, normally zero, can be changed at compile time |
| 737 | with a custom definition of <a href='undocumented#SkPaintDefaults_Flags'>SkPaintDefaults_Flags</a>. |
| 738 | All flags can be read and written explicitly; <a href='#SkPaint_Flags'>Flags</a> allows manipulating |
| 739 | multiple settings at once. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 740 | |
| 741 | ### Constants |
| 742 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 743 | <table style='border-collapse: collapse; width: 62.5em'> |
| 744 | <tr><th style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>Const</th> |
| 745 | <th style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>Value</th> |
| 746 | <th style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>Description</th></tr> |
| 747 | <tr style='background-color: #f0f0f0; '> |
| 748 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kAntiAlias_Flag'><code>SkPaint::kAntiAlias_Flag</code></a></td> |
| 749 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>0x0001</td> |
| 750 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
Cary Clark | ffb3d68 | 2018-05-17 12:17:28 -0400 | [diff] [blame] | 751 | mask for setting Anti_Alias</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 752 | </tr> |
| 753 | <tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 754 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kDither_Flag'><code>SkPaint::kDither_Flag</code></a></td> |
| 755 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>0x0004</td> |
| 756 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 757 | mask for setting Dither</td> |
| 758 | </tr> |
| 759 | <tr style='background-color: #f0f0f0; '> |
| 760 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kFakeBoldText_Flag'><code>SkPaint::kFakeBoldText_Flag</code></a></td> |
| 761 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>0x0020</td> |
| 762 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 763 | mask for setting Fake_Bold</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 764 | </tr> |
| 765 | <tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 766 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kLinearText_Flag'><code>SkPaint::kLinearText_Flag</code></a></td> |
| 767 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>0x0040</td> |
| 768 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 769 | mask for setting Linear_Text</td> |
| 770 | </tr> |
| 771 | <tr style='background-color: #f0f0f0; '> |
| 772 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kSubpixelText_Flag'><code>SkPaint::kSubpixelText_Flag</code></a></td> |
| 773 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>0x0080</td> |
| 774 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 775 | mask for setting Subpixel_Text</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 776 | </tr> |
| 777 | <tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 778 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kLCDRenderText_Flag'><code>SkPaint::kLCDRenderText_Flag</code></a></td> |
| 779 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>0x0200</td> |
| 780 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 781 | mask for setting LCD_Text</td> |
| 782 | </tr> |
| 783 | <tr style='background-color: #f0f0f0; '> |
| 784 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kEmbeddedBitmapText_Flag'><code>SkPaint::kEmbeddedBitmapText_Flag</code></a></td> |
| 785 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>0x0400</td> |
| 786 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 787 | mask for setting Font_Embedded_Bitmaps</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 788 | </tr> |
| 789 | <tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 790 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kAutoHinting_Flag'><code>SkPaint::kAutoHinting_Flag</code></a></td> |
| 791 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>0x0800</td> |
| 792 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 793 | mask for setting Automatic_Hinting</td> |
| 794 | </tr> |
| 795 | <tr style='background-color: #f0f0f0; '> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 796 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kAllFlags'><code>SkPaint::kAllFlags</code></a></td> |
| 797 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>0xFFFF</td> |
| 798 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 799 | 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] | 800 | </td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 801 | </tr> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 802 | <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] | 803 | </table> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 804 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 805 | <a name='SkPaint_ReserveFlags'></a> |
| 806 | |
| 807 | --- |
Cary Clark | 06c20f3 | 2018-03-20 15:53:27 -0400 | [diff] [blame] | 808 | |
Cary Clark | e8161dd | 2018-09-06 12:47:04 -0400 | [diff] [blame] | 809 | To be deprecated soon. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 810 | |
Cary Clark | e8161dd | 2018-09-06 12:47:04 -0400 | [diff] [blame] | 811 | Only valid for Android framework. |
Cary Clark | 4855f78 | 2018-02-06 09:41:53 -0500 | [diff] [blame] | 812 | |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 813 | <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] | 814 | enum <a href='#SkPaint_ReserveFlags'>ReserveFlags</a> { |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 815 | <a href='#SkPaint_kUnderlineText_ReserveFlag'>kUnderlineText_ReserveFlag</a> = 0x08, |
| 816 | <a href='#SkPaint_kStrikeThruText_ReserveFlag'>kStrikeThruText_ReserveFlag</a> = 0x10, |
Cary Clark | 186d08f | 2018-04-03 08:43:27 -0400 | [diff] [blame] | 817 | }; |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 818 | </pre> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 819 | |
| 820 | ### Constants |
| 821 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 822 | <table style='border-collapse: collapse; width: 62.5em'> |
| 823 | <tr><th style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>Const</th> |
| 824 | <th style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>Value</th> |
| 825 | <th style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>Description</th></tr> |
| 826 | <tr style='background-color: #f0f0f0; '> |
| 827 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kUnderlineText_ReserveFlag'><code>SkPaint::kUnderlineText_ReserveFlag</code></a></td> |
| 828 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>0x0008</td> |
| 829 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
Cary Clark | e8161dd | 2018-09-06 12:47:04 -0400 | [diff] [blame] | 830 | To be deprecated soon. |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 831 | |
Cary Clark | e8161dd | 2018-09-06 12:47:04 -0400 | [diff] [blame] | 832 | </td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 833 | </tr> |
| 834 | <tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 835 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kStrikeThruText_ReserveFlag'><code>SkPaint::kStrikeThruText_ReserveFlag</code></a></td> |
| 836 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>0x0010</td> |
| 837 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
Cary Clark | e8161dd | 2018-09-06 12:47:04 -0400 | [diff] [blame] | 838 | To be deprecated soon. |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 839 | |
Cary Clark | e8161dd | 2018-09-06 12:47:04 -0400 | [diff] [blame] | 840 | </td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 841 | </tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 842 | </table> |
Cary Clark | 4855f78 | 2018-02-06 09:41:53 -0500 | [diff] [blame] | 843 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 844 | <a name='SkPaint_getFlags'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 845 | |
| 846 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 847 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 848 | <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] | 849 | uint32_t <a href='#SkPaint_getFlags'>getFlags</a>() const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 850 | </pre> |
| 851 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 852 | 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 |
| 853 | 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] | 854 | |
| 855 | ### Return Value |
| 856 | |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 857 | 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] | 858 | |
| 859 | ### Example |
| 860 | |
| 861 | <div><fiddle-embed name="8a3f8c309533388b01aa66e1267f322d"> |
| 862 | |
| 863 | #### Example Output |
| 864 | |
| 865 | ~~~~ |
| 866 | (SkPaint::kAntiAlias_Flag & paint.getFlags()) != 0 |
| 867 | ~~~~ |
| 868 | |
| 869 | </fiddle-embed></div> |
| 870 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 871 | <a name='SkPaint_setFlags'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 872 | |
| 873 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 874 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 875 | <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] | 876 | void <a href='#SkPaint_setFlags'>setFlags</a>(uint32_t flags) |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 877 | </pre> |
| 878 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 879 | 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. |
| 880 | 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] | 881 | |
| 882 | ### Parameters |
| 883 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 884 | <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] | 885 | <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] | 886 | </tr> |
| 887 | </table> |
| 888 | |
| 889 | ### Example |
| 890 | |
| 891 | <div><fiddle-embed name="54baed3f6bc4b9c31ba664e27767fdc7"> |
| 892 | |
| 893 | #### Example Output |
| 894 | |
| 895 | ~~~~ |
| 896 | paint.isAntiAlias() |
| 897 | paint.isDither() |
| 898 | ~~~~ |
| 899 | |
| 900 | </fiddle-embed></div> |
| 901 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 902 | <a name='Anti_Alias'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 903 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 904 | --- |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 905 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 906 | <a href='#Paint_Anti_Alias'>Anti_Alias</a> drawing approximates partial <a href='undocumented#Pixel'>pixel</a> coverage with transparency. |
| 907 | 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. |
| 908 | 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] | 909 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 910 | The rule for <a href='undocumented#Alias'>Aliased</a> pixels is inconsistent across platforms. A shape edge |
| 911 | 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] | 912 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 913 | <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 |
| 914 | 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] | 915 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 916 | A platform may only support <a href='#Paint_Anti_Alias'>Anti_Aliased</a> drawing. Some GPU-backed platforms use |
| 917 | <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] | 918 | <a href='undocumented#Alias'>Alias</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 919 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 920 | 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] | 921 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 922 | <a href='#Paint_Anti_Alias'>Anti_Alias</a> is disabled by default. |
| 923 | <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> |
| 924 | at compile time. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 925 | |
| 926 | ### Example |
| 927 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 928 | <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. |
| 929 | A blue <a href='undocumented#Line'>line</a> draws only where the <a href='undocumented#Pixel'>pixel</a> centers are contained. |
| 930 | The <a href='undocumented#Line'>lines</a> are drawn into <a href='SkBitmap_Reference#Bitmap'>Bitmap</a>, then drawn magnified to make the |
| 931 | <a href='undocumented#Alias'>Aliasing</a> easier to see. |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 932 | </div></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 933 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 934 | <a name='SkPaint_isAntiAlias'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 935 | |
| 936 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 937 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 938 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 939 | bool <a href='#SkPaint_isAntiAlias'>isAntiAlias</a>() const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 940 | </pre> |
| 941 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 942 | 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] | 943 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 944 | 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] | 945 | |
| 946 | ### Return Value |
| 947 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 948 | <a href='#SkPaint_kAntiAlias_Flag'>kAntiAlias_Flag</a> state |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 949 | |
| 950 | ### Example |
| 951 | |
skia-bookmaker | b95bbba | 2018-07-06 05:23:23 +0000 | [diff] [blame] | 952 | <div><fiddle-embed name="d7d5f4f7da7acd5104a652f490c6f7b8"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 953 | |
| 954 | #### Example Output |
| 955 | |
| 956 | ~~~~ |
| 957 | paint.isAntiAlias() == !!(paint.getFlags() & SkPaint::kAntiAlias_Flag) |
| 958 | paint.isAntiAlias() == !!(paint.getFlags() & SkPaint::kAntiAlias_Flag) |
| 959 | ~~~~ |
| 960 | |
| 961 | </fiddle-embed></div> |
| 962 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 963 | <a name='SkPaint_setAntiAlias'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 964 | |
| 965 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 966 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 967 | <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] | 968 | void <a href='#SkPaint_setAntiAlias'>setAntiAlias</a>(bool aa) |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 969 | </pre> |
| 970 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 971 | Requests, but does not require, that <a href='SkPath_Reference#SkPath'>SkPath</a> edge pixels draw opaque or with |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 972 | partial transparency. |
| 973 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 974 | Sets <a href='#SkPaint_kAntiAlias_Flag'>kAntiAlias_Flag</a> if <a href='#SkPaint_setAntiAlias_aa'>aa</a> is true. |
| 975 | 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] | 976 | |
| 977 | ### Parameters |
| 978 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 979 | <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] | 980 | <td>setting for <a href='#SkPaint_kAntiAlias_Flag'>kAntiAlias_Flag</a></td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 981 | </tr> |
| 982 | </table> |
| 983 | |
| 984 | ### Example |
| 985 | |
skia-bookmaker | b95bbba | 2018-07-06 05:23:23 +0000 | [diff] [blame] | 986 | <div><fiddle-embed name="c2ff148374d01cbef845b223e725905c"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 987 | |
| 988 | #### Example Output |
| 989 | |
| 990 | ~~~~ |
| 991 | paint1 == paint2 |
| 992 | ~~~~ |
| 993 | |
| 994 | </fiddle-embed></div> |
| 995 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 996 | <a name='Dither'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 997 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 998 | --- |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 999 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1000 | Dither increases fidelity by adjusting the <a href='SkColor_Reference#Color'>color</a> of adjacent pixels. |
| 1001 | This can help to smooth <a href='SkColor_Reference#Color'>color</a> transitions and reducing banding in gradients. |
| 1002 | Dithering lessens visible banding from <a href='SkImageInfo_Reference#kRGB_565_SkColorType'>kRGB_565_SkColorType</a> |
| 1003 | and <a href='SkImageInfo_Reference#kRGBA_8888_SkColorType'>kRGBA_8888_SkColorType</a> gradients, |
| 1004 | 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] | 1005 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1006 | Dithering is always enabled for linear gradients drawing into |
| 1007 | <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>. |
| 1008 | 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] | 1009 | <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] | 1010 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1011 | Dither is disabled by default. |
| 1012 | 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> |
| 1013 | at compile time. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1014 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1015 | 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] | 1016 | |
| 1017 | ### Example |
| 1018 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1019 | <div><fiddle-embed name="8b26507690b71462f44642b911890bbf"><div>Dithering in the bottom half more closely approximates the requested <a href='SkColor_Reference#Color'>color</a> by |
| 1020 | 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] | 1021 | </div></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1022 | |
| 1023 | ### Example |
| 1024 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1025 | <div><fiddle-embed name="76d4d4a7931a48495e4d5f54e073be53"><div>Dithering introduces subtle adjustments to <a href='SkColor_Reference#Color'>color</a> to smooth gradients. |
| 1026 | Drawing the gradient repeatedly with <a href='SkBlendMode_Reference#SkBlendMode'>SkBlendMode</a>::<a href='#SkBlendMode_kPlus'>kPlus</a> exaggerates the |
| 1027 | dither, making it easier to see. |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 1028 | </div></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1029 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1030 | ### See Also |
| 1031 | |
| 1032 | Gradient <a href='SkImageInfo_Reference#kRGB_565_SkColorType'>kRGB_565_SkColorType</a> |
| 1033 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1034 | <a name='SkPaint_isDither'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1035 | |
| 1036 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1037 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1038 | <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] | 1039 | bool <a href='#SkPaint_isDither'>isDither</a>() const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1040 | </pre> |
| 1041 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1042 | 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] | 1043 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1044 | 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] | 1045 | |
| 1046 | ### Return Value |
| 1047 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1048 | <a href='#SkPaint_kDither_Flag'>kDither_Flag</a> state |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1049 | |
| 1050 | ### Example |
| 1051 | |
| 1052 | <div><fiddle-embed name="f4ce93f6c5e7335436a985377fd980c0"> |
| 1053 | |
| 1054 | #### Example Output |
| 1055 | |
| 1056 | ~~~~ |
| 1057 | paint.isDither() == !!(paint.getFlags() & SkPaint::kDither_Flag) |
| 1058 | paint.isDither() == !!(paint.getFlags() & SkPaint::kDither_Flag) |
| 1059 | ~~~~ |
| 1060 | |
| 1061 | </fiddle-embed></div> |
| 1062 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1063 | <a name='SkPaint_setDither'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1064 | |
| 1065 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1066 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1067 | <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] | 1068 | void <a href='#SkPaint_setDither'>setDither</a>(bool dither) |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1069 | </pre> |
| 1070 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1071 | 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] | 1072 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1073 | Sets <a href='#SkPaint_kDither_Flag'>kDither_Flag</a> if <a href='#SkPaint_setDither_dither'>dither</a> is true. |
| 1074 | 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] | 1075 | |
| 1076 | ### Parameters |
| 1077 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1078 | <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] | 1079 | <td>setting for <a href='#SkPaint_kDither_Flag'>kDither_Flag</a></td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1080 | </tr> |
| 1081 | </table> |
| 1082 | |
| 1083 | ### Example |
| 1084 | |
| 1085 | <div><fiddle-embed name="69b7162e8324d9239dd02dd9ada2bdff"> |
| 1086 | |
| 1087 | #### Example Output |
| 1088 | |
| 1089 | ~~~~ |
| 1090 | paint1 == paint2 |
| 1091 | ~~~~ |
| 1092 | |
| 1093 | </fiddle-embed></div> |
| 1094 | |
| 1095 | ### See Also |
| 1096 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1097 | <a href='SkImageInfo_Reference#kRGB_565_SkColorType'>kRGB_565_SkColorType</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1098 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1099 | <a name='Device_Text'></a> |
| 1100 | |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1101 | --- |
| 1102 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1103 | <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] | 1104 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1105 | 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 |
| 1106 | create a <a href='SkColor_Reference#Color'>color</a>, and relies |
| 1107 | 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. |
| 1108 | <a href='#Paint_LCD_Text'>LCD_Text</a> can be enabled on devices that orient stripes horizontally or vertically, and that order |
| 1109 | 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] | 1110 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1111 | <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. |
| 1112 | As the opaqueness |
| 1113 | 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] | 1114 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1115 | Either or both techniques can be enabled. |
| 1116 | <a href='#SkPaint_kLCDRenderText_Flag'>kLCDRenderText_Flag</a> and <a href='#SkPaint_kSubpixelText_Flag'>kSubpixelText_Flag</a> are clear by default. |
| 1117 | <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 |
| 1118 | <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] | 1119 | |
| 1120 | ### Example |
| 1121 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1122 | <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>. |
| 1123 | 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. |
| 1124 | 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] | 1125 | </div></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1126 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1127 | <a name='Linear_Text'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1128 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1129 | <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 | 8cc4cdc | 2018-11-09 23:16:58 -0500 | [diff] [blame] | 1130 | If <a href='#SkPaint_kLinearText_Flag'>kLinearText_Flag</a> is set, it has the same effect as setting <a href='#SkPaint_Hinting'>Hinting</a> to <a href='undocumented#SkFontHinting'>SkFontHinting</a>::<a href='#SkFontHinting_kNormal'>kNormal</a>. |
| 1131 | If <a href='#SkPaint_kLinearText_Flag'>kLinearText_Flag</a> is clear, it is the same as setting <a href='#SkPaint_Hinting'>Hinting</a> to <a href='undocumented#SkFontHinting'>SkFontHinting</a>::<a href='#SkFontHinting_kNone'>kNone</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1132 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1133 | <a name='SkPaint_isLinearText'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1134 | |
| 1135 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1136 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1137 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1138 | bool <a href='#SkPaint_isLinearText'>isLinearText</a>() const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1139 | </pre> |
| 1140 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1141 | Returns true if <a href='undocumented#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] | 1142 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1143 | 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] | 1144 | |
| 1145 | ### Return Value |
| 1146 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1147 | <a href='#SkPaint_kLinearText_Flag'>kLinearText_Flag</a> state |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1148 | |
| 1149 | ### Example |
| 1150 | |
| 1151 | <div><fiddle-embed name="2890ad644f980637837e6fcb386fb462"></fiddle-embed></div> |
| 1152 | |
| 1153 | ### See Also |
| 1154 | |
Cary Clark | 8cc4cdc | 2018-11-09 23:16:58 -0500 | [diff] [blame] | 1155 | <a href='#SkPaint_setLinearText'>setLinearText</a> <a href='#SkPaint_Hinting'>Hinting</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1156 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1157 | <a name='SkPaint_setLinearText'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1158 | |
| 1159 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1160 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1161 | <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] | 1162 | void <a href='#SkPaint_setLinearText'>setLinearText</a>(bool linearText) |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1163 | </pre> |
| 1164 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1165 | Returns true if <a href='undocumented#Text'>text</a> is converted to <a href='SkPath_Reference#SkPath'>SkPath</a> before drawing and measuring. |
| 1166 | By default, <a href='#SkPaint_kLinearText_Flag'>kLinearText_Flag</a> is clear. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1167 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1168 | Sets <a href='#SkPaint_kLinearText_Flag'>kLinearText_Flag</a> if <a href='#SkPaint_setLinearText_linearText'>linearText</a> is true. |
| 1169 | 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] | 1170 | |
| 1171 | ### Parameters |
| 1172 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1173 | <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] | 1174 | <td>setting for <a href='#SkPaint_kLinearText_Flag'>kLinearText_Flag</a></td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1175 | </tr> |
| 1176 | </table> |
| 1177 | |
| 1178 | ### Example |
| 1179 | |
Cary Clark | 8364706 | 2018-07-18 16:21:51 -0400 | [diff] [blame] | 1180 | <div><fiddle-embed name="c93bb912f3bddfb4d96d3ad70ada552b"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1181 | |
| 1182 | ### See Also |
| 1183 | |
Cary Clark | 8cc4cdc | 2018-11-09 23:16:58 -0500 | [diff] [blame] | 1184 | <a href='#SkPaint_isLinearText'>isLinearText</a> <a href='#SkPaint_Hinting'>Hinting</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1185 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1186 | <a name='Subpixel_Text'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1187 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1188 | <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. |
| 1189 | As the opaqueness |
| 1190 | 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] | 1191 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1192 | <a name='SkPaint_isSubpixelText'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1193 | |
| 1194 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1195 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1196 | <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] | 1197 | bool <a href='#SkPaint_isSubpixelText'>isSubpixelText</a>() const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1198 | </pre> |
| 1199 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1200 | 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] | 1201 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1202 | 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] | 1203 | |
| 1204 | ### Return Value |
| 1205 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1206 | <a href='#SkPaint_kSubpixelText_Flag'>kSubpixelText_Flag</a> state |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1207 | |
| 1208 | ### Example |
| 1209 | |
| 1210 | <div><fiddle-embed name="abe9afc0932e2199324ae6cbb396e67c"> |
| 1211 | |
| 1212 | #### Example Output |
| 1213 | |
| 1214 | ~~~~ |
| 1215 | paint.isSubpixelText() == !!(paint.getFlags() & SkPaint::kSubpixelText_Flag) |
| 1216 | paint.isSubpixelText() == !!(paint.getFlags() & SkPaint::kSubpixelText_Flag) |
| 1217 | ~~~~ |
| 1218 | |
| 1219 | </fiddle-embed></div> |
| 1220 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1221 | <a name='SkPaint_setSubpixelText'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1222 | |
| 1223 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1224 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1225 | <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] | 1226 | void <a href='#SkPaint_setSubpixelText'>setSubpixelText</a>(bool subpixelText) |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1227 | </pre> |
| 1228 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1229 | 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] | 1230 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1231 | Sets <a href='#SkPaint_kSubpixelText_Flag'>kSubpixelText_Flag</a> if <a href='#SkPaint_setSubpixelText_subpixelText'>subpixelText</a> is true. |
| 1232 | 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] | 1233 | |
| 1234 | ### Parameters |
| 1235 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1236 | <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] | 1237 | <td>setting for <a href='#SkPaint_kSubpixelText_Flag'>kSubpixelText_Flag</a></td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1238 | </tr> |
| 1239 | </table> |
| 1240 | |
| 1241 | ### Example |
| 1242 | |
| 1243 | <div><fiddle-embed name="a77bbc1a4e3be9a8ab0f842f877c5ee4"> |
| 1244 | |
| 1245 | #### Example Output |
| 1246 | |
| 1247 | ~~~~ |
| 1248 | paint1 == paint2 |
| 1249 | ~~~~ |
| 1250 | |
| 1251 | </fiddle-embed></div> |
| 1252 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1253 | <a name='LCD_Text'></a> |
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 | 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 |
| 1256 | create a <a href='SkColor_Reference#Color'>color</a>, and relies |
| 1257 | 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. |
| 1258 | <a href='#Paint_LCD_Text'>LCD_Text</a> can be enabled on devices that orient stripes horizontally or vertically, and that order |
| 1259 | 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] | 1260 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1261 | <a name='SkPaint_isLCDRenderText'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1262 | |
| 1263 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1264 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1265 | <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] | 1266 | bool <a href='#SkPaint_isLCDRenderText'>isLCDRenderText</a>() const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1267 | </pre> |
| 1268 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1269 | 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] | 1270 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1271 | 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] | 1272 | |
| 1273 | ### Return Value |
| 1274 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1275 | <a href='#SkPaint_kLCDRenderText_Flag'>kLCDRenderText_Flag</a> state |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1276 | |
| 1277 | ### Example |
| 1278 | |
skia-bookmaker | a391c72 | 2018-07-09 05:28:19 +0000 | [diff] [blame] | 1279 | <div><fiddle-embed name="68e1fd95dd2fd06a333899d2bd2396b9"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1280 | |
| 1281 | #### Example Output |
| 1282 | |
| 1283 | ~~~~ |
| 1284 | paint.isLCDRenderText() == !!(paint.getFlags() & SkPaint::kLCDRenderText_Flag) |
| 1285 | paint.isLCDRenderText() == !!(paint.getFlags() & SkPaint::kLCDRenderText_Flag) |
| 1286 | ~~~~ |
| 1287 | |
| 1288 | </fiddle-embed></div> |
| 1289 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1290 | <a name='SkPaint_setLCDRenderText'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1291 | |
| 1292 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1293 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1294 | <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] | 1295 | void <a href='#SkPaint_setLCDRenderText'>setLCDRenderText</a>(bool lcdText) |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1296 | </pre> |
| 1297 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1298 | 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] | 1299 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1300 | Sets <a href='#SkPaint_kLCDRenderText_Flag'>kLCDRenderText_Flag</a> if <a href='#SkPaint_setLCDRenderText_lcdText'>lcdText</a> is true. |
| 1301 | 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] | 1302 | |
| 1303 | ### Parameters |
| 1304 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1305 | <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] | 1306 | <td>setting for <a href='#SkPaint_kLCDRenderText_Flag'>kLCDRenderText_Flag</a></td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1307 | </tr> |
| 1308 | </table> |
| 1309 | |
| 1310 | ### Example |
| 1311 | |
skia-bookmaker | e0a458f | 2018-07-16 05:29:00 +0000 | [diff] [blame] | 1312 | <div><fiddle-embed name="50dedf8450159571a3edaf4f0050defe"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1313 | |
| 1314 | #### Example Output |
| 1315 | |
| 1316 | ~~~~ |
| 1317 | paint1 == paint2 |
| 1318 | ~~~~ |
| 1319 | |
| 1320 | </fiddle-embed></div> |
| 1321 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1322 | <a name='Font_Embedded_Bitmaps'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1323 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1324 | --- |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 1325 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1326 | <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>. |
| 1327 | <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 |
| 1328 | in a <a href='undocumented#Font'>font</a> if the platform supports this option. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1329 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1330 | 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 |
| 1331 | the outline <a href='undocumented#Glyph'>glyph</a> if <a href='#SkPaint_kEmbeddedBitmapText_Flag'>kEmbeddedBitmapText_Flag</a> is clear. |
| 1332 | Windows may select the <a href='SkBitmap_Reference#Bitmap'>bitmap</a> <a href='undocumented#Glyph'>glyph</a> but is not required to do so. |
| 1333 | <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] | 1334 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1335 | <a href='#Paint_Font_Embedded_Bitmaps'>Font_Embedded_Bitmaps</a> is disabled by default. |
| 1336 | <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 |
| 1337 | <a href='#SkPaint_kEmbeddedBitmapText_Flag'>kEmbeddedBitmapText_Flag</a> at compile time. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1338 | |
| 1339 | ### Example |
| 1340 | |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 1341 | <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] | 1342 | <div>The "hintgasp" TrueType font in the Skia resources/fonts directory |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 1343 | includes an embedded bitmap Glyph at odd font sizes. This example works |
| 1344 | on platforms that use FreeType as their Font_Engine. |
| 1345 | Windows may, but is not required to, return a bitmap glyph if |
| 1346 | kEmbeddedBitmapText_Flag is set.</div>SkBitmap bitmap; |
| 1347 | bitmap.allocN32Pixels(30, 15); |
| 1348 | bitmap.eraseColor(0); |
| 1349 | SkCanvas offscreen(bitmap); |
| 1350 | SkPaint paint; |
| 1351 | paint.setAntiAlias(true); |
| 1352 | paint.setTextSize(13); |
Hal Canary | 53e5e7d | 2017-12-08 14:25:14 -0500 | [diff] [blame] | 1353 | paint.setTypeface(MakeResourceAsTypeface("fonts/hintgasp.ttf")); |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 1354 | for (bool embedded : { false, true}) { |
| 1355 | paint.setEmbeddedBitmapText(embedded); |
| 1356 | offscreen.drawString("A", embedded ? 5 : 15, 15, paint); |
| 1357 | } |
| 1358 | canvas->drawBitmap(bitmap, 0, 0); |
| 1359 | canvas->scale(10, 10); |
| 1360 | canvas->drawBitmap(bitmap, -2, 1); |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 1361 | |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 1362 | </pre> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1363 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1364 | <a name='SkPaint_isEmbeddedBitmapText'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1365 | |
| 1366 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1367 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1368 | <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] | 1369 | bool <a href='#SkPaint_isEmbeddedBitmapText'>isEmbeddedBitmapText</a>() const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1370 | </pre> |
| 1371 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1372 | Returns true if <a href='undocumented#Font'>font</a> engine may return <a href='undocumented#Glyph'>glyphs</a> from <a href='undocumented#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] | 1373 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1374 | 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] | 1375 | |
| 1376 | ### Return Value |
| 1377 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1378 | <a href='#SkPaint_kEmbeddedBitmapText_Flag'>kEmbeddedBitmapText_Flag</a> state |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1379 | |
| 1380 | ### Example |
| 1381 | |
| 1382 | <div><fiddle-embed name="eba10b27b790e87183ae451b3fc5c4b1"> |
| 1383 | |
| 1384 | #### Example Output |
| 1385 | |
| 1386 | ~~~~ |
| 1387 | paint.isEmbeddedBitmapText() == !!(paint.getFlags() & SkPaint::kEmbeddedBitmapText_Flag) |
| 1388 | paint.isEmbeddedBitmapText() == !!(paint.getFlags() & SkPaint::kEmbeddedBitmapText_Flag) |
| 1389 | ~~~~ |
| 1390 | |
| 1391 | </fiddle-embed></div> |
| 1392 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1393 | <a name='SkPaint_setEmbeddedBitmapText'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1394 | |
| 1395 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1396 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1397 | <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] | 1398 | void <a href='#SkPaint_setEmbeddedBitmapText'>setEmbeddedBitmapText</a>(bool useEmbeddedBitmapText) |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1399 | </pre> |
| 1400 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1401 | 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] | 1402 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1403 | Sets <a href='#SkPaint_kEmbeddedBitmapText_Flag'>kEmbeddedBitmapText_Flag</a> if <a href='#SkPaint_setEmbeddedBitmapText_useEmbeddedBitmapText'>useEmbeddedBitmapText</a> is true. |
| 1404 | 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] | 1405 | |
| 1406 | ### Parameters |
| 1407 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1408 | <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] | 1409 | <td>setting for <a href='#SkPaint_kEmbeddedBitmapText_Flag'>kEmbeddedBitmapText_Flag</a></td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1410 | </tr> |
| 1411 | </table> |
| 1412 | |
| 1413 | ### Example |
| 1414 | |
| 1415 | <div><fiddle-embed name="246dffdd93a484ba4ad7ecf71198a5d4"> |
| 1416 | |
| 1417 | #### Example Output |
| 1418 | |
| 1419 | ~~~~ |
| 1420 | paint1 == paint2 |
| 1421 | ~~~~ |
| 1422 | |
| 1423 | </fiddle-embed></div> |
| 1424 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1425 | <a name='Automatic_Hinting'></a> |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 1426 | |
Cary Clark | 8cc4cdc | 2018-11-09 23:16:58 -0500 | [diff] [blame] | 1427 | If <a href='#SkPaint_Hinting'>Hinting</a> 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] | 1428 | instructs the <a href='#Font_Manager'>Font_Manager</a> to always hint <a href='undocumented#Glyph'>Glyphs</a>. |
Cary Clark | 8cc4cdc | 2018-11-09 23:16:58 -0500 | [diff] [blame] | 1429 | <a href='#Paint_Automatic_Hinting'>Automatic_Hinting</a> has no effect if <a href='#SkPaint_Hinting'>Hinting</a> 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] | 1430 | <a href='undocumented#SkFontHinting'>SkFontHinting</a>::<a href='#SkFontHinting_kSlight'>kSlight</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1431 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1432 | <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] | 1433 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1434 | <a name='SkPaint_isAutohinted'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1435 | |
| 1436 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1437 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1438 | <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] | 1439 | bool <a href='#SkPaint_isAutohinted'>isAutohinted</a>() const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1440 | </pre> |
| 1441 | |
Cary Clark | 8cc4cdc | 2018-11-09 23:16:58 -0500 | [diff] [blame] | 1442 | Returns true if <a href='SkPaint_Reference#SkPaint'>SkPaint</a>::<a href='#SkPaint_Hinting'>Hinting</a> is set to <a href='undocumented#SkFontHinting'>SkFontHinting</a>::<a href='#SkFontHinting_kNormal'>kNormal</a> or |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1443 | <a href='undocumented#SkFontHinting'>SkFontHinting</a>::<a href='#SkFontHinting_kFull'>kFull</a>, and if platform uses FreeType as the <a href='undocumented#Font'>font</a> manager. |
| 1444 | If true, instructs the <a href='undocumented#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] | 1445 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1446 | 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] | 1447 | |
| 1448 | ### Return Value |
| 1449 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1450 | <a href='#SkPaint_kAutoHinting_Flag'>kAutoHinting_Flag</a> state |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1451 | |
| 1452 | ### Example |
| 1453 | |
| 1454 | <div><fiddle-embed name="aa4781afbe3b90e7ef56a287e5b9ce1e"> |
| 1455 | |
| 1456 | #### Example Output |
| 1457 | |
| 1458 | ~~~~ |
| 1459 | paint.isAutohinted() == !!(paint.getFlags() & SkPaint::kAutoHinting_Flag) |
| 1460 | paint.isAutohinted() == !!(paint.getFlags() & SkPaint::kAutoHinting_Flag) |
| 1461 | ~~~~ |
| 1462 | |
| 1463 | </fiddle-embed></div> |
| 1464 | |
| 1465 | ### See Also |
| 1466 | |
Cary Clark | 8cc4cdc | 2018-11-09 23:16:58 -0500 | [diff] [blame] | 1467 | <a href='#SkPaint_setAutohinted'>setAutohinted</a> <a href='#SkPaint_Hinting'>Hinting</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1468 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1469 | <a name='SkPaint_setAutohinted'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1470 | |
| 1471 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1472 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1473 | <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] | 1474 | void <a href='#SkPaint_setAutohinted'>setAutohinted</a>(bool useAutohinter) |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1475 | </pre> |
| 1476 | |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 1477 | Sets whether to always hint <a href='undocumented#Glyph'>glyphs</a>. |
Cary Clark | 8cc4cdc | 2018-11-09 23:16:58 -0500 | [diff] [blame] | 1478 | If <a href='SkPaint_Reference#SkPaint'>SkPaint</a>::<a href='#SkPaint_Hinting'>Hinting</a> 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] | 1479 | 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 | 8cc4cdc | 2018-11-09 23:16:58 -0500 | [diff] [blame] | 1480 | <a href='SkPaint_Reference#Automatic_Hinting'>auto-hinting</a> has no effect if <a href='SkPaint_Reference#SkPaint'>SkPaint</a>::<a href='#SkPaint_Hinting'>Hinting</a> 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] | 1481 | <a href='undocumented#SkFontHinting'>SkFontHinting</a>::<a href='#SkFontHinting_kSlight'>kSlight</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1482 | |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 1483 | 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] | 1484 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1485 | Sets <a href='#SkPaint_kAutoHinting_Flag'>kAutoHinting_Flag</a> if <a href='#SkPaint_setAutohinted_useAutohinter'>useAutohinter</a> is true. |
| 1486 | 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] | 1487 | |
| 1488 | ### Parameters |
| 1489 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1490 | <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] | 1491 | <td>setting for <a href='#SkPaint_kAutoHinting_Flag'>kAutoHinting_Flag</a></td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1492 | </tr> |
| 1493 | </table> |
| 1494 | |
| 1495 | ### Example |
| 1496 | |
| 1497 | <div><fiddle-embed name="4e185306d7de9390fe8445eed0139309"></fiddle-embed></div> |
| 1498 | |
| 1499 | ### See Also |
| 1500 | |
Cary Clark | 8cc4cdc | 2018-11-09 23:16:58 -0500 | [diff] [blame] | 1501 | <a href='#SkPaint_isAutohinted'>isAutohinted</a> <a href='#SkPaint_Hinting'>Hinting</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1502 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1503 | <a name='Fake_Bold'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1504 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1505 | --- |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 1506 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1507 | <a href='#Paint_Fake_Bold'>Fake_Bold</a> approximates the bold <a href='undocumented#Font'>font</a> style accompanying a normal <a href='undocumented#Font'>font</a> when a bold <a href='undocumented#Font'>font</a> face |
| 1508 | is not available. Skia does not provide <a href='undocumented#Font'>font</a> substitution; it is up to the client to find the |
| 1509 | bold <a href='undocumented#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] | 1510 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1511 | Use <a href='#Paint_Text_Skew_X'>Text_Skew_X</a> to approximate an italic <a href='undocumented#Font'>font</a> style when the italic <a href='undocumented#Font'>font</a> face |
| 1512 | is not available. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1513 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1514 | A FreeType based port may define SK_USE_FREETYPE_EMBOLDEN at compile time to direct |
| 1515 | the <a href='undocumented#Font_Engine'>font engine</a> to create the bold <a href='undocumented#Glyph'>Glyphs</a>. Otherwise, the extra bold is computed |
| 1516 | 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] | 1517 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1518 | <a href='#Paint_Fake_Bold'>Fake_Bold</a> is disabled by default. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1519 | |
| 1520 | ### Example |
| 1521 | |
| 1522 | <div><fiddle-embed name="e811f4829a2daaaeaad3795504a7e02a"></fiddle-embed></div> |
| 1523 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1524 | <a name='SkPaint_isFakeBoldText'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1525 | |
| 1526 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1527 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1528 | <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] | 1529 | bool <a href='#SkPaint_isFakeBoldText'>isFakeBoldText</a>() const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1530 | </pre> |
| 1531 | |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 1532 | 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] | 1533 | from outlines. |
| 1534 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1535 | 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] | 1536 | |
| 1537 | ### Return Value |
| 1538 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1539 | <a href='#SkPaint_kFakeBoldText_Flag'>kFakeBoldText_Flag</a> state |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1540 | |
| 1541 | ### Example |
| 1542 | |
| 1543 | <div><fiddle-embed name="f54d1f85b16073b80b9eef2e1a1d151d"> |
| 1544 | |
| 1545 | #### Example Output |
| 1546 | |
| 1547 | ~~~~ |
| 1548 | paint.isFakeBoldText() == !!(paint.getFlags() & SkPaint::kFakeBoldText_Flag) |
| 1549 | paint.isFakeBoldText() == !!(paint.getFlags() & SkPaint::kFakeBoldText_Flag) |
| 1550 | ~~~~ |
| 1551 | |
| 1552 | </fiddle-embed></div> |
| 1553 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1554 | <a name='SkPaint_setFakeBoldText'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1555 | |
| 1556 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1557 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1558 | <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] | 1559 | void <a href='#SkPaint_setFakeBoldText'>setFakeBoldText</a>(bool fakeBoldText) |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1560 | </pre> |
| 1561 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1562 | 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] | 1563 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1564 | Sets <a href='#SkPaint_kFakeBoldText_Flag'>kFakeBoldText_Flag</a> if <a href='#SkPaint_setFakeBoldText_fakeBoldText'>fakeBoldText</a> is true. |
| 1565 | 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] | 1566 | |
| 1567 | ### Parameters |
| 1568 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1569 | <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] | 1570 | <td>setting for <a href='#SkPaint_kFakeBoldText_Flag'>kFakeBoldText_Flag</a></td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1571 | </tr> |
| 1572 | </table> |
| 1573 | |
| 1574 | ### Example |
| 1575 | |
| 1576 | <div><fiddle-embed name="594d47858eb11028cb626515a520910a"> |
| 1577 | |
| 1578 | #### Example Output |
| 1579 | |
| 1580 | ~~~~ |
| 1581 | paint1 == paint2 |
| 1582 | ~~~~ |
| 1583 | |
| 1584 | </fiddle-embed></div> |
| 1585 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1586 | <a name='Full_Hinting_Spacing'></a> |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 1587 | |
Cary Clark | 8cc4cdc | 2018-11-09 23:16:58 -0500 | [diff] [blame] | 1588 | if <a href='#SkPaint_Hinting'>Hinting</a> 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] | 1589 | spacing by the difference of the hinted and unhinted <a href='#Left_Side_Bearing'>Left_Side_Bearing</a> and |
| 1590 | <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 |
| 1591 | FreeType as their <a href='#Font_Engine'>Font_Engine</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1592 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1593 | <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 |
| 1594 | a specific pair of characters is adjusted using <a href='undocumented#Data'>data</a> in the <a href='undocumented#Font'>font</a> kerning tables. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1595 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1596 | <a name='Filter_Quality_Methods'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1597 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1598 | --- |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 1599 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1600 | <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. |
| 1601 | A lower <a href='#Filter_Quality'>Filter_Quality</a> draws faster, but has less fidelity. |
| 1602 | A higher <a href='#Filter_Quality'>Filter_Quality</a> draws slower, but looks better. |
| 1603 | 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 |
| 1604 | in a noticeable difference. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1605 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1606 | <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] | 1607 | |
| 1608 | <table> <tr> |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 1609 | <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] | 1610 | </tr> <tr> |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 1611 | <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] | 1612 | </tr> <tr> |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 1613 | <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] | 1614 | </tr> <tr> |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 1615 | <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] | 1616 | </tr> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1617 | </table> |
| 1618 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1619 | 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] | 1620 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1621 | <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] | 1622 | |
| 1623 | ### Example |
| 1624 | |
skia-bookmaker | 525f9a9 | 2018-05-03 06:27:39 +0000 | [diff] [blame] | 1625 | <div><fiddle-embed name="69369cff2f5b145a6f616092513266a0"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1626 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1627 | <a name='SkPaint_getFilterQuality'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1628 | |
| 1629 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1630 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1631 | <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] | 1632 | <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] | 1633 | </pre> |
| 1634 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1635 | Returns <a href='undocumented#SkFilterQuality'>SkFilterQuality</a>, the <a href='SkImage_Reference#Image'>image</a> filtering level. A lower setting |
| 1636 | 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] | 1637 | |
| 1638 | ### Return Value |
| 1639 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1640 | 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] | 1641 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1642 | <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] | 1643 | |
| 1644 | ### Example |
| 1645 | |
| 1646 | <div><fiddle-embed name="d4ca1f23809b6835c4ba46ea98a86900"> |
| 1647 | |
| 1648 | #### Example Output |
| 1649 | |
| 1650 | ~~~~ |
| 1651 | kNone_SkFilterQuality == paint.getFilterQuality() |
| 1652 | ~~~~ |
| 1653 | |
| 1654 | </fiddle-embed></div> |
| 1655 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1656 | <a name='SkPaint_setFilterQuality'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1657 | |
| 1658 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1659 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1660 | <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] | 1661 | 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] | 1662 | </pre> |
| 1663 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1664 | Sets <a href='undocumented#SkFilterQuality'>SkFilterQuality</a>, the <a href='SkImage_Reference#Image'>image</a> filtering level. A lower setting |
| 1665 | draws faster; a higher setting looks better when the <a href='SkImage_Reference#Image'>image</a> is scaled. |
| 1666 | 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] | 1667 | |
| 1668 | ### Parameters |
| 1669 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1670 | <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] | 1671 | <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] | 1672 | </tr> |
| 1673 | </table> |
| 1674 | |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 1675 | <a href='undocumented#kMedium_SkFilterQuality'>kMedium_SkFilterQuality</a>, <a href='undocumented#kHigh_SkFilterQuality'>kHigh_SkFilterQuality</a> |
| 1676 | |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1677 | ### Example |
| 1678 | |
| 1679 | <div><fiddle-embed name="e4288fabf24ee60b645e8bb6ea0afadf"> |
| 1680 | |
| 1681 | #### Example Output |
| 1682 | |
| 1683 | ~~~~ |
| 1684 | kHigh_SkFilterQuality == paint.getFilterQuality() |
| 1685 | ~~~~ |
| 1686 | |
| 1687 | </fiddle-embed></div> |
| 1688 | |
| 1689 | ### See Also |
| 1690 | |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 1691 | <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] | 1692 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1693 | <a name='Color_Methods'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1694 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1695 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1696 | |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 1697 | | name | description | |
| 1698 | | --- | --- | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1699 | | <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> | |
| 1700 | | <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] | 1701 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1702 | <a href='SkColor_Reference#Color'>Color</a> specifies the red, blue, green, and <a href='#Color_Alpha'>Color_Alpha</a> |
| 1703 | values used to draw a filled or stroked shape in a 32-bit value. Each component |
| 1704 | occupies 8-bits, ranging from zero: no contribution; to 255: full intensity. |
| 1705 | All values in any combination are valid. |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 1706 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1707 | <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 |
| 1708 | RGB: red, blue, and green. |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 1709 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1710 | The bit positions of <a href='#Color_Alpha'>Color_Alpha</a> and RGB are independent of the bit |
| 1711 | positions on the output <a href='undocumented#Device'>device</a>, which may have more or fewer bits, and may have |
| 1712 | a different arrangement. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1713 | |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 1714 | | bit positions | <a href='#Color_Alpha'>Color_Alpha</a> | red | blue | green | |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1715 | | --- | --- | --- | --- | --- | |
| 1716 | | | 31 - 24 | 23 - 16 | 15 - 8 | 7 - 0 | |
| 1717 | |
| 1718 | ### Example |
| 1719 | |
Ravi Mistry | 874e22b | 2018-07-19 03:49:13 +0000 | [diff] [blame] | 1720 | <div><fiddle-embed name="214b559d75c65a7bef6ef4be1f860053"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1721 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1722 | <a name='SkPaint_getColor'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1723 | |
| 1724 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1725 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1726 | <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] | 1727 | <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] | 1728 | </pre> |
| 1729 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1730 | Retrieves <a href='SkColor_Reference#Alpha'>alpha</a> and RGB, <a href='undocumented#Unpremultiply'>unpremultiplied</a>, packed into 32 bits. |
| 1731 | 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 |
| 1732 | a <a href='SkColor_Reference#Color'>color</a> component. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1733 | |
| 1734 | ### Return Value |
| 1735 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1736 | <a href='undocumented#Unpremultiply'>unpremultiplied</a> ARGB |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1737 | |
| 1738 | ### Example |
| 1739 | |
skia-bookmaker | 61cc9fa | 2018-07-11 05:28:17 +0000 | [diff] [blame] | 1740 | <div><fiddle-embed name="72d41f890203109a41f589a7403acae9"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1741 | |
| 1742 | #### Example Output |
| 1743 | |
| 1744 | ~~~~ |
| 1745 | Yellow is 100% red, 100% green, and 0% blue. |
| 1746 | ~~~~ |
| 1747 | |
| 1748 | </fiddle-embed></div> |
| 1749 | |
| 1750 | ### See Also |
| 1751 | |
Cary Clark | bbe8ff9 | 2018-09-05 11:39:01 -0400 | [diff] [blame] | 1752 | <a href='#SkPaint_getColor4f'>getColor4f</a> <a href='SkColor_Reference#SkColor'>SkColor</a> |
| 1753 | |
Cary Clark | bbe8ff9 | 2018-09-05 11:39:01 -0400 | [diff] [blame] | 1754 | <a name='SkPaint_getColor4f'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1755 | |
| 1756 | --- |
Cary Clark | bbe8ff9 | 2018-09-05 11:39:01 -0400 | [diff] [blame] | 1757 | |
| 1758 | <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] | 1759 | <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] | 1760 | </pre> |
| 1761 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1762 | 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] | 1763 | are extended sRGB values (sRGB gamut, and encoded with the sRGB transfer function). |
| 1764 | |
| 1765 | ### Return Value |
| 1766 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1767 | <a href='undocumented#Unpremultiply'>unpremultiplied</a> RGBA |
Cary Clark | bbe8ff9 | 2018-09-05 11:39:01 -0400 | [diff] [blame] | 1768 | |
| 1769 | ### Example |
| 1770 | |
| 1771 | <div><fiddle-embed name="8512ea2176f36e8f1aeef311ff228790"> |
| 1772 | |
| 1773 | #### Example Output |
| 1774 | |
| 1775 | ~~~~ |
| 1776 | Yellow is 100% red, 100% green, and 0% blue. |
| 1777 | ~~~~ |
| 1778 | |
| 1779 | </fiddle-embed></div> |
| 1780 | |
| 1781 | ### See Also |
| 1782 | |
| 1783 | <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] | 1784 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1785 | <a name='SkPaint_setColor'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1786 | |
| 1787 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1788 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1789 | <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] | 1790 | 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] | 1791 | </pre> |
| 1792 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1793 | 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, |
| 1794 | <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] | 1795 | |
| 1796 | ### Parameters |
| 1797 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1798 | <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] | 1799 | <td><a href='undocumented#Unpremultiply'>unpremultiplied</a> ARGB</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1800 | </tr> |
| 1801 | </table> |
| 1802 | |
| 1803 | ### Example |
| 1804 | |
skia-bookmaker | 233c652 | 2018-07-04 05:33:26 +0000 | [diff] [blame] | 1805 | <div><fiddle-embed name="6e70f18300bd676a3c056ceb6b62f8df"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1806 | |
| 1807 | #### Example Output |
| 1808 | |
| 1809 | ~~~~ |
| 1810 | green1 == green2 |
| 1811 | ~~~~ |
| 1812 | |
| 1813 | </fiddle-embed></div> |
| 1814 | |
| 1815 | ### See Also |
| 1816 | |
Cary Clark | bbe8ff9 | 2018-09-05 11:39:01 -0400 | [diff] [blame] | 1817 | <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> |
| 1818 | |
Cary Clark | bbe8ff9 | 2018-09-05 11:39:01 -0400 | [diff] [blame] | 1819 | <a name='SkPaint_setColor4f'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1820 | |
| 1821 | --- |
Cary Clark | bbe8ff9 | 2018-09-05 11:39:01 -0400 | [diff] [blame] | 1822 | |
| 1823 | <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] | 1824 | 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] | 1825 | </pre> |
| 1826 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1827 | 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 |
| 1828 | <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 |
| 1829 | 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] | 1830 | sRGB <a href='undocumented#Color_Space'>color space</a>. |
Cary Clark | bbe8ff9 | 2018-09-05 11:39:01 -0400 | [diff] [blame] | 1831 | |
| 1832 | ### Parameters |
| 1833 | |
| 1834 | <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] | 1835 | <td><a href='undocumented#Unpremultiply'>unpremultiplied</a> RGBA</td> |
Cary Clark | bbe8ff9 | 2018-09-05 11:39:01 -0400 | [diff] [blame] | 1836 | </tr> |
| 1837 | <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] | 1838 | <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] | 1839 | </tr> |
| 1840 | </table> |
| 1841 | |
| 1842 | ### Example |
| 1843 | |
| 1844 | <div><fiddle-embed name="fa60859e3d03bdc117a05b32e093a8f1"> |
| 1845 | |
| 1846 | #### Example Output |
| 1847 | |
| 1848 | ~~~~ |
| 1849 | green1 == green2 |
| 1850 | ~~~~ |
| 1851 | |
| 1852 | </fiddle-embed></div> |
| 1853 | |
| 1854 | ### See Also |
| 1855 | |
| 1856 | <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] | 1857 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1858 | <a name='Alpha_Methods'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1859 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1860 | <a href='#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] | 1861 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1862 | <a name='SkPaint_getAlpha'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1863 | |
| 1864 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1865 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1866 | <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] | 1867 | uint8_t <a href='#SkPaint_getAlpha'>getAlpha</a>() const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1868 | </pre> |
| 1869 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1870 | 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] | 1871 | |
| 1872 | ### Return Value |
| 1873 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1874 | <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] | 1875 | |
| 1876 | ### Example |
| 1877 | |
Cary Clark | 8364706 | 2018-07-18 16:21:51 -0400 | [diff] [blame] | 1878 | <div><fiddle-embed name="9a85bb62fe3d877b18fb7f952c4fa7f7"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1879 | |
| 1880 | #### Example Output |
| 1881 | |
| 1882 | ~~~~ |
| 1883 | 255 == paint.getAlpha() |
| 1884 | ~~~~ |
| 1885 | |
| 1886 | </fiddle-embed></div> |
| 1887 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1888 | <a name='SkPaint_setAlpha'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1889 | |
| 1890 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1891 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1892 | <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] | 1893 | 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] | 1894 | </pre> |
| 1895 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1896 | Replaces <a href='SkColor_Reference#Alpha'>alpha</a>, leaving RGB |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1897 | unchanged. An out of range value triggers an assert in the debug |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1898 | build. <a href='#SkPaint_setAlpha_a'>a</a> is <a href='#SkPaint_setAlpha_a'>a</a> value from zero to 255. |
| 1899 | <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] | 1900 | fully opaque. |
| 1901 | |
| 1902 | ### Parameters |
| 1903 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1904 | <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] | 1905 | <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] | 1906 | </tr> |
| 1907 | </table> |
| 1908 | |
| 1909 | ### Example |
| 1910 | |
Ravi Mistry | 874e22b | 2018-07-19 03:49:13 +0000 | [diff] [blame] | 1911 | <div><fiddle-embed name="6ddc0360512dfb9947e75c17e6a8103d"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1912 | |
| 1913 | #### Example Output |
| 1914 | |
| 1915 | ~~~~ |
| 1916 | 0x44112233 == paint.getColor() |
| 1917 | ~~~~ |
| 1918 | |
| 1919 | </fiddle-embed></div> |
| 1920 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1921 | <a name='SkPaint_setARGB'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1922 | |
| 1923 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1924 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1925 | <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] | 1926 | 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] | 1927 | </pre> |
| 1928 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1929 | 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. |
| 1930 | 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] | 1931 | |
| 1932 | ### Parameters |
| 1933 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1934 | <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] | 1935 | <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] | 1936 | </tr> |
| 1937 | <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] | 1938 | <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] | 1939 | </tr> |
| 1940 | <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] | 1941 | <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] | 1942 | </tr> |
| 1943 | <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] | 1944 | <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] | 1945 | </tr> |
| 1946 | </table> |
| 1947 | |
| 1948 | ### Example |
| 1949 | |
skia-bookmaker | 61cc9fa | 2018-07-11 05:28:17 +0000 | [diff] [blame] | 1950 | <div><fiddle-embed name="cb62e4755789ed32f7120dc55984959d"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1951 | |
| 1952 | #### Example Output |
| 1953 | |
| 1954 | ~~~~ |
| 1955 | transRed1 == transRed2 |
| 1956 | ~~~~ |
| 1957 | |
| 1958 | </fiddle-embed></div> |
| 1959 | |
| 1960 | ### See Also |
| 1961 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1962 | <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] | 1963 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1964 | <a name='Style'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1965 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1966 | --- |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 1967 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1968 | <a href='#SkPaint_Style'>Style</a> specifies if the geometry is filled, stroked, or both filled and stroked. |
| 1969 | 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] | 1970 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1971 | <a name='Style_Fill'></a> |
| 1972 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1973 | Set <a href='#SkPaint_Style'>Style</a> to <a href='#SkPaint_kFill_Style'>kFill_Style</a> to fill the shape. |
| 1974 | The fill covers the area inside the geometry for most shapes. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1975 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1976 | <a name='Style_Stroke'></a> |
| 1977 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1978 | 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] | 1979 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1980 | The stroke covers the area described by following the shape edge with a pen or brush of |
| 1981 | <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>. |
| 1982 | The area covered where the shape turns a corner is described by <a href='#Paint_Stroke_Join'>Stroke_Join</a>. |
| 1983 | 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 |
| 1984 | 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] | 1985 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1986 | ### See Also |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1987 | |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 1988 | <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] | 1989 | |
| 1990 | <a name='Hairline'></a> |
| 1991 | |
| 1992 | --- |
| 1993 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1994 | <a href='#Paint_Stroke_Width'>Stroke_Width</a> of zero has a special meaning and switches drawing to use Hairline. |
| 1995 | Hairline draws the thinnest continuous frame. If <a href='#SkPaint_kAntiAlias_Flag'>kAntiAlias_Flag</a> is clear, adjacent pixels |
| 1996 | flow horizontally, vertically,or diagonally. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1997 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 1998 | <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 |
| 1999 | 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 |
| 2000 | <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 |
| 2001 | GPU-backed implementations apply transparency at a later drawing stage, avoiding double hit pixels |
| 2002 | while stroking. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2003 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2004 | ### See Also |
| 2005 | |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 2006 | <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] | 2007 | |
| 2008 | <a name='SkPaint_Style'></a> |
| 2009 | |
| 2010 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2011 | |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 2012 | <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] | 2013 | enum <a href='#SkPaint_Style'>Style</a> : uint8_t { |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 2014 | <a href='#SkPaint_kFill_Style'>kFill_Style</a>, |
| 2015 | <a href='#SkPaint_kStroke_Style'>kStroke_Style</a>, |
| 2016 | <a href='#SkPaint_kStrokeAndFill_Style'>kStrokeAndFill_Style</a>, |
Cary Clark | 186d08f | 2018-04-03 08:43:27 -0400 | [diff] [blame] | 2017 | }; |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2018 | </pre> |
Cary Clark | d98f78c | 2018-04-26 08:32:37 -0400 | [diff] [blame] | 2019 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2020 | <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] | 2021 | 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] | 2022 | </pre> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2023 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2024 | Set <a href='#SkPaint_Style'>Style</a> to fill, stroke, or both fill and stroke geometry. |
| 2025 | The stroke and fill |
| 2026 | 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] | 2027 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2028 | Use <a href='#SkPaint_kStrokeAndFill_Style'>kStrokeAndFill_Style</a> to avoid hitting the same pixels twice with a stroke draw and |
| 2029 | a fill draw. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2030 | |
| 2031 | ### Constants |
| 2032 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2033 | <table style='border-collapse: collapse; width: 62.5em'> |
| 2034 | <tr><th style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>Const</th> |
| 2035 | <th style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>Value</th> |
| 2036 | <th style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>Description</th></tr> |
| 2037 | <tr style='background-color: #f0f0f0; '> |
| 2038 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kFill_Style'><code>SkPaint::kFill_Style</code></a></td> |
| 2039 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>0</td> |
| 2040 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2041 | 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>. |
| 2042 | <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 |
| 2043 | <a href='#SkPaint_kFill_Style'>kFill_Style</a> is set, and ignore the set <a href='#SkPaint_Style'>Style</a>. |
| 2044 | 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, |
| 2045 | and to create an unfilled hole inside the shape. |
| 2046 | <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] | 2047 | </td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2048 | </tr> |
| 2049 | <tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2050 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kStroke_Style'><code>SkPaint::kStroke_Style</code></a></td> |
| 2051 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>1</td> |
| 2052 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2053 | 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>. |
| 2054 | <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, |
| 2055 | and ignore the set <a href='#SkPaint_Style'>Style</a>. |
| 2056 | 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] | 2057 | </td> |
| 2058 | </tr> |
| 2059 | <tr style='background-color: #f0f0f0; '> |
| 2060 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kStrokeAndFill_Style'><code>SkPaint::kStrokeAndFill_Style</code></a></td> |
| 2061 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>2</td> |
| 2062 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2063 | 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>. |
| 2064 | <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>, |
| 2065 | 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] | 2066 | </td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2067 | </tr> |
| 2068 | <tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2069 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kStyleCount'><code>SkPaint::kStyleCount</code></a></td> |
| 2070 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>3</td> |
| 2071 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2072 | 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] | 2073 | </td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2074 | </tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2075 | </table> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2076 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2077 | <a name='SkPaint_getStyle'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2078 | |
| 2079 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2080 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2081 | <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] | 2082 | <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] | 2083 | </pre> |
| 2084 | |
Cary Clark | 80247e5 | 2018-07-11 16:18:41 -0400 | [diff] [blame] | 2085 | Returns whether the geometry is filled, stroked, or filled and stroked. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2086 | |
| 2087 | ### Return Value |
| 2088 | |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 2089 | 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] | 2090 | |
| 2091 | ### Example |
| 2092 | |
| 2093 | <div><fiddle-embed name="1c5e18c3c0102d2dac86a78ba8c8ce01"> |
| 2094 | |
| 2095 | #### Example Output |
| 2096 | |
| 2097 | ~~~~ |
| 2098 | SkPaint::kFill_Style == paint.getStyle() |
| 2099 | ~~~~ |
| 2100 | |
| 2101 | </fiddle-embed></div> |
| 2102 | |
| 2103 | ### See Also |
| 2104 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2105 | <a href='#SkPaint_Style'>Style</a> <a href='#SkPaint_setStyle'>setStyle</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2106 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2107 | <a name='SkPaint_setStyle'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2108 | |
| 2109 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2110 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2111 | <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] | 2112 | 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] | 2113 | </pre> |
| 2114 | |
| 2115 | Sets whether the geometry is filled, stroked, or filled and stroked. |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2116 | 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] | 2117 | |
| 2118 | ### Parameters |
| 2119 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2120 | <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] | 2121 | <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] | 2122 | </tr> |
| 2123 | </table> |
| 2124 | |
| 2125 | ### Example |
| 2126 | |
| 2127 | <div><fiddle-embed name="c7bb6248e4735b8d1a32d02fba40d344"></fiddle-embed></div> |
| 2128 | |
| 2129 | ### See Also |
| 2130 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2131 | <a href='#SkPaint_Style'>Style</a> <a href='#SkPaint_getStyle'>getStyle</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2132 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2133 | <a name='Stroke_Width'></a> |
| 2134 | |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2135 | --- |
| 2136 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2137 | <a href='#Paint_Stroke_Width'>Stroke_Width</a> sets the width for stroking. The width is the thickness |
| 2138 | 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 |
| 2139 | 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] | 2140 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2141 | When width is greater than zero, the stroke encompasses as many pixels partially |
| 2142 | or fully as needed. When the width equals zero, the <a href='SkPaint_Reference#Paint'>paint</a> enables hairlines; |
| 2143 | the stroke is always one <a href='undocumented#Pixel'>pixel</a> wide. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2144 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2145 | The stroke dimensions are scaled by the <a href='SkCanvas_Reference#Canvas_Matrix'>canvas matrix</a>, but Hairline stroke |
| 2146 | remains one <a href='undocumented#Pixel'>pixel</a> wide regardless of scaling. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2147 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2148 | 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] | 2149 | |
| 2150 | ### Example |
| 2151 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2152 | <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 |
| 2153 | <a href='undocumented#Line'>line</a> and the platform implementation. |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 2154 | </div></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2155 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2156 | <a name='SkPaint_getStrokeWidth'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2157 | |
| 2158 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2159 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2160 | <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] | 2161 | <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] | 2162 | </pre> |
| 2163 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2164 | 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] | 2165 | outline the shape. |
| 2166 | |
| 2167 | ### Return Value |
| 2168 | |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 2169 | zero for hairline, greater than zero for pen thickness |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2170 | |
| 2171 | ### Example |
| 2172 | |
skia-bookmaker | b95bbba | 2018-07-06 05:23:23 +0000 | [diff] [blame] | 2173 | <div><fiddle-embed name="99aa73f64df8bbf06e656cd891a81b9e"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2174 | |
| 2175 | #### Example Output |
| 2176 | |
| 2177 | ~~~~ |
| 2178 | 0 == paint.getStrokeWidth() |
| 2179 | ~~~~ |
| 2180 | |
| 2181 | </fiddle-embed></div> |
| 2182 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2183 | <a name='SkPaint_setStrokeWidth'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2184 | |
| 2185 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2186 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2187 | <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] | 2188 | 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] | 2189 | </pre> |
| 2190 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2191 | 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] | 2192 | outline the shape. |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2193 | 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] | 2194 | |
| 2195 | ### Parameters |
| 2196 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2197 | <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] | 2198 | <td>zero thickness for hairline; greater than zero for pen thickness</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2199 | </tr> |
| 2200 | </table> |
| 2201 | |
| 2202 | ### Example |
| 2203 | |
| 2204 | <div><fiddle-embed name="0c4446c0870b5c7b5a2efe77ff92afb8"> |
| 2205 | |
| 2206 | #### Example Output |
| 2207 | |
| 2208 | ~~~~ |
| 2209 | 5 == paint.getStrokeWidth() |
| 2210 | ~~~~ |
| 2211 | |
| 2212 | </fiddle-embed></div> |
| 2213 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2214 | <a name='Miter_Limit'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2215 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2216 | --- |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 2217 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2218 | <a href='#Paint_Miter_Limit'>Miter_Limit</a> specifies the maximum miter length, |
| 2219 | relative to the <a href='#Stroke_Width'>stroke width</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2220 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2221 | <a href='#Paint_Miter_Limit'>Miter_Limit</a> is used when the <a href='#Paint_Stroke_Join'>Stroke_Join</a> |
| 2222 | 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> |
| 2223 | or <a href='#SkPaint_kStrokeAndFill_Style'>kStrokeAndFill_Style</a>. |
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 | If the miter at a corner exceeds this limit, <a href='#SkPaint_kMiter_Join'>kMiter_Join</a> |
| 2226 | is replaced with <a href='#SkPaint_kBevel_Join'>kBevel_Join</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2227 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2228 | <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] | 2229 | <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] | 2230 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2231 | <a href='#Paint_Miter_Limit'>Miter_Limit</a> default value is 4. |
| 2232 | The default may be changed at compile time by setting <a href='undocumented#SkPaintDefaults_MiterLimit'>SkPaintDefaults_MiterLimit</a> |
| 2233 | in "SkUserConfig.h" or as a define supplied by the build environment. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2234 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2235 | Here are some miter limits and the angles that triggers them. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2236 | |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 2237 | | <a href='#Miter_Limit'>miter limit</a> | angle in degrees | |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2238 | | --- | --- | |
| 2239 | | 10 | 11.48 | |
| 2240 | | 9 | 12.76 | |
| 2241 | | 8 | 14.36 | |
| 2242 | | 7 | 16.43 | |
| 2243 | | 6 | 19.19 | |
| 2244 | | 5 | 23.07 | |
| 2245 | | 4 | 28.96 | |
| 2246 | | 3 | 38.94 | |
| 2247 | | 2 | 60 | |
| 2248 | | 1 | 180 | |
| 2249 | |
| 2250 | ### Example |
| 2251 | |
Cary Clark | a619d45 | 2018-07-16 08:12:01 -0400 | [diff] [blame] | 2252 | <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] | 2253 | 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] | 2254 | by a bevel join. |
| 2255 | </div></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2256 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2257 | <a name='SkPaint_getStrokeMiter'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2258 | |
| 2259 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2260 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2261 | <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] | 2262 | <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] | 2263 | </pre> |
| 2264 | |
Cary Clark | 80247e5 | 2018-07-11 16:18:41 -0400 | [diff] [blame] | 2265 | Returns the limit at which a sharp corner is drawn beveled. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2266 | |
| 2267 | ### Return Value |
| 2268 | |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 2269 | zero and greater miter limit |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2270 | |
| 2271 | ### Example |
| 2272 | |
| 2273 | <div><fiddle-embed name="50da74a43b725f07a914df588c867d36"> |
| 2274 | |
| 2275 | #### Example Output |
| 2276 | |
| 2277 | ~~~~ |
| 2278 | default miter limit == 4 |
| 2279 | ~~~~ |
| 2280 | |
| 2281 | </fiddle-embed></div> |
| 2282 | |
| 2283 | ### See Also |
| 2284 | |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 2285 | <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] | 2286 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2287 | <a name='SkPaint_setStrokeMiter'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2288 | |
| 2289 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2290 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2291 | <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] | 2292 | 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] | 2293 | </pre> |
| 2294 | |
Cary Clark | 80247e5 | 2018-07-11 16:18:41 -0400 | [diff] [blame] | 2295 | Sets the limit at which a sharp corner is drawn beveled. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2296 | Valid values are zero and greater. |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2297 | 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] | 2298 | |
| 2299 | ### Parameters |
| 2300 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2301 | <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] | 2302 | <td>zero and greater <a href='#Miter_Limit'>miter limit</a></td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2303 | </tr> |
| 2304 | </table> |
| 2305 | |
| 2306 | ### Example |
| 2307 | |
skia-bookmaker | a717ca9 | 2018-07-08 05:32:09 +0000 | [diff] [blame] | 2308 | <div><fiddle-embed name="700b284dbc97785c6a9c9636088713ad"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2309 | |
| 2310 | #### Example Output |
| 2311 | |
| 2312 | ~~~~ |
| 2313 | default miter limit == 8 |
| 2314 | ~~~~ |
| 2315 | |
| 2316 | </fiddle-embed></div> |
| 2317 | |
| 2318 | ### See Also |
| 2319 | |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 2320 | <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] | 2321 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2322 | <a name='Stroke_Cap'></a> |
| 2323 | |
| 2324 | <a name='SkPaint_Cap'></a> |
| 2325 | |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2326 | --- |
| 2327 | |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 2328 | <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] | 2329 | enum <a href='#SkPaint_Cap'>Cap</a> { |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 2330 | <a href='#SkPaint_kButt_Cap'>kButt_Cap</a>, |
| 2331 | <a href='#SkPaint_kRound_Cap'>kRound_Cap</a>, |
| 2332 | <a href='#SkPaint_kSquare_Cap'>kSquare_Cap</a>, |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 2333 | <a href='#SkPaint_kLast_Cap'>kLast_Cap</a> = <a href='#SkPaint_kSquare_Cap'>kSquare_Cap</a>, |
| 2334 | <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] | 2335 | }; |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2336 | </pre> |
Cary Clark | 6fc5041 | 2017-09-21 12:31:06 -0400 | [diff] [blame] | 2337 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2338 | <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] | 2339 | 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] | 2340 | </pre> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2341 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2342 | <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] | 2343 | |
| 2344 | ### Constants |
| 2345 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2346 | <table style='border-collapse: collapse; width: 62.5em'> |
| 2347 | <tr><th style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>Const</th> |
| 2348 | <th style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>Value</th> |
| 2349 | <th style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>Description</th></tr> |
| 2350 | <tr style='background-color: #f0f0f0; '> |
| 2351 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kButt_Cap'><code>SkPaint::kButt_Cap</code></a></td> |
| 2352 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>0</td> |
| 2353 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 2354 | Does not extend the stroke past the beginning or the end. |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 2355 | </td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2356 | </tr> |
| 2357 | <tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2358 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kRound_Cap'><code>SkPaint::kRound_Cap</code></a></td> |
| 2359 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>1</td> |
| 2360 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2361 | Adds a <a href='undocumented#Circle'>circle</a> with a diameter equal to <a href='#Paint_Stroke_Width'>Stroke_Width</a> at the beginning |
| 2362 | and end. |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 2363 | </td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2364 | </tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2365 | <tr style='background-color: #f0f0f0; '> |
| 2366 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kSquare_Cap'><code>SkPaint::kSquare_Cap</code></a></td> |
| 2367 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>2</td> |
| 2368 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2369 | Adds a square with sides equal to <a href='#Paint_Stroke_Width'>Stroke_Width</a> at the beginning |
| 2370 | and end. The square sides are parallel to the initial and final direction |
| 2371 | of the stroke. |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 2372 | </td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2373 | </tr> |
| 2374 | <tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2375 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kLast_Cap'><code>SkPaint::kLast_Cap</code></a></td> |
| 2376 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>2</td> |
| 2377 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 2378 | 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] | 2379 | </td> |
| 2380 | </tr> |
| 2381 | <tr style='background-color: #f0f0f0; '> |
| 2382 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kDefault_Cap'><code>SkPaint::kDefault_Cap</code></a></td> |
| 2383 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>0</td> |
| 2384 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2385 | <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] | 2386 | </td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2387 | </tr> |
| 2388 | <tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2389 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kCapCount'><code>SkPaint::kCapCount</code></a></td> |
| 2390 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>3</td> |
| 2391 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2392 | 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] | 2393 | </td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2394 | </tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2395 | </table> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2396 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2397 | Stroke describes the area covered by a pen of <a href='#Paint_Stroke_Width'>Stroke_Width</a> as it |
| 2398 | 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] | 2399 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2400 | 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 |
| 2401 | visible beginning and end. |
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 | <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] | 2404 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2405 | <a href='#SkPaint_kButt_Cap'>kButt_Cap</a> and <a href='#Path_Overview_Contour_Zero_Length'>Zero_Length_Contour</a> is not drawn. |
| 2406 | <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> |
| 2407 | at the <a href='SkPath_Overview#Contour'>contour</a> <a href='SkPoint_Reference#Point'>point</a>. |
| 2408 | <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 |
| 2409 | <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] | 2410 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2411 | <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] | 2412 | |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2413 | ### Example |
| 2414 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 2415 | <div><fiddle-embed name="2bffb6384cc20077e632e7d01da045ca"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2416 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2417 | <a name='SkPaint_getStrokeCap'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2418 | |
| 2419 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2420 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2421 | <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] | 2422 | <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] | 2423 | </pre> |
| 2424 | |
Cary Clark | 80247e5 | 2018-07-11 16:18:41 -0400 | [diff] [blame] | 2425 | Returns the geometry drawn at the beginning and end of strokes. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2426 | |
| 2427 | ### Return Value |
| 2428 | |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 2429 | 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] | 2430 | |
| 2431 | ### Example |
| 2432 | |
| 2433 | <div><fiddle-embed name="aabf9baee8e026fae36fca30e955512b"> |
| 2434 | |
| 2435 | #### Example Output |
| 2436 | |
| 2437 | ~~~~ |
| 2438 | kButt_Cap == default stroke cap |
| 2439 | ~~~~ |
| 2440 | |
| 2441 | </fiddle-embed></div> |
| 2442 | |
| 2443 | ### See Also |
| 2444 | |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 2445 | <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] | 2446 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2447 | <a name='SkPaint_setStrokeCap'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2448 | |
| 2449 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2450 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2451 | <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] | 2452 | 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] | 2453 | </pre> |
| 2454 | |
Cary Clark | 80247e5 | 2018-07-11 16:18:41 -0400 | [diff] [blame] | 2455 | Sets the geometry drawn at the beginning and end of strokes. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2456 | |
| 2457 | ### Parameters |
| 2458 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2459 | <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] | 2460 | <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] | 2461 | </tr> |
| 2462 | </table> |
| 2463 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2464 | 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] | 2465 | |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2466 | ### Example |
| 2467 | |
| 2468 | <div><fiddle-embed name="de83fbd848a4625345b4b87a6e55d98a"> |
| 2469 | |
| 2470 | #### Example Output |
| 2471 | |
| 2472 | ~~~~ |
| 2473 | kRound_Cap == paint.getStrokeCap() |
| 2474 | ~~~~ |
| 2475 | |
| 2476 | </fiddle-embed></div> |
| 2477 | |
| 2478 | ### See Also |
| 2479 | |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 2480 | <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] | 2481 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2482 | <a name='Stroke_Join'></a> |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 2483 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2484 | <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] | 2485 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2486 | Stroke describes the area covered by a pen of <a href='#Paint_Stroke_Width'>Stroke_Width</a> as it |
| 2487 | 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] | 2488 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2489 | If the <a href='SkPath_Overview#Contour'>contour</a> direction changes abruptly, because the tangent direction leading |
| 2490 | 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 |
| 2491 | 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] | 2492 | |
| 2493 | ### Example |
| 2494 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 2495 | <div><fiddle-embed name="917c44b504d3f9308571fd3835d90a0d"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2496 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2497 | <a name='SkPaint_Join'></a> |
| 2498 | |
| 2499 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2500 | |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 2501 | <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] | 2502 | enum <a href='#SkPaint_Join'>Join</a> : uint8_t { |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 2503 | <a href='#SkPaint_kMiter_Join'>kMiter_Join</a>, |
| 2504 | <a href='#SkPaint_kRound_Join'>kRound_Join</a>, |
| 2505 | <a href='#SkPaint_kBevel_Join'>kBevel_Join</a>, |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 2506 | <a href='#SkPaint_kLast_Join'>kLast_Join</a> = <a href='#SkPaint_kBevel_Join'>kBevel_Join</a>, |
| 2507 | <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] | 2508 | }; |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2509 | </pre> |
Cary Clark | 6fc5041 | 2017-09-21 12:31:06 -0400 | [diff] [blame] | 2510 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2511 | <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] | 2512 | 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] | 2513 | </pre> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2514 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2515 | <a href='#SkPaint_Join'>Join</a> specifies how corners are drawn when a shape is stroked. <a href='#SkPaint_Join'>Join</a> |
| 2516 | affects the four corners of a stroked rectangle, and the connected segments in a |
| 2517 | stroked <a href='SkPath_Reference#Path'>path</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2518 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2519 | Choose miter join to draw sharp corners. Choose round join to draw a <a href='undocumented#Circle'>circle</a> with a |
| 2520 | radius equal to the <a href='#Stroke_Width'>stroke width</a> on top of the corner. Choose bevel join to minimally |
| 2521 | connect the thick strokes. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2522 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2523 | 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 |
| 2524 | not contain the actual join. For instance, a <a href='#Fill_Path'>fill path</a> constructed with round joins does |
| 2525 | 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] | 2526 | |
| 2527 | ### Constants |
| 2528 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2529 | <table style='border-collapse: collapse; width: 62.5em'> |
| 2530 | <tr><th style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>Const</th> |
| 2531 | <th style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>Value</th> |
| 2532 | <th style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>Description</th></tr> |
| 2533 | <tr style='background-color: #f0f0f0; '> |
| 2534 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kMiter_Join'><code>SkPaint::kMiter_Join</code></a></td> |
| 2535 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>0</td> |
| 2536 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 2537 | 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] | 2538 | 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] | 2539 | </td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2540 | </tr> |
| 2541 | <tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2542 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kRound_Join'><code>SkPaint::kRound_Join</code></a></td> |
| 2543 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>1</td> |
| 2544 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2545 | 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] | 2546 | </td> |
| 2547 | </tr> |
| 2548 | <tr style='background-color: #f0f0f0; '> |
| 2549 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kBevel_Join'><code>SkPaint::kBevel_Join</code></a></td> |
| 2550 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>2</td> |
| 2551 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 2552 | Connects the outside edges of the sharp corner. |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 2553 | </td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2554 | </tr> |
| 2555 | <tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2556 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kLast_Join'><code>SkPaint::kLast_Join</code></a></td> |
| 2557 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>2</td> |
| 2558 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 2559 | equivalent to the largest value for Stroke_Join</td> |
| 2560 | </tr> |
| 2561 | <tr style='background-color: #f0f0f0; '> |
| 2562 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kDefault_Join'><code>SkPaint::kDefault_Join</code></a></td> |
| 2563 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>1</td> |
| 2564 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2565 | <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] | 2566 | </td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2567 | </tr> |
| 2568 | <tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2569 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kJoinCount'><code>SkPaint::kJoinCount</code></a></td> |
| 2570 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>3</td> |
| 2571 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2572 | 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] | 2573 | </td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2574 | </tr> |
| 2575 | </table> |
| 2576 | |
| 2577 | ### Example |
| 2578 | |
| 2579 | <div><fiddle-embed name="3b1aebacc21c1836a52876b9b0b3905e"></fiddle-embed></div> |
| 2580 | |
| 2581 | ### See Also |
| 2582 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2583 | <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] | 2584 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2585 | <a name='SkPaint_getStrokeJoin'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2586 | |
| 2587 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2588 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2589 | <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] | 2590 | <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] | 2591 | </pre> |
| 2592 | |
Cary Clark | 80247e5 | 2018-07-11 16:18:41 -0400 | [diff] [blame] | 2593 | Returns the geometry drawn at the corners of strokes. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2594 | |
| 2595 | ### Return Value |
| 2596 | |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 2597 | 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] | 2598 | |
| 2599 | ### Example |
| 2600 | |
Cary Clark | 7f644ec | 2018-07-19 10:50:44 -0400 | [diff] [blame] | 2601 | <div><fiddle-embed name="31bf751d0a8ddf176b871810820d8199"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2602 | |
| 2603 | #### Example Output |
| 2604 | |
| 2605 | ~~~~ |
| 2606 | kMiter_Join == default stroke join |
| 2607 | ~~~~ |
| 2608 | |
| 2609 | </fiddle-embed></div> |
| 2610 | |
| 2611 | ### See Also |
| 2612 | |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 2613 | <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] | 2614 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2615 | <a name='SkPaint_setStrokeJoin'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2616 | |
| 2617 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2618 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2619 | <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] | 2620 | 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] | 2621 | </pre> |
| 2622 | |
Cary Clark | 80247e5 | 2018-07-11 16:18:41 -0400 | [diff] [blame] | 2623 | Sets the geometry drawn at the corners of strokes. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2624 | |
| 2625 | ### Parameters |
| 2626 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2627 | <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] | 2628 | <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] | 2629 | </tr> |
| 2630 | </table> |
| 2631 | |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 2632 | otherwise, has no effect |
| 2633 | |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2634 | ### Example |
| 2635 | |
| 2636 | <div><fiddle-embed name="48d963ad4286eddf680f9c511eb6da91"> |
| 2637 | |
| 2638 | #### Example Output |
| 2639 | |
| 2640 | ~~~~ |
| 2641 | kMiter_Join == paint.getStrokeJoin() |
| 2642 | ~~~~ |
| 2643 | |
| 2644 | </fiddle-embed></div> |
| 2645 | |
| 2646 | ### See Also |
| 2647 | |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 2648 | <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] | 2649 | |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2650 | ### See Also |
| 2651 | |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 2652 | <a href='#Paint_Miter_Limit'>Miter_Limit</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2653 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2654 | <a name='Fill_Path'></a> |
| 2655 | |
| 2656 | --- |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 2657 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2658 | <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] | 2659 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2660 | 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 |
| 2661 | replaces the destination <a href='SkPath_Reference#Path'>Path</a>. Otherwise, the source <a href='SkPath_Reference#Path'>Path</a> is replaces the |
| 2662 | destination <a href='SkPath_Reference#Path'>Path</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2663 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2664 | 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 |
| 2665 | 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] | 2666 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2667 | 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>, |
| 2668 | 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>, |
| 2669 | 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] | 2670 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2671 | 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] | 2672 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2673 | 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> |
| 2674 | returns false since Hairline has no filled equivalent. |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2675 | |
| 2676 | ### See Also |
| 2677 | |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 2678 | <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] | 2679 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2680 | <a name='SkPaint_getFillPath'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2681 | |
| 2682 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2683 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2684 | <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] | 2685 | 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] | 2686 | </pre> |
| 2687 | |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 2688 | 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] | 2689 | |
| 2690 | ### Parameters |
| 2691 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2692 | <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] | 2693 | <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] | 2694 | </tr> |
| 2695 | <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] | 2696 | <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] | 2697 | </tr> |
| 2698 | <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] | 2699 | <td>optional limit passed to <a href='undocumented#SkPathEffect'>SkPathEffect</a></td> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2700 | </tr> |
| 2701 | <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] | 2702 | <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] | 2703 | </tr> |
| 2704 | </table> |
| 2705 | |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 2706 | to favor speed and <a href='undocumented#Size'>size</a> |
| 2707 | |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2708 | ### Return Value |
| 2709 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2710 | 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] | 2711 | |
| 2712 | ### Example |
| 2713 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2714 | <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. |
| 2715 | At the lowest precision, the <a href='SkPath_Reference#Quad'>Quad</a> stroke is approximated by a rectangle. |
| 2716 | 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] | 2717 | </div></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2718 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2719 | <a name='SkPaint_getFillPath_2'></a> |
Cary Clark | 2dc84ad | 2018-01-26 12:56:22 -0500 | [diff] [blame] | 2720 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2721 | --- |
| 2722 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2723 | <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] | 2724 | 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] | 2725 | </pre> |
| 2726 | |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 2727 | 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] | 2728 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2729 | 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>. |
| 2730 | <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] | 2731 | |
| 2732 | ### Parameters |
| 2733 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2734 | <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] | 2735 | <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] | 2736 | </tr> |
| 2737 | <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] | 2738 | <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] | 2739 | </tr> |
| 2740 | </table> |
| 2741 | |
| 2742 | ### Return Value |
| 2743 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2744 | 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] | 2745 | |
| 2746 | ### Example |
| 2747 | |
| 2748 | <div><fiddle-embed name="e6d8ca0cc17e0b475bd54dd995825468"></fiddle-embed></div> |
| 2749 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2750 | <a name='Shader_Methods'></a> |
| 2751 | |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2752 | --- |
| 2753 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2754 | <a href='undocumented#Shader'>Shader</a> defines the colors used when drawing a shape. |
| 2755 | <a href='undocumented#Shader'>Shader</a> may be an <a href='SkImage_Reference#Image'>image</a>, a gradient, or a computed fill. |
| 2756 | 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] | 2757 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2758 | <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>. |
| 2759 | 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 |
| 2760 | the fill. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2761 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2762 | 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] | 2763 | |
| 2764 | ### Example |
| 2765 | |
| 2766 | <div><fiddle-embed name="c015dc2010c15e1c00b4f7330232b0f7"></fiddle-embed></div> |
| 2767 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2768 | 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] | 2769 | |
| 2770 | ### Example |
| 2771 | |
skia-bookmaker | 525f9a9 | 2018-05-03 06:27:39 +0000 | [diff] [blame] | 2772 | <div><fiddle-embed name="fe80fd80b98a20823db7fb9a077243c7"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2773 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2774 | <a name='SkPaint_getShader'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2775 | |
| 2776 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2777 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2778 | <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] | 2779 | <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] | 2780 | </pre> |
| 2781 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2782 | 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] | 2783 | |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 2784 | 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] | 2785 | |
| 2786 | ### Return Value |
| 2787 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2788 | <a href='undocumented#SkShader'>SkShader</a> if previously set, nullptr otherwise |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2789 | |
| 2790 | ### Example |
| 2791 | |
| 2792 | <div><fiddle-embed name="09f15b9fd88882850da2d235eb86292f"> |
| 2793 | |
| 2794 | #### Example Output |
| 2795 | |
| 2796 | ~~~~ |
| 2797 | nullptr == shader |
| 2798 | nullptr != shader |
| 2799 | ~~~~ |
| 2800 | |
| 2801 | </fiddle-embed></div> |
| 2802 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2803 | <a name='SkPaint_refShader'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2804 | |
| 2805 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2806 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2807 | <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] | 2808 | <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] | 2809 | </pre> |
| 2810 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2811 | 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] | 2812 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2813 | 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] | 2814 | |
| 2815 | ### Return Value |
| 2816 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2817 | <a href='undocumented#SkShader'>SkShader</a> if previously set, nullptr otherwise |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2818 | |
| 2819 | ### Example |
| 2820 | |
| 2821 | <div><fiddle-embed name="53da0295972a418cbc9607bbb17feaa8"> |
| 2822 | |
| 2823 | #### Example Output |
| 2824 | |
| 2825 | ~~~~ |
| 2826 | shader unique: true |
| 2827 | shader unique: false |
| 2828 | ~~~~ |
| 2829 | |
| 2830 | </fiddle-embed></div> |
| 2831 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2832 | <a name='SkPaint_setShader'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2833 | |
| 2834 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2835 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2836 | <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] | 2837 | 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] | 2838 | </pre> |
| 2839 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2840 | 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] | 2841 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2842 | 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>. |
| 2843 | 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] | 2844 | |
| 2845 | ### Parameters |
| 2846 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2847 | <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] | 2848 | <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] | 2849 | </tr> |
| 2850 | </table> |
| 2851 | |
| 2852 | ### Example |
| 2853 | |
skia-bookmaker | e0a458f | 2018-07-16 05:29:00 +0000 | [diff] [blame] | 2854 | <div><fiddle-embed name="77e64d5bae9b1ba037fd99252bb4aa58"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2855 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2856 | <a name='Color_Filter_Methods'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2857 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2858 | --- |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 2859 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2860 | <a href='#Color_Filter'>Color_Filter</a> alters the <a href='SkColor_Reference#Color'>color</a> used when drawing a shape. |
| 2861 | <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. |
| 2862 | 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] | 2863 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2864 | 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] | 2865 | |
| 2866 | ### Example |
| 2867 | |
| 2868 | <div><fiddle-embed name="5abde56ca2f89a18b8e231abd1b57c56"></fiddle-embed></div> |
| 2869 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2870 | <a name='SkPaint_getColorFilter'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2871 | |
| 2872 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2873 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2874 | <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] | 2875 | <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] | 2876 | </pre> |
| 2877 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2878 | Returns <a href='undocumented#SkColorFilter'>SkColorFilter</a> if set, or nullptr. |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 2879 | 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] | 2880 | |
| 2881 | ### Return Value |
| 2882 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2883 | <a href='undocumented#SkColorFilter'>SkColorFilter</a> if previously set, nullptr otherwise |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2884 | |
| 2885 | ### Example |
| 2886 | |
| 2887 | <div><fiddle-embed name="093bdc627d6b59002670fd290931f6c9"> |
| 2888 | |
| 2889 | #### Example Output |
| 2890 | |
| 2891 | ~~~~ |
| 2892 | nullptr == color filter |
| 2893 | nullptr != color filter |
| 2894 | ~~~~ |
| 2895 | |
| 2896 | </fiddle-embed></div> |
| 2897 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2898 | <a name='SkPaint_refColorFilter'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2899 | |
| 2900 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2901 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2902 | <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] | 2903 | <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] | 2904 | </pre> |
| 2905 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2906 | Returns <a href='undocumented#SkColorFilter'>SkColorFilter</a> if set, or nullptr. |
| 2907 | 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] | 2908 | |
| 2909 | ### Return Value |
| 2910 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2911 | <a href='undocumented#SkColorFilter'>SkColorFilter</a> if set, or nullptr |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2912 | |
| 2913 | ### Example |
| 2914 | |
| 2915 | <div><fiddle-embed name="b588c95fa4c86ddbc4b0546762f08297"> |
| 2916 | |
| 2917 | #### Example Output |
| 2918 | |
| 2919 | ~~~~ |
| 2920 | color filter unique: true |
| 2921 | color filter unique: false |
| 2922 | ~~~~ |
| 2923 | |
| 2924 | </fiddle-embed></div> |
| 2925 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2926 | <a name='SkPaint_setColorFilter'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2927 | |
| 2928 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2929 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2930 | <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] | 2931 | 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] | 2932 | </pre> |
| 2933 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2934 | Sets <a href='undocumented#SkColorFilter'>SkColorFilter</a> to filter, decreasing <a href='undocumented#SkRefCnt'>SkRefCnt</a> of the previous |
| 2935 | <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] | 2936 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2937 | Increments filter <a href='undocumented#SkRefCnt'>SkRefCnt</a> by one. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2938 | |
| 2939 | ### Parameters |
| 2940 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2941 | <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] | 2942 | <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] | 2943 | </tr> |
| 2944 | </table> |
| 2945 | |
| 2946 | ### Example |
| 2947 | |
skia-bookmaker | 61cc9fa | 2018-07-11 05:28:17 +0000 | [diff] [blame] | 2948 | <div><fiddle-embed name="c7b786dc9b3501cd0eaba47494b6fa31"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2949 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2950 | <a name='Blend_Mode_Methods'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2951 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2952 | --- |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 2953 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2954 | <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>. |
| 2955 | 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> |
| 2956 | over the destination <a href='SkColor_Reference#Color'>color</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2957 | |
| 2958 | ### Example |
| 2959 | |
Cary Clark | 8364706 | 2018-07-18 16:21:51 -0400 | [diff] [blame] | 2960 | <div><fiddle-embed name="73092d4d06faecea3c204d852a4dd8a8"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2961 | |
| 2962 | ### See Also |
| 2963 | |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 2964 | <a href='#Blend_Mode'>Blend_Mode</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2965 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2966 | <a name='SkPaint_getBlendMode'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2967 | |
| 2968 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2969 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2970 | <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] | 2971 | <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] | 2972 | </pre> |
| 2973 | |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 2974 | Returns <a href='SkBlendMode_Reference#SkBlendMode'>SkBlendMode</a>. |
| 2975 | 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] | 2976 | |
| 2977 | ### Return Value |
| 2978 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 2979 | 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] | 2980 | |
| 2981 | ### Example |
| 2982 | |
skia-bookmaker | 525f9a9 | 2018-05-03 06:27:39 +0000 | [diff] [blame] | 2983 | <div><fiddle-embed name="a1e059c8f6740fa2044cc64152b39dda"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2984 | |
| 2985 | #### Example Output |
| 2986 | |
| 2987 | ~~~~ |
| 2988 | kSrcOver == getBlendMode |
| 2989 | kSrcOver != getBlendMode |
| 2990 | ~~~~ |
| 2991 | |
| 2992 | </fiddle-embed></div> |
| 2993 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2994 | <a name='SkPaint_isSrcOver'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2995 | |
| 2996 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2997 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2998 | <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] | 2999 | bool <a href='#SkPaint_isSrcOver'>isSrcOver</a>() const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3000 | </pre> |
| 3001 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3002 | 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] | 3003 | |
| 3004 | ### Return Value |
| 3005 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3006 | 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] | 3007 | |
| 3008 | ### Example |
| 3009 | |
| 3010 | <div><fiddle-embed name="257c9473db7a2b3a0fb2b9e2431e59a6"> |
| 3011 | |
| 3012 | #### Example Output |
| 3013 | |
| 3014 | ~~~~ |
| 3015 | isSrcOver == true |
| 3016 | isSrcOver != true |
| 3017 | ~~~~ |
| 3018 | |
| 3019 | </fiddle-embed></div> |
| 3020 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3021 | <a name='SkPaint_setBlendMode'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3022 | |
| 3023 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3024 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3025 | <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] | 3026 | 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] | 3027 | </pre> |
| 3028 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3029 | 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] | 3030 | Does not check for valid input. |
| 3031 | |
| 3032 | ### Parameters |
| 3033 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3034 | <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] | 3035 | <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] | 3036 | </tr> |
| 3037 | </table> |
| 3038 | |
| 3039 | ### Example |
| 3040 | |
| 3041 | <div><fiddle-embed name="257c9473db7a2b3a0fb2b9e2431e59a6"> |
| 3042 | |
| 3043 | #### Example Output |
| 3044 | |
| 3045 | ~~~~ |
| 3046 | isSrcOver == true |
| 3047 | isSrcOver != true |
| 3048 | ~~~~ |
| 3049 | |
| 3050 | </fiddle-embed></div> |
| 3051 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3052 | <a name='Path_Effect_Methods'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3053 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3054 | --- |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 3055 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3056 | <a href='#Path_Effect'>Path_Effect</a> modifies the <a href='SkPath_Reference#Path'>path</a> geometry before drawing it. |
| 3057 | <a href='#Path_Effect'>Path_Effect</a> may implement dashing, custom fill effects and custom stroke effects. |
| 3058 | 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] | 3059 | |
| 3060 | ### Example |
| 3061 | |
| 3062 | <div><fiddle-embed name="8cf5684b187d60f09e11c4a48993ea39"></fiddle-embed></div> |
| 3063 | |
| 3064 | ### See Also |
| 3065 | |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 3066 | <a href='#Path_Effect'>Path_Effect</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3067 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3068 | <a name='SkPaint_getPathEffect'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3069 | |
| 3070 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3071 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3072 | <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] | 3073 | <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] | 3074 | </pre> |
| 3075 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3076 | Returns <a href='undocumented#SkPathEffect'>SkPathEffect</a> if set, or nullptr. |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 3077 | 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] | 3078 | |
| 3079 | ### Return Value |
| 3080 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3081 | <a href='undocumented#SkPathEffect'>SkPathEffect</a> if previously set, nullptr otherwise |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3082 | |
| 3083 | ### Example |
| 3084 | |
skia-bookmaker | b95bbba | 2018-07-06 05:23:23 +0000 | [diff] [blame] | 3085 | <div><fiddle-embed name="211a1b14bfa6c4332082c8eab4fbc5fd"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3086 | |
| 3087 | #### Example Output |
| 3088 | |
| 3089 | ~~~~ |
| 3090 | nullptr == path effect |
| 3091 | nullptr != path effect |
| 3092 | ~~~~ |
| 3093 | |
| 3094 | </fiddle-embed></div> |
| 3095 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3096 | <a name='SkPaint_refPathEffect'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3097 | |
| 3098 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3099 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3100 | <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] | 3101 | <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] | 3102 | </pre> |
| 3103 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3104 | Returns <a href='undocumented#SkPathEffect'>SkPathEffect</a> if set, or nullptr. |
| 3105 | 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] | 3106 | |
| 3107 | ### Return Value |
| 3108 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3109 | <a href='undocumented#SkPathEffect'>SkPathEffect</a> if previously set, nullptr otherwise |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3110 | |
| 3111 | ### Example |
| 3112 | |
Cary Clark | 8364706 | 2018-07-18 16:21:51 -0400 | [diff] [blame] | 3113 | <div><fiddle-embed name="f56039b94c702c2704c8c5100e623aca"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3114 | |
| 3115 | #### Example Output |
| 3116 | |
| 3117 | ~~~~ |
| 3118 | path effect unique: true |
| 3119 | path effect unique: false |
| 3120 | ~~~~ |
| 3121 | |
| 3122 | </fiddle-embed></div> |
| 3123 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3124 | <a name='SkPaint_setPathEffect'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3125 | |
| 3126 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3127 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3128 | <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] | 3129 | 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] | 3130 | </pre> |
| 3131 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3132 | 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 |
| 3133 | <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] | 3134 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3135 | 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] | 3136 | |
| 3137 | ### Parameters |
| 3138 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3139 | <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] | 3140 | <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] | 3141 | </tr> |
| 3142 | </table> |
| 3143 | |
| 3144 | ### Example |
| 3145 | |
| 3146 | <div><fiddle-embed name="52dd55074ca0b7d520d04e750ca2a0d7"></fiddle-embed></div> |
| 3147 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3148 | <a name='Mask_Filter_Methods'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3149 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3150 | --- |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 3151 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3152 | <a href='#Mask_Filter'>Mask_Filter</a> uses coverage of the shape drawn to create <a href='#Mask_Alpha'>Mask_Alpha</a>. |
| 3153 | <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] | 3154 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3155 | <a href='#Mask_Filter'>Mask_Filter</a> may change the geometry and transparency of the shape, such as |
| 3156 | creating a blur effect. Set <a href='#Mask_Filter'>Mask_Filter</a> to nullptr to prevent <a href='#Mask_Filter'>Mask_Filter</a> from |
| 3157 | modifying the draw. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3158 | |
| 3159 | ### Example |
| 3160 | |
Cary Clark | 681287e | 2018-03-16 11:34:15 -0400 | [diff] [blame] | 3161 | <div><fiddle-embed name="55d7b9d482ac8e17a6153f555a8adb8d"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3162 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3163 | <a name='SkPaint_getMaskFilter'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3164 | |
| 3165 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3166 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3167 | <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] | 3168 | <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] | 3169 | </pre> |
| 3170 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3171 | Returns <a href='undocumented#SkMaskFilter'>SkMaskFilter</a> if set, or nullptr. |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 3172 | 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] | 3173 | |
| 3174 | ### Return Value |
| 3175 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3176 | <a href='undocumented#SkMaskFilter'>SkMaskFilter</a> if previously set, nullptr otherwise |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3177 | |
| 3178 | ### Example |
| 3179 | |
Cary Clark | 681287e | 2018-03-16 11:34:15 -0400 | [diff] [blame] | 3180 | <div><fiddle-embed name="5ac4b31371726da87bb7390b385e9fee"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3181 | |
| 3182 | #### Example Output |
| 3183 | |
| 3184 | ~~~~ |
| 3185 | nullptr == mask filter |
| 3186 | nullptr != mask filter |
| 3187 | ~~~~ |
| 3188 | |
| 3189 | </fiddle-embed></div> |
| 3190 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3191 | <a name='SkPaint_refMaskFilter'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3192 | |
| 3193 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3194 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3195 | <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] | 3196 | <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] | 3197 | </pre> |
| 3198 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3199 | Returns <a href='undocumented#SkMaskFilter'>SkMaskFilter</a> if set, or nullptr. |
Cary Clark | 6fc5041 | 2017-09-21 12:31:06 -0400 | [diff] [blame] | 3200 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3201 | 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] | 3202 | |
| 3203 | ### Return Value |
| 3204 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3205 | <a href='undocumented#SkMaskFilter'>SkMaskFilter</a> if previously set, nullptr otherwise |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3206 | |
| 3207 | ### Example |
| 3208 | |
Cary Clark | 8364706 | 2018-07-18 16:21:51 -0400 | [diff] [blame] | 3209 | <div><fiddle-embed name="084b0dc3cebd78718c651d58f257f799"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3210 | |
| 3211 | #### Example Output |
| 3212 | |
| 3213 | ~~~~ |
| 3214 | mask filter unique: true |
| 3215 | mask filter unique: false |
| 3216 | ~~~~ |
| 3217 | |
| 3218 | </fiddle-embed></div> |
| 3219 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3220 | <a name='SkPaint_setMaskFilter'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3221 | |
| 3222 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3223 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3224 | <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] | 3225 | 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] | 3226 | </pre> |
| 3227 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3228 | 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 |
| 3229 | <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] | 3230 | <a href='undocumented#Mask_Alpha'>mask alpha</a> unaltered. |
Cary Clark | 6fc5041 | 2017-09-21 12:31:06 -0400 | [diff] [blame] | 3231 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3232 | 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] | 3233 | |
| 3234 | ### Parameters |
| 3235 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3236 | <table> <tr> <td><a name='SkPaint_setMaskFilter_maskFilter'><code><strong>maskFilter</strong></code></a></td> |
| 3237 | <td>modifies clipping mask generated from drawn geometry</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3238 | </tr> |
| 3239 | </table> |
| 3240 | |
| 3241 | ### Example |
| 3242 | |
Cary Clark | 681287e | 2018-03-16 11:34:15 -0400 | [diff] [blame] | 3243 | <div><fiddle-embed name="a993831c40f3e134f809134e3b74e4a6"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3244 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3245 | <a name='Typeface_Methods'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3246 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3247 | --- |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 3248 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3249 | <a href='undocumented#Typeface'>Typeface</a> identifies the <a href='undocumented#Font'>font</a> used when drawing and measuring <a href='undocumented#Text'>text</a>. |
| 3250 | <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>. |
| 3251 | The default <a href='undocumented#Typeface'>Typeface</a> defers to the platform-specific default <a href='undocumented#Font'>font</a> |
| 3252 | implementation. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3253 | |
| 3254 | ### Example |
| 3255 | |
skia-bookmaker | 61cc9fa | 2018-07-11 05:28:17 +0000 | [diff] [blame] | 3256 | <div><fiddle-embed name="1a7a5062725139760962582f599f1b97"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3257 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3258 | <a name='SkPaint_getTypeface'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3259 | |
| 3260 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3261 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3262 | <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] | 3263 | <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] | 3264 | </pre> |
| 3265 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3266 | Returns <a href='undocumented#SkTypeface'>SkTypeface</a> if set, or nullptr. |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 3267 | 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] | 3268 | |
| 3269 | ### Return Value |
| 3270 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3271 | <a href='undocumented#SkTypeface'>SkTypeface</a> if previously set, nullptr otherwise |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3272 | |
| 3273 | ### Example |
| 3274 | |
Cary Clark | f960398 | 2018-07-17 08:20:27 -0400 | [diff] [blame] | 3275 | <div><fiddle-embed name="5ce718e5a184baaac80e7098d7dad67b"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3276 | |
| 3277 | #### Example Output |
| 3278 | |
| 3279 | ~~~~ |
| 3280 | nullptr == typeface |
| 3281 | nullptr != typeface |
| 3282 | ~~~~ |
| 3283 | |
| 3284 | </fiddle-embed></div> |
| 3285 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3286 | <a name='SkPaint_refTypeface'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3287 | |
| 3288 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3289 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3290 | <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] | 3291 | <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] | 3292 | </pre> |
| 3293 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3294 | 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] | 3295 | |
| 3296 | ### Return Value |
| 3297 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3298 | <a href='undocumented#SkTypeface'>SkTypeface</a> if previously set, nullptr otherwise |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3299 | |
| 3300 | ### Example |
| 3301 | |
Cary Clark | 8364706 | 2018-07-18 16:21:51 -0400 | [diff] [blame] | 3302 | <div><fiddle-embed name="8b5aa7e555a0dc31be69db7cadf471a1"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3303 | |
| 3304 | #### Example Output |
| 3305 | |
| 3306 | ~~~~ |
| 3307 | typeface1 != typeface2 |
| 3308 | typeface1 == typeface2 |
| 3309 | ~~~~ |
| 3310 | |
| 3311 | </fiddle-embed></div> |
| 3312 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3313 | <a name='SkPaint_setTypeface'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3314 | |
| 3315 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3316 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3317 | <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] | 3318 | 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] | 3319 | </pre> |
| 3320 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3321 | 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>. |
| 3322 | Pass nullptr to clear <a href='undocumented#SkTypeface'>SkTypeface</a> and use the default <a href='#SkPaint_setTypeface_typeface'>typeface</a>. Increments |
| 3323 | <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] | 3324 | |
| 3325 | ### Parameters |
| 3326 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3327 | <table> <tr> <td><a name='SkPaint_setTypeface_typeface'><code><strong>typeface</strong></code></a></td> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3328 | <td><a href='undocumented#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] | 3329 | </tr> |
| 3330 | </table> |
| 3331 | |
| 3332 | ### Example |
| 3333 | |
Cary Clark | 71961fb | 2018-01-05 14:21:59 -0500 | [diff] [blame] | 3334 | <div><fiddle-embed name="0e6fbb7773cd925b274552f4cd1abef2"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3335 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3336 | <a name='Image_Filter_Methods'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3337 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3338 | --- |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 3339 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3340 | <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> |
| 3341 | 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>, |
| 3342 | 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] | 3343 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3344 | <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> |
| 3345 | 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. |
| 3346 | <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] | 3347 | <a href='#Mask_Filter'>Mask_Filter</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3348 | |
| 3349 | ### Example |
| 3350 | |
skia-bookmaker | 44bad2e | 2018-07-05 05:35:27 +0000 | [diff] [blame] | 3351 | <div><fiddle-embed name="ece04ee3d3761e3425f37c8f06f054c1"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3352 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3353 | <a name='SkPaint_getImageFilter'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3354 | |
| 3355 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3356 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3357 | <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] | 3358 | <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] | 3359 | </pre> |
| 3360 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3361 | Returns <a href='undocumented#SkImageFilter'>SkImageFilter</a> if set, or nullptr. |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 3362 | 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] | 3363 | |
| 3364 | ### Return Value |
| 3365 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3366 | <a href='undocumented#SkImageFilter'>SkImageFilter</a> if previously set, nullptr otherwise |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3367 | |
| 3368 | ### Example |
| 3369 | |
skia-bookmaker | b95bbba | 2018-07-06 05:23:23 +0000 | [diff] [blame] | 3370 | <div><fiddle-embed name="c11f8eaa1dd149bc18db21e23ce26904"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3371 | |
| 3372 | #### Example Output |
| 3373 | |
| 3374 | ~~~~ |
| 3375 | nullptr == image filter |
| 3376 | nullptr != image filter |
| 3377 | ~~~~ |
| 3378 | |
| 3379 | </fiddle-embed></div> |
| 3380 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3381 | <a name='SkPaint_refImageFilter'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3382 | |
| 3383 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3384 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3385 | <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] | 3386 | <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] | 3387 | </pre> |
| 3388 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3389 | Returns <a href='undocumented#SkImageFilter'>SkImageFilter</a> if set, or nullptr. |
| 3390 | 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] | 3391 | |
| 3392 | ### Return Value |
| 3393 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3394 | <a href='undocumented#SkImageFilter'>SkImageFilter</a> if previously set, nullptr otherwise |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3395 | |
| 3396 | ### Example |
| 3397 | |
| 3398 | <div><fiddle-embed name="13f09088b569251547107d14ae989dc1"> |
| 3399 | |
| 3400 | #### Example Output |
| 3401 | |
| 3402 | ~~~~ |
| 3403 | image filter unique: true |
| 3404 | image filter unique: false |
| 3405 | ~~~~ |
| 3406 | |
| 3407 | </fiddle-embed></div> |
| 3408 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3409 | <a name='SkPaint_setImageFilter'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3410 | |
| 3411 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3412 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3413 | <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] | 3414 | 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] | 3415 | </pre> |
| 3416 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3417 | 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 |
| 3418 | <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] | 3419 | on drawing. |
Cary Clark | 6fc5041 | 2017-09-21 12:31:06 -0400 | [diff] [blame] | 3420 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3421 | 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] | 3422 | |
| 3423 | ### Parameters |
| 3424 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3425 | <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] | 3426 | <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] | 3427 | </tr> |
| 3428 | </table> |
| 3429 | |
| 3430 | ### Example |
| 3431 | |
| 3432 | <div><fiddle-embed name="6679d6e4ec632715ee03e68391bd7f9a"></fiddle-embed></div> |
| 3433 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3434 | <a name='Draw_Looper_Methods'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3435 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3436 | --- |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 3437 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3438 | <a href='#Draw_Looper'>Draw_Looper</a> sets a modifier that communicates state from one <a href='#Draw_Layer'>Draw_Layer</a> |
| 3439 | to another to construct the draw. |
Cary Clark | 6fc5041 | 2017-09-21 12:31:06 -0400 | [diff] [blame] | 3440 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3441 | <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. |
| 3442 | <a href='#Draw_Looper'>Draw_Looper</a> may be used to draw multiple colors or create a colored shadow. |
| 3443 | 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] | 3444 | |
| 3445 | ### Example |
| 3446 | |
| 3447 | <div><fiddle-embed name="84ec12a36e50df5ac565cc7a75ffbe9f"></fiddle-embed></div> |
| 3448 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3449 | <a name='SkPaint_getDrawLooper'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3450 | |
| 3451 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3452 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3453 | <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] | 3454 | <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] | 3455 | </pre> |
| 3456 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3457 | Returns <a href='undocumented#SkDrawLooper'>SkDrawLooper</a> if set, or nullptr. |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 3458 | 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] | 3459 | |
| 3460 | ### Return Value |
| 3461 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3462 | <a href='undocumented#SkDrawLooper'>SkDrawLooper</a> if previously set, nullptr otherwise |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3463 | |
| 3464 | ### Example |
| 3465 | |
| 3466 | <div><fiddle-embed name="af4c5acc7a91e7f23c2af48018903ad4"> |
| 3467 | |
| 3468 | #### Example Output |
| 3469 | |
| 3470 | ~~~~ |
| 3471 | nullptr == draw looper |
| 3472 | nullptr != draw looper |
| 3473 | ~~~~ |
| 3474 | |
| 3475 | </fiddle-embed></div> |
| 3476 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3477 | <a name='SkPaint_refDrawLooper'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3478 | |
| 3479 | --- |
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 | <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] | 3482 | <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] | 3483 | </pre> |
| 3484 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3485 | Returns <a href='undocumented#SkDrawLooper'>SkDrawLooper</a> if set, or nullptr. |
| 3486 | 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] | 3487 | |
| 3488 | ### Return Value |
| 3489 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3490 | <a href='undocumented#SkDrawLooper'>SkDrawLooper</a> if previously set, nullptr otherwise |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3491 | |
| 3492 | ### Example |
| 3493 | |
| 3494 | <div><fiddle-embed name="2a3782c33f04ed17a725d0e449c6f7c3"> |
| 3495 | |
| 3496 | #### Example Output |
| 3497 | |
| 3498 | ~~~~ |
| 3499 | draw looper unique: true |
| 3500 | draw looper unique: false |
| 3501 | ~~~~ |
| 3502 | |
| 3503 | </fiddle-embed></div> |
| 3504 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3505 | <a name='SkPaint_getLooper'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3506 | |
| 3507 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3508 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3509 | <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] | 3510 | <a href='undocumented#SkDrawLooper'>SkDrawLooper</a>* <a href='#SkPaint_getLooper'>getLooper</a>() const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3511 | </pre> |
| 3512 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3513 | Deprecated. |
| 3514 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3515 | <a name='SkPaint_setDrawLooper'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3516 | |
| 3517 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3518 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3519 | <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] | 3520 | void setDrawLooper(<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] | 3521 | </pre> |
| 3522 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3523 | 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 |
| 3524 | <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] | 3525 | drawing unaltered. |
| 3526 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3527 | 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] | 3528 | |
| 3529 | ### Parameters |
| 3530 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3531 | <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] | 3532 | <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] | 3533 | </tr> |
| 3534 | </table> |
| 3535 | |
| 3536 | ### Example |
| 3537 | |
| 3538 | <div><fiddle-embed name="bf10f838b330f0a3a3266d42ea68a638"></fiddle-embed></div> |
| 3539 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3540 | <a name='SkPaint_setLooper'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3541 | |
| 3542 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3543 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3544 | <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] | 3545 | void <a href='#SkPaint_setLooper'>setLooper</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] | 3546 | </pre> |
| 3547 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3548 | Deprecated. |
| 3549 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3550 | <a name='Text_Size'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3551 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3552 | --- |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 3553 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3554 | <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>. |
| 3555 | <a href='#Paint_Text_Size'>Text_Size</a> can be set to any positive value or zero. |
| 3556 | <a href='#Paint_Text_Size'>Text_Size</a> defaults to 12. |
| 3557 | 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] | 3558 | |
| 3559 | ### Example |
| 3560 | |
| 3561 | <div><fiddle-embed name="91c9a3e498bb9412e4522a95d076ed5f"></fiddle-embed></div> |
| 3562 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3563 | <a name='SkPaint_getTextSize'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3564 | |
| 3565 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3566 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3567 | <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] | 3568 | <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] | 3569 | </pre> |
| 3570 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3571 | 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] | 3572 | |
| 3573 | ### Return Value |
| 3574 | |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 3575 | typographic height of <a href='undocumented#Text'>text</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3576 | |
| 3577 | ### Example |
| 3578 | |
skia-bookmaker | 233c652 | 2018-07-04 05:33:26 +0000 | [diff] [blame] | 3579 | <div><fiddle-embed name="983e2a71ba72d4ba8c945420040b8f1c"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3580 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3581 | <a name='SkPaint_setTextSize'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3582 | |
| 3583 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3584 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [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 | 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] | 3587 | </pre> |
| 3588 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3589 | Sets <a href='#Text_Size'>text size</a> in <a href='SkPoint_Reference#Point'>points</a>. |
| 3590 | 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] | 3591 | |
| 3592 | ### Parameters |
| 3593 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3594 | <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] | 3595 | <td>typographic height of <a href='undocumented#Text'>text</a></td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3596 | </tr> |
| 3597 | </table> |
| 3598 | |
| 3599 | ### Example |
| 3600 | |
skia-bookmaker | 44bad2e | 2018-07-05 05:35:27 +0000 | [diff] [blame] | 3601 | <div><fiddle-embed name="6510c9e2f57b83c47e67829e7a68d493"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3602 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3603 | <a name='Text_Scale_X'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3604 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3605 | --- |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 3606 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3607 | <a href='#Paint_Text_Scale_X'>Text_Scale_X</a> adjusts the <a href='undocumented#Text'>text</a> horizontal scale. |
| 3608 | <a href='undocumented#Text'>Text</a> scaling approximates condensed and expanded type faces when the actual face |
| 3609 | is not available. |
| 3610 | <a href='#Paint_Text_Scale_X'>Text_Scale_X</a> can be set to any value. |
| 3611 | <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] | 3612 | |
| 3613 | ### Example |
| 3614 | |
skia-bookmaker | 44bad2e | 2018-07-05 05:35:27 +0000 | [diff] [blame] | 3615 | <div><fiddle-embed name="d13d787c1e36f515319fc998411c1d91"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3616 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3617 | <a name='SkPaint_getTextScaleX'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3618 | |
| 3619 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3620 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3621 | <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] | 3622 | <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] | 3623 | </pre> |
| 3624 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3625 | Returns <a href='undocumented#Text'>text</a> scale on x-axis. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3626 | Default value is 1. |
| 3627 | |
| 3628 | ### Return Value |
| 3629 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3630 | <a href='undocumented#Text'>text</a> horizontal scale |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3631 | |
| 3632 | ### Example |
| 3633 | |
| 3634 | <div><fiddle-embed name="5dc8e58f6910cb8e4de9ed60f888188b"></fiddle-embed></div> |
| 3635 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3636 | <a name='SkPaint_setTextScaleX'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3637 | |
| 3638 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3639 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3640 | <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] | 3641 | 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] | 3642 | </pre> |
| 3643 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3644 | Sets <a href='undocumented#Text'>text scale</a> on x-axis. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3645 | Default value is 1. |
| 3646 | |
| 3647 | ### Parameters |
| 3648 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3649 | <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] | 3650 | <td><a href='undocumented#Text'>text</a> horizontal scale</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3651 | </tr> |
| 3652 | </table> |
| 3653 | |
| 3654 | ### Example |
| 3655 | |
| 3656 | <div><fiddle-embed name="a75bbdb8bb866b125c4c1dd5e967d470"></fiddle-embed></div> |
| 3657 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3658 | <a name='Text_Skew_X'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3659 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3660 | --- |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 3661 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3662 | <a href='#Paint_Text_Skew_X'>Text_Skew_X</a> adjusts the <a href='undocumented#Text'>text</a> horizontal slant. |
| 3663 | <a href='undocumented#Text'>Text</a> skewing approximates italic and oblique type faces when the actual face |
| 3664 | is not available. |
| 3665 | <a href='#Paint_Text_Skew_X'>Text_Skew_X</a> can be set to any value. |
| 3666 | <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] | 3667 | |
| 3668 | ### Example |
| 3669 | |
| 3670 | <div><fiddle-embed name="aff208b0aab265f273045b27e683c17c"></fiddle-embed></div> |
| 3671 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3672 | <a name='SkPaint_getTextSkewX'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3673 | |
| 3674 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3675 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3676 | <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] | 3677 | <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] | 3678 | </pre> |
| 3679 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3680 | Returns <a href='undocumented#Text'>text</a> skew on x-axis. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3681 | Default value is zero. |
| 3682 | |
| 3683 | ### Return Value |
| 3684 | |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 3685 | additional shear on x-axis relative to y-axis |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3686 | |
| 3687 | ### Example |
| 3688 | |
Cary Clark | 7f644ec | 2018-07-19 10:50:44 -0400 | [diff] [blame] | 3689 | <div><fiddle-embed name="11c10f466dae0d1639dbb9f6a0040218"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3690 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3691 | <a name='SkPaint_setTextSkewX'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3692 | |
| 3693 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3694 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3695 | <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] | 3696 | 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] | 3697 | </pre> |
| 3698 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3699 | Sets <a href='undocumented#Text'>text skew</a> on x-axis. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3700 | Default value is zero. |
| 3701 | |
| 3702 | ### Parameters |
| 3703 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3704 | <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] | 3705 | <td>additional shear on x-axis relative to y-axis</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3706 | </tr> |
| 3707 | </table> |
| 3708 | |
| 3709 | ### Example |
| 3710 | |
skia-bookmaker | 61cc9fa | 2018-07-11 05:28:17 +0000 | [diff] [blame] | 3711 | <div><fiddle-embed name="6bd705a6e0c5f8ee24f302fe531bfabc"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3712 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3713 | <a name='Text_Encoding'></a> |
| 3714 | |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3715 | --- |
| 3716 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3717 | <a name='SkPaint_TextEncoding'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3718 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3719 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3720 | |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 3721 | <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] | 3722 | enum <a href='#SkPaint_TextEncoding'>TextEncoding</a> : uint8_t { |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 3723 | <a href='#SkPaint_kUTF8_TextEncoding'>kUTF8_TextEncoding</a>, |
| 3724 | <a href='#SkPaint_kUTF16_TextEncoding'>kUTF16_TextEncoding</a>, |
| 3725 | <a href='#SkPaint_kUTF32_TextEncoding'>kUTF32_TextEncoding</a>, |
| 3726 | <a href='#SkPaint_kGlyphID_TextEncoding'>kGlyphID_TextEncoding</a>, |
Cary Clark | 186d08f | 2018-04-03 08:43:27 -0400 | [diff] [blame] | 3727 | }; |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 3728 | </pre> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3729 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3730 | <a href='#SkPaint_TextEncoding'>TextEncoding</a> determines whether <a href='undocumented#Text'>text</a> specifies character codes and their encoded |
| 3731 | <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] | 3732 | <a href='https://unicode.org/standard/standard.html'>Unicode standard</a></a> . |
Cary Clark | 6fc5041 | 2017-09-21 12:31:06 -0400 | [diff] [blame] | 3733 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3734 | Character codes encoded <a href='undocumented#Size'>size</a> are specified by UTF-8, UTF-16, or UTF-32. |
| 3735 | All character code formats are able to represent all of Unicode, differing only |
| 3736 | in the total storage required. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3737 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3738 | <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] | 3739 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3740 | <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] | 3741 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3742 | <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] | 3743 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3744 | <a href='#Font_Manager'>Font_Manager</a> uses <a href='undocumented#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. |
| 3745 | 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] | 3746 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3747 | <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] | 3748 | |
| 3749 | ### Constants |
| 3750 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3751 | <table style='border-collapse: collapse; width: 62.5em'> |
| 3752 | <tr><th style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>Const</th> |
| 3753 | <th style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>Value</th> |
| 3754 | <th style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>Description</th></tr> |
| 3755 | <tr style='background-color: #f0f0f0; '> |
| 3756 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kUTF8_TextEncoding'><code>SkPaint::kUTF8_TextEncoding</code></a></td> |
| 3757 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>0</td> |
| 3758 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 3759 | uses bytes to represent UTF-8 or ASCII</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3760 | </tr> |
| 3761 | <tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3762 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kUTF16_TextEncoding'><code>SkPaint::kUTF16_TextEncoding</code></a></td> |
| 3763 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>1</td> |
| 3764 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 3765 | uses two byte words to represent most of Unicode</td> |
| 3766 | </tr> |
| 3767 | <tr style='background-color: #f0f0f0; '> |
| 3768 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kUTF32_TextEncoding'><code>SkPaint::kUTF32_TextEncoding</code></a></td> |
| 3769 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>2</td> |
| 3770 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 3771 | uses four byte words to represent all of Unicode</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3772 | </tr> |
| 3773 | <tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3774 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kGlyphID_TextEncoding'><code>SkPaint::kGlyphID_TextEncoding</code></a></td> |
| 3775 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>3</td> |
| 3776 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 3777 | uses two byte words to represent glyph indices</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3778 | </tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3779 | </table> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3780 | |
| 3781 | ### Example |
| 3782 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3783 | <div><fiddle-embed name="b29294e7f29d160a1b46abf2dcec9d2a"><div>First <a href='undocumented#Line'>line</a> is encoded in UTF-8. |
| 3784 | Second <a href='undocumented#Line'>line</a> is encoded in UTF-16. |
| 3785 | Third <a href='undocumented#Line'>line</a> is encoded in UTF-32. |
| 3786 | 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] | 3787 | </div></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3788 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3789 | <a name='SkPaint_getTextEncoding'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3790 | |
| 3791 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3792 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3793 | <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] | 3794 | <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] | 3795 | </pre> |
| 3796 | |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 3797 | Returns <a href='SkPaint_Reference#SkPaint'>SkPaint</a>::<a href='#SkPaint_TextEncoding'>TextEncoding</a>. |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3798 | <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='undocumented#Font'>font</a> <a href='undocumented#Glyph'>glyph</a> indices. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3799 | |
| 3800 | ### Return Value |
| 3801 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3802 | 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] | 3803 | |
| 3804 | <a href='#SkPaint_kGlyphID_TextEncoding'>kGlyphID_TextEncoding</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3805 | |
| 3806 | ### Example |
| 3807 | |
skia-bookmaker | 525f9a9 | 2018-05-03 06:27:39 +0000 | [diff] [blame] | 3808 | <div><fiddle-embed name="c6cc2780a9828b3af8c4621c12b29a1b"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3809 | |
| 3810 | #### Example Output |
| 3811 | |
| 3812 | ~~~~ |
| 3813 | kUTF8_TextEncoding == text encoding |
| 3814 | kGlyphID_TextEncoding == text encoding |
| 3815 | ~~~~ |
| 3816 | |
| 3817 | </fiddle-embed></div> |
| 3818 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3819 | <a name='SkPaint_setTextEncoding'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3820 | |
| 3821 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3822 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3823 | <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] | 3824 | 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] | 3825 | </pre> |
| 3826 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3827 | Sets <a href='SkPaint_Reference#SkPaint'>SkPaint</a>::<a href='#SkPaint_TextEncoding'>TextEncoding</a> to <a href='#SkPaint_setTextEncoding_encoding'>encoding</a>. |
| 3828 | <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='undocumented#Font'>font</a> <a href='undocumented#Glyph'>glyph</a> indices. |
| 3829 | Invalid values for <a href='#SkPaint_setTextEncoding_encoding'>encoding</a> are ignored. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3830 | |
| 3831 | ### Parameters |
| 3832 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3833 | <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] | 3834 | <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] | 3835 | </tr> |
| 3836 | </table> |
| 3837 | |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 3838 | <a href='#SkPaint_kGlyphID_TextEncoding'>kGlyphID_TextEncoding</a> |
| 3839 | |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3840 | ### Example |
| 3841 | |
Cary Clark | 75fd449 | 2018-06-20 12:45:16 -0400 | [diff] [blame] | 3842 | <div><fiddle-embed name="6d9ffdd3c5543e9f12972a06dd4a0ce5"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3843 | |
| 3844 | #### Example Output |
| 3845 | |
| 3846 | ~~~~ |
| 3847 | 4 != text encoding |
| 3848 | ~~~~ |
| 3849 | |
| 3850 | </fiddle-embed></div> |
| 3851 | |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 3852 | <a name='SkPaint_FontMetrics'></a> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3853 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3854 | --- |
| 3855 | |
Cary Clark | 7e69c8f | 2018-11-06 20:40:45 -0500 | [diff] [blame] | 3856 | <a name='Font_Metrics'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3857 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3858 | <a name='SkPaint_getFontMetrics'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3859 | |
| 3860 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3861 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3862 | <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] | 3863 | <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] | 3864 | </pre> |
| 3865 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3866 | Returns <a href='undocumented#SkFontMetrics'>SkFontMetrics</a> associated with <a href='undocumented#SkTypeface'>SkTypeface</a>. |
| 3867 | 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] | 3868 | descent, ascent, and leading. |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3869 | 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>. |
| 3870 | 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] | 3871 | 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>, |
| 3872 | <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] | 3873 | |
| 3874 | ### Parameters |
| 3875 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3876 | <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] | 3877 | <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] | 3878 | </tr> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3879 | </table> |
| 3880 | |
| 3881 | ### Return Value |
| 3882 | |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 3883 | recommended spacing between <a href='undocumented#Line'>lines</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3884 | |
| 3885 | ### Example |
| 3886 | |
skia-bookmaker | 2dc1e34 | 2018-11-02 05:33:11 +0000 | [diff] [blame] | 3887 | <div><fiddle-embed name="59d9b8249afa1c2af6186711250ce240"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3888 | |
| 3889 | ### See Also |
| 3890 | |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 3891 | <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] | 3892 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3893 | <a name='SkPaint_getFontSpacing'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3894 | |
| 3895 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3896 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3897 | <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] | 3898 | <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] | 3899 | </pre> |
| 3900 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3901 | 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] | 3902 | descent, ascent, and leading. |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3903 | 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] | 3904 | dimensions required by stroking and <a href='undocumented#SkPathEffect'>SkPathEffect</a>. |
| 3905 | Returns the same result as <a href='#SkPaint_getFontMetrics'>getFontMetrics</a>(). |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3906 | |
| 3907 | ### Return Value |
| 3908 | |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 3909 | recommended spacing between <a href='undocumented#Line'>lines</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3910 | |
| 3911 | ### Example |
| 3912 | |
| 3913 | <div><fiddle-embed name="424741e26e1b174e43087d67422ce14f"> |
| 3914 | |
| 3915 | #### Example Output |
| 3916 | |
| 3917 | ~~~~ |
| 3918 | textSize: 12 fontSpacing: 13.9688 |
| 3919 | textSize: 18 fontSpacing: 20.9531 |
| 3920 | textSize: 24 fontSpacing: 27.9375 |
| 3921 | textSize: 32 fontSpacing: 37.25 |
| 3922 | ~~~~ |
| 3923 | |
| 3924 | </fiddle-embed></div> |
| 3925 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3926 | <a name='SkPaint_textToGlyphs'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3927 | |
| 3928 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3929 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3930 | <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] | 3931 | 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] | 3932 | </pre> |
| 3933 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3934 | Converts <a href='#SkPaint_textToGlyphs_text'>text</a> into <a href='undocumented#Glyph'>glyph</a> indices. |
| 3935 | Returns the number of <a href='undocumented#Glyph'>glyph</a> indices represented by <a href='#SkPaint_textToGlyphs_text'>text</a>. |
| 3936 | <a href='SkPaint_Reference#SkPaint'>SkPaint</a>::<a href='#SkPaint_TextEncoding'>TextEncoding</a> specifies how <a href='#SkPaint_textToGlyphs_text'>text</a> represents characters or <a href='#SkPaint_textToGlyphs_glyphs'>glyphs</a>. |
| 3937 | <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] | 3938 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3939 | 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] | 3940 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3941 | If <a href='#SkPaint_textToGlyphs_byteLength'>byteLength</a> equals zero, returns zero. |
| 3942 | 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] | 3943 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3944 | If <a href='SkPaint_Reference#SkPaint'>SkPaint</a>::<a href='#SkPaint_TextEncoding'>TextEncoding</a> is <a href='#SkPaint_kUTF8_TextEncoding'>kUTF8_TextEncoding</a> and |
| 3945 | <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] | 3946 | |
| 3947 | ### Parameters |
| 3948 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3949 | <table> <tr> <td><a name='SkPaint_textToGlyphs_text'><code><strong>text</strong></code></a></td> |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 3950 | <td>character storage encoded with <a href='SkPaint_Reference#SkPaint'>SkPaint</a>::<a href='#SkPaint_TextEncoding'>TextEncoding</a></td> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3951 | </tr> |
| 3952 | <tr> <td><a name='SkPaint_textToGlyphs_byteLength'><code><strong>byteLength</strong></code></a></td> |
| 3953 | <td>length of character storage in bytes</td> |
| 3954 | </tr> |
| 3955 | <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] | 3956 | <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] | 3957 | </tr> |
| 3958 | </table> |
| 3959 | |
| 3960 | ### Return Value |
| 3961 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3962 | 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] | 3963 | |
| 3964 | ### Example |
| 3965 | |
| 3966 | <div><fiddle-embed name="343e9471a7f7b5f09abdc3b44983433b"></fiddle-embed></div> |
| 3967 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3968 | <a name='SkPaint_countText'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3969 | |
| 3970 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3971 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3972 | <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] | 3973 | 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] | 3974 | </pre> |
| 3975 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3976 | Returns the number of <a href='undocumented#Glyph'>glyphs</a> in <a href='#SkPaint_countText_text'>text</a>. |
| 3977 | Uses <a href='SkPaint_Reference#SkPaint'>SkPaint</a>::<a href='#SkPaint_TextEncoding'>TextEncoding</a> to count the <a href='undocumented#Glyph'>glyphs</a>. |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 3978 | Returns the same result as <a href='#SkPaint_textToGlyphs'>textToGlyphs</a>(). |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3979 | |
| 3980 | ### Parameters |
| 3981 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3982 | <table> <tr> <td><a name='SkPaint_countText_text'><code><strong>text</strong></code></a></td> |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 3983 | <td>character storage encoded with <a href='SkPaint_Reference#SkPaint'>SkPaint</a>::<a href='#SkPaint_TextEncoding'>TextEncoding</a></td> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3984 | </tr> |
| 3985 | <tr> <td><a name='SkPaint_countText_byteLength'><code><strong>byteLength</strong></code></a></td> |
| 3986 | <td>length of character storage in bytes</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3987 | </tr> |
| 3988 | </table> |
| 3989 | |
| 3990 | ### Return Value |
| 3991 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 3992 | 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] | 3993 | |
| 3994 | ### Example |
| 3995 | |
Cary Clark | f960398 | 2018-07-17 08:20:27 -0400 | [diff] [blame] | 3996 | <div><fiddle-embed name="85436c71aab5410767fc688ab0573e09"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3997 | |
| 3998 | #### Example Output |
| 3999 | |
| 4000 | ~~~~ |
| 4001 | count = 5 |
| 4002 | ~~~~ |
| 4003 | |
| 4004 | </fiddle-embed></div> |
| 4005 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4006 | <a name='SkPaint_containsText'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 4007 | |
| 4008 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 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 | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4011 | 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] | 4012 | </pre> |
| 4013 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4014 | Returns true if all <a href='#SkPaint_containsText_text'>text</a> corresponds to a non-zero <a href='undocumented#Glyph'>glyph</a> index. |
| 4015 | 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] | 4016 | <a href='undocumented#SkTypeface'>SkTypeface</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4017 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4018 | If <a href='SkPaint_Reference#SkPaint'>SkPaint</a>::<a href='#SkPaint_TextEncoding'>TextEncoding</a> is <a href='#SkPaint_kGlyphID_TextEncoding'>kGlyphID_TextEncoding</a>, |
| 4019 | returns true if all <a href='undocumented#Glyph'>glyph</a> indices in <a href='#SkPaint_containsText_text'>text</a> are non-zero; |
| 4020 | 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] | 4021 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4022 | Returns true if <a href='#SkPaint_containsText_byteLength'>byteLength</a> is zero. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4023 | |
| 4024 | ### Parameters |
| 4025 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4026 | <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] | 4027 | <td>array of characters or <a href='undocumented#Glyph'>glyphs</a></td> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4028 | </tr> |
| 4029 | <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] | 4030 | <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] | 4031 | </tr> |
| 4032 | </table> |
| 4033 | |
| 4034 | ### Return Value |
| 4035 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4036 | 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] | 4037 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4038 | <div><a href='#SkPaint_containsText'>containsText</a> succeeds for degree symbol, but cannot find a <a href='undocumented#Glyph'>glyph</a> index |
| 4039 | 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] | 4040 | </div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4041 | |
| 4042 | #### Example Output |
| 4043 | |
| 4044 | ~~~~ |
| 4045 | 0x00b0 == has char |
| 4046 | 0xd800 != has char |
| 4047 | ~~~~ |
| 4048 | |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4049 | ### Example |
| 4050 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4051 | <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 |
| 4052 | 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] | 4053 | </div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4054 | |
| 4055 | #### Example Output |
| 4056 | |
| 4057 | ~~~~ |
| 4058 | 0x01ff == has glyph |
| 4059 | 0x0000 != has glyph |
| 4060 | 0xffff == has glyph |
| 4061 | ~~~~ |
| 4062 | |
| 4063 | </fiddle-embed></div> |
| 4064 | |
| 4065 | ### See Also |
| 4066 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4067 | <a href='#SkPaint_setTextEncoding'>setTextEncoding</a> <a href='undocumented#Typeface'>Typeface</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4068 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4069 | <a name='SkPaint_glyphsToUnichars'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 4070 | |
| 4071 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4072 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4073 | <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] | 4074 | 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] | 4075 | </pre> |
| 4076 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4077 | Converts <a href='#SkPaint_glyphsToUnichars_glyphs'>glyphs</a> into <a href='#SkPaint_glyphsToUnichars_text'>text</a> if possible. |
| 4078 | <a href='undocumented#Glyph'>Glyph</a> values without direct Unicode equivalents are mapped to zero. |
| 4079 | Uses the <a href='undocumented#SkTypeface'>SkTypeface</a>, but is unaffected |
| 4080 | by <a href='SkPaint_Reference#SkPaint'>SkPaint</a>::<a href='#SkPaint_TextEncoding'>TextEncoding</a>; the <a href='#SkPaint_glyphsToUnichars_text'>text</a> values returned are equivalent to <a href='#SkPaint_kUTF32_TextEncoding'>kUTF32_TextEncoding</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4081 | |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 4082 | Only supported on platforms that use FreeType as the <a href='undocumented#Font_Engine'>font engine</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4083 | |
| 4084 | ### Parameters |
| 4085 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4086 | <table> <tr> <td><a name='SkPaint_glyphsToUnichars_glyphs'><code><strong>glyphs</strong></code></a></td> |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 4087 | <td>array of indices into <a href='undocumented#Font'>font</a></td> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4088 | </tr> |
| 4089 | <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] | 4090 | <td>length of <a href='undocumented#Glyph'>glyph</a> array</td> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4091 | </tr> |
| 4092 | <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] | 4093 | <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] | 4094 | </tr> |
| 4095 | </table> |
| 4096 | |
| 4097 | ### Example |
| 4098 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4099 | <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] | 4100 | </div></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4101 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 4102 | <a name='Measure_Text'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4103 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4104 | <a name='SkPaint_measureText'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 4105 | |
| 4106 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4107 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4108 | <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] | 4109 | <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] | 4110 | </pre> |
| 4111 | |
Cary Clark | 3aca39d | 2018-10-23 14:44:05 -0400 | [diff] [blame] | 4112 | Returns the advance width of <a href='#SkPaint_measureText_text'>text</a>. |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4113 | The advance is the normal distance to move before drawing additional <a href='#SkPaint_measureText_text'>text</a>. |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4114 | Uses <a href='SkPaint_Reference#SkPaint'>SkPaint</a>::<a href='#SkPaint_TextEncoding'>TextEncoding</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>, |
| 4115 | 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 |
| 4116 | <a href='undocumented#SkPathEffect'>SkPathEffect</a> to scale the metrics and <a href='#SkPaint_measureText_bounds'>bounds</a>. |
| 4117 | Returns the bounding box of <a href='#SkPaint_measureText_text'>text</a> if <a href='#SkPaint_measureText_bounds'>bounds</a> is not nullptr. |
| 4118 | 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] | 4119 | |
| 4120 | ### Parameters |
| 4121 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4122 | <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] | 4123 | <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] | 4124 | </tr> |
| 4125 | <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] | 4126 | <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] | 4127 | </tr> |
| 4128 | <tr> <td><a name='SkPaint_measureText_bounds'><code><strong>bounds</strong></code></a></td> |
| 4129 | <td>returns bounding box relative to (0, 0) if not nullptr</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4130 | </tr> |
| 4131 | </table> |
| 4132 | |
| 4133 | ### Return Value |
| 4134 | |
| 4135 | advance width or height |
| 4136 | |
| 4137 | ### Example |
| 4138 | |
Cary Clark | 8364706 | 2018-07-18 16:21:51 -0400 | [diff] [blame] | 4139 | <div><fiddle-embed name="06084f609184470135a9cd9ebc5af149"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4140 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4141 | <a name='SkPaint_measureText_2'></a> |
Cary Clark | 2dc84ad | 2018-01-26 12:56:22 -0500 | [diff] [blame] | 4142 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 4143 | --- |
| 4144 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4145 | <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] | 4146 | <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] | 4147 | </pre> |
| 4148 | |
Cary Clark | 3aca39d | 2018-10-23 14:44:05 -0400 | [diff] [blame] | 4149 | 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] | 4150 | The advance is the normal distance to move before drawing additional <a href='#SkPaint_measureText_2_text'>text</a>. |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4151 | Uses <a href='SkPaint_Reference#SkPaint'>SkPaint</a>::<a href='#SkPaint_TextEncoding'>TextEncoding</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>, |
| 4152 | and <a href='#Text_Size'>text size</a> to scale the metrics. |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 4153 | 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] | 4154 | |
| 4155 | ### Parameters |
| 4156 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4157 | <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] | 4158 | <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] | 4159 | </tr> |
| 4160 | <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] | 4161 | <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] | 4162 | </tr> |
| 4163 | </table> |
| 4164 | |
| 4165 | ### Return Value |
| 4166 | |
| 4167 | advance width or height |
| 4168 | |
| 4169 | ### Example |
| 4170 | |
| 4171 | <div><fiddle-embed name="f1139a5ddd17fd47c2f45f6e642cac76"> |
| 4172 | |
| 4173 | #### Example Output |
| 4174 | |
| 4175 | ~~~~ |
| 4176 | default width = 5 |
| 4177 | double width = 10 |
| 4178 | ~~~~ |
| 4179 | |
| 4180 | </fiddle-embed></div> |
| 4181 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4182 | <a name='SkPaint_breakText'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 4183 | |
| 4184 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4185 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4186 | <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] | 4187 | 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, |
| 4188 | <a href='undocumented#SkScalar'>SkScalar</a>* measuredWidth = nullptr) const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4189 | </pre> |
| 4190 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4191 | Returns the bytes of <a href='#SkPaint_breakText_text'>text</a> that fit within <a href='#SkPaint_breakText_maxWidth'>maxWidth</a>. |
| 4192 | 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] | 4193 | 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] | 4194 | 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. |
| 4195 | Uses <a href='SkPaint_Reference#SkPaint'>SkPaint</a>::<a href='#SkPaint_TextEncoding'>TextEncoding</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>, |
| 4196 | and <a href='#Text_Size'>text size</a> to scale the metrics. |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 4197 | 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] | 4198 | |
| 4199 | ### Parameters |
| 4200 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4201 | <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] | 4202 | <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] | 4203 | </tr> |
| 4204 | <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] | 4205 | <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] | 4206 | </tr> |
| 4207 | <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] | 4208 | <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] | 4209 | </tr> |
| 4210 | <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] | 4211 | <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] | 4212 | </tr> |
| 4213 | </table> |
| 4214 | |
| 4215 | ### Return Value |
| 4216 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4217 | 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] | 4218 | |
| 4219 | ### Example |
| 4220 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4221 | <div><fiddle-embed name="fd0033470ccbd5c7059670fdbf96cffc"><div><a href='undocumented#Line'>Line</a> under "Breakfast" shows desired width, shorter than available characters. |
| 4222 | <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] | 4223 | </div></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4224 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4225 | <a name='SkPaint_getTextWidths'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 4226 | |
| 4227 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4228 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4229 | <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] | 4230 | 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] | 4231 | </pre> |
| 4232 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4233 | 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 |
| 4234 | the <a href='undocumented#Glyph'>glyph</a> count in <a href='#SkPaint_getTextWidths_text'>text</a>. |
| 4235 | Both <a href='#SkPaint_getTextWidths_widths'>widths</a> and <a href='#SkPaint_getTextWidths_bounds'>bounds</a> may be nullptr. |
| 4236 | 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. |
| 4237 | 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. |
| 4238 | Uses <a href='SkPaint_Reference#SkPaint'>SkPaint</a>::<a href='#SkPaint_TextEncoding'>TextEncoding</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>, |
| 4239 | 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] | 4240 | 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] | 4241 | 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] | 4242 | |
| 4243 | ### Parameters |
| 4244 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4245 | <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] | 4246 | <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] | 4247 | </tr> |
| 4248 | <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] | 4249 | <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] | 4250 | </tr> |
| 4251 | <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] | 4252 | <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] | 4253 | </tr> |
| 4254 | <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] | 4255 | <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] | 4256 | </tr> |
| 4257 | </table> |
| 4258 | |
| 4259 | ### Return Value |
| 4260 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4261 | <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] | 4262 | |
| 4263 | ### Example |
| 4264 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4265 | <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. |
| 4266 | 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] | 4267 | </div></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4268 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 4269 | <a name='Text_Path'></a> |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 4270 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4271 | <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] | 4272 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4273 | <a name='SkPaint_getTextPath'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 4274 | |
| 4275 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4276 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4277 | <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] | 4278 | 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] | 4279 | </pre> |
| 4280 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4281 | Returns the geometry as <a href='SkPath_Reference#SkPath'>SkPath</a> equivalent to the drawn <a href='#SkPaint_getTextPath_text'>text</a>. |
| 4282 | Uses <a href='SkPaint_Reference#SkPaint'>SkPaint</a>::<a href='#SkPaint_TextEncoding'>TextEncoding</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>, |
| 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 | 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>. |
| 4285 | 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] | 4286 | |
| 4287 | ### Parameters |
| 4288 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4289 | <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] | 4290 | <td>character codes or <a href='undocumented#Glyph'>glyph</a> indices</td> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4291 | </tr> |
| 4292 | <tr> <td><a name='SkPaint_getTextPath_length'><code><strong>length</strong></code></a></td> |
| 4293 | <td>number of bytes of <a href='#SkPaint_getTextPath_text'>text</a></td> |
| 4294 | </tr> |
| 4295 | <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] | 4296 | <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] | 4297 | </tr> |
| 4298 | <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] | 4299 | <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] | 4300 | </tr> |
| 4301 | <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] | 4302 | <td>geometry of the <a href='undocumented#Glyph'>glyphs</a></td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4303 | </tr> |
| 4304 | </table> |
| 4305 | |
| 4306 | ### Example |
| 4307 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4308 | <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 |
| 4309 | the offset location. The result is rendered with one draw call. |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 4310 | </div></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4311 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4312 | <a name='SkPaint_getPosTextPath'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 4313 | |
| 4314 | --- |
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 | <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] | 4317 | 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] | 4318 | </pre> |
| 4319 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4320 | Returns the geometry as <a href='SkPath_Reference#SkPath'>SkPath</a> equivalent to the drawn <a href='#SkPaint_getPosTextPath_text'>text</a>. |
| 4321 | Uses <a href='SkPaint_Reference#SkPaint'>SkPaint</a>::<a href='#SkPaint_TextEncoding'>TextEncoding</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>, |
| 4322 | 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>. |
| 4323 | 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>. |
| 4324 | Uses <a href='#SkPaint_getPosTextPath_pos'>pos</a> array to position <a href='#SkPaint_getPosTextPath_path'>path</a>. |
| 4325 | <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] | 4326 | |
| 4327 | ### Parameters |
| 4328 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4329 | <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] | 4330 | <td>character codes or <a href='undocumented#Glyph'>glyph</a> indices</td> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4331 | </tr> |
| 4332 | <tr> <td><a name='SkPaint_getPosTextPath_length'><code><strong>length</strong></code></a></td> |
| 4333 | <td>number of bytes of <a href='#SkPaint_getPosTextPath_text'>text</a></td> |
| 4334 | </tr> |
| 4335 | <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] | 4336 | <td>positions of each <a href='undocumented#Glyph'>glyph</a></td> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4337 | </tr> |
| 4338 | <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] | 4339 | <td>geometry of the <a href='undocumented#Glyph'>glyphs</a></td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4340 | </tr> |
| 4341 | </table> |
| 4342 | |
| 4343 | ### Example |
| 4344 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4345 | <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] | 4346 | </div></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4347 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 4348 | <a name='Text_Intercepts'></a> |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 4349 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4350 | <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 |
| 4351 | 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 |
| 4352 | underline that skips Descenders. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4353 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4354 | <a name='SkPaint_getTextIntercepts'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 4355 | |
| 4356 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4357 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4358 | <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] | 4359 | 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, |
| 4360 | 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] | 4361 | </pre> |
| 4362 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4363 | Returns the number of <a href='#SkPaint_getTextIntercepts_intervals'>intervals</a> that intersect <a href='#SkPaint_getTextIntercepts_bounds'>bounds</a>. |
| 4364 | <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. |
| 4365 | 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] | 4366 | the <a href='undocumented#String'>string</a>. |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4367 | Uses <a href='SkPaint_Reference#SkPaint'>SkPaint</a>::<a href='#SkPaint_TextEncoding'>TextEncoding</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>, |
| 4368 | 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>. |
| 4369 | 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] | 4370 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4371 | 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] | 4372 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4373 | <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] | 4374 | |
| 4375 | ### Parameters |
| 4376 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4377 | <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] | 4378 | <td>character codes or <a href='undocumented#Glyph'>glyph</a> indices</td> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4379 | </tr> |
| 4380 | <tr> <td><a name='SkPaint_getTextIntercepts_length'><code><strong>length</strong></code></a></td> |
| 4381 | <td>number of bytes of <a href='#SkPaint_getTextIntercepts_text'>text</a></td> |
| 4382 | </tr> |
| 4383 | <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] | 4384 | <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] | 4385 | </tr> |
| 4386 | <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] | 4387 | <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] | 4388 | </tr> |
| 4389 | <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] | 4390 | <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] | 4391 | </tr> |
| 4392 | <tr> <td><a name='SkPaint_getTextIntercepts_intervals'><code><strong>intervals</strong></code></a></td> |
| 4393 | <td>returned intersections; may be nullptr</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4394 | </tr> |
| 4395 | </table> |
| 4396 | |
| 4397 | ### Return Value |
| 4398 | |
| 4399 | number of intersections; may be zero |
| 4400 | |
| 4401 | ### Example |
| 4402 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4403 | <div><fiddle-embed name="2a0b80ed20d193c688085b79deb5bdc9"><div>Underline uses intercepts to draw on either side of the <a href='undocumented#Glyph'>glyph</a> Descender. |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 4404 | </div></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4405 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4406 | <a name='SkPaint_getPosTextIntercepts'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 4407 | |
| 4408 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4409 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4410 | <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] | 4411 | 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[], |
| 4412 | 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] | 4413 | </pre> |
| 4414 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4415 | Returns the number of <a href='#SkPaint_getPosTextIntercepts_intervals'>intervals</a> that intersect <a href='#SkPaint_getPosTextIntercepts_bounds'>bounds</a>. |
| 4416 | <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. |
| 4417 | 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] | 4418 | the <a href='undocumented#String'>string</a>. |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4419 | Uses <a href='SkPaint_Reference#SkPaint'>SkPaint</a>::<a href='#SkPaint_TextEncoding'>TextEncoding</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>, |
| 4420 | 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>. |
| 4421 | 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] | 4422 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4423 | 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] | 4424 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4425 | <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] | 4426 | |
| 4427 | ### Parameters |
| 4428 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4429 | <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] | 4430 | <td>character codes or <a href='undocumented#Glyph'>glyph</a> indices</td> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4431 | </tr> |
| 4432 | <tr> <td><a name='SkPaint_getPosTextIntercepts_length'><code><strong>length</strong></code></a></td> |
| 4433 | <td>number of bytes of <a href='#SkPaint_getPosTextIntercepts_text'>text</a></td> |
| 4434 | </tr> |
| 4435 | <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] | 4436 | <td>positions of each <a href='undocumented#Glyph'>glyph</a></td> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4437 | </tr> |
| 4438 | <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] | 4439 | <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] | 4440 | </tr> |
| 4441 | <tr> <td><a name='SkPaint_getPosTextIntercepts_intervals'><code><strong>intervals</strong></code></a></td> |
| 4442 | <td>returned intersections; may be nullptr</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4443 | </tr> |
| 4444 | </table> |
| 4445 | |
| 4446 | ### Return Value |
| 4447 | |
Cary Clark | a523d2d | 2017-08-30 08:58:10 -0400 | [diff] [blame] | 4448 | number of intersections; may be zero |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4449 | |
| 4450 | ### Example |
| 4451 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4452 | <div><fiddle-embed name="5b5754fdb90b44c245d72567854eca04"><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. |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 4453 | </div></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4454 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4455 | <a name='SkPaint_getPosTextHIntercepts'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 4456 | |
| 4457 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4458 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4459 | <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] | 4460 | 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, |
| 4461 | 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] | 4462 | </pre> |
| 4463 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4464 | Returns the number of <a href='#SkPaint_getPosTextHIntercepts_intervals'>intervals</a> that intersect <a href='#SkPaint_getPosTextHIntercepts_bounds'>bounds</a>. |
| 4465 | <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. |
| 4466 | 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] | 4467 | the <a href='undocumented#String'>string</a>. |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4468 | Uses <a href='SkPaint_Reference#SkPaint'>SkPaint</a>::<a href='#SkPaint_TextEncoding'>TextEncoding</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>, |
| 4469 | 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>. |
| 4470 | 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] | 4471 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4472 | 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] | 4473 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4474 | <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] | 4475 | |
| 4476 | ### Parameters |
| 4477 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4478 | <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] | 4479 | <td>character codes or <a href='undocumented#Glyph'>glyph</a> indices</td> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4480 | </tr> |
| 4481 | <tr> <td><a name='SkPaint_getPosTextHIntercepts_length'><code><strong>length</strong></code></a></td> |
| 4482 | <td>number of bytes of <a href='#SkPaint_getPosTextHIntercepts_text'>text</a></td> |
| 4483 | </tr> |
| 4484 | <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] | 4485 | <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] | 4486 | </tr> |
| 4487 | <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] | 4488 | <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] | 4489 | </tr> |
| 4490 | <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] | 4491 | <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] | 4492 | </tr> |
| 4493 | <tr> <td><a name='SkPaint_getPosTextHIntercepts_intervals'><code><strong>intervals</strong></code></a></td> |
| 4494 | <td>returned intersections; may be nullptr</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4495 | </tr> |
| 4496 | </table> |
| 4497 | |
| 4498 | ### Return Value |
| 4499 | |
| 4500 | number of intersections; may be zero |
| 4501 | |
| 4502 | ### Example |
| 4503 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4504 | <div><fiddle-embed name="dc9851c43acc3716aca8c9a4d40d452d"><div><a href='undocumented#Text'>Text</a> intercepts do not take stroke thickness into consideration. |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 4505 | </div></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4506 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4507 | <a name='SkPaint_getTextBlobIntercepts'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 4508 | |
| 4509 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4510 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4511 | <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] | 4512 | 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] | 4513 | </pre> |
| 4514 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4515 | Returns the number of <a href='#SkPaint_getTextBlobIntercepts_intervals'>intervals</a> that intersect <a href='#SkPaint_getTextBlobIntercepts_bounds'>bounds</a>. |
| 4516 | <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. |
| 4517 | 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] | 4518 | the <a href='undocumented#String'>string</a>. |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4519 | Uses <a href='undocumented#SkTypeface'>SkTypeface</a> to get the <a href='undocumented#Glyph'>glyph</a> <a href='SkPath_Reference#Path'>paths</a>, |
| 4520 | 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] | 4521 | Uses run array to position <a href='#SkPaint_getTextBlobIntercepts_intervals'>intervals</a>. |
skia-bookmaker | 525f9a9 | 2018-05-03 06:27:39 +0000 | [diff] [blame] | 4522 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4523 | <a href='SkPaint_Reference#SkPaint'>SkPaint</a>::<a href='#SkPaint_TextEncoding'>TextEncoding</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] | 4524 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4525 | 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] | 4526 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4527 | <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] | 4528 | |
| 4529 | ### Parameters |
| 4530 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4531 | <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] | 4532 | <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] | 4533 | </tr> |
| 4534 | <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] | 4535 | <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] | 4536 | </tr> |
| 4537 | <tr> <td><a name='SkPaint_getTextBlobIntercepts_intervals'><code><strong>intervals</strong></code></a></td> |
| 4538 | <td>returned intersections; may be nullptr</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4539 | </tr> |
| 4540 | </table> |
| 4541 | |
| 4542 | ### Return Value |
| 4543 | |
| 4544 | number of intersections; may be zero |
| 4545 | |
| 4546 | ### Example |
| 4547 | |
skia-bookmaker | 44bad2e | 2018-07-05 05:35:27 +0000 | [diff] [blame] | 4548 | <div><fiddle-embed name="f2229dd5c8e76f9e12fafe59b61353c8"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4549 | |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 4550 | <a name='SkPaint_getFontBounds'></a> |
| 4551 | |
| 4552 | --- |
| 4553 | |
| 4554 | <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] | 4555 | <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] | 4556 | </pre> |
| 4557 | |
| 4558 | Returns the union of bounds of all <a href='undocumented#Glyph'>glyphs</a>. |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4559 | Returned dimensions are computed by <a href='undocumented#Font'>font</a> manager from <a href='undocumented#Font'>font</a> <a href='undocumented#Data'>data</a>, |
Cary Clark | 8cc4cdc | 2018-11-09 23:16:58 -0500 | [diff] [blame] | 4560 | ignoring <a href='SkPaint_Reference#SkPaint'>SkPaint</a>::<a href='#SkPaint_Hinting'>Hinting</a>. Includes <a href='undocumented#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] | 4561 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4562 | 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] | 4563 | returns the bounds as: |
| 4564 | { <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> }. |
| 4565 | |
| 4566 | ### Return Value |
| 4567 | |
| 4568 | union of bounds of all <a href='undocumented#Glyph'>glyphs</a> |
| 4569 | |
| 4570 | ### Example |
| 4571 | |
skia-bookmaker | 1e1ba0e | 2018-11-13 05:36:58 +0000 | [diff] [blame] | 4572 | <div><fiddle-embed name="f29d005a75efd4746c6744004a0cb421"> |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 4573 | |
| 4574 | #### Example Output |
| 4575 | |
| 4576 | ~~~~ |
| 4577 | metrics bounds = { -12.2461, -14.7891, 21.5215, 5.55469 } |
| 4578 | font bounds = { -12.2461, -14.7891, 21.5215, 5.55469 } |
| 4579 | ~~~~ |
| 4580 | |
| 4581 | </fiddle-embed></div> |
| 4582 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4583 | <a name='SkPaint_nothingToDraw'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 4584 | |
| 4585 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4586 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4587 | <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] | 4588 | bool <a href='#SkPaint_nothingToDraw'>nothingToDraw</a>() const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4589 | </pre> |
| 4590 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4591 | Returns true if <a href='SkPaint_Reference#SkPaint'>SkPaint</a> prevents all drawing; |
| 4592 | 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] | 4593 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4594 | Returns true if, for example, <a href='SkBlendMode_Reference#SkBlendMode'>SkBlendMode</a> combined with <a href='SkColor_Reference#Alpha'>alpha</a> computes a |
| 4595 | new <a href='SkColor_Reference#Alpha'>alpha</a> of zero. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4596 | |
| 4597 | ### Return Value |
| 4598 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4599 | true if <a href='SkPaint_Reference#SkPaint'>SkPaint</a> prevents all drawing |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4600 | |
| 4601 | ### Example |
| 4602 | |
Cary Clark | 8364706 | 2018-07-18 16:21:51 -0400 | [diff] [blame] | 4603 | <div><fiddle-embed name="2973b05bfbb6b4c29332c8ac4fcf3995"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4604 | |
| 4605 | #### Example Output |
| 4606 | |
| 4607 | ~~~~ |
| 4608 | initial nothing to draw: false |
| 4609 | blend dst nothing to draw: true |
| 4610 | blend src over nothing to draw: false |
| 4611 | alpha 0 nothing to draw: true |
| 4612 | ~~~~ |
| 4613 | |
| 4614 | </fiddle-embed></div> |
| 4615 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 4616 | <a name='Fast_Bounds'></a> |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 4617 | |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 4618 | Private: To be made private. |
| 4619 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4620 | <a href='#Paint_Fast_Bounds'>Fast_Bounds</a> functions conservatively outset a drawing bounds by additional area |
| 4621 | <a href='SkPaint_Reference#Paint'>Paint</a> may draw to. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4622 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4623 | <a name='SkPaint_canComputeFastBounds'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 4624 | |
| 4625 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4626 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4627 | <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] | 4628 | bool <a href='#SkPaint_canComputeFastBounds'>canComputeFastBounds</a>() const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4629 | </pre> |
| 4630 | |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 4631 | Private: (to be made private) |
| 4632 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4633 | Returns true if <a href='SkPaint_Reference#Paint'>Paint</a> does not include elements requiring extensive computation |
| 4634 | to compute <a href='undocumented#Device'>Device</a> bounds of drawn geometry. For instance, <a href='SkPaint_Reference#Paint'>Paint</a> with <a href='#Path_Effect'>Path_Effect</a> |
| 4635 | always returns false. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4636 | |
| 4637 | ### Return Value |
| 4638 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4639 | true if <a href='SkPaint_Reference#Paint'>Paint</a> allows for fast computation of bounds |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4640 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4641 | <a name='SkPaint_computeFastBounds'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 4642 | |
| 4643 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4644 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4645 | <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] | 4646 | const <a href='SkRect_Reference#SkRect'>SkRect</a>& <a href='#SkPaint_computeFastBounds'>computeFastBounds</a>(const <a href='SkRect_Reference#SkRect'>SkRect</a>& orig, <a href='SkRect_Reference#SkRect'>SkRect</a>* storage) const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4647 | </pre> |
| 4648 | |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 4649 | Private: (to be made private) |
| 4650 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4651 | Only call if <a href='#SkPaint_canComputeFastBounds'>canComputeFastBounds</a> returned true. This takes a |
| 4652 | raw rectangle, the raw bounds of a shape; and adjusts it for stylistic |
| 4653 | effects in the <a href='SkPaint_Reference#Paint'>paint</a>, such as stroking. If needed, it uses the <a href='#SkPaint_computeFastBounds_storage'>storage</a> |
| 4654 | parameter. It returns the adjusted bounds that can then be used |
| 4655 | for <a href='SkCanvas_Reference#SkCanvas'>SkCanvas</a>::<a href='#SkCanvas_quickReject'>quickReject</a> tests. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4656 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4657 | The returned <a href='SkRect_Reference#Rect'>Rect</a> will either be <a href='#SkPaint_computeFastBounds_orig'>orig</a> or <a href='#SkPaint_computeFastBounds_storage'>storage</a>, thus the caller |
| 4658 | should not rely on <a href='#SkPaint_computeFastBounds_storage'>storage</a> being set to the result, but should always |
| 4659 | use the returned value. It is legal for <a href='#SkPaint_computeFastBounds_orig'>orig</a> and <a href='#SkPaint_computeFastBounds_storage'>storage</a> to be the same |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4660 | <a href='SkRect_Reference#Rect'>Rect</a>. |
| 4661 | |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 4662 | Private: For example: |
| 4663 | if (!path.isInverseFillType() && paint.canComputeFastBounds()) { |
| 4664 | SkRect storage; |
| 4665 | if (canvas->quickReject(paint.computeFastBounds(path.getBounds(), &storage))) { |
| 4666 | return; // do not draw the path |
| 4667 | } |
| 4668 | } |
| 4669 | // draw the path |
| 4670 | |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4671 | ### Parameters |
| 4672 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4673 | <table> <tr> <td><a name='SkPaint_computeFastBounds_orig'><code><strong>orig</strong></code></a></td> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4674 | <td>geometry modified by <a href='SkPaint_Reference#Paint'>Paint</a> when drawn</td> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4675 | </tr> |
| 4676 | <tr> <td><a name='SkPaint_computeFastBounds_storage'><code><strong>storage</strong></code></a></td> |
| 4677 | <td>computed bounds of geometry; may not be nullptr</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4678 | </tr> |
| 4679 | </table> |
| 4680 | |
| 4681 | ### Return Value |
| 4682 | |
| 4683 | fast computed bounds |
| 4684 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4685 | <a name='SkPaint_computeFastStrokeBounds'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 4686 | |
| 4687 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4688 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4689 | <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] | 4690 | const <a href='SkRect_Reference#SkRect'>SkRect</a>& <a href='#SkPaint_computeFastStrokeBounds'>computeFastStrokeBounds</a>(const <a href='SkRect_Reference#SkRect'>SkRect</a>& orig, <a href='SkRect_Reference#SkRect'>SkRect</a>* storage) const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4691 | </pre> |
| 4692 | |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 4693 | Private: (to be made private) |
| 4694 | |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4695 | ### Parameters |
| 4696 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4697 | <table> <tr> <td><a name='SkPaint_computeFastStrokeBounds_orig'><code><strong>orig</strong></code></a></td> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4698 | <td>geometry modified by <a href='SkPaint_Reference#Paint'>Paint</a> when drawn</td> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4699 | </tr> |
| 4700 | <tr> <td><a name='SkPaint_computeFastStrokeBounds_storage'><code><strong>storage</strong></code></a></td> |
| 4701 | <td>computed bounds of geometry</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4702 | </tr> |
| 4703 | </table> |
| 4704 | |
| 4705 | ### Return Value |
| 4706 | |
| 4707 | fast computed bounds |
| 4708 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4709 | <a name='SkPaint_doComputeFastBounds'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 4710 | |
| 4711 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4712 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4713 | <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] | 4714 | const <a href='SkRect_Reference#SkRect'>SkRect</a>& <a href='#SkPaint_doComputeFastBounds'>doComputeFastBounds</a>(const <a href='SkRect_Reference#SkRect'>SkRect</a>& orig, <a href='SkRect_Reference#SkRect'>SkRect</a>* storage, <a href='#SkPaint_Style'>Style</a> style) const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4715 | </pre> |
| 4716 | |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 4717 | Private: (to be made private) |
| 4718 | |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4719 | Computes the bounds, overriding the <a href='SkPaint_Reference#Paint'>Paint</a> <a href='#SkPaint_Style'>Style</a>. This can be used to |
| 4720 | account for additional width required by stroking <a href='#SkPaint_doComputeFastBounds_orig'>orig</a>, without |
| 4721 | altering <a href='#SkPaint_Style'>Style</a> set to fill. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4722 | |
| 4723 | ### Parameters |
| 4724 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4725 | <table> <tr> <td><a name='SkPaint_doComputeFastBounds_orig'><code><strong>orig</strong></code></a></td> |
Cary Clark | 777eede | 2018-11-09 16:04:58 -0500 | [diff] [blame] | 4726 | <td>geometry modified by <a href='SkPaint_Reference#Paint'>Paint</a> when drawn</td> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4727 | </tr> |
| 4728 | <tr> <td><a name='SkPaint_doComputeFastBounds_storage'><code><strong>storage</strong></code></a></td> |
| 4729 | <td>computed bounds of geometry</td> |
| 4730 | </tr> |
| 4731 | <tr> <td><a name='SkPaint_doComputeFastBounds_style'><code><strong>style</strong></code></a></td> |
| 4732 | <td>overrides <a href='#SkPaint_Style'>Style</a></td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4733 | </tr> |
| 4734 | </table> |
| 4735 | |
| 4736 | ### Return Value |
| 4737 | |
| 4738 | fast computed bounds |
| 4739 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 4740 | <a name='Utility'></a> |
Cary Clark | 78de751 | 2018-02-07 07:27:09 -0500 | [diff] [blame] | 4741 | |