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"> |
| 10 | class <a href='#SkPaint'>SkPaint</a> { |
| 11 | public: |
| 12 | <a href='#SkPaint_empty_constructor'>SkPaint()</a>; |
| 13 | <a href='#SkPaint_copy_const_SkPaint'>SkPaint(const SkPaint& paint)</a>; |
| 14 | <a href='#SkPaint_move_SkPaint'>SkPaint(SkPaint&& paint)</a>; |
| 15 | <a href='#SkPaint_destructor'>~SkPaint()</a>; |
| 16 | <a href='#SkPaint'>SkPaint</a>& <a href='#SkPaint_copy_operator'>operator=(const SkPaint& paint)</a>; |
| 17 | <a href='#SkPaint'>SkPaint</a>& <a href='#SkPaint_move_operator'>operator=(SkPaint&& paint)</a>; |
| 18 | friend bool <a href='#SkPaint_equal_operator'>operator==(const SkPaint& a, const SkPaint& b)</a>; |
| 19 | friend bool <a href='#SkPaint_notequal_operator'>operator!=(const SkPaint& a, const SkPaint& b)</a>; |
| 20 | uint32_t <a href='#SkPaint_getHash'>getHash</a>() const; |
| 21 | void <a href='#SkPaint_reset'>reset</a>(); |
| 22 | |
| 23 | enum <a href='#SkPaint_Hinting'>Hinting</a> { |
| 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 | |
| 30 | <a href='#SkPaint_Hinting'>Hinting</a> <a href='#SkPaint_getHinting'>getHinting</a>() const; |
| 31 | void <a href='#SkPaint_setHinting'>setHinting</a>(<a href='#SkPaint_Hinting'>Hinting</a> hintingLevel); |
| 32 | |
| 33 | enum <a href='#SkPaint_Flags'>Flags</a> { |
| 34 | <a href='#SkPaint_kAntiAlias_Flag'>kAntiAlias_Flag</a> = 0x01, |
| 35 | <a href='#SkPaint_kDither_Flag'>kDither_Flag</a> = 0x04, |
| 36 | <a href='#SkPaint_kFakeBoldText_Flag'>kFakeBoldText_Flag</a> = 0x20, |
| 37 | <a href='#SkPaint_kLinearText_Flag'>kLinearText_Flag</a> = 0x40, |
| 38 | <a href='#SkPaint_kSubpixelText_Flag'>kSubpixelText_Flag</a> = 0x80, |
| 39 | <a href='#SkPaint_kLCDRenderText_Flag'>kLCDRenderText_Flag</a> = 0x200, |
| 40 | <a href='#SkPaint_kEmbeddedBitmapText_Flag'>kEmbeddedBitmapText_Flag</a> = 0x400, |
| 41 | <a href='#SkPaint_kAutoHinting_Flag'>kAutoHinting_Flag</a> = 0x800, |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 42 | <a href='#SkPaint_kAllFlags'>kAllFlags</a> = 0xFFFF, |
| 43 | }; |
| 44 | |
| 45 | enum <a href='#SkPaint_ReserveFlags'>ReserveFlags</a> { |
| 46 | <a href='#SkPaint_kUnderlineText_ReserveFlag'>kUnderlineText_ReserveFlag</a> = 0x08, |
| 47 | <a href='#SkPaint_kStrikeThruText_ReserveFlag'>kStrikeThruText_ReserveFlag</a> = 0x10, |
| 48 | }; |
| 49 | |
| 50 | uint32_t <a href='#SkPaint_getFlags'>getFlags</a>() const; |
| 51 | void <a href='#SkPaint_setFlags'>setFlags</a>(uint32_t flags); |
| 52 | bool <a href='#SkPaint_isAntiAlias'>isAntiAlias</a>() const; |
| 53 | void <a href='#SkPaint_setAntiAlias'>setAntiAlias</a>(bool aa); |
| 54 | bool <a href='#SkPaint_isDither'>isDither</a>() const; |
| 55 | void <a href='#SkPaint_setDither'>setDither</a>(bool dither); |
| 56 | bool <a href='#SkPaint_isLinearText'>isLinearText</a>() const; |
| 57 | void <a href='#SkPaint_setLinearText'>setLinearText</a>(bool linearText); |
| 58 | bool <a href='#SkPaint_isSubpixelText'>isSubpixelText</a>() const; |
| 59 | void <a href='#SkPaint_setSubpixelText'>setSubpixelText</a>(bool subpixelText); |
| 60 | bool <a href='#SkPaint_isLCDRenderText'>isLCDRenderText</a>() const; |
| 61 | void <a href='#SkPaint_setLCDRenderText'>setLCDRenderText</a>(bool lcdText); |
| 62 | bool <a href='#SkPaint_isEmbeddedBitmapText'>isEmbeddedBitmapText</a>() const; |
| 63 | void <a href='#SkPaint_setEmbeddedBitmapText'>setEmbeddedBitmapText</a>(bool useEmbeddedBitmapText); |
| 64 | bool <a href='#SkPaint_isAutohinted'>isAutohinted</a>() const; |
| 65 | void <a href='#SkPaint_setAutohinted'>setAutohinted</a>(bool useAutohinter); |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 66 | bool <a href='#SkPaint_isFakeBoldText'>isFakeBoldText</a>() const; |
| 67 | void <a href='#SkPaint_setFakeBoldText'>setFakeBoldText</a>(bool fakeBoldText); |
| 68 | bool <a href='#SkPaint_isDevKernText'>isDevKernText</a>() const; |
| 69 | void <a href='#SkPaint_setDevKernText'>setDevKernText</a>(bool); |
| 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); |
| 72 | |
| 73 | enum <a href='#SkPaint_Style'>Style</a> { |
| 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 | |
| 79 | static constexpr int <a href='#SkPaint_kStyleCount'>kStyleCount</a> = <a href='#SkPaint_kStrokeAndFill_Style'>kStrokeAndFill_Style</a> + 1; |
| 80 | |
| 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> color); |
| 86 | void <a href='#SkPaint_setColor4f'>setColor4f</a>(const <a href='SkColor4f_Reference#SkColor4f'>SkColor4f</a>& color, <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); |
| 94 | |
| 95 | enum <a href='#SkPaint_Cap'>Cap</a> { |
| 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 | |
| 103 | static constexpr int <a href='#SkPaint_kCapCount'>kCapCount</a> = <a href='#SkPaint_kLast_Cap'>kLast_Cap</a> + 1; |
| 104 | |
| 105 | enum <a href='#SkPaint_Join'>Join</a> { |
| 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 | |
| 113 | static constexpr int <a href='#SkPaint_kJoinCount'>kJoinCount</a> = <a href='#SkPaint_kLast_Join'>kLast_Join</a> + 1; |
| 114 | |
| 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_2'>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>(sk_sp<<a href='undocumented#SkShader'>SkShader</a>> shader); |
| 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>(sk_sp<<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>(sk_sp<<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>(sk_sp<<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>(sk_sp<<a href='undocumented#SkTypeface'>SkTypeface</a>> typeface); |
| 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>(sk_sp<<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>(sk_sp<<a href='undocumented#SkDrawLooper'>SkDrawLooper</a>> drawLooper); |
| 147 | void <a href='#SkPaint_setLooper'>setLooper</a>(sk_sp<<a href='undocumented#SkDrawLooper'>SkDrawLooper</a>> drawLooper); |
| 148 | |
| 149 | enum <a href='#SkPaint_Align'>Align</a> { |
| 150 | <a href='#SkPaint_kLeft_Align'>kLeft_Align</a>, |
| 151 | <a href='#SkPaint_kCenter_Align'>kCenter_Align</a>, |
| 152 | <a href='#SkPaint_kRight_Align'>kRight_Align</a>, |
| 153 | }; |
| 154 | |
| 155 | static constexpr int <a href='#SkPaint_kAlignCount'>kAlignCount</a> = 3; |
| 156 | |
| 157 | <a href='#SkPaint_Align'>Align</a> <a href='#SkPaint_getTextAlign'>getTextAlign</a>() const; |
| 158 | void <a href='#SkPaint_setTextAlign'>setTextAlign</a>(<a href='#SkPaint_Align'>Align</a> align); |
| 159 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_getTextSize'>getTextSize</a>() const; |
| 160 | void <a href='#SkPaint_setTextSize'>setTextSize</a>(<a href='undocumented#SkScalar'>SkScalar</a> textSize); |
| 161 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_getTextScaleX'>getTextScaleX</a>() const; |
| 162 | void <a href='#SkPaint_setTextScaleX'>setTextScaleX</a>(<a href='undocumented#SkScalar'>SkScalar</a> scaleX); |
| 163 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_getTextSkewX'>getTextSkewX</a>() const; |
| 164 | void <a href='#SkPaint_setTextSkewX'>setTextSkewX</a>(<a href='undocumented#SkScalar'>SkScalar</a> skewX); |
| 165 | |
| 166 | enum <a href='#SkPaint_TextEncoding'>TextEncoding</a> { |
| 167 | <a href='#SkPaint_kUTF8_TextEncoding'>kUTF8_TextEncoding</a>, |
| 168 | <a href='#SkPaint_kUTF16_TextEncoding'>kUTF16_TextEncoding</a>, |
| 169 | <a href='#SkPaint_kUTF32_TextEncoding'>kUTF32_TextEncoding</a>, |
| 170 | <a href='#SkPaint_kGlyphID_TextEncoding'>kGlyphID_TextEncoding</a>, |
| 171 | }; |
| 172 | |
| 173 | <a href='#SkPaint_TextEncoding'>TextEncoding</a> <a href='#SkPaint_getTextEncoding'>getTextEncoding</a>() const; |
| 174 | void <a href='#SkPaint_setTextEncoding'>setTextEncoding</a>(<a href='#SkPaint_TextEncoding'>TextEncoding</a> encoding); |
| 175 | |
| 176 | struct <a href='#SkPaint_FontMetrics'>FontMetrics</a> { |
| 177 | |
| 178 | enum <a href='#SkPaint_FontMetrics_FontMetricsFlags'>FontMetricsFlags</a> { |
| 179 | <a href='#SkPaint_FontMetrics_kUnderlineThicknessIsValid_Flag'>kUnderlineThicknessIsValid_Flag</a> = 1 << 0, |
| 180 | <a href='#SkPaint_FontMetrics_kUnderlinePositionIsValid_Flag'>kUnderlinePositionIsValid_Flag</a> = 1 << 1, |
| 181 | <a href='#SkPaint_FontMetrics_kStrikeoutThicknessIsValid_Flag'>kStrikeoutThicknessIsValid_Flag</a> = 1 << 2, |
| 182 | <a href='#SkPaint_FontMetrics_kStrikeoutPositionIsValid_Flag'>kStrikeoutPositionIsValid_Flag</a> = 1 << 3, |
| 183 | }; |
| 184 | |
| 185 | uint32_t <a href='#SkPaint_FontMetrics_fFlags'>fFlags</a>; |
| 186 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_FontMetrics_fTop'>fTop</a>; |
| 187 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_FontMetrics_fAscent'>fAscent</a>; |
| 188 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_FontMetrics_fDescent'>fDescent</a>; |
| 189 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_FontMetrics_fBottom'>fBottom</a>; |
| 190 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_FontMetrics_fLeading'>fLeading</a>; |
| 191 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_FontMetrics_fAvgCharWidth'>fAvgCharWidth</a>; |
| 192 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_FontMetrics_fMaxCharWidth'>fMaxCharWidth</a>; |
| 193 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_FontMetrics_fXMin'>fXMin</a>; |
| 194 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_FontMetrics_fXMax'>fXMax</a>; |
| 195 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_FontMetrics_fXHeight'>fXHeight</a>; |
| 196 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_FontMetrics_fCapHeight'>fCapHeight</a>; |
| 197 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_FontMetrics_fUnderlineThickness'>fUnderlineThickness</a>; |
| 198 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_FontMetrics_fUnderlinePosition'>fUnderlinePosition</a>; |
| 199 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_FontMetrics_fStrikeoutThickness'>fStrikeoutThickness</a>; |
| 200 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_FontMetrics_fStrikeoutPosition'>fStrikeoutPosition</a>; |
| 201 | bool <a href='#SkPaint_FontMetrics_hasUnderlineThickness'>hasUnderlineThickness</a>(<a href='undocumented#SkScalar'>SkScalar</a>* thickness) const; |
| 202 | bool <a href='#SkPaint_FontMetrics_hasUnderlinePosition'>hasUnderlinePosition</a>(<a href='undocumented#SkScalar'>SkScalar</a>* position) const; |
| 203 | bool <a href='#SkPaint_FontMetrics_hasStrikeoutThickness'>hasStrikeoutThickness</a>(<a href='undocumented#SkScalar'>SkScalar</a>* thickness) const; |
| 204 | bool <a href='#SkPaint_FontMetrics_hasStrikeoutPosition'>hasStrikeoutPosition</a>(<a href='undocumented#SkScalar'>SkScalar</a>* position) const; |
| 205 | }; |
| 206 | |
| 207 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_getFontMetrics'>getFontMetrics</a>(<a href='#SkPaint_FontMetrics'>FontMetrics</a>* metrics, <a href='undocumented#SkScalar'>SkScalar</a> scale = 0) const; |
| 208 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_getFontSpacing'>getFontSpacing</a>() const; |
| 209 | int <a href='#SkPaint_textToGlyphs'>textToGlyphs</a>(const void* text, size_t byteLength, |
| 210 | <a href='undocumented#SkGlyphID'>SkGlyphID</a> glyphs[]) const; |
| 211 | bool <a href='#SkPaint_containsText'>containsText</a>(const void* text, size_t byteLength) const; |
| 212 | void <a href='#SkPaint_glyphsToUnichars'>glyphsToUnichars</a>(const <a href='undocumented#SkGlyphID'>SkGlyphID</a> glyphs[], int count, <a href='undocumented#SkUnichar'>SkUnichar</a> text[]) const; |
| 213 | int <a href='#SkPaint_countText'>countText</a>(const void* text, size_t byteLength) const; |
| 214 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_measureText'>measureText</a>(const void* text, size_t length, <a href='SkRect_Reference#SkRect'>SkRect</a>* bounds) const; |
| 215 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_measureText_2'>measureText</a>(const void* text, size_t length) const; |
| 216 | size_t <a href='#SkPaint_breakText'>breakText</a>(const void* text, size_t length, <a href='undocumented#SkScalar'>SkScalar</a> maxWidth, |
| 217 | <a href='undocumented#SkScalar'>SkScalar</a>* measuredWidth = nullptr) const; |
| 218 | int <a href='#SkPaint_getTextWidths'>getTextWidths</a>(const void* text, size_t byteLength, <a href='undocumented#SkScalar'>SkScalar</a> widths[], |
| 219 | <a href='SkRect_Reference#SkRect'>SkRect</a> bounds[] = nullptr) const; |
| 220 | void <a href='#SkPaint_getTextPath'>getTextPath</a>(const void* text, size_t length, <a href='undocumented#SkScalar'>SkScalar</a> x, <a href='undocumented#SkScalar'>SkScalar</a> y, |
| 221 | <a href='SkPath_Reference#SkPath'>SkPath</a>* path) const; |
| 222 | void <a href='#SkPaint_getPosTextPath'>getPosTextPath</a>(const void* text, size_t length, |
| 223 | const <a href='SkPoint_Reference#SkPoint'>SkPoint</a> pos[], <a href='SkPath_Reference#SkPath'>SkPath</a>* path) const; |
| 224 | int <a href='#SkPaint_getTextIntercepts'>getTextIntercepts</a>(const void* text, size_t length, <a href='undocumented#SkScalar'>SkScalar</a> x, <a href='undocumented#SkScalar'>SkScalar</a> y, |
| 225 | const <a href='undocumented#SkScalar'>SkScalar</a> bounds[2], <a href='undocumented#SkScalar'>SkScalar</a>* intervals) const; |
| 226 | int <a href='#SkPaint_getPosTextIntercepts'>getPosTextIntercepts</a>(const void* text, size_t length, const <a href='SkPoint_Reference#SkPoint'>SkPoint</a> pos[], |
| 227 | const <a href='undocumented#SkScalar'>SkScalar</a> bounds[2], <a href='undocumented#SkScalar'>SkScalar</a>* intervals) const; |
| 228 | int <a href='#SkPaint_getPosTextHIntercepts'>getPosTextHIntercepts</a>(const void* text, size_t length, const <a href='undocumented#SkScalar'>SkScalar</a> xpos[], |
| 229 | <a href='undocumented#SkScalar'>SkScalar</a> constY, const <a href='undocumented#SkScalar'>SkScalar</a> bounds[2], <a href='undocumented#SkScalar'>SkScalar</a>* intervals) const; |
| 230 | 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], |
| 231 | <a href='undocumented#SkScalar'>SkScalar</a>* intervals) const; |
| 232 | <a href='SkRect_Reference#SkRect'>SkRect</a> <a href='#SkPaint_getFontBounds'>getFontBounds</a>() const; |
| 233 | bool <a href='#SkPaint_nothingToDraw'>nothingToDraw</a>() const; |
| 234 | bool <a href='#SkPaint_canComputeFastBounds'>canComputeFastBounds</a>() const; |
| 235 | 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; |
| 236 | const <a href='SkRect_Reference#SkRect'>SkRect</a>& <a href='#SkPaint_computeFastStrokeBounds'>computeFastStrokeBounds</a>(const <a href='SkRect_Reference#SkRect'>SkRect</a>& orig, |
| 237 | <a href='SkRect_Reference#SkRect'>SkRect</a>* storage) const; |
| 238 | 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, |
| 239 | <a href='#SkPaint_Style'>Style</a> style) const; |
| 240 | }; |
| 241 | </pre> |
| 242 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 243 | <a href='#Paint'>Paint</a> controls options applied when drawing and measuring. <a href='#Paint'>Paint</a> collects all |
| 244 | options outside of the <a href='SkCanvas_Reference#Clip'>Canvas Clip</a> and <a href='SkCanvas_Reference#Matrix'>Canvas Matrix</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 245 | |
Cary Clark | 7cfcbca | 2018-01-04 16:11:51 -0500 | [diff] [blame] | 246 | Various options apply to text, strokes and fills, and images. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 247 | |
| 248 | Some options may not be implemented on all platforms; in these cases, setting |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 249 | the option has no effect. Some options are conveniences that duplicate <a href='SkCanvas_Reference#Canvas'>Canvas</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 250 | functionality; for instance, text size is identical to matrix scale. |
| 251 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 252 | <a href='#Paint'>Paint</a> options are rarely exclusive; each option modifies a stage of the drawing |
| 253 | pipeline and multiple pipeline stages may be affected by a single <a href='#Paint'>Paint</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 254 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 255 | <a href='#Paint'>Paint</a> collects effects and filters that describe single-pass and multiple-pass |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 256 | algorithms that alter the drawing geometry, color, and transparency. For instance, |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 257 | <a href='#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] | 258 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 259 | The objects contained by <a href='#Paint'>Paint</a> are opaque, and cannot be edited outside of the <a href='#Paint'>Paint</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 260 | to affect it. The implementation is free to defer computations associated with the |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 261 | <a href='#Paint'>Paint</a>, or ignore them altogether. For instance, some GPU implementations draw all |
Cary Clark | ffb3d68 | 2018-05-17 12:17:28 -0400 | [diff] [blame] | 262 | <a href='SkPath_Reference#Path'>Path</a> geometries with <a href='#Anti_Alias'>Anti Aliasing</a>, regardless of how <a href='#SkPaint_kAntiAlias_Flag'>SkPaint::kAntiAlias Flag</a> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 263 | is set in <a href='#Paint'>Paint</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 264 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 265 | <a href='#Paint'>Paint</a> describes a single color, a single font, a single image quality, and so on. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 266 | Multiple colors are drawn either by using multiple paints or with objects like |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 267 | <a href='undocumented#Shader'>Shader</a> attached to <a href='#Paint'>Paint</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 268 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 269 | <a name='SkPaint_empty_constructor'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 270 | |
| 271 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 272 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 273 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 274 | <a href='#SkPaint'>SkPaint</a>() |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 275 | </pre> |
| 276 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 277 | Constructs <a href='#Paint'>Paint</a> with default values. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 278 | |
| 279 | | attribute | default value | |
| 280 | | --- | --- | |
Cary Clark | ffb3d68 | 2018-05-17 12:17:28 -0400 | [diff] [blame] | 281 | | <a href='#Anti_Alias'>Anti Alias</a> | false | |
Cary Clark | 224c700 | 2018-06-27 11:00:21 -0400 | [diff] [blame] | 282 | | <a href='SkBlendMode_Reference#Blend_Mode'>Blend Mode</a> | <a href='SkBlendMode_Reference#SkBlendMode_kSrcOver'>SkBlendMode::kSrcOver</a> | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 283 | | <a href='SkColor_Reference#Color'>Color</a> | <a href='SkColor_Reference#SK_ColorBLACK'>SK ColorBLACK</a> | |
| 284 | | <a href='SkColor_Reference#Alpha'>Color Alpha</a> | 255 | |
| 285 | | <a href='undocumented#Color_Filter'>Color Filter</a> | nullptr | |
| 286 | | <a href='#Dither'>Dither</a> | false | |
| 287 | | <a href='undocumented#Draw_Looper'>Draw Looper</a> | nullptr | |
| 288 | | <a href='#Fake_Bold'>Fake Bold</a> | false | |
| 289 | | <a href='undocumented#Filter_Quality'>Filter Quality</a> | <a href='undocumented#kNone_SkFilterQuality'>kNone_SkFilterQuality</a> | |
| 290 | | <a href='#Font_Embedded_Bitmaps'>Font Embedded Bitmaps</a> | false | |
| 291 | | <a href='#Automatic_Hinting'>Automatic Hinting</a> | false | |
| 292 | | <a href='#Full_Hinting_Spacing'>Full Hinting Spacing</a> | false | |
| 293 | | <a href='#SkPaint_Hinting'>Hinting</a> | <a href='#SkPaint_kNormal_Hinting'>kNormal Hinting</a> | |
| 294 | | <a href='undocumented#Image_Filter'>Image Filter</a> | nullptr | |
| 295 | | <a href='#LCD_Text'>LCD Text</a> | false | |
| 296 | | <a href='#Linear_Text'>Linear Text</a> | false | |
| 297 | | <a href='#Miter_Limit'>Miter Limit</a> | 4 | |
| 298 | | <a href='undocumented#Mask_Filter'>Mask Filter</a> | nullptr | |
| 299 | | <a href='undocumented#Path_Effect'>Path Effect</a> | nullptr | |
| 300 | | <a href='undocumented#Shader'>Shader</a> | nullptr | |
| 301 | | <a href='#SkPaint_Style'>Style</a> | <a href='#SkPaint_kFill_Style'>kFill Style</a> | |
| 302 | | <a href='#Text_Align'>Text Align</a> | <a href='#SkPaint_kLeft_Align'>kLeft Align</a> | |
| 303 | | <a href='#Text_Encoding'>Text Encoding</a> | <a href='#SkPaint_kUTF8_TextEncoding'>kUTF8 TextEncoding</a> | |
| 304 | | <a href='#Text_Scale_X'>Text Scale X</a> | 1 | |
| 305 | | <a href='#Text_Size'>Text Size</a> | 12 | |
| 306 | | <a href='#Text_Skew_X'>Text Skew X</a> | 0 | |
| 307 | | <a href='undocumented#Typeface'>Typeface</a> | nullptr | |
| 308 | | <a href='#Stroke_Cap'>Stroke Cap</a> | <a href='#SkPaint_kButt_Cap'>kButt Cap</a> | |
| 309 | | <a href='#Stroke_Join'>Stroke Join</a> | <a href='#SkPaint_kMiter_Join'>kMiter Join</a> | |
| 310 | | <a href='#Stroke_Width'>Stroke Width</a> | 0 | |
| 311 | | <a href='#Subpixel_Text'>Subpixel Text</a> | false | |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 312 | |
| 313 | The flags, text size, hinting, and miter limit may be overridden at compile time by defining |
Cary Clark | 7cfcbca | 2018-01-04 16:11:51 -0500 | [diff] [blame] | 314 | paint default values. The overrides may be included in "SkUserConfig.h" or predefined by the |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 315 | build system. |
| 316 | |
| 317 | ### Return Value |
| 318 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 319 | default initialized <a href='#Paint'>Paint</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 320 | |
| 321 | ### Example |
| 322 | |
| 323 | <div><fiddle-embed name="c4b2186d85c142a481298f7144295ffd"></fiddle-embed></div> |
| 324 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 325 | <a name='SkPaint_copy_const_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"> |
| 330 | <a href='#SkPaint'>SkPaint</a>(const <a href='#SkPaint'>SkPaint</a>& paint) |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 331 | </pre> |
| 332 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 333 | Makes a shallow copy of <a href='#Paint'>Paint</a>. <a href='undocumented#Typeface'>Typeface</a>, <a href='undocumented#Path_Effect'>Path Effect</a>, <a href='undocumented#Shader'>Shader</a>, |
| 334 | <a href='undocumented#Mask_Filter'>Mask Filter</a>, <a href='undocumented#Color_Filter'>Color Filter</a>, <a href='undocumented#Draw_Looper'>Draw Looper</a>, and <a href='undocumented#Image_Filter'>Image Filter</a> are shared |
| 335 | between the original <a href='#SkPaint_copy_const_SkPaint_paint'>paint</a> and the copy. Objects containing <a href='undocumented#Reference_Count'>Reference Count</a> increment |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 336 | their references by one. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 337 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 338 | The referenced objects <a href='undocumented#Path_Effect'>Path Effect</a>, <a href='undocumented#Shader'>Shader</a>, <a href='undocumented#Mask_Filter'>Mask Filter</a>, <a href='undocumented#Color_Filter'>Color Filter</a>, |
| 339 | <a href='undocumented#Draw_Looper'>Draw Looper</a>, and <a href='undocumented#Image_Filter'>Image Filter</a> cannot be modified after they are created. |
| 340 | This prevents objects with <a href='undocumented#Reference_Count'>Reference Count</a> from being modified once <a href='#Paint'>Paint</a> refers to them. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 341 | |
| 342 | ### Parameters |
| 343 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 344 | <table> <tr> <td><a name='SkPaint_copy_const_SkPaint_paint'><code><strong>paint</strong></code></a></td> |
| 345 | <td>original to copy</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 346 | </tr> |
| 347 | </table> |
| 348 | |
| 349 | ### Return Value |
| 350 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 351 | shallow copy of <a href='#SkPaint_copy_const_SkPaint_paint'>paint</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 352 | |
| 353 | ### Example |
| 354 | |
skia-bookmaker | 44bad2e | 2018-07-05 05:35:27 +0000 | [diff] [blame] | 355 | <div><fiddle-embed name="b99971ad0ef243d617925289d963b62d"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 356 | |
| 357 | #### Example Output |
| 358 | |
| 359 | ~~~~ |
| 360 | SK_ColorRED == paint1.getColor() |
| 361 | SK_ColorBLUE == paint2.getColor() |
| 362 | ~~~~ |
| 363 | |
| 364 | </fiddle-embed></div> |
| 365 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 366 | <a name='SkPaint_move_SkPaint'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 367 | |
| 368 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 369 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 370 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 371 | <a href='#SkPaint'>SkPaint</a>(<a href='#SkPaint'>SkPaint</a>&& paint) |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 372 | </pre> |
| 373 | |
Cary Clark | d0530ba | 2017-09-14 11:25:39 -0400 | [diff] [blame] | 374 | Implements a move constructor to avoid increasing the reference counts |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 375 | 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] | 376 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 377 | 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] | 378 | |
| 379 | ### Parameters |
| 380 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 381 | <table> <tr> <td><a name='SkPaint_move_SkPaint_paint'><code><strong>paint</strong></code></a></td> |
| 382 | <td>original to move</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 383 | </tr> |
| 384 | </table> |
| 385 | |
| 386 | ### Return Value |
| 387 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 388 | content of <a href='#SkPaint_move_SkPaint_paint'>paint</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 389 | |
| 390 | ### Example |
| 391 | |
Cary Clark | 8364706 | 2018-07-18 16:21:51 -0400 | [diff] [blame] | 392 | <div><fiddle-embed name="8ed1488a503cd5282b86a51614aa90b1"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 393 | |
| 394 | #### Example Output |
| 395 | |
| 396 | ~~~~ |
| 397 | path effect unique: true |
| 398 | ~~~~ |
| 399 | |
| 400 | </fiddle-embed></div> |
| 401 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 402 | <a name='SkPaint_reset'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 403 | |
| 404 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 405 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 406 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 407 | void <a href='#SkPaint_reset'>reset</a>() |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 408 | </pre> |
| 409 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 410 | Sets all <a href='#Paint'>Paint</a> contents to their initial values. This is equivalent to replacing |
| 411 | <a href='#Paint'>Paint</a> with the result of <a href='#SkPaint_empty_constructor'>SkPaint()</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 412 | |
| 413 | ### Example |
| 414 | |
| 415 | <div><fiddle-embed name="ef269937ade7e7353635121d9a64f9f7"> |
| 416 | |
| 417 | #### Example Output |
| 418 | |
| 419 | ~~~~ |
| 420 | paint1 == paint2 |
| 421 | ~~~~ |
| 422 | |
| 423 | </fiddle-embed></div> |
| 424 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 425 | <a name='SkPaint_destructor'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 426 | |
| 427 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 428 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 429 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 430 | <a href='#SkPaint_destructor'>~SkPaint</a>() |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 431 | </pre> |
| 432 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 433 | Decreases <a href='#Paint'>Paint</a> <a href='undocumented#Reference_Count'>Reference Count</a> of owned objects: <a href='undocumented#Typeface'>Typeface</a>, <a href='undocumented#Path_Effect'>Path Effect</a>, <a href='undocumented#Shader'>Shader</a>, |
| 434 | <a href='undocumented#Mask_Filter'>Mask Filter</a>, <a href='undocumented#Color_Filter'>Color Filter</a>, <a href='undocumented#Draw_Looper'>Draw Looper</a>, and <a href='undocumented#Image_Filter'>Image Filter</a>. If the |
| 435 | objects containing <a href='undocumented#Reference_Count'>Reference Count</a> go to zero, they are deleted. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 436 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 437 | <a name='Management'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 438 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 439 | <a name='SkPaint_copy_operator'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 440 | |
| 441 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 442 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 443 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 444 | <a href='#SkPaint'>SkPaint</a>& <a href='#SkPaint_copy_operator'>operator=(const SkPaint& paint)</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 445 | </pre> |
| 446 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 447 | Makes a shallow copy of <a href='#Paint'>Paint</a>. <a href='undocumented#Typeface'>Typeface</a>, <a href='undocumented#Path_Effect'>Path Effect</a>, <a href='undocumented#Shader'>Shader</a>, |
| 448 | <a href='undocumented#Mask_Filter'>Mask Filter</a>, <a href='undocumented#Color_Filter'>Color Filter</a>, <a href='undocumented#Draw_Looper'>Draw Looper</a>, and <a href='undocumented#Image_Filter'>Image Filter</a> are shared |
| 449 | between the original <a href='#SkPaint_copy_operator_paint'>paint</a> and the copy. Objects containing <a href='undocumented#Reference_Count'>Reference Count</a> in the |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 450 | prior destination are decreased by one, and the referenced objects are deleted if the |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 451 | resulting count is zero. Objects containing <a href='undocumented#Reference_Count'>Reference Count</a> in the parameter <a href='#SkPaint_copy_operator_paint'>paint</a> |
| 452 | 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] | 453 | |
| 454 | ### Parameters |
| 455 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 456 | <table> <tr> <td><a name='SkPaint_copy_operator_paint'><code><strong>paint</strong></code></a></td> |
| 457 | <td>original to copy</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 458 | </tr> |
| 459 | </table> |
| 460 | |
| 461 | ### Return Value |
| 462 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 463 | content of <a href='#SkPaint_copy_operator_paint'>paint</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 464 | |
| 465 | ### Example |
| 466 | |
| 467 | <div><fiddle-embed name="b476a9088f80dece176ed577807d3992"> |
| 468 | |
| 469 | #### Example Output |
| 470 | |
| 471 | ~~~~ |
| 472 | SK_ColorRED == paint1.getColor() |
| 473 | SK_ColorRED == paint2.getColor() |
| 474 | ~~~~ |
| 475 | |
| 476 | </fiddle-embed></div> |
| 477 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 478 | <a name='SkPaint_move_operator'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 479 | |
| 480 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 481 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 482 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 483 | <a href='#SkPaint'>SkPaint</a>& <a href='#SkPaint_move_operator'>operator=(SkPaint&& paint)</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 484 | </pre> |
| 485 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 486 | Moves the <a href='#SkPaint_move_operator_paint'>paint</a> to avoid increasing the reference counts |
| 487 | of objects referenced by the <a href='#SkPaint_move_operator_paint'>paint</a> parameter. Objects containing <a href='undocumented#Reference_Count'>Reference Count</a> in the |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 488 | prior destination are decreased by one; those objects are deleted if the resulting count |
| 489 | is zero. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 490 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 491 | 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] | 492 | |
| 493 | ### Parameters |
| 494 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 495 | <table> <tr> <td><a name='SkPaint_move_operator_paint'><code><strong>paint</strong></code></a></td> |
| 496 | <td>original to move</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 497 | </tr> |
| 498 | </table> |
| 499 | |
| 500 | ### Return Value |
| 501 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 502 | content of <a href='#SkPaint_move_operator_paint'>paint</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 503 | |
| 504 | ### Example |
| 505 | |
Ravi Mistry | 874e22b | 2018-07-19 03:49:13 +0000 | [diff] [blame] | 506 | <div><fiddle-embed name="9fb7459b097d713f5f1fe5675afe14f5"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 507 | |
| 508 | #### Example Output |
| 509 | |
| 510 | ~~~~ |
| 511 | SK_ColorRED == paint2.getColor() |
| 512 | ~~~~ |
| 513 | |
| 514 | </fiddle-embed></div> |
| 515 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 516 | <a name='SkPaint_equal_operator'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 517 | |
| 518 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 519 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 520 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 521 | bool <a href='#SkPaint_equal_operator'>operator==(const SkPaint& a, const SkPaint& b)</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 522 | </pre> |
| 523 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 524 | 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 |
| 525 | if <a href='undocumented#Typeface'>Typeface</a>, <a href='undocumented#Path_Effect'>Path Effect</a>, <a href='undocumented#Shader'>Shader</a>, <a href='undocumented#Mask_Filter'>Mask Filter</a>, <a href='undocumented#Color_Filter'>Color Filter</a>, |
| 526 | <a href='undocumented#Draw_Looper'>Draw Looper</a>, or <a href='undocumented#Image_Filter'>Image Filter</a> have identical contents but different pointers. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 527 | |
| 528 | ### Parameters |
| 529 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 530 | <table> <tr> <td><a name='SkPaint_equal_operator_a'><code><strong>a</strong></code></a></td> |
| 531 | <td><a href='#Paint'>Paint</a> to compare</td> |
| 532 | </tr> |
| 533 | <tr> <td><a name='SkPaint_equal_operator_b'><code><strong>b</strong></code></a></td> |
| 534 | <td><a href='#Paint'>Paint</a> to compare</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 535 | </tr> |
| 536 | </table> |
| 537 | |
| 538 | ### Return Value |
| 539 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 540 | true if <a href='#Paint'>Paint</a> pair are equivalent |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 541 | |
| 542 | ### Example |
| 543 | |
| 544 | <div><fiddle-embed name="7481a948e34672720337a631830586dd"> |
| 545 | |
| 546 | #### Example Output |
| 547 | |
| 548 | ~~~~ |
| 549 | paint1 == paint2 |
| 550 | paint1 != paint2 |
| 551 | ~~~~ |
| 552 | |
| 553 | </fiddle-embed></div> |
| 554 | |
Cary Clark | 06c20f3 | 2018-03-20 15:53:27 -0400 | [diff] [blame] | 555 | ### See Also |
| 556 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 557 | <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] | 558 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 559 | <a name='SkPaint_notequal_operator'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 560 | |
| 561 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 562 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 563 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 564 | bool <a href='#SkPaint_notequal_operator'>operator!=(const SkPaint& a, const SkPaint& b)</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 565 | </pre> |
| 566 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 567 | 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 |
| 568 | if <a href='undocumented#Typeface'>Typeface</a>, <a href='undocumented#Path_Effect'>Path Effect</a>, <a href='undocumented#Shader'>Shader</a>, <a href='undocumented#Mask_Filter'>Mask Filter</a>, <a href='undocumented#Color_Filter'>Color Filter</a>, |
| 569 | <a href='undocumented#Draw_Looper'>Draw Looper</a>, or <a href='undocumented#Image_Filter'>Image Filter</a> have identical contents but different pointers. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 570 | |
| 571 | ### Parameters |
| 572 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 573 | <table> <tr> <td><a name='SkPaint_notequal_operator_a'><code><strong>a</strong></code></a></td> |
| 574 | <td><a href='#Paint'>Paint</a> to compare</td> |
| 575 | </tr> |
| 576 | <tr> <td><a name='SkPaint_notequal_operator_b'><code><strong>b</strong></code></a></td> |
| 577 | <td><a href='#Paint'>Paint</a> to compare</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 578 | </tr> |
| 579 | </table> |
| 580 | |
| 581 | ### Return Value |
| 582 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 583 | true if <a href='#Paint'>Paint</a> pair are not equivalent |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 584 | |
| 585 | ### Example |
| 586 | |
skia-bookmaker | a717ca9 | 2018-07-08 05:32:09 +0000 | [diff] [blame] | 587 | <div><fiddle-embed name="b6c8484b1187f555b435ad5369833be4"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 588 | |
| 589 | #### Example Output |
| 590 | |
| 591 | ~~~~ |
| 592 | paint1 == paint2 |
| 593 | paint1 == paint2 |
| 594 | ~~~~ |
| 595 | |
| 596 | </fiddle-embed></div> |
| 597 | |
Cary Clark | 06c20f3 | 2018-03-20 15:53:27 -0400 | [diff] [blame] | 598 | ### See Also |
| 599 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 600 | <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] | 601 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 602 | <a name='SkPaint_getHash'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 603 | |
| 604 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 605 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 606 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 607 | uint32_t <a href='#SkPaint_getHash'>getHash</a>() const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 608 | </pre> |
| 609 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 610 | Returns a hash generated from <a href='#Paint'>Paint</a> values and pointers. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 611 | Identical hashes guarantee that the paints are |
| 612 | equivalent, but differing hashes do not guarantee that the paints have differing |
| 613 | contents. |
| 614 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 615 | 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] | 616 | their hashes are also equal. |
| 617 | |
| 618 | The hash returned is platform and implementation specific. |
| 619 | |
| 620 | ### Return Value |
| 621 | |
| 622 | a shallow hash |
| 623 | |
| 624 | ### Example |
| 625 | |
Cary Clark | 8364706 | 2018-07-18 16:21:51 -0400 | [diff] [blame] | 626 | <div><fiddle-embed name="7f7e1b701361912b344f90ae6b530393"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 627 | |
| 628 | #### Example Output |
| 629 | |
| 630 | ~~~~ |
| 631 | paint1 == paint2 |
| 632 | paint1.getHash() == paint2.getHash() |
| 633 | ~~~~ |
| 634 | |
| 635 | </fiddle-embed></div> |
| 636 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 637 | <a name='Hinting'></a> |
| 638 | |
| 639 | <a name='SkPaint_Hinting'></a> |
| 640 | |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 641 | --- |
| 642 | |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 643 | <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] | 644 | enum <a href='#SkPaint_Hinting'>Hinting</a> { |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 645 | <a href='#SkPaint_kNo_Hinting'>kNo_Hinting</a> = 0, |
| 646 | <a href='#SkPaint_kSlight_Hinting'>kSlight_Hinting</a> = 1, |
| 647 | <a href='#SkPaint_kNormal_Hinting'>kNormal_Hinting</a> = 2, |
| 648 | <a href='#SkPaint_kFull_Hinting'>kFull_Hinting</a> = 3, |
Cary Clark | 186d08f | 2018-04-03 08:43:27 -0400 | [diff] [blame] | 649 | }; |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 650 | </pre> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 651 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 652 | <a href='#SkPaint_Hinting'>Hinting</a> adjusts the glyph outlines so that the shape provides a uniform |
| 653 | look at a given point size on font engines that support it. <a href='#SkPaint_Hinting'>Hinting</a> may have a |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 654 | muted effect or no effect at all depending on the platform. |
| 655 | |
Cary Clark | 7cfcbca | 2018-01-04 16:11:51 -0500 | [diff] [blame] | 656 | The four levels roughly control corresponding features on platforms that use FreeType |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 657 | as the <a href='undocumented#Engine'>Font Engine</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 658 | |
| 659 | ### Constants |
| 660 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 661 | <table style='border-collapse: collapse; width: 62.5em'> |
| 662 | <tr><th style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>Const</th> |
| 663 | <th style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>Value</th> |
| 664 | <th style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>Description</th></tr> |
| 665 | <tr style='background-color: #f0f0f0; '> |
| 666 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kNo_Hinting'><code>SkPaint::kNo_Hinting</code></a></td> |
| 667 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>0</td> |
| 668 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 669 | Leaves glyph outlines unchanged from their native representation. |
Cary Clark | 7cfcbca | 2018-01-04 16:11:51 -0500 | [diff] [blame] | 670 | With FreeType, this is equivalent to the FT_LOAD_NO_HINTING |
| 671 | bit-field constant supplied to FT_Load_Glyph, which indicates that the vector |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 672 | outline being loaded should not be fitted to the pixel grid but simply scaled |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 673 | to 26.6 fractional pixels. |
| 674 | </td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 675 | </tr> |
| 676 | <tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 677 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kSlight_Hinting'><code>SkPaint::kSlight_Hinting</code></a></td> |
| 678 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>1</td> |
| 679 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 680 | Modifies glyph outlines minimally to improve constrast. |
Cary Clark | 7cfcbca | 2018-01-04 16:11:51 -0500 | [diff] [blame] | 681 | With FreeType, this is equivalent in spirit to the |
| 682 | FT_LOAD_TARGET_LIGHT value supplied to FT_Load_Glyph. It chooses a |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 683 | lighter hinting algorithm for non-monochrome modes. |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 684 | Generated <a href='undocumented#Glyph'>Glyphs</a> may be fuzzy but better resemble their original shape. |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 685 | </td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 686 | </tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 687 | <tr style='background-color: #f0f0f0; '> |
| 688 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kNormal_Hinting'><code>SkPaint::kNormal_Hinting</code></a></td> |
| 689 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>2</td> |
| 690 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 691 | Modifies glyph outlines to improve constrast. This is the default. |
Cary Clark | 7cfcbca | 2018-01-04 16:11:51 -0500 | [diff] [blame] | 692 | With FreeType, this supplies FT_LOAD_TARGET_NORMAL to FT_Load_Glyph, |
| 693 | choosing the default hinting algorithm, which is optimized for standard |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 694 | gray-level rendering. |
| 695 | </td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 696 | </tr> |
| 697 | <tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 698 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kFull_Hinting'><code>SkPaint::kFull_Hinting</code></a></td> |
| 699 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>3</td> |
| 700 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
Cary Clark | 137b874 | 2018-05-30 09:21:49 -0400 | [diff] [blame] | 701 | Modifies glyph outlines for maximum constrast. With FreeType, this selects |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 702 | FT_LOAD_TARGET_LCD or FT_LOAD_TARGET_LCD_V if <a href='#SkPaint_kLCDRenderText_Flag'>kLCDRenderText Flag</a> is set. |
Cary Clark | 7cfcbca | 2018-01-04 16:11:51 -0500 | [diff] [blame] | 703 | FT_LOAD_TARGET_LCD is a variant of FT_LOAD_TARGET_NORMAL optimized for |
| 704 | horizontally decimated LCD displays; FT_LOAD_TARGET_LCD_V is a |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 705 | variant of FT_LOAD_TARGET_NORMAL optimized for vertically decimated LCD displays. |
| 706 | </td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 707 | </tr> |
| 708 | </table> |
| 709 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 710 | On <a href='undocumented#OS_X'>OS X</a> and iOS, hinting controls whether <a href='undocumented#Core_Graphics'>Core Graphics</a> dilates the font outlines |
Cary Clark | 137b874 | 2018-05-30 09:21:49 -0400 | [diff] [blame] | 711 | to account for LCD text. No hinting uses <a href='undocumented#Core_Text'>Core Text</a> <a href='undocumented#Grayscale'>Grayscale</a> output. |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 712 | Normal hinting uses <a href='undocumented#Core_Text'>Core Text</a> LCD output. If <a href='#SkPaint_kLCDRenderText_Flag'>kLCDRenderText Flag</a> is clear, |
Cary Clark | 137b874 | 2018-05-30 09:21:49 -0400 | [diff] [blame] | 713 | the LCD output is reduced to a single <a href='undocumented#Grayscale'>Grayscale</a> channel. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 714 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 715 | On Windows with DirectWrite, <a href='#SkPaint_Hinting'>Hinting</a> has no effect. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 716 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 717 | <a href='#SkPaint_Hinting'>Hinting</a> defaults to <a href='#SkPaint_kNormal_Hinting'>kNormal Hinting</a>. |
| 718 | Set <a href='undocumented#SkPaintDefaults_Hinting'>SkPaintDefaults Hinting</a> at compile time to change the default setting. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 719 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 720 | <a name='SkPaint_getHinting'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 721 | |
| 722 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 723 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 724 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 725 | <a href='#SkPaint_Hinting'>Hinting</a> <a href='#SkPaint_getHinting'>getHinting</a>() const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 726 | </pre> |
| 727 | |
| 728 | Returns level of glyph outline adjustment. |
| 729 | |
| 730 | ### Return Value |
| 731 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 732 | 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> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 733 | |
| 734 | ### Example |
| 735 | |
Cary Clark | 8364706 | 2018-07-18 16:21:51 -0400 | [diff] [blame] | 736 | <div><fiddle-embed name="329e2e5a5919ac431e1c58878a5b99e0"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 737 | |
| 738 | #### Example Output |
| 739 | |
| 740 | ~~~~ |
| 741 | SkPaint::kNormal_Hinting == paint.getHinting() |
| 742 | ~~~~ |
| 743 | |
| 744 | </fiddle-embed></div> |
| 745 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 746 | <a name='SkPaint_setHinting'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 747 | |
| 748 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 749 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 750 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 751 | void <a href='#SkPaint_setHinting'>setHinting</a>(<a href='#SkPaint_Hinting'>Hinting</a> hintingLevel) |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 752 | </pre> |
| 753 | |
| 754 | Sets level of glyph outline adjustment. |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 755 | 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] | 756 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 757 | | <a href='#SkPaint_Hinting'>Hinting</a> | value | effect on generated glyph outlines | |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 758 | | --- | --- | --- | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 759 | | <a href='#SkPaint_kNo_Hinting'>kNo Hinting</a> | 0 | leaves glyph outlines unchanged from their native representation | |
| 760 | | <a href='#SkPaint_kSlight_Hinting'>kSlight Hinting</a> | 1 | modifies glyph outlines minimally to improve contrast | |
| 761 | | <a href='#SkPaint_kNormal_Hinting'>kNormal Hinting</a> | 2 | modifies glyph outlines to improve contrast | |
| 762 | | <a href='#SkPaint_kFull_Hinting'>kFull Hinting</a> | 3 | modifies glyph outlines for maximum contrast | |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 763 | |
| 764 | ### Parameters |
| 765 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 766 | <table> <tr> <td><a name='SkPaint_setHinting_hintingLevel'><code><strong>hintingLevel</strong></code></a></td> |
| 767 | <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> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 768 | </tr> |
| 769 | </table> |
| 770 | |
| 771 | ### Example |
| 772 | |
| 773 | <div><fiddle-embed name="78153fbd3f1000cb33b97bbe831ed34e"> |
| 774 | |
| 775 | #### Example Output |
| 776 | |
| 777 | ~~~~ |
| 778 | paint1 == paint2 |
| 779 | ~~~~ |
| 780 | |
| 781 | </fiddle-embed></div> |
| 782 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 783 | <a name='Flags'></a> |
| 784 | |
| 785 | <a name='SkPaint_Flags'></a> |
| 786 | |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 787 | --- |
| 788 | |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 789 | <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] | 790 | enum <a href='#SkPaint_Flags'>Flags</a> { |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 791 | <a href='#SkPaint_kAntiAlias_Flag'>kAntiAlias_Flag</a> = 0x01, |
| 792 | <a href='#SkPaint_kDither_Flag'>kDither_Flag</a> = 0x04, |
| 793 | <a href='#SkPaint_kFakeBoldText_Flag'>kFakeBoldText_Flag</a> = 0x20, |
| 794 | <a href='#SkPaint_kLinearText_Flag'>kLinearText_Flag</a> = 0x40, |
| 795 | <a href='#SkPaint_kSubpixelText_Flag'>kSubpixelText_Flag</a> = 0x80, |
| 796 | <a href='#SkPaint_kLCDRenderText_Flag'>kLCDRenderText_Flag</a> = 0x200, |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 797 | <a href='#SkPaint_kEmbeddedBitmapText_Flag'>kEmbeddedBitmapText_Flag</a> = 0x400, |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 798 | <a href='#SkPaint_kAutoHinting_Flag'>kAutoHinting_Flag</a> = 0x800, |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 799 | <a href='#SkPaint_kAllFlags'>kAllFlags</a> = 0xFFFF, |
Cary Clark | 186d08f | 2018-04-03 08:43:27 -0400 | [diff] [blame] | 800 | }; |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 801 | </pre> |
| 802 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 803 | The bit values stored in <a href='#SkPaint_Flags'>Flags</a>. |
| 804 | The default value for <a href='#SkPaint_Flags'>Flags</a>, normally zero, can be changed at compile time |
| 805 | with a custom definition of <a href='undocumented#SkPaintDefaults_Flags'>SkPaintDefaults Flags</a>. |
| 806 | All flags can be read and written explicitly; <a href='#SkPaint_Flags'>Flags</a> allows manipulating |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 807 | multiple settings at once. |
| 808 | |
| 809 | ### Constants |
| 810 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 811 | <table style='border-collapse: collapse; width: 62.5em'> |
| 812 | <tr><th style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>Const</th> |
| 813 | <th style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>Value</th> |
| 814 | <th style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>Description</th></tr> |
| 815 | <tr style='background-color: #f0f0f0; '> |
| 816 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kAntiAlias_Flag'><code>SkPaint::kAntiAlias_Flag</code></a></td> |
| 817 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>0x0001</td> |
| 818 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
Cary Clark | ffb3d68 | 2018-05-17 12:17:28 -0400 | [diff] [blame] | 819 | mask for setting Anti_Alias</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 820 | </tr> |
| 821 | <tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 822 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kDither_Flag'><code>SkPaint::kDither_Flag</code></a></td> |
| 823 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>0x0004</td> |
| 824 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 825 | mask for setting Dither</td> |
| 826 | </tr> |
| 827 | <tr style='background-color: #f0f0f0; '> |
| 828 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kFakeBoldText_Flag'><code>SkPaint::kFakeBoldText_Flag</code></a></td> |
| 829 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>0x0020</td> |
| 830 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 831 | mask for setting Fake_Bold</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 832 | </tr> |
| 833 | <tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 834 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kLinearText_Flag'><code>SkPaint::kLinearText_Flag</code></a></td> |
| 835 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>0x0040</td> |
| 836 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 837 | mask for setting Linear_Text</td> |
| 838 | </tr> |
| 839 | <tr style='background-color: #f0f0f0; '> |
| 840 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kSubpixelText_Flag'><code>SkPaint::kSubpixelText_Flag</code></a></td> |
| 841 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>0x0080</td> |
| 842 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 843 | mask for setting Subpixel_Text</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 844 | </tr> |
| 845 | <tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 846 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kLCDRenderText_Flag'><code>SkPaint::kLCDRenderText_Flag</code></a></td> |
| 847 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>0x0200</td> |
| 848 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 849 | mask for setting LCD_Text</td> |
| 850 | </tr> |
| 851 | <tr style='background-color: #f0f0f0; '> |
| 852 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kEmbeddedBitmapText_Flag'><code>SkPaint::kEmbeddedBitmapText_Flag</code></a></td> |
| 853 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>0x0400</td> |
| 854 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 855 | mask for setting Font_Embedded_Bitmaps</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 856 | </tr> |
| 857 | <tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 858 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kAutoHinting_Flag'><code>SkPaint::kAutoHinting_Flag</code></a></td> |
| 859 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>0x0800</td> |
| 860 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 861 | mask for setting Automatic_Hinting</td> |
| 862 | </tr> |
| 863 | <tr style='background-color: #f0f0f0; '> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 864 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kAllFlags'><code>SkPaint::kAllFlags</code></a></td> |
| 865 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>0xFFFF</td> |
| 866 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 867 | mask of all <a href='#SkPaint_Flags'>Flags</a>, including private flags and flags reserved for future use</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 868 | </tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 869 | <a href='#SkPaint_Flags'>Flags</a> default to all flags clear, disabling the associated feature. |
| 870 | </table> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 871 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 872 | <a name='SkPaint_ReserveFlags'></a> |
| 873 | |
| 874 | --- |
Cary Clark | 06c20f3 | 2018-03-20 15:53:27 -0400 | [diff] [blame] | 875 | |
Cary Clark | e8161dd | 2018-09-06 12:47:04 -0400 | [diff] [blame] | 876 | To be deprecated soon. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 877 | |
Cary Clark | e8161dd | 2018-09-06 12:47:04 -0400 | [diff] [blame] | 878 | Only valid for Android framework. |
Cary Clark | 4855f78 | 2018-02-06 09:41:53 -0500 | [diff] [blame] | 879 | |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 880 | <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] | 881 | enum <a href='#SkPaint_ReserveFlags'>ReserveFlags</a> { |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 882 | <a href='#SkPaint_kUnderlineText_ReserveFlag'>kUnderlineText_ReserveFlag</a> = 0x08, |
| 883 | <a href='#SkPaint_kStrikeThruText_ReserveFlag'>kStrikeThruText_ReserveFlag</a> = 0x10, |
Cary Clark | 186d08f | 2018-04-03 08:43:27 -0400 | [diff] [blame] | 884 | }; |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 885 | </pre> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 886 | |
| 887 | ### Constants |
| 888 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 889 | <table style='border-collapse: collapse; width: 62.5em'> |
| 890 | <tr><th style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>Const</th> |
| 891 | <th style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>Value</th> |
| 892 | <th style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>Description</th></tr> |
| 893 | <tr style='background-color: #f0f0f0; '> |
| 894 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kUnderlineText_ReserveFlag'><code>SkPaint::kUnderlineText_ReserveFlag</code></a></td> |
| 895 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>0x0008</td> |
| 896 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
Cary Clark | e8161dd | 2018-09-06 12:47:04 -0400 | [diff] [blame] | 897 | To be deprecated soon. |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 898 | |
Cary Clark | e8161dd | 2018-09-06 12:47:04 -0400 | [diff] [blame] | 899 | </td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 900 | </tr> |
| 901 | <tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 902 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kStrikeThruText_ReserveFlag'><code>SkPaint::kStrikeThruText_ReserveFlag</code></a></td> |
| 903 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>0x0010</td> |
| 904 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
Cary Clark | e8161dd | 2018-09-06 12:47:04 -0400 | [diff] [blame] | 905 | To be deprecated soon. |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 906 | |
Cary Clark | e8161dd | 2018-09-06 12:47:04 -0400 | [diff] [blame] | 907 | </td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 908 | </tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 909 | </table> |
Cary Clark | 4855f78 | 2018-02-06 09:41:53 -0500 | [diff] [blame] | 910 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 911 | <a name='SkPaint_getFlags'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 912 | |
| 913 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 914 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 915 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 916 | uint32_t <a href='#SkPaint_getFlags'>getFlags</a>() const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 917 | </pre> |
| 918 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 919 | Returns paint settings described by <a href='#SkPaint_Flags'>Flags</a>. Each setting uses one |
| 920 | bit, and can be tested with <a href='#SkPaint_Flags'>Flags</a> members. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 921 | |
| 922 | ### Return Value |
| 923 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 924 | zero, one, or more bits described by <a href='#SkPaint_Flags'>Flags</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 925 | |
| 926 | ### Example |
| 927 | |
| 928 | <div><fiddle-embed name="8a3f8c309533388b01aa66e1267f322d"> |
| 929 | |
| 930 | #### Example Output |
| 931 | |
| 932 | ~~~~ |
| 933 | (SkPaint::kAntiAlias_Flag & paint.getFlags()) != 0 |
| 934 | ~~~~ |
| 935 | |
| 936 | </fiddle-embed></div> |
| 937 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 938 | <a name='SkPaint_setFlags'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 939 | |
| 940 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 941 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 942 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 943 | void <a href='#SkPaint_setFlags'>setFlags</a>(uint32_t flags) |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 944 | </pre> |
| 945 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 946 | Replaces <a href='#SkPaint_Flags'>Flags</a> with <a href='#SkPaint_setFlags_flags'>flags</a>, the union of the <a href='#SkPaint_Flags'>Flags</a> members. |
| 947 | All <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] | 948 | |
| 949 | ### Parameters |
| 950 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 951 | <table> <tr> <td><a name='SkPaint_setFlags_flags'><code><strong>flags</strong></code></a></td> |
| 952 | <td>union of <a href='#SkPaint_Flags'>Flags</a> for <a href='#Paint'>Paint</a></td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 953 | </tr> |
| 954 | </table> |
| 955 | |
| 956 | ### Example |
| 957 | |
| 958 | <div><fiddle-embed name="54baed3f6bc4b9c31ba664e27767fdc7"> |
| 959 | |
| 960 | #### Example Output |
| 961 | |
| 962 | ~~~~ |
| 963 | paint.isAntiAlias() |
| 964 | paint.isDither() |
| 965 | ~~~~ |
| 966 | |
| 967 | </fiddle-embed></div> |
| 968 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 969 | <a name='Anti_Alias'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 970 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 971 | --- |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 972 | |
Cary Clark | ffb3d68 | 2018-05-17 12:17:28 -0400 | [diff] [blame] | 973 | <a href='#Anti_Alias'>Anti Alias</a> drawing approximates partial pixel coverage with transparency. |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 974 | If <a href='#SkPaint_kAntiAlias_Flag'>kAntiAlias Flag</a> is clear, pixel centers contained by the shape edge are drawn opaque. |
| 975 | If <a href='#SkPaint_kAntiAlias_Flag'>kAntiAlias Flag</a> is set, pixels are drawn with <a href='SkColor_Reference#Alpha'>Color Alpha</a> equal to their coverage. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 976 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 977 | The rule for <a href='undocumented#Alias'>Aliased</a> pixels is inconsistent across platforms. A shape edge |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 978 | passing through the pixel center may, but is not required to, draw the pixel. |
| 979 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 980 | <a href='undocumented#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 |
| 981 | 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] | 982 | |
Cary Clark | ffb3d68 | 2018-05-17 12:17:28 -0400 | [diff] [blame] | 983 | A platform may only support <a href='#Anti_Alias'>Anti Aliased</a> drawing. Some GPU-backed platforms use |
| 984 | <a href='undocumented#Supersampling'>Supersampling</a> to <a href='#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] | 985 | <a href='undocumented#Alias'>Alias</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 986 | |
Cary Clark | ffb3d68 | 2018-05-17 12:17:28 -0400 | [diff] [blame] | 987 | The amount of coverage computed for <a href='#Anti_Alias'>Anti Aliased</a> pixels also varies across platforms. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 988 | |
Cary Clark | ffb3d68 | 2018-05-17 12:17:28 -0400 | [diff] [blame] | 989 | <a href='#Anti_Alias'>Anti Alias</a> is disabled by default. |
| 990 | <a href='#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> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 991 | at compile time. |
| 992 | |
| 993 | ### Example |
| 994 | |
| 995 | <div><fiddle-embed name="a6575a49467ce8d28bb01cc7638fa04d"><div>A red line is drawn with transparency on the edges to make it look smoother. |
| 996 | A blue line draws only where the pixel centers are contained. |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 997 | The lines are drawn into <a href='SkBitmap_Reference#Bitmap'>Bitmap</a>, then drawn magnified to make the |
| 998 | <a href='undocumented#Alias'>Aliasing</a> easier to see. |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 999 | </div></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1000 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1001 | <a name='SkPaint_isAntiAlias'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1002 | |
| 1003 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1004 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1005 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 1006 | bool <a href='#SkPaint_isAntiAlias'>isAntiAlias</a>() const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1007 | </pre> |
| 1008 | |
Cary Clark | 80247e5 | 2018-07-11 16:18:41 -0400 | [diff] [blame] | 1009 | Returns true if pixels on the active edges of <a href='SkPath_Reference#Path'>Path</a> may be drawn with partial transparency. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1010 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1011 | 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] | 1012 | |
| 1013 | ### Return Value |
| 1014 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1015 | <a href='#SkPaint_kAntiAlias_Flag'>kAntiAlias Flag</a> state |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1016 | |
| 1017 | ### Example |
| 1018 | |
skia-bookmaker | b95bbba | 2018-07-06 05:23:23 +0000 | [diff] [blame] | 1019 | <div><fiddle-embed name="d7d5f4f7da7acd5104a652f490c6f7b8"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1020 | |
| 1021 | #### Example Output |
| 1022 | |
| 1023 | ~~~~ |
| 1024 | paint.isAntiAlias() == !!(paint.getFlags() & SkPaint::kAntiAlias_Flag) |
| 1025 | paint.isAntiAlias() == !!(paint.getFlags() & SkPaint::kAntiAlias_Flag) |
| 1026 | ~~~~ |
| 1027 | |
| 1028 | </fiddle-embed></div> |
| 1029 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1030 | <a name='SkPaint_setAntiAlias'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1031 | |
| 1032 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1033 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1034 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 1035 | void <a href='#SkPaint_setAntiAlias'>setAntiAlias</a>(bool aa) |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1036 | </pre> |
| 1037 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1038 | Requests, but does not require, that <a href='SkPath_Reference#Path'>Path</a> edge pixels draw opaque or with |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1039 | partial transparency. |
| 1040 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1041 | Sets <a href='#SkPaint_kAntiAlias_Flag'>kAntiAlias Flag</a> if <a href='#SkPaint_setAntiAlias_aa'>aa</a> is true. |
| 1042 | 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] | 1043 | |
| 1044 | ### Parameters |
| 1045 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1046 | <table> <tr> <td><a name='SkPaint_setAntiAlias_aa'><code><strong>aa</strong></code></a></td> |
| 1047 | <td>setting for <a href='#SkPaint_kAntiAlias_Flag'>kAntiAlias Flag</a></td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1048 | </tr> |
| 1049 | </table> |
| 1050 | |
| 1051 | ### Example |
| 1052 | |
skia-bookmaker | b95bbba | 2018-07-06 05:23:23 +0000 | [diff] [blame] | 1053 | <div><fiddle-embed name="c2ff148374d01cbef845b223e725905c"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1054 | |
| 1055 | #### Example Output |
| 1056 | |
| 1057 | ~~~~ |
| 1058 | paint1 == paint2 |
| 1059 | ~~~~ |
| 1060 | |
| 1061 | </fiddle-embed></div> |
| 1062 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1063 | <a name='Dither'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1064 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1065 | --- |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 1066 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1067 | <a href='#Dither'>Dither</a> increases fidelity by adjusting the color of adjacent pixels. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1068 | This can help to smooth color transitions and reducing banding in gradients. |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1069 | Dithering lessens visible banding from <a href='SkImageInfo_Reference#kRGB_565_SkColorType'>kRGB_565_SkColorType</a> |
| 1070 | and <a href='SkImageInfo_Reference#kRGBA_8888_SkColorType'>kRGBA_8888_SkColorType</a> gradients, |
| 1071 | 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] | 1072 | |
| 1073 | Dithering is always enabled for linear gradients drawing into |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1074 | <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>. |
| 1075 | <a href='#Dither'>Dither</a> cannot be enabled for <a href='SkImageInfo_Reference#kAlpha_8_SkColorType'>kAlpha_8_SkColorType</a> <a href='SkSurface_Reference#Surface'>Surface</a> and |
| 1076 | <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] | 1077 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1078 | <a href='#Dither'>Dither</a> is disabled by default. |
| 1079 | <a href='#Dither'>Dither</a> can be enabled by default by setting <a href='undocumented#SkPaintDefaults_Flags'>SkPaintDefaults Flags</a> to <a href='#SkPaint_kDither_Flag'>kDither Flag</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1080 | at compile time. |
| 1081 | |
Cary Clark | 2be81cf | 2018-09-13 12:04:30 -0400 | [diff] [blame] | 1082 | Some platform implementations may ignore dithering. Set <code>SK_IGNORE_GPU_DITHER</code>to ignore <a href='#Dither'>Dither</a> on <a href='undocumented#GPU_Surface'>GPU Surface</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1083 | |
| 1084 | ### Example |
| 1085 | |
skia-bookmaker | 44bad2e | 2018-07-05 05:35:27 +0000 | [diff] [blame] | 1086 | <div><fiddle-embed name="8b26507690b71462f44642b911890bbf"><div>Dithering in the bottom half more closely approximates the requested color by |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 1087 | alternating nearby colors from pixel to pixel. |
| 1088 | </div></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1089 | |
| 1090 | ### Example |
| 1091 | |
Cary Clark | a619d45 | 2018-07-16 08:12:01 -0400 | [diff] [blame] | 1092 | <div><fiddle-embed name="76d4d4a7931a48495e4d5f54e073be53"><div>Dithering introduces subtle adjustments to color to smooth gradients. |
Cary Clark | 224c700 | 2018-06-27 11:00:21 -0400 | [diff] [blame] | 1093 | Drawing the gradient repeatedly with <a href='SkBlendMode_Reference#SkBlendMode_kPlus'>SkBlendMode::kPlus</a> exaggerates the |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 1094 | dither, making it easier to see. |
| 1095 | </div></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1096 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1097 | ### See Also |
| 1098 | |
| 1099 | Gradient <a href='SkImageInfo_Reference#kRGB_565_SkColorType'>kRGB_565_SkColorType</a> |
| 1100 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1101 | <a name='SkPaint_isDither'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1102 | |
| 1103 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1104 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1105 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 1106 | bool <a href='#SkPaint_isDither'>isDither</a>() const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1107 | </pre> |
| 1108 | |
Cary Clark | 80247e5 | 2018-07-11 16:18:41 -0400 | [diff] [blame] | 1109 | Returns true if color error may be distributed to smooth color transition. |
skia-bookmaker | 525f9a9 | 2018-05-03 06:27:39 +0000 | [diff] [blame] | 1110 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1111 | 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] | 1112 | |
| 1113 | ### Return Value |
| 1114 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1115 | <a href='#SkPaint_kDither_Flag'>kDither Flag</a> state |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1116 | |
| 1117 | ### Example |
| 1118 | |
| 1119 | <div><fiddle-embed name="f4ce93f6c5e7335436a985377fd980c0"> |
| 1120 | |
| 1121 | #### Example Output |
| 1122 | |
| 1123 | ~~~~ |
| 1124 | paint.isDither() == !!(paint.getFlags() & SkPaint::kDither_Flag) |
| 1125 | paint.isDither() == !!(paint.getFlags() & SkPaint::kDither_Flag) |
| 1126 | ~~~~ |
| 1127 | |
| 1128 | </fiddle-embed></div> |
| 1129 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1130 | <a name='SkPaint_setDither'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1131 | |
| 1132 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1133 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1134 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 1135 | void <a href='#SkPaint_setDither'>setDither</a>(bool dither) |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1136 | </pre> |
| 1137 | |
| 1138 | Requests, but does not require, to distribute color error. |
| 1139 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1140 | Sets <a href='#SkPaint_kDither_Flag'>kDither Flag</a> if <a href='#SkPaint_setDither_dither'>dither</a> is true. |
| 1141 | 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] | 1142 | |
| 1143 | ### Parameters |
| 1144 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1145 | <table> <tr> <td><a name='SkPaint_setDither_dither'><code><strong>dither</strong></code></a></td> |
| 1146 | <td>setting for <a href='#SkPaint_kDither_Flag'>kDither Flag</a></td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1147 | </tr> |
| 1148 | </table> |
| 1149 | |
| 1150 | ### Example |
| 1151 | |
| 1152 | <div><fiddle-embed name="69b7162e8324d9239dd02dd9ada2bdff"> |
| 1153 | |
| 1154 | #### Example Output |
| 1155 | |
| 1156 | ~~~~ |
| 1157 | paint1 == paint2 |
| 1158 | ~~~~ |
| 1159 | |
| 1160 | </fiddle-embed></div> |
| 1161 | |
| 1162 | ### See Also |
| 1163 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1164 | <a href='SkImageInfo_Reference#kRGB_565_SkColorType'>kRGB_565_SkColorType</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1165 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1166 | <a name='Device_Text'></a> |
| 1167 | |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1168 | --- |
| 1169 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1170 | <a href='#LCD_Text'>LCD Text</a> and <a href='#Subpixel_Text'>Subpixel Text</a> increase the precision of glyph position. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1171 | |
Cary Clark | ffb3d68 | 2018-05-17 12:17:28 -0400 | [diff] [blame] | 1172 | 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 |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1173 | create a color, and relies |
Cary Clark | ce10124 | 2017-09-01 15:51:02 -0400 | [diff] [blame] | 1174 | on the small size of the stripe and visual perception to make the color fringing imperceptible. |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1175 | <a href='#LCD_Text'>LCD Text</a> can be enabled on devices that orient stripes horizontally or vertically, and that order |
Cary Clark | ffb3d68 | 2018-05-17 12:17:28 -0400 | [diff] [blame] | 1176 | the color components as RGB or BGR. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1177 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1178 | <a href='#SkPaint_Flags'>Flags</a> <a href='#SkPaint_kSubpixelText_Flag'>kSubpixelText Flag</a> uses the pixel transparency to represent a fractional offset. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1179 | As the opaqueness |
| 1180 | of the color increases, the edge of the glyph appears to move towards the outside of the pixel. |
| 1181 | |
| 1182 | Either or both techniques can be enabled. |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1183 | <a href='#SkPaint_kLCDRenderText_Flag'>kLCDRenderText Flag</a> and <a href='#SkPaint_kSubpixelText_Flag'>kSubpixelText Flag</a> are clear by default. |
| 1184 | <a href='#LCD_Text'>LCD Text</a> or <a href='#Subpixel_Text'>Subpixel Text</a> can be enabled by default by setting <a href='undocumented#SkPaintDefaults_Flags'>SkPaintDefaults Flags</a> to |
| 1185 | <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] | 1186 | |
| 1187 | ### Example |
| 1188 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1189 | <div><fiddle-embed name="4606ae1be792d6bc46d496432f050ee9"><div>Four commas are drawn normally and with combinations of <a href='#LCD_Text'>LCD Text</a> and <a href='#Subpixel_Text'>Subpixel Text</a>. |
| 1190 | When <a href='#Subpixel_Text'>Subpixel Text</a> is disabled, the comma <a href='undocumented#Glyph'>Glyphs</a> are identical, but not evenly spaced. |
| 1191 | When <a href='#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] | 1192 | </div></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1193 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1194 | <a name='Linear_Text'></a> |
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 | <a href='#Linear_Text'>Linear Text</a> selects whether text is rendered as a <a href='undocumented#Glyph'>Glyph</a> or as a <a href='SkPath_Reference#Path'>Path</a>. |
| 1197 | If <a href='#SkPaint_kLinearText_Flag'>kLinearText Flag</a> is set, it has the same effect as setting <a href='#SkPaint_Hinting'>Hinting</a> to <a href='#SkPaint_kNormal_Hinting'>kNormal Hinting</a>. |
| 1198 | If <a href='#SkPaint_kLinearText_Flag'>kLinearText Flag</a> is clear, it is the same as setting <a href='#SkPaint_Hinting'>Hinting</a> to <a href='#SkPaint_kNo_Hinting'>kNo Hinting</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1199 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1200 | <a name='SkPaint_isLinearText'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1201 | |
| 1202 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1203 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1204 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 1205 | bool <a href='#SkPaint_isLinearText'>isLinearText</a>() const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1206 | </pre> |
| 1207 | |
Cary Clark | 80247e5 | 2018-07-11 16:18:41 -0400 | [diff] [blame] | 1208 | Returns true if text is converted to <a href='SkPath_Reference#Path'>Path</a> before drawing and measuring. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1209 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1210 | 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] | 1211 | |
| 1212 | ### Return Value |
| 1213 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1214 | <a href='#SkPaint_kLinearText_Flag'>kLinearText Flag</a> state |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1215 | |
| 1216 | ### Example |
| 1217 | |
| 1218 | <div><fiddle-embed name="2890ad644f980637837e6fcb386fb462"></fiddle-embed></div> |
| 1219 | |
| 1220 | ### See Also |
| 1221 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1222 | <a href='#SkPaint_setLinearText'>setLinearText</a> <a href='#SkPaint_Hinting'>Hinting</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1223 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1224 | <a name='SkPaint_setLinearText'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1225 | |
| 1226 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1227 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1228 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 1229 | void <a href='#SkPaint_setLinearText'>setLinearText</a>(bool linearText) |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1230 | </pre> |
| 1231 | |
Cary Clark | 80247e5 | 2018-07-11 16:18:41 -0400 | [diff] [blame] | 1232 | Returns true if text is converted to <a href='SkPath_Reference#Path'>Path</a> before drawing and measuring. |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1233 | By default, <a href='#SkPaint_kLinearText_Flag'>kLinearText Flag</a> is clear. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1234 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1235 | Sets <a href='#SkPaint_kLinearText_Flag'>kLinearText Flag</a> if <a href='#SkPaint_setLinearText_linearText'>linearText</a> is true. |
| 1236 | 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] | 1237 | |
| 1238 | ### Parameters |
| 1239 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1240 | <table> <tr> <td><a name='SkPaint_setLinearText_linearText'><code><strong>linearText</strong></code></a></td> |
| 1241 | <td>setting for <a href='#SkPaint_kLinearText_Flag'>kLinearText Flag</a></td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1242 | </tr> |
| 1243 | </table> |
| 1244 | |
| 1245 | ### Example |
| 1246 | |
Cary Clark | 8364706 | 2018-07-18 16:21:51 -0400 | [diff] [blame] | 1247 | <div><fiddle-embed name="c93bb912f3bddfb4d96d3ad70ada552b"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1248 | |
| 1249 | ### See Also |
| 1250 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1251 | <a href='#SkPaint_isLinearText'>isLinearText</a> <a href='#SkPaint_Hinting'>Hinting</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1252 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1253 | <a name='Subpixel_Text'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1254 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1255 | <a href='#SkPaint_Flags'>Flags</a> <a href='#SkPaint_kSubpixelText_Flag'>kSubpixelText Flag</a> uses the pixel transparency to represent a fractional offset. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1256 | As the opaqueness |
| 1257 | of the color increases, the edge of the glyph appears to move towards the outside of the pixel. |
| 1258 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1259 | <a name='SkPaint_isSubpixelText'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1260 | |
| 1261 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1262 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1263 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 1264 | bool <a href='#SkPaint_isSubpixelText'>isSubpixelText</a>() const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1265 | </pre> |
| 1266 | |
Cary Clark | 80247e5 | 2018-07-11 16:18:41 -0400 | [diff] [blame] | 1267 | Returns true if <a href='undocumented#Glyph'>Glyphs</a> at different sub-pixel positions may differ on pixel edge coverage. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1268 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1269 | 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] | 1270 | |
| 1271 | ### Return Value |
| 1272 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1273 | <a href='#SkPaint_kSubpixelText_Flag'>kSubpixelText Flag</a> state |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1274 | |
| 1275 | ### Example |
| 1276 | |
| 1277 | <div><fiddle-embed name="abe9afc0932e2199324ae6cbb396e67c"> |
| 1278 | |
| 1279 | #### Example Output |
| 1280 | |
| 1281 | ~~~~ |
| 1282 | paint.isSubpixelText() == !!(paint.getFlags() & SkPaint::kSubpixelText_Flag) |
| 1283 | paint.isSubpixelText() == !!(paint.getFlags() & SkPaint::kSubpixelText_Flag) |
| 1284 | ~~~~ |
| 1285 | |
| 1286 | </fiddle-embed></div> |
| 1287 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1288 | <a name='SkPaint_setSubpixelText'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1289 | |
| 1290 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1291 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1292 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 1293 | void <a href='#SkPaint_setSubpixelText'>setSubpixelText</a>(bool subpixelText) |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1294 | </pre> |
| 1295 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1296 | 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] | 1297 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1298 | Sets <a href='#SkPaint_kSubpixelText_Flag'>kSubpixelText Flag</a> if <a href='#SkPaint_setSubpixelText_subpixelText'>subpixelText</a> is true. |
| 1299 | 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] | 1300 | |
| 1301 | ### Parameters |
| 1302 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1303 | <table> <tr> <td><a name='SkPaint_setSubpixelText_subpixelText'><code><strong>subpixelText</strong></code></a></td> |
| 1304 | <td>setting for <a href='#SkPaint_kSubpixelText_Flag'>kSubpixelText Flag</a></td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1305 | </tr> |
| 1306 | </table> |
| 1307 | |
| 1308 | ### Example |
| 1309 | |
| 1310 | <div><fiddle-embed name="a77bbc1a4e3be9a8ab0f842f877c5ee4"> |
| 1311 | |
| 1312 | #### Example Output |
| 1313 | |
| 1314 | ~~~~ |
| 1315 | paint1 == paint2 |
| 1316 | ~~~~ |
| 1317 | |
| 1318 | </fiddle-embed></div> |
| 1319 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1320 | <a name='LCD_Text'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1321 | |
Cary Clark | ffb3d68 | 2018-05-17 12:17:28 -0400 | [diff] [blame] | 1322 | 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 |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1323 | create a color, and relies |
Cary Clark | ce10124 | 2017-09-01 15:51:02 -0400 | [diff] [blame] | 1324 | on the small size of the stripe and visual perception to make the color fringing imperceptible. |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1325 | <a href='#LCD_Text'>LCD Text</a> can be enabled on devices that orient stripes horizontally or vertically, and that order |
Cary Clark | ffb3d68 | 2018-05-17 12:17:28 -0400 | [diff] [blame] | 1326 | the color components as RGB or BGR. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1327 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1328 | <a name='SkPaint_isLCDRenderText'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1329 | |
| 1330 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1331 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1332 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 1333 | bool <a href='#SkPaint_isLCDRenderText'>isLCDRenderText</a>() const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1334 | </pre> |
| 1335 | |
Cary Clark | 80247e5 | 2018-07-11 16:18:41 -0400 | [diff] [blame] | 1336 | Returns true if <a href='undocumented#Glyph'>Glyphs</a> may use LCD striping to improve glyph edges. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1337 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1338 | Returns true if <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] | 1339 | |
| 1340 | ### Return Value |
| 1341 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1342 | <a href='#SkPaint_kLCDRenderText_Flag'>kLCDRenderText Flag</a> state |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1343 | |
| 1344 | ### Example |
| 1345 | |
skia-bookmaker | a391c72 | 2018-07-09 05:28:19 +0000 | [diff] [blame] | 1346 | <div><fiddle-embed name="68e1fd95dd2fd06a333899d2bd2396b9"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1347 | |
| 1348 | #### Example Output |
| 1349 | |
| 1350 | ~~~~ |
| 1351 | paint.isLCDRenderText() == !!(paint.getFlags() & SkPaint::kLCDRenderText_Flag) |
| 1352 | paint.isLCDRenderText() == !!(paint.getFlags() & SkPaint::kLCDRenderText_Flag) |
| 1353 | ~~~~ |
| 1354 | |
| 1355 | </fiddle-embed></div> |
| 1356 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1357 | <a name='SkPaint_setLCDRenderText'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1358 | |
| 1359 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1360 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1361 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 1362 | void <a href='#SkPaint_setLCDRenderText'>setLCDRenderText</a>(bool lcdText) |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1363 | </pre> |
| 1364 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1365 | Requests, but does not require, that <a href='undocumented#Glyph'>Glyphs</a> use LCD striping for glyph edges. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1366 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1367 | Sets <a href='#SkPaint_kLCDRenderText_Flag'>kLCDRenderText Flag</a> if <a href='#SkPaint_setLCDRenderText_lcdText'>lcdText</a> is true. |
| 1368 | 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] | 1369 | |
| 1370 | ### Parameters |
| 1371 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1372 | <table> <tr> <td><a name='SkPaint_setLCDRenderText_lcdText'><code><strong>lcdText</strong></code></a></td> |
| 1373 | <td>setting for <a href='#SkPaint_kLCDRenderText_Flag'>kLCDRenderText Flag</a></td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1374 | </tr> |
| 1375 | </table> |
| 1376 | |
| 1377 | ### Example |
| 1378 | |
skia-bookmaker | e0a458f | 2018-07-16 05:29:00 +0000 | [diff] [blame] | 1379 | <div><fiddle-embed name="50dedf8450159571a3edaf4f0050defe"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1380 | |
| 1381 | #### Example Output |
| 1382 | |
| 1383 | ~~~~ |
| 1384 | paint1 == paint2 |
| 1385 | ~~~~ |
| 1386 | |
| 1387 | </fiddle-embed></div> |
| 1388 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1389 | <a name='Font_Embedded_Bitmaps'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1390 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1391 | --- |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 1392 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1393 | <a href='#Font_Embedded_Bitmaps'>Font Embedded Bitmaps</a> allows selecting custom sized bitmap <a href='undocumented#Glyph'>Glyphs</a>. |
| 1394 | <a href='#SkPaint_Flags'>Flags</a> <a href='#SkPaint_kEmbeddedBitmapText_Flag'>kEmbeddedBitmapText Flag</a> when set chooses an embedded bitmap glyph over an outline contained |
Cary Clark | 7cfcbca | 2018-01-04 16:11:51 -0500 | [diff] [blame] | 1395 | in a font if the platform supports this option. |
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 | FreeType selects the bitmap glyph if available when <a href='#SkPaint_kEmbeddedBitmapText_Flag'>kEmbeddedBitmapText Flag</a> is set, and selects |
| 1398 | the outline glyph if <a href='#SkPaint_kEmbeddedBitmapText_Flag'>kEmbeddedBitmapText Flag</a> is clear. |
Cary Clark | 7cfcbca | 2018-01-04 16:11:51 -0500 | [diff] [blame] | 1399 | Windows may select the bitmap glyph but is not required to do so. |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1400 | <a href='undocumented#OS_X'>OS X</a> and iOS do not support this option. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1401 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1402 | <a href='#Font_Embedded_Bitmaps'>Font Embedded Bitmaps</a> is disabled by default. |
| 1403 | <a href='#Font_Embedded_Bitmaps'>Font Embedded Bitmaps</a> can be enabled by default by setting <a href='undocumented#SkPaintDefaults_Flags'>SkPaintDefaults Flags</a> to |
| 1404 | <a href='#SkPaint_kEmbeddedBitmapText_Flag'>kEmbeddedBitmapText Flag</a> at compile time. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1405 | |
| 1406 | ### Example |
| 1407 | |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 1408 | <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] | 1409 | <div>The "hintgasp" TrueType font in the Skia resources/fonts directory |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 1410 | includes an embedded bitmap Glyph at odd font sizes. This example works |
| 1411 | on platforms that use FreeType as their Font_Engine. |
| 1412 | Windows may, but is not required to, return a bitmap glyph if |
| 1413 | kEmbeddedBitmapText_Flag is set.</div>SkBitmap bitmap; |
| 1414 | bitmap.allocN32Pixels(30, 15); |
| 1415 | bitmap.eraseColor(0); |
| 1416 | SkCanvas offscreen(bitmap); |
| 1417 | SkPaint paint; |
| 1418 | paint.setAntiAlias(true); |
| 1419 | paint.setTextSize(13); |
Hal Canary | 53e5e7d | 2017-12-08 14:25:14 -0500 | [diff] [blame] | 1420 | paint.setTypeface(MakeResourceAsTypeface("fonts/hintgasp.ttf")); |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 1421 | for (bool embedded : { false, true}) { |
| 1422 | paint.setEmbeddedBitmapText(embedded); |
| 1423 | offscreen.drawString("A", embedded ? 5 : 15, 15, paint); |
| 1424 | } |
| 1425 | canvas->drawBitmap(bitmap, 0, 0); |
| 1426 | canvas->scale(10, 10); |
| 1427 | canvas->drawBitmap(bitmap, -2, 1); |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 1428 | |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 1429 | </pre> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1430 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1431 | <a name='SkPaint_isEmbeddedBitmapText'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1432 | |
| 1433 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1434 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1435 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 1436 | bool <a href='#SkPaint_isEmbeddedBitmapText'>isEmbeddedBitmapText</a>() const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1437 | </pre> |
| 1438 | |
Cary Clark | 80247e5 | 2018-07-11 16:18:41 -0400 | [diff] [blame] | 1439 | Returns true if <a href='undocumented#Engine'>Font Engine</a> may return <a href='undocumented#Glyph'>Glyphs</a> from font bitmaps instead of from outlines. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1440 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1441 | 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] | 1442 | |
| 1443 | ### Return Value |
| 1444 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1445 | <a href='#SkPaint_kEmbeddedBitmapText_Flag'>kEmbeddedBitmapText Flag</a> state |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1446 | |
| 1447 | ### Example |
| 1448 | |
| 1449 | <div><fiddle-embed name="eba10b27b790e87183ae451b3fc5c4b1"> |
| 1450 | |
| 1451 | #### Example Output |
| 1452 | |
| 1453 | ~~~~ |
| 1454 | paint.isEmbeddedBitmapText() == !!(paint.getFlags() & SkPaint::kEmbeddedBitmapText_Flag) |
| 1455 | paint.isEmbeddedBitmapText() == !!(paint.getFlags() & SkPaint::kEmbeddedBitmapText_Flag) |
| 1456 | ~~~~ |
| 1457 | |
| 1458 | </fiddle-embed></div> |
| 1459 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1460 | <a name='SkPaint_setEmbeddedBitmapText'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1461 | |
| 1462 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1463 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1464 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 1465 | void <a href='#SkPaint_setEmbeddedBitmapText'>setEmbeddedBitmapText</a>(bool useEmbeddedBitmapText) |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1466 | </pre> |
| 1467 | |
| 1468 | Requests, but does not require, to use bitmaps in fonts instead of outlines. |
| 1469 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1470 | Sets <a href='#SkPaint_kEmbeddedBitmapText_Flag'>kEmbeddedBitmapText Flag</a> if <a href='#SkPaint_setEmbeddedBitmapText_useEmbeddedBitmapText'>useEmbeddedBitmapText</a> is true. |
| 1471 | 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] | 1472 | |
| 1473 | ### Parameters |
| 1474 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1475 | <table> <tr> <td><a name='SkPaint_setEmbeddedBitmapText_useEmbeddedBitmapText'><code><strong>useEmbeddedBitmapText</strong></code></a></td> |
| 1476 | <td>setting for <a href='#SkPaint_kEmbeddedBitmapText_Flag'>kEmbeddedBitmapText Flag</a></td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1477 | </tr> |
| 1478 | </table> |
| 1479 | |
| 1480 | ### Example |
| 1481 | |
| 1482 | <div><fiddle-embed name="246dffdd93a484ba4ad7ecf71198a5d4"> |
| 1483 | |
| 1484 | #### Example Output |
| 1485 | |
| 1486 | ~~~~ |
| 1487 | paint1 == paint2 |
| 1488 | ~~~~ |
| 1489 | |
| 1490 | </fiddle-embed></div> |
| 1491 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1492 | <a name='Automatic_Hinting'></a> |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 1493 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1494 | If <a href='#SkPaint_Hinting'>Hinting</a> is set to <a href='#SkPaint_kNormal_Hinting'>kNormal Hinting</a> or <a href='#SkPaint_kFull_Hinting'>kFull Hinting</a>, <a href='#Automatic_Hinting'>Automatic Hinting</a> |
| 1495 | instructs the <a href='undocumented#Font_Manager'>Font Manager</a> to always hint <a href='undocumented#Glyph'>Glyphs</a>. |
| 1496 | <a href='#Automatic_Hinting'>Automatic Hinting</a> has no effect if <a href='#SkPaint_Hinting'>Hinting</a> is set to <a href='#SkPaint_kNo_Hinting'>kNo Hinting</a> or |
| 1497 | <a href='#SkPaint_kSlight_Hinting'>kSlight Hinting</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1498 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1499 | <a href='#Automatic_Hinting'>Automatic Hinting</a> 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] | 1500 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1501 | <a name='SkPaint_isAutohinted'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1502 | |
| 1503 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1504 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1505 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 1506 | bool <a href='#SkPaint_isAutohinted'>isAutohinted</a>() const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1507 | </pre> |
| 1508 | |
Cary Clark | 80247e5 | 2018-07-11 16:18:41 -0400 | [diff] [blame] | 1509 | Returns true if <a href='#SkPaint_Hinting'>Hinting</a> is set to <a href='#SkPaint_kNormal_Hinting'>kNormal Hinting</a> or <a href='#SkPaint_kFull_Hinting'>kFull Hinting</a>, and if |
| 1510 | platform uses FreeType as the <a href='undocumented#Font_Manager'>Font Manager</a>. If true, instructs |
| 1511 | the <a href='undocumented#Font_Manager'>Font Manager</a> to always hint <a href='undocumented#Glyph'>Glyphs</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1512 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1513 | 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] | 1514 | |
| 1515 | ### Return Value |
| 1516 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1517 | <a href='#SkPaint_kAutoHinting_Flag'>kAutoHinting Flag</a> state |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1518 | |
| 1519 | ### Example |
| 1520 | |
| 1521 | <div><fiddle-embed name="aa4781afbe3b90e7ef56a287e5b9ce1e"> |
| 1522 | |
| 1523 | #### Example Output |
| 1524 | |
| 1525 | ~~~~ |
| 1526 | paint.isAutohinted() == !!(paint.getFlags() & SkPaint::kAutoHinting_Flag) |
| 1527 | paint.isAutohinted() == !!(paint.getFlags() & SkPaint::kAutoHinting_Flag) |
| 1528 | ~~~~ |
| 1529 | |
| 1530 | </fiddle-embed></div> |
| 1531 | |
| 1532 | ### See Also |
| 1533 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1534 | <a href='#SkPaint_setAutohinted'>setAutohinted</a> <a href='#SkPaint_Hinting'>Hinting</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1535 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1536 | <a name='SkPaint_setAutohinted'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1537 | |
| 1538 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1539 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1540 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 1541 | void <a href='#SkPaint_setAutohinted'>setAutohinted</a>(bool useAutohinter) |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1542 | </pre> |
| 1543 | |
Cary Clark | 80247e5 | 2018-07-11 16:18:41 -0400 | [diff] [blame] | 1544 | Sets whether to always hint <a href='undocumented#Glyph'>Glyphs</a>. |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1545 | If <a href='#SkPaint_Hinting'>Hinting</a> is set to <a href='#SkPaint_kNormal_Hinting'>kNormal Hinting</a> or <a href='#SkPaint_kFull_Hinting'>kFull Hinting</a> and <a href='#SkPaint_setAutohinted_useAutohinter'>useAutohinter</a> is set, |
Cary Clark | 80247e5 | 2018-07-11 16:18:41 -0400 | [diff] [blame] | 1546 | instructs the <a href='undocumented#Font_Manager'>Font Manager</a> to always hint <a href='undocumented#Glyph'>Glyphs</a>. |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1547 | <a href='#Automatic_Hinting'>Automatic Hinting</a> has no effect if <a href='#SkPaint_Hinting'>Hinting</a> is set to <a href='#SkPaint_kNo_Hinting'>kNo Hinting</a> or |
| 1548 | <a href='#SkPaint_kSlight_Hinting'>kSlight Hinting</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1549 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1550 | 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] | 1551 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1552 | Sets <a href='#SkPaint_kAutoHinting_Flag'>kAutoHinting Flag</a> if <a href='#SkPaint_setAutohinted_useAutohinter'>useAutohinter</a> is true. |
| 1553 | 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] | 1554 | |
| 1555 | ### Parameters |
| 1556 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1557 | <table> <tr> <td><a name='SkPaint_setAutohinted_useAutohinter'><code><strong>useAutohinter</strong></code></a></td> |
| 1558 | <td>setting for <a href='#SkPaint_kAutoHinting_Flag'>kAutoHinting Flag</a></td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1559 | </tr> |
| 1560 | </table> |
| 1561 | |
| 1562 | ### Example |
| 1563 | |
| 1564 | <div><fiddle-embed name="4e185306d7de9390fe8445eed0139309"></fiddle-embed></div> |
| 1565 | |
| 1566 | ### See Also |
| 1567 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1568 | <a href='#SkPaint_isAutohinted'>isAutohinted</a> <a href='#SkPaint_Hinting'>Hinting</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1569 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1570 | <a name='Fake_Bold'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1571 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1572 | --- |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 1573 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1574 | <a href='#Fake_Bold'>Fake Bold</a> approximates the bold font style accompanying a normal font when a bold font face |
Cary Clark | 7cfcbca | 2018-01-04 16:11:51 -0500 | [diff] [blame] | 1575 | is not available. Skia does not provide font substitution; it is up to the client to find the |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1576 | bold font face using the platform <a href='undocumented#Font_Manager'>Font Manager</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1577 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1578 | Use <a href='#Text_Skew_X'>Text Skew X</a> to approximate an italic font style when the italic font face |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1579 | is not available. |
| 1580 | |
Cary Clark | 7cfcbca | 2018-01-04 16:11:51 -0500 | [diff] [blame] | 1581 | A FreeType based port may define SK_USE_FREETYPE_EMBOLDEN at compile time to direct |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1582 | the font engine to create the bold <a href='undocumented#Glyph'>Glyphs</a>. Otherwise, the extra bold is computed |
| 1583 | by increasing the stroke width and setting the <a href='#SkPaint_Style'>Style</a> to <a href='#SkPaint_kStrokeAndFill_Style'>kStrokeAndFill Style</a> as needed. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1584 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1585 | <a href='#Fake_Bold'>Fake Bold</a> is disabled by default. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1586 | |
| 1587 | ### Example |
| 1588 | |
| 1589 | <div><fiddle-embed name="e811f4829a2daaaeaad3795504a7e02a"></fiddle-embed></div> |
| 1590 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1591 | <a name='SkPaint_isFakeBoldText'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1592 | |
| 1593 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1594 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1595 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 1596 | bool <a href='#SkPaint_isFakeBoldText'>isFakeBoldText</a>() const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1597 | </pre> |
| 1598 | |
Cary Clark | 80247e5 | 2018-07-11 16:18:41 -0400 | [diff] [blame] | 1599 | Returns true if approximate bold by increasing the stroke width when creating glyph bitmaps |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1600 | from outlines. |
| 1601 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1602 | 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] | 1603 | |
| 1604 | ### Return Value |
| 1605 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1606 | <a href='#SkPaint_kFakeBoldText_Flag'>kFakeBoldText Flag</a> state |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1607 | |
| 1608 | ### Example |
| 1609 | |
| 1610 | <div><fiddle-embed name="f54d1f85b16073b80b9eef2e1a1d151d"> |
| 1611 | |
| 1612 | #### Example Output |
| 1613 | |
| 1614 | ~~~~ |
| 1615 | paint.isFakeBoldText() == !!(paint.getFlags() & SkPaint::kFakeBoldText_Flag) |
| 1616 | paint.isFakeBoldText() == !!(paint.getFlags() & SkPaint::kFakeBoldText_Flag) |
| 1617 | ~~~~ |
| 1618 | |
| 1619 | </fiddle-embed></div> |
| 1620 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1621 | <a name='SkPaint_setFakeBoldText'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1622 | |
| 1623 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1624 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1625 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 1626 | void <a href='#SkPaint_setFakeBoldText'>setFakeBoldText</a>(bool fakeBoldText) |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1627 | </pre> |
| 1628 | |
Cary Clark | 80247e5 | 2018-07-11 16:18:41 -0400 | [diff] [blame] | 1629 | Increases stroke width when creating glyph bitmaps to approximate a bold typeface. |
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 | Sets <a href='#SkPaint_kFakeBoldText_Flag'>kFakeBoldText Flag</a> if <a href='#SkPaint_setFakeBoldText_fakeBoldText'>fakeBoldText</a> is true. |
| 1632 | 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] | 1633 | |
| 1634 | ### Parameters |
| 1635 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1636 | <table> <tr> <td><a name='SkPaint_setFakeBoldText_fakeBoldText'><code><strong>fakeBoldText</strong></code></a></td> |
| 1637 | <td>setting for <a href='#SkPaint_kFakeBoldText_Flag'>kFakeBoldText Flag</a></td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1638 | </tr> |
| 1639 | </table> |
| 1640 | |
| 1641 | ### Example |
| 1642 | |
| 1643 | <div><fiddle-embed name="594d47858eb11028cb626515a520910a"> |
| 1644 | |
| 1645 | #### Example Output |
| 1646 | |
| 1647 | ~~~~ |
| 1648 | paint1 == paint2 |
| 1649 | ~~~~ |
| 1650 | |
| 1651 | </fiddle-embed></div> |
| 1652 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1653 | <a name='Full_Hinting_Spacing'></a> |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 1654 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1655 | if <a href='#SkPaint_Hinting'>Hinting</a> is set to <a href='#SkPaint_kFull_Hinting'>kFull Hinting</a>, <a href='#Full_Hinting_Spacing'>Full Hinting Spacing</a> adjusts the character |
Cary Clark | 137b874 | 2018-05-30 09:21:49 -0400 | [diff] [blame] | 1656 | spacing by the difference of the hinted and <a href='undocumented#Unhinted'>Unhinted</a> <a href='undocumented#Left_Side_Bearing'>Left Side Bearing</a> and |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1657 | <a href='undocumented#Right_Side_Bearing'>Right Side Bearing</a>. <a href='#Full_Hinting_Spacing'>Full Hinting Spacing</a> only applies to platforms that use |
| 1658 | FreeType as their <a href='undocumented#Engine'>Font Engine</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1659 | |
Cary Clark | 137b874 | 2018-05-30 09:21:49 -0400 | [diff] [blame] | 1660 | <a href='#Full_Hinting_Spacing'>Full Hinting Spacing</a> is not related to text <a href='undocumented#Kerning'>Kerning</a>, where the space between |
| 1661 | a specific pair of characters is adjusted using data in the font <a href='undocumented#Kerning'>Kerning</a> tables. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1662 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1663 | <a name='SkPaint_isDevKernText'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1664 | |
| 1665 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1666 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1667 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 1668 | bool <a href='#SkPaint_isDevKernText'>isDevKernText</a>() const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1669 | </pre> |
| 1670 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1671 | Deprecated. |
| 1672 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1673 | <a name='SkPaint_setDevKernText'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1674 | |
| 1675 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1676 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1677 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 1678 | void <a href='#SkPaint_setDevKernText'>setDevKernText</a>(bool) |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1679 | </pre> |
| 1680 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1681 | Deprecated. |
| 1682 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1683 | <a name='Filter_Quality_Methods'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1684 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1685 | --- |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 1686 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1687 | <a href='undocumented#Filter_Quality'>Filter Quality</a> trades speed for image filtering when the image is scaled. |
| 1688 | A lower <a href='undocumented#Filter_Quality'>Filter Quality</a> draws faster, but has less fidelity. |
| 1689 | A higher <a href='undocumented#Filter_Quality'>Filter Quality</a> draws slower, but looks better. |
| 1690 | If the image is drawn without scaling, the <a href='undocumented#Filter_Quality'>Filter Quality</a> choice will not result |
Cary Clark | ce10124 | 2017-09-01 15:51:02 -0400 | [diff] [blame] | 1691 | in a noticeable difference. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1692 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1693 | <a href='undocumented#Filter_Quality'>Filter Quality</a> is used in <a href='#Paint'>Paint</a> passed as a parameter to |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1694 | |
| 1695 | <table> <tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1696 | <td><a href='SkCanvas_Reference#SkCanvas_drawBitmap'>SkCanvas::drawBitmap</a></td> |
| 1697 | </tr> <tr> |
| 1698 | <td><a href='SkCanvas_Reference#SkCanvas_drawBitmapRect'>SkCanvas::drawBitmapRect</a></td> |
| 1699 | </tr> <tr> |
| 1700 | <td><a href='SkCanvas_Reference#SkCanvas_drawImage'>SkCanvas::drawImage</a></td> |
| 1701 | </tr> <tr> |
| 1702 | <td><a href='SkCanvas_Reference#SkCanvas_drawImageRect'>SkCanvas::drawImageRect</a></td> |
| 1703 | </tr> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1704 | </table> |
| 1705 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1706 | and when <a href='#Paint'>Paint</a> has a <a href='undocumented#Shader'>Shader</a> specialization that uses <a href='SkImage_Reference#Image'>Image</a> or <a href='SkBitmap_Reference#Bitmap'>Bitmap</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1707 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1708 | <a href='undocumented#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] | 1709 | |
| 1710 | ### Example |
| 1711 | |
skia-bookmaker | 525f9a9 | 2018-05-03 06:27:39 +0000 | [diff] [blame] | 1712 | <div><fiddle-embed name="69369cff2f5b145a6f616092513266a0"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1713 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1714 | <a name='SkPaint_getFilterQuality'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1715 | |
| 1716 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1717 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1718 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 1719 | <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] | 1720 | </pre> |
| 1721 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1722 | Returns <a href='undocumented#Filter_Quality'>Filter Quality</a>, the image filtering level. A lower setting |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1723 | draws faster; a higher setting looks better when the image is scaled. |
| 1724 | |
| 1725 | ### Return Value |
| 1726 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1727 | one of: <a href='undocumented#kNone_SkFilterQuality'>kNone_SkFilterQuality</a>, <a href='undocumented#kLow_SkFilterQuality'>kLow_SkFilterQuality</a>, |
| 1728 | <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] | 1729 | |
| 1730 | ### Example |
| 1731 | |
| 1732 | <div><fiddle-embed name="d4ca1f23809b6835c4ba46ea98a86900"> |
| 1733 | |
| 1734 | #### Example Output |
| 1735 | |
| 1736 | ~~~~ |
| 1737 | kNone_SkFilterQuality == paint.getFilterQuality() |
| 1738 | ~~~~ |
| 1739 | |
| 1740 | </fiddle-embed></div> |
| 1741 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1742 | <a name='SkPaint_setFilterQuality'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1743 | |
| 1744 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1745 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1746 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 1747 | 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] | 1748 | </pre> |
| 1749 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1750 | Sets <a href='undocumented#Filter_Quality'>Filter Quality</a>, the image filtering level. A lower setting |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1751 | draws faster; a higher setting looks better when the image is scaled. |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1752 | 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] | 1753 | |
| 1754 | ### Parameters |
| 1755 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1756 | <table> <tr> <td><a name='SkPaint_setFilterQuality_quality'><code><strong>quality</strong></code></a></td> |
| 1757 | <td>one of: <a href='undocumented#kNone_SkFilterQuality'>kNone_SkFilterQuality</a>, <a href='undocumented#kLow_SkFilterQuality'>kLow_SkFilterQuality</a>, |
| 1758 | <a href='undocumented#kMedium_SkFilterQuality'>kMedium_SkFilterQuality</a>, <a href='undocumented#kHigh_SkFilterQuality'>kHigh_SkFilterQuality</a></td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1759 | </tr> |
| 1760 | </table> |
| 1761 | |
| 1762 | ### Example |
| 1763 | |
| 1764 | <div><fiddle-embed name="e4288fabf24ee60b645e8bb6ea0afadf"> |
| 1765 | |
| 1766 | #### Example Output |
| 1767 | |
| 1768 | ~~~~ |
| 1769 | kHigh_SkFilterQuality == paint.getFilterQuality() |
| 1770 | ~~~~ |
| 1771 | |
| 1772 | </fiddle-embed></div> |
| 1773 | |
| 1774 | ### See Also |
| 1775 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1776 | <a href='undocumented#SkFilterQuality'>SkFilterQuality</a> <a href='undocumented#Image_Scaling'>Image Scaling</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1777 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1778 | <a name='Color_Methods'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1779 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1780 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1781 | |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 1782 | | name | description | |
| 1783 | | --- | --- | |
Cary Clark | ffb3d68 | 2018-05-17 12:17:28 -0400 | [diff] [blame] | 1784 | | <a href='#SkPaint_getColor'>getColor</a> | returns <a href='SkColor_Reference#Alpha'>Color Alpha</a> and RGB, one drawing color | |
| 1785 | | <a href='#SkPaint_setColor'>setColor</a> | sets <a href='SkColor_Reference#Alpha'>Color Alpha</a> and RGB, one drawing color | |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1786 | |
Cary Clark | ffb3d68 | 2018-05-17 12:17:28 -0400 | [diff] [blame] | 1787 | <a href='SkColor_Reference#Color'>Color</a> specifies the red, blue, green, and <a href='SkColor_Reference#Alpha'>Color Alpha</a> |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 1788 | values used to draw a filled or stroked shape in a 32-bit value. Each component |
| 1789 | occupies 8-bits, ranging from zero: no contribution; to 255: full intensity. |
| 1790 | All values in any combination are valid. |
| 1791 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1792 | <a href='SkColor_Reference#Color'>Color</a> is not <a href='undocumented#Premultiply'>Premultiplied</a>; <a href='SkColor_Reference#Alpha'>Color Alpha</a> sets the transparency independent of |
Cary Clark | ffb3d68 | 2018-05-17 12:17:28 -0400 | [diff] [blame] | 1793 | RGB: red, blue, and green. |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 1794 | |
Cary Clark | ffb3d68 | 2018-05-17 12:17:28 -0400 | [diff] [blame] | 1795 | The bit positions of <a href='SkColor_Reference#Alpha'>Color Alpha</a> and RGB are independent of the bit |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 1796 | positions on the output device, which may have more or fewer bits, and may have |
| 1797 | a different arrangement. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1798 | |
Cary Clark | ffb3d68 | 2018-05-17 12:17:28 -0400 | [diff] [blame] | 1799 | | bit positions | <a href='SkColor_Reference#Alpha'>Color Alpha</a> | red | blue | green | |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1800 | | --- | --- | --- | --- | --- | |
| 1801 | | | 31 - 24 | 23 - 16 | 15 - 8 | 7 - 0 | |
| 1802 | |
| 1803 | ### Example |
| 1804 | |
Ravi Mistry | 874e22b | 2018-07-19 03:49:13 +0000 | [diff] [blame] | 1805 | <div><fiddle-embed name="214b559d75c65a7bef6ef4be1f860053"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1806 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1807 | <a name='SkPaint_getColor'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1808 | |
| 1809 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1810 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1811 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 1812 | <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] | 1813 | </pre> |
| 1814 | |
Cary Clark | ffb3d68 | 2018-05-17 12:17:28 -0400 | [diff] [blame] | 1815 | Retrieves <a href='SkColor_Reference#Alpha'>Alpha</a> and RGB, <a href='undocumented#Unpremultiply'>Unpremultiplied</a>, packed into 32 bits. |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1816 | 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 |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1817 | a color component. |
| 1818 | |
| 1819 | ### Return Value |
| 1820 | |
Cary Clark | ffb3d68 | 2018-05-17 12:17:28 -0400 | [diff] [blame] | 1821 | <a href='undocumented#Unpremultiply'>Unpremultiplied</a> ARGB |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1822 | |
| 1823 | ### Example |
| 1824 | |
skia-bookmaker | 61cc9fa | 2018-07-11 05:28:17 +0000 | [diff] [blame] | 1825 | <div><fiddle-embed name="72d41f890203109a41f589a7403acae9"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1826 | |
| 1827 | #### Example Output |
| 1828 | |
| 1829 | ~~~~ |
| 1830 | Yellow is 100% red, 100% green, and 0% blue. |
| 1831 | ~~~~ |
| 1832 | |
| 1833 | </fiddle-embed></div> |
| 1834 | |
| 1835 | ### See Also |
| 1836 | |
Cary Clark | bbe8ff9 | 2018-09-05 11:39:01 -0400 | [diff] [blame] | 1837 | <a href='#SkPaint_getColor4f'>getColor4f</a> <a href='SkColor_Reference#SkColor'>SkColor</a> |
| 1838 | |
Cary Clark | bbe8ff9 | 2018-09-05 11:39:01 -0400 | [diff] [blame] | 1839 | <a name='SkPaint_getColor4f'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1840 | |
| 1841 | --- |
Cary Clark | bbe8ff9 | 2018-09-05 11:39:01 -0400 | [diff] [blame] | 1842 | |
| 1843 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 1844 | <a href='SkColor4f_Reference#SkColor4f'>SkColor4f</a> <a href='#SkPaint_getColor4f'>getColor4f</a>() const |
| 1845 | </pre> |
| 1846 | |
| 1847 | Retrieves alpha and RGB, unpmreultiplied, as four floating point values. RGB are |
| 1848 | are extended sRGB values (sRGB gamut, and encoded with the sRGB transfer function). |
| 1849 | |
| 1850 | ### Return Value |
| 1851 | |
| 1852 | <a href='undocumented#Unpremultiply'>Unpremultiplied</a> RGBA |
| 1853 | |
| 1854 | ### Example |
| 1855 | |
| 1856 | <div><fiddle-embed name="8512ea2176f36e8f1aeef311ff228790"> |
| 1857 | |
| 1858 | #### Example Output |
| 1859 | |
| 1860 | ~~~~ |
| 1861 | Yellow is 100% red, 100% green, and 0% blue. |
| 1862 | ~~~~ |
| 1863 | |
| 1864 | </fiddle-embed></div> |
| 1865 | |
| 1866 | ### See Also |
| 1867 | |
| 1868 | <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] | 1869 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1870 | <a name='SkPaint_setColor'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1871 | |
| 1872 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1873 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1874 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 1875 | void <a href='#SkPaint_setColor'>setColor</a>(<a href='SkColor_Reference#SkColor'>SkColor</a> color) |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1876 | </pre> |
| 1877 | |
Cary Clark | ffb3d68 | 2018-05-17 12:17:28 -0400 | [diff] [blame] | 1878 | 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, |
| 1879 | <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] | 1880 | |
| 1881 | ### Parameters |
| 1882 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1883 | <table> <tr> <td><a name='SkPaint_setColor_color'><code><strong>color</strong></code></a></td> |
Cary Clark | ffb3d68 | 2018-05-17 12:17:28 -0400 | [diff] [blame] | 1884 | <td><a href='undocumented#Unpremultiply'>Unpremultiplied</a> ARGB</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1885 | </tr> |
| 1886 | </table> |
| 1887 | |
| 1888 | ### Example |
| 1889 | |
skia-bookmaker | 233c652 | 2018-07-04 05:33:26 +0000 | [diff] [blame] | 1890 | <div><fiddle-embed name="6e70f18300bd676a3c056ceb6b62f8df"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1891 | |
| 1892 | #### Example Output |
| 1893 | |
| 1894 | ~~~~ |
| 1895 | green1 == green2 |
| 1896 | ~~~~ |
| 1897 | |
| 1898 | </fiddle-embed></div> |
| 1899 | |
| 1900 | ### See Also |
| 1901 | |
Cary Clark | bbe8ff9 | 2018-09-05 11:39:01 -0400 | [diff] [blame] | 1902 | <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> |
| 1903 | |
Cary Clark | bbe8ff9 | 2018-09-05 11:39:01 -0400 | [diff] [blame] | 1904 | <a name='SkPaint_setColor4f'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1905 | |
| 1906 | --- |
Cary Clark | bbe8ff9 | 2018-09-05 11:39:01 -0400 | [diff] [blame] | 1907 | |
| 1908 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 1909 | void <a href='#SkPaint_setColor4f'>setColor4f</a>(const <a href='SkColor4f_Reference#SkColor4f'>SkColor4f</a>& color, <a href='undocumented#SkColorSpace'>SkColorSpace</a>* colorSpace) |
| 1910 | </pre> |
| 1911 | |
| 1912 | Sets alpha and RGB used when stroking and filling. The <a href='#SkPaint_setColor4f_color'>color</a> is four floating |
| 1913 | point values, unpremultiplied. The <a href='#SkPaint_setColor4f_color'>color</a> values are interpreted as being in |
| 1914 | 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 |
| 1915 | sRGB <a href='#SkPaint_setColor4f_color'>color</a> space. |
| 1916 | |
| 1917 | ### Parameters |
| 1918 | |
| 1919 | <table> <tr> <td><a name='SkPaint_setColor4f_color'><code><strong>color</strong></code></a></td> |
| 1920 | <td><a href='undocumented#Unpremultiply'>Unpremultiplied</a> RGBA</td> |
| 1921 | </tr> |
| 1922 | <tr> <td><a name='SkPaint_setColor4f_colorSpace'><code><strong>colorSpace</strong></code></a></td> |
| 1923 | <td><a href='undocumented#Color_Space'>Color Space</a> describing the encoding of <a href='#SkPaint_setColor4f_color'>color</a></td> |
| 1924 | </tr> |
| 1925 | </table> |
| 1926 | |
| 1927 | ### Example |
| 1928 | |
| 1929 | <div><fiddle-embed name="fa60859e3d03bdc117a05b32e093a8f1"> |
| 1930 | |
| 1931 | #### Example Output |
| 1932 | |
| 1933 | ~~~~ |
| 1934 | green1 == green2 |
| 1935 | ~~~~ |
| 1936 | |
| 1937 | </fiddle-embed></div> |
| 1938 | |
| 1939 | ### See Also |
| 1940 | |
| 1941 | <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] | 1942 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1943 | <a name='Alpha_Methods'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1944 | |
Cary Clark | ffb3d68 | 2018-05-17 12:17:28 -0400 | [diff] [blame] | 1945 | <a href='SkColor_Reference#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] | 1946 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1947 | <a name='SkPaint_getAlpha'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1948 | |
| 1949 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1950 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1951 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 1952 | uint8_t <a href='#SkPaint_getAlpha'>getAlpha</a>() const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1953 | </pre> |
| 1954 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1955 | 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] | 1956 | |
| 1957 | ### Return Value |
| 1958 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1959 | <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] | 1960 | |
| 1961 | ### Example |
| 1962 | |
Cary Clark | 8364706 | 2018-07-18 16:21:51 -0400 | [diff] [blame] | 1963 | <div><fiddle-embed name="9a85bb62fe3d877b18fb7f952c4fa7f7"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1964 | |
| 1965 | #### Example Output |
| 1966 | |
| 1967 | ~~~~ |
| 1968 | 255 == paint.getAlpha() |
| 1969 | ~~~~ |
| 1970 | |
| 1971 | </fiddle-embed></div> |
| 1972 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1973 | <a name='SkPaint_setAlpha'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1974 | |
| 1975 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1976 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1977 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 1978 | 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] | 1979 | </pre> |
| 1980 | |
Cary Clark | ffb3d68 | 2018-05-17 12:17:28 -0400 | [diff] [blame] | 1981 | Replaces <a href='SkColor_Reference#Alpha'>Alpha</a>, leaving RGB |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1982 | unchanged. An out of range value triggers an assert in the debug |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1983 | build. <a href='#SkPaint_setAlpha_a'>a</a> is <a href='#SkPaint_setAlpha_a'>a</a> value from zero to 255. |
| 1984 | <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] | 1985 | fully opaque. |
| 1986 | |
| 1987 | ### Parameters |
| 1988 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1989 | <table> <tr> <td><a name='SkPaint_setAlpha_a'><code><strong>a</strong></code></a></td> |
| 1990 | <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] | 1991 | </tr> |
| 1992 | </table> |
| 1993 | |
| 1994 | ### Example |
| 1995 | |
Ravi Mistry | 874e22b | 2018-07-19 03:49:13 +0000 | [diff] [blame] | 1996 | <div><fiddle-embed name="6ddc0360512dfb9947e75c17e6a8103d"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1997 | |
| 1998 | #### Example Output |
| 1999 | |
| 2000 | ~~~~ |
| 2001 | 0x44112233 == paint.getColor() |
| 2002 | ~~~~ |
| 2003 | |
| 2004 | </fiddle-embed></div> |
| 2005 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2006 | <a name='SkPaint_setARGB'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2007 | |
| 2008 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2009 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2010 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 2011 | 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] | 2012 | </pre> |
| 2013 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2014 | Sets <a href='SkColor_Reference#Color'>Color</a> used when drawing solid fills. The color components range from 0 to 255. |
Cary Clark | ffb3d68 | 2018-05-17 12:17:28 -0400 | [diff] [blame] | 2015 | The color 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] | 2016 | |
| 2017 | ### Parameters |
| 2018 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2019 | <table> <tr> <td><a name='SkPaint_setARGB_a'><code><strong>a</strong></code></a></td> |
| 2020 | <td>amount of <a href='SkColor_Reference#Alpha'>Color Alpha</a>, from fully transparent (0) to fully opaque (255)</td> |
| 2021 | </tr> |
| 2022 | <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] | 2023 | <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] | 2024 | </tr> |
| 2025 | <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] | 2026 | <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] | 2027 | </tr> |
| 2028 | <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] | 2029 | <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] | 2030 | </tr> |
| 2031 | </table> |
| 2032 | |
| 2033 | ### Example |
| 2034 | |
skia-bookmaker | 61cc9fa | 2018-07-11 05:28:17 +0000 | [diff] [blame] | 2035 | <div><fiddle-embed name="cb62e4755789ed32f7120dc55984959d"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2036 | |
| 2037 | #### Example Output |
| 2038 | |
| 2039 | ~~~~ |
| 2040 | transRed1 == transRed2 |
| 2041 | ~~~~ |
| 2042 | |
| 2043 | </fiddle-embed></div> |
| 2044 | |
| 2045 | ### See Also |
| 2046 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2047 | <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] | 2048 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2049 | <a name='Style'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2050 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2051 | --- |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 2052 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2053 | <a href='#SkPaint_Style'>Style</a> specifies if the geometry is filled, stroked, or both filled and stroked. |
| 2054 | 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] | 2055 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2056 | <a name='Style_Fill'></a> |
| 2057 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2058 | Set <a href='#SkPaint_Style'>Style</a> to <a href='#SkPaint_kFill_Style'>kFill Style</a> to fill the shape. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2059 | The fill covers the area inside the geometry for most shapes. |
| 2060 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2061 | <a name='Style_Stroke'></a> |
| 2062 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2063 | 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] | 2064 | |
Cary Clark | bc5697d | 2017-10-04 14:31:33 -0400 | [diff] [blame] | 2065 | The stroke covers the area described by following the shape edge with a pen or brush of |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2066 | <a href='#Stroke_Width'>Stroke Width</a>. The area covered where the shape starts and stops is described by <a href='#Stroke_Cap'>Stroke Cap</a>. |
| 2067 | The area covered where the shape turns a corner is described by <a href='#Stroke_Join'>Stroke Join</a>. |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2068 | The stroke is centered on the shape; it extends equally on either side of the shape edge.As <a href='#Stroke_Width'>Stroke Width</a> gets smaller, the drawn path frame is thinner. <a href='#Stroke_Width'>Stroke Width</a> less than one |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2069 | may have gaps, and if <a href='#SkPaint_kAntiAlias_Flag'>kAntiAlias Flag</a> is set, <a href='SkColor_Reference#Alpha'>Color Alpha</a> will increase to visually decrease coverage. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2070 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2071 | ### See Also |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2072 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2073 | <a href='SkPath_Reference#Fill_Type'>Path Fill Type</a> <a href='undocumented#Path_Effect'>Path Effect</a> <a href='#Style_Fill'>Style Fill</a> <a href='#Style_Stroke'>Style Stroke</a> |
| 2074 | |
| 2075 | <a name='Hairline'></a> |
| 2076 | |
| 2077 | --- |
| 2078 | |
| 2079 | <a href='#Stroke_Width'>Stroke Width</a> of zero has a special meaning and switches drawing to use <a href='#Hairline'>Hairline</a>. |
| 2080 | <a href='#Hairline'>Hairline</a> draws the thinnest continuous frame. If <a href='#SkPaint_kAntiAlias_Flag'>kAntiAlias Flag</a> is clear, adjacent pixels |
Cary Clark | 7cfcbca | 2018-01-04 16:11:51 -0500 | [diff] [blame] | 2081 | flow horizontally, vertically,or diagonally. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2082 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2083 | <a href='SkPath_Reference#Path'>Path</a> drawing with <a href='#Hairline'>Hairline</a> may hit the same pixel more than once. For instance, <a href='SkPath_Reference#Path'>Path</a> containing |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 2084 | two lines in one <a href='SkPath_Overview#Contour'>Path Contour</a> will draw the corner point once, but may both lines may draw the adjacent |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2085 | pixel. If <a href='#SkPaint_kAntiAlias_Flag'>kAntiAlias Flag</a> is set, transparency is applied twice, resulting in a darker pixel. Some |
Cary Clark | 7cfcbca | 2018-01-04 16:11:51 -0500 | [diff] [blame] | 2086 | GPU-backed implementations apply transparency at a later drawing stage, avoiding double hit pixels |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2087 | while stroking. |
| 2088 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2089 | ### See Also |
| 2090 | |
| 2091 | <a href='SkPath_Reference#Fill_Type'>Path Fill Type</a> <a href='undocumented#Path_Effect'>Path Effect</a> <a href='#Style_Fill'>Style Fill</a> <a href='#Style_Stroke'>Style Stroke</a> |
| 2092 | |
| 2093 | <a name='SkPaint_Style'></a> |
| 2094 | |
| 2095 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2096 | |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 2097 | <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] | 2098 | enum <a href='#SkPaint_Style'>Style</a> { |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 2099 | <a href='#SkPaint_kFill_Style'>kFill_Style</a>, |
| 2100 | <a href='#SkPaint_kStroke_Style'>kStroke_Style</a>, |
| 2101 | <a href='#SkPaint_kStrokeAndFill_Style'>kStrokeAndFill_Style</a>, |
Cary Clark | 186d08f | 2018-04-03 08:43:27 -0400 | [diff] [blame] | 2102 | }; |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2103 | </pre> |
Cary Clark | d98f78c | 2018-04-26 08:32:37 -0400 | [diff] [blame] | 2104 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2105 | <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] | 2106 | 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] | 2107 | </pre> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2108 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2109 | Set <a href='#SkPaint_Style'>Style</a> to fill, stroke, or both fill and stroke geometry. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2110 | The stroke and fill |
| 2111 | share all paint attributes; for instance, they are drawn with the same color. |
| 2112 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2113 | Use <a href='#SkPaint_kStrokeAndFill_Style'>kStrokeAndFill Style</a> to avoid hitting the same pixels twice with a stroke draw and |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2114 | a fill draw. |
| 2115 | |
| 2116 | ### Constants |
| 2117 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2118 | <table style='border-collapse: collapse; width: 62.5em'> |
| 2119 | <tr><th style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>Const</th> |
| 2120 | <th style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>Value</th> |
| 2121 | <th style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>Description</th></tr> |
| 2122 | <tr style='background-color: #f0f0f0; '> |
| 2123 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kFill_Style'><code>SkPaint::kFill_Style</code></a></td> |
| 2124 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>0</td> |
| 2125 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
Cary Clark | d2ca79c | 2018-08-10 13:09:13 -0400 | [diff] [blame] | 2126 | Applies to <a href='SkRect_Reference#Rect'>Rect</a>, <a href='SkRegion_Reference#Region'>Region</a>, <a href='SkRRect_Reference#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>. |
| 2127 | <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 |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2128 | <a href='#SkPaint_kFill_Style'>kFill Style</a> is set, and ignore the set <a href='#SkPaint_Style'>Style</a>. |
| 2129 | The <a href='SkPath_Reference#Fill_Type'>Path Fill Type</a> specifies additional rules to fill the area outside the path edge, |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2130 | and to create an unfilled hole inside the shape. |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2131 | <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] | 2132 | </td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2133 | </tr> |
| 2134 | <tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2135 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kStroke_Style'><code>SkPaint::kStroke_Style</code></a></td> |
| 2136 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>1</td> |
| 2137 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
Cary Clark | d2ca79c | 2018-08-10 13:09:13 -0400 | [diff] [blame] | 2138 | Applies to <a href='SkRect_Reference#Rect'>Rect</a>, <a href='SkRegion_Reference#Region'>Region</a>, <a href='SkRRect_Reference#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>. |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2139 | <a href='undocumented#Arc'>Arcs</a>, <a href='undocumented#Line'>Lines</a>, and points, are always drawn as if <a href='#SkPaint_kStroke_Style'>kStroke Style</a> is set, |
| 2140 | and ignore the set <a href='#SkPaint_Style'>Style</a>. |
| 2141 | The stroke construction is unaffected by the <a href='SkPath_Reference#Fill_Type'>Path Fill Type</a>. |
| 2142 | </td> |
| 2143 | </tr> |
| 2144 | <tr style='background-color: #f0f0f0; '> |
| 2145 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kStrokeAndFill_Style'><code>SkPaint::kStrokeAndFill_Style</code></a></td> |
| 2146 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>2</td> |
| 2147 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
Cary Clark | d2ca79c | 2018-08-10 13:09:13 -0400 | [diff] [blame] | 2148 | Applies to <a href='SkRect_Reference#Rect'>Rect</a>, <a href='SkRegion_Reference#Region'>Region</a>, <a href='SkRRect_Reference#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>. |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2149 | <a href='SkPath_Reference#Path'>Path</a> is treated as if it is set to <a href='SkPath_Reference#SkPath_kWinding_FillType'>SkPath::kWinding FillType</a>, |
| 2150 | and the set <a href='SkPath_Reference#Fill_Type'>Path Fill Type</a> is ignored. |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 2151 | </td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2152 | </tr> |
| 2153 | <tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2154 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kStyleCount'><code>SkPaint::kStyleCount</code></a></td> |
| 2155 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>3</td> |
| 2156 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 2157 | 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] | 2158 | </td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2159 | </tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2160 | </table> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2161 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2162 | <a name='SkPaint_getStyle'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2163 | |
| 2164 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2165 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2166 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 2167 | <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] | 2168 | </pre> |
| 2169 | |
Cary Clark | 80247e5 | 2018-07-11 16:18:41 -0400 | [diff] [blame] | 2170 | Returns whether the geometry is filled, stroked, or filled and stroked. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2171 | |
| 2172 | ### Return Value |
| 2173 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2174 | 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] | 2175 | |
| 2176 | ### Example |
| 2177 | |
| 2178 | <div><fiddle-embed name="1c5e18c3c0102d2dac86a78ba8c8ce01"> |
| 2179 | |
| 2180 | #### Example Output |
| 2181 | |
| 2182 | ~~~~ |
| 2183 | SkPaint::kFill_Style == paint.getStyle() |
| 2184 | ~~~~ |
| 2185 | |
| 2186 | </fiddle-embed></div> |
| 2187 | |
| 2188 | ### See Also |
| 2189 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2190 | <a href='#SkPaint_Style'>Style</a> <a href='#SkPaint_setStyle'>setStyle</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2191 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2192 | <a name='SkPaint_setStyle'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2193 | |
| 2194 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2195 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2196 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 2197 | 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] | 2198 | </pre> |
| 2199 | |
| 2200 | Sets whether the geometry is filled, stroked, or filled and stroked. |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2201 | Has no effect if <a href='#SkPaint_setStyle_style'>style</a> is not a legal <a href='#SkPaint_Style'>Style</a> value. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2202 | |
| 2203 | ### Parameters |
| 2204 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2205 | <table> <tr> <td><a name='SkPaint_setStyle_style'><code><strong>style</strong></code></a></td> |
| 2206 | <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] | 2207 | </tr> |
| 2208 | </table> |
| 2209 | |
| 2210 | ### Example |
| 2211 | |
| 2212 | <div><fiddle-embed name="c7bb6248e4735b8d1a32d02fba40d344"></fiddle-embed></div> |
| 2213 | |
| 2214 | ### See Also |
| 2215 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2216 | <a href='#SkPaint_Style'>Style</a> <a href='#SkPaint_getStyle'>getStyle</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2217 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2218 | <a name='Stroke_Width'></a> |
| 2219 | |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2220 | --- |
| 2221 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2222 | <a href='#Stroke_Width'>Stroke Width</a> sets the width for stroking. The width is the thickness |
Cary Clark | 7cfcbca | 2018-01-04 16:11:51 -0500 | [diff] [blame] | 2223 | of the stroke perpendicular to the path direction when the paint style is |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2224 | 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] | 2225 | |
| 2226 | When width is greater than zero, the stroke encompasses as many pixels partially |
| 2227 | or fully as needed. When the width equals zero, the paint enables hairlines; |
Cary Clark | 7cfcbca | 2018-01-04 16:11:51 -0500 | [diff] [blame] | 2228 | the stroke is always one pixel wide. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2229 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2230 | The stroke dimensions are scaled by the canvas matrix, but <a href='#Hairline'>Hairline</a> stroke |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2231 | remains one pixel wide regardless of scaling. |
| 2232 | |
| 2233 | The default width for the paint is zero. |
| 2234 | |
| 2235 | ### Example |
| 2236 | |
skia-bookmaker | 525f9a9 | 2018-05-03 06:27:39 +0000 | [diff] [blame] | 2237 | <div><fiddle-embed name="5112c7209a19e035c61cef33a624a652" gpu="true"><div>The pixels hit to represent thin lines vary with the angle of the |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 2238 | line and the platform implementation. |
| 2239 | </div></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2240 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2241 | <a name='SkPaint_getStrokeWidth'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2242 | |
| 2243 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2244 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2245 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 2246 | <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] | 2247 | </pre> |
| 2248 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2249 | Returns the thickness of the pen used by <a href='#Paint'>Paint</a> to |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2250 | outline the shape. |
| 2251 | |
| 2252 | ### Return Value |
| 2253 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2254 | zero for <a href='#Hairline'>Hairline</a>, greater than zero for pen thickness |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2255 | |
| 2256 | ### Example |
| 2257 | |
skia-bookmaker | b95bbba | 2018-07-06 05:23:23 +0000 | [diff] [blame] | 2258 | <div><fiddle-embed name="99aa73f64df8bbf06e656cd891a81b9e"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2259 | |
| 2260 | #### Example Output |
| 2261 | |
| 2262 | ~~~~ |
| 2263 | 0 == paint.getStrokeWidth() |
| 2264 | ~~~~ |
| 2265 | |
| 2266 | </fiddle-embed></div> |
| 2267 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2268 | <a name='SkPaint_setStrokeWidth'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2269 | |
| 2270 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2271 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2272 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 2273 | 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] | 2274 | </pre> |
| 2275 | |
| 2276 | Sets the thickness of the pen used by the paint to |
Cary Clark | 7cfcbca | 2018-01-04 16:11:51 -0500 | [diff] [blame] | 2277 | outline the shape. |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2278 | 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] | 2279 | |
| 2280 | ### Parameters |
| 2281 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2282 | <table> <tr> <td><a name='SkPaint_setStrokeWidth_width'><code><strong>width</strong></code></a></td> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2283 | <td>zero thickness for <a href='#Hairline'>Hairline</a>; greater than zero for pen thickness</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2284 | </tr> |
| 2285 | </table> |
| 2286 | |
| 2287 | ### Example |
| 2288 | |
| 2289 | <div><fiddle-embed name="0c4446c0870b5c7b5a2efe77ff92afb8"> |
| 2290 | |
| 2291 | #### Example Output |
| 2292 | |
| 2293 | ~~~~ |
| 2294 | 5 == paint.getStrokeWidth() |
| 2295 | ~~~~ |
| 2296 | |
| 2297 | </fiddle-embed></div> |
| 2298 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2299 | <a name='Miter_Limit'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2300 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2301 | --- |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 2302 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2303 | <a href='#Miter_Limit'>Miter Limit</a> specifies the maximum miter length, |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2304 | relative to the stroke width. |
| 2305 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2306 | <a href='#Miter_Limit'>Miter Limit</a> is used when the <a href='#Stroke_Join'>Stroke Join</a> |
| 2307 | 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> |
| 2308 | or <a href='#SkPaint_kStrokeAndFill_Style'>kStrokeAndFill Style</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2309 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2310 | If the miter at a corner exceeds this limit, <a href='#SkPaint_kMiter_Join'>kMiter Join</a> |
| 2311 | is replaced with <a href='#SkPaint_kBevel_Join'>kBevel Join</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2312 | |
Cary Clark | 2be81cf | 2018-09-13 12:04:30 -0400 | [diff] [blame] | 2313 | <a href='#Miter_Limit'>Miter Limit</a> can be computed from the corner angle using: |
| 2314 | <code>miter limit = 1 / sin \( angle / 2 \)</code>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2315 | |
Cary Clark | 2be81cf | 2018-09-13 12:04:30 -0400 | [diff] [blame] | 2316 | <a href='#Miter_Limit'>Miter Limit</a> default value is 4. |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2317 | The default may be changed at compile time by setting <a href='undocumented#SkPaintDefaults_MiterLimit'>SkPaintDefaults MiterLimit</a> |
Cary Clark | 7cfcbca | 2018-01-04 16:11:51 -0500 | [diff] [blame] | 2318 | in "SkUserConfig.h" or as a define supplied by the build environment. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2319 | |
| 2320 | Here are some miter limits and the angles that triggers them. |
| 2321 | |
| 2322 | | miter limit | angle in degrees | |
| 2323 | | --- | --- | |
| 2324 | | 10 | 11.48 | |
| 2325 | | 9 | 12.76 | |
| 2326 | | 8 | 14.36 | |
| 2327 | | 7 | 16.43 | |
| 2328 | | 6 | 19.19 | |
| 2329 | | 5 | 23.07 | |
| 2330 | | 4 | 28.96 | |
| 2331 | | 3 | 38.94 | |
| 2332 | | 2 | 60 | |
| 2333 | | 1 | 180 | |
| 2334 | |
| 2335 | ### Example |
| 2336 | |
Cary Clark | a619d45 | 2018-07-16 08:12:01 -0400 | [diff] [blame] | 2337 | <div><fiddle-embed name="5de2de0f00354e59074a9bb1a42d5a63"><div>This example draws a stroked corner and the miter length beneath. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2338 | When the miter limit is decreased slightly, the miter join is replaced |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 2339 | by a bevel join. |
| 2340 | </div></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2341 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2342 | <a name='SkPaint_getStrokeMiter'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2343 | |
| 2344 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2345 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2346 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 2347 | <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] | 2348 | </pre> |
| 2349 | |
Cary Clark | 80247e5 | 2018-07-11 16:18:41 -0400 | [diff] [blame] | 2350 | Returns the limit at which a sharp corner is drawn beveled. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2351 | |
| 2352 | ### Return Value |
| 2353 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2354 | zero and greater <a href='#Miter_Limit'>Miter Limit</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2355 | |
| 2356 | ### Example |
| 2357 | |
| 2358 | <div><fiddle-embed name="50da74a43b725f07a914df588c867d36"> |
| 2359 | |
| 2360 | #### Example Output |
| 2361 | |
| 2362 | ~~~~ |
| 2363 | default miter limit == 4 |
| 2364 | ~~~~ |
| 2365 | |
| 2366 | </fiddle-embed></div> |
| 2367 | |
| 2368 | ### See Also |
| 2369 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2370 | <a href='#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] | 2371 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2372 | <a name='SkPaint_setStrokeMiter'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2373 | |
| 2374 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2375 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2376 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 2377 | 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] | 2378 | </pre> |
| 2379 | |
Cary Clark | 80247e5 | 2018-07-11 16:18:41 -0400 | [diff] [blame] | 2380 | Sets the limit at which a sharp corner is drawn beveled. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2381 | Valid values are zero and greater. |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2382 | 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] | 2383 | |
| 2384 | ### Parameters |
| 2385 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2386 | <table> <tr> <td><a name='SkPaint_setStrokeMiter_miter'><code><strong>miter</strong></code></a></td> |
| 2387 | <td>zero and greater <a href='#Miter_Limit'>Miter Limit</a></td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2388 | </tr> |
| 2389 | </table> |
| 2390 | |
| 2391 | ### Example |
| 2392 | |
skia-bookmaker | a717ca9 | 2018-07-08 05:32:09 +0000 | [diff] [blame] | 2393 | <div><fiddle-embed name="700b284dbc97785c6a9c9636088713ad"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2394 | |
| 2395 | #### Example Output |
| 2396 | |
| 2397 | ~~~~ |
| 2398 | default miter limit == 8 |
| 2399 | ~~~~ |
| 2400 | |
| 2401 | </fiddle-embed></div> |
| 2402 | |
| 2403 | ### See Also |
| 2404 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2405 | <a href='#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] | 2406 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2407 | <a name='Stroke_Cap'></a> |
| 2408 | |
| 2409 | <a name='SkPaint_Cap'></a> |
| 2410 | |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2411 | --- |
| 2412 | |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 2413 | <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] | 2414 | enum <a href='#SkPaint_Cap'>Cap</a> { |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 2415 | <a href='#SkPaint_kButt_Cap'>kButt_Cap</a>, |
| 2416 | <a href='#SkPaint_kRound_Cap'>kRound_Cap</a>, |
| 2417 | <a href='#SkPaint_kSquare_Cap'>kSquare_Cap</a>, |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 2418 | <a href='#SkPaint_kLast_Cap'>kLast_Cap</a> = <a href='#SkPaint_kSquare_Cap'>kSquare_Cap</a>, |
| 2419 | <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] | 2420 | }; |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2421 | </pre> |
Cary Clark | 6fc5041 | 2017-09-21 12:31:06 -0400 | [diff] [blame] | 2422 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2423 | <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] | 2424 | 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] | 2425 | </pre> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2426 | |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 2427 | <a href='#Stroke_Cap'>Stroke Cap</a> draws at the beginning and end of an open <a href='SkPath_Overview#Contour'>Path Contour</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2428 | |
| 2429 | ### Constants |
| 2430 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2431 | <table style='border-collapse: collapse; width: 62.5em'> |
| 2432 | <tr><th style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>Const</th> |
| 2433 | <th style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>Value</th> |
| 2434 | <th style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>Description</th></tr> |
| 2435 | <tr style='background-color: #f0f0f0; '> |
| 2436 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kButt_Cap'><code>SkPaint::kButt_Cap</code></a></td> |
| 2437 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>0</td> |
| 2438 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 2439 | Does not extend the stroke past the beginning or the end. |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 2440 | </td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2441 | </tr> |
| 2442 | <tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2443 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kRound_Cap'><code>SkPaint::kRound_Cap</code></a></td> |
| 2444 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>1</td> |
| 2445 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 2446 | Adds a circle with a diameter equal to <a href='#Stroke_Width'>Stroke Width</a> at the beginning |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 2447 | and end. |
| 2448 | </td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2449 | </tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2450 | <tr style='background-color: #f0f0f0; '> |
| 2451 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kSquare_Cap'><code>SkPaint::kSquare_Cap</code></a></td> |
| 2452 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>2</td> |
| 2453 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 2454 | Adds a square with sides equal to <a href='#Stroke_Width'>Stroke Width</a> at the beginning |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2455 | and end. The square sides are parallel to the initial and final direction |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 2456 | of the stroke. |
| 2457 | </td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2458 | </tr> |
| 2459 | <tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2460 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kLast_Cap'><code>SkPaint::kLast_Cap</code></a></td> |
| 2461 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>2</td> |
| 2462 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 2463 | Equivalent to the largest value for <a href='#Stroke_Cap'>Stroke Cap</a>. |
| 2464 | </td> |
| 2465 | </tr> |
| 2466 | <tr style='background-color: #f0f0f0; '> |
| 2467 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kDefault_Cap'><code>SkPaint::kDefault_Cap</code></a></td> |
| 2468 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>0</td> |
| 2469 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 2470 | <a href='#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] | 2471 | </td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2472 | </tr> |
| 2473 | <tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2474 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kCapCount'><code>SkPaint::kCapCount</code></a></td> |
| 2475 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>3</td> |
| 2476 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 2477 | May be used to verify that <a href='#Stroke_Cap'>Stroke Cap</a> is a legal value. |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 2478 | </td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2479 | </tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2480 | </table> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2481 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2482 | Stroke describes the area covered by a pen of <a href='#Stroke_Width'>Stroke Width</a> as it |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 2483 | follows the <a href='SkPath_Overview#Contour'>Path Contour</a>, moving parallel to the contour direction. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2484 | |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 2485 | If the <a href='SkPath_Overview#Contour'>Path Contour</a> is not terminated by <a href='SkPath_Reference#SkPath_kClose_Verb'>SkPath::kClose Verb</a>, the contour has a |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2486 | visible beginning and end. |
| 2487 | |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 2488 | <a href='SkPath_Overview#Contour'>Path Contour</a> may start and end at the same point; defining <a href='SkPath_Overview#Contour_Zero_Length'>Zero Length Contour</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2489 | |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 2490 | <a href='#SkPaint_kButt_Cap'>kButt Cap</a> and <a href='SkPath_Overview#Contour_Zero_Length'>Zero Length Contour</a> is not drawn. |
| 2491 | <a href='#SkPaint_kRound_Cap'>kRound Cap</a> and <a href='SkPath_Overview#Contour_Zero_Length'>Zero Length Contour</a> draws a circle of diameter <a href='#Stroke_Width'>Stroke Width</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2492 | at the contour point. |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 2493 | <a href='#SkPaint_kSquare_Cap'>kSquare Cap</a> and <a href='SkPath_Overview#Contour_Zero_Length'>Zero Length Contour</a> draws an upright square with a side of |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2494 | <a href='#Stroke_Width'>Stroke Width</a> at the contour point. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2495 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2496 | <a href='#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] | 2497 | |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2498 | ### Example |
| 2499 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 2500 | <div><fiddle-embed name="2bffb6384cc20077e632e7d01da045ca"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2501 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2502 | <a name='SkPaint_getStrokeCap'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2503 | |
| 2504 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2505 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2506 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 2507 | <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] | 2508 | </pre> |
| 2509 | |
Cary Clark | 80247e5 | 2018-07-11 16:18:41 -0400 | [diff] [blame] | 2510 | Returns the geometry drawn at the beginning and end of strokes. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2511 | |
| 2512 | ### Return Value |
| 2513 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2514 | 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] | 2515 | |
| 2516 | ### Example |
| 2517 | |
| 2518 | <div><fiddle-embed name="aabf9baee8e026fae36fca30e955512b"> |
| 2519 | |
| 2520 | #### Example Output |
| 2521 | |
| 2522 | ~~~~ |
| 2523 | kButt_Cap == default stroke cap |
| 2524 | ~~~~ |
| 2525 | |
| 2526 | </fiddle-embed></div> |
| 2527 | |
| 2528 | ### See Also |
| 2529 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2530 | <a href='#Stroke_Cap'>Stroke Cap</a> <a href='#SkPaint_setStrokeCap'>setStrokeCap</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2531 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2532 | <a name='SkPaint_setStrokeCap'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2533 | |
| 2534 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2535 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2536 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 2537 | 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] | 2538 | </pre> |
| 2539 | |
Cary Clark | 80247e5 | 2018-07-11 16:18:41 -0400 | [diff] [blame] | 2540 | Sets the geometry drawn at the beginning and end of strokes. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2541 | |
| 2542 | ### Parameters |
| 2543 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2544 | <table> <tr> <td><a name='SkPaint_setStrokeCap_cap'><code><strong>cap</strong></code></a></td> |
| 2545 | <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>; |
| 2546 | has no effect if <a href='#SkPaint_setStrokeCap_cap'>cap</a> is not valid</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2547 | </tr> |
| 2548 | </table> |
| 2549 | |
| 2550 | ### Example |
| 2551 | |
| 2552 | <div><fiddle-embed name="de83fbd848a4625345b4b87a6e55d98a"> |
| 2553 | |
| 2554 | #### Example Output |
| 2555 | |
| 2556 | ~~~~ |
| 2557 | kRound_Cap == paint.getStrokeCap() |
| 2558 | ~~~~ |
| 2559 | |
| 2560 | </fiddle-embed></div> |
| 2561 | |
| 2562 | ### See Also |
| 2563 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2564 | <a href='#Stroke_Cap'>Stroke Cap</a> <a href='#SkPaint_getStrokeCap'>getStrokeCap</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2565 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2566 | <a name='Stroke_Join'></a> |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 2567 | |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 2568 | <a href='#Stroke_Join'>Stroke Join</a> draws at the sharp corners of an open or closed <a href='SkPath_Overview#Contour'>Path Contour</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2569 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2570 | Stroke describes the area covered by a pen of <a href='#Stroke_Width'>Stroke Width</a> as it |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 2571 | follows the <a href='SkPath_Overview#Contour'>Path Contour</a>, moving parallel to the contour direction. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2572 | |
| 2573 | If the contour direction changes abruptly, because the tangent direction leading |
| 2574 | to the end of a curve within the contour does not match the tangent direction of |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2575 | the following curve, the pair of curves meet at <a href='#Stroke_Join'>Stroke Join</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2576 | |
| 2577 | ### Example |
| 2578 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 2579 | <div><fiddle-embed name="917c44b504d3f9308571fd3835d90a0d"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2580 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2581 | <a name='SkPaint_Join'></a> |
| 2582 | |
| 2583 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2584 | |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 2585 | <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] | 2586 | enum <a href='#SkPaint_Join'>Join</a> { |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 2587 | <a href='#SkPaint_kMiter_Join'>kMiter_Join</a>, |
| 2588 | <a href='#SkPaint_kRound_Join'>kRound_Join</a>, |
| 2589 | <a href='#SkPaint_kBevel_Join'>kBevel_Join</a>, |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 2590 | <a href='#SkPaint_kLast_Join'>kLast_Join</a> = <a href='#SkPaint_kBevel_Join'>kBevel_Join</a>, |
| 2591 | <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] | 2592 | }; |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2593 | </pre> |
Cary Clark | 6fc5041 | 2017-09-21 12:31:06 -0400 | [diff] [blame] | 2594 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2595 | <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] | 2596 | 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] | 2597 | </pre> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2598 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2599 | <a href='#SkPaint_Join'>Join</a> specifies how corners are drawn when a shape is stroked. <a href='#SkPaint_Join'>Join</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2600 | affects the four corners of a stroked rectangle, and the connected segments in a |
| 2601 | stroked path. |
| 2602 | |
| 2603 | Choose miter join to draw sharp corners. Choose round join to draw a circle with a |
| 2604 | radius equal to the stroke width on top of the corner. Choose bevel join to minimally |
| 2605 | connect the thick strokes. |
| 2606 | |
Cary Clark | 7cfcbca | 2018-01-04 16:11:51 -0500 | [diff] [blame] | 2607 | The fill path constructed to describe the stroked path respects the join setting but may |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2608 | not contain the actual join. For instance, a fill path constructed with round joins does |
| 2609 | not necessarily include circles at each connected segment. |
| 2610 | |
| 2611 | ### Constants |
| 2612 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2613 | <table style='border-collapse: collapse; width: 62.5em'> |
| 2614 | <tr><th style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>Const</th> |
| 2615 | <th style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>Value</th> |
| 2616 | <th style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>Description</th></tr> |
| 2617 | <tr style='background-color: #f0f0f0; '> |
| 2618 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kMiter_Join'><code>SkPaint::kMiter_Join</code></a></td> |
| 2619 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>0</td> |
| 2620 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 2621 | Extends the outside corner to the extent allowed by <a href='#Miter_Limit'>Miter Limit</a>. |
| 2622 | If the extension exceeds <a href='#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] | 2623 | </td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2624 | </tr> |
| 2625 | <tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2626 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kRound_Join'><code>SkPaint::kRound_Join</code></a></td> |
| 2627 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>1</td> |
| 2628 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 2629 | Adds a circle with a diameter of <a href='#Stroke_Width'>Stroke Width</a> at the sharp corner. |
| 2630 | </td> |
| 2631 | </tr> |
| 2632 | <tr style='background-color: #f0f0f0; '> |
| 2633 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kBevel_Join'><code>SkPaint::kBevel_Join</code></a></td> |
| 2634 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>2</td> |
| 2635 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 2636 | Connects the outside edges of the sharp corner. |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 2637 | </td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2638 | </tr> |
| 2639 | <tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2640 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kLast_Join'><code>SkPaint::kLast_Join</code></a></td> |
| 2641 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>2</td> |
| 2642 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 2643 | equivalent to the largest value for Stroke_Join</td> |
| 2644 | </tr> |
| 2645 | <tr style='background-color: #f0f0f0; '> |
| 2646 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kDefault_Join'><code>SkPaint::kDefault_Join</code></a></td> |
| 2647 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>1</td> |
| 2648 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 2649 | <a href='#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] | 2650 | </td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2651 | </tr> |
| 2652 | <tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2653 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kJoinCount'><code>SkPaint::kJoinCount</code></a></td> |
| 2654 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>3</td> |
| 2655 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 2656 | May be used to verify that <a href='#Stroke_Join'>Stroke Join</a> is a legal value. |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 2657 | </td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2658 | </tr> |
| 2659 | </table> |
| 2660 | |
| 2661 | ### Example |
| 2662 | |
| 2663 | <div><fiddle-embed name="3b1aebacc21c1836a52876b9b0b3905e"></fiddle-embed></div> |
| 2664 | |
| 2665 | ### See Also |
| 2666 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2667 | <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] | 2668 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2669 | <a name='SkPaint_getStrokeJoin'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2670 | |
| 2671 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2672 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2673 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 2674 | <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] | 2675 | </pre> |
| 2676 | |
Cary Clark | 80247e5 | 2018-07-11 16:18:41 -0400 | [diff] [blame] | 2677 | Returns the geometry drawn at the corners of strokes. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2678 | |
| 2679 | ### Return Value |
| 2680 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2681 | 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] | 2682 | |
| 2683 | ### Example |
| 2684 | |
Cary Clark | 7f644ec | 2018-07-19 10:50:44 -0400 | [diff] [blame] | 2685 | <div><fiddle-embed name="31bf751d0a8ddf176b871810820d8199"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2686 | |
| 2687 | #### Example Output |
| 2688 | |
| 2689 | ~~~~ |
| 2690 | kMiter_Join == default stroke join |
| 2691 | ~~~~ |
| 2692 | |
| 2693 | </fiddle-embed></div> |
| 2694 | |
| 2695 | ### See Also |
| 2696 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2697 | <a href='#Stroke_Join'>Stroke Join</a> <a href='#SkPaint_setStrokeJoin'>setStrokeJoin</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2698 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2699 | <a name='SkPaint_setStrokeJoin'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2700 | |
| 2701 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2702 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2703 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 2704 | 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] | 2705 | </pre> |
| 2706 | |
Cary Clark | 80247e5 | 2018-07-11 16:18:41 -0400 | [diff] [blame] | 2707 | Sets the geometry drawn at the corners of strokes. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2708 | |
| 2709 | ### Parameters |
| 2710 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2711 | <table> <tr> <td><a name='SkPaint_setStrokeJoin_join'><code><strong>join</strong></code></a></td> |
| 2712 | <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>; |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 2713 | otherwise, has no effect</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2714 | </tr> |
| 2715 | </table> |
| 2716 | |
| 2717 | ### Example |
| 2718 | |
| 2719 | <div><fiddle-embed name="48d963ad4286eddf680f9c511eb6da91"> |
| 2720 | |
| 2721 | #### Example Output |
| 2722 | |
| 2723 | ~~~~ |
| 2724 | kMiter_Join == paint.getStrokeJoin() |
| 2725 | ~~~~ |
| 2726 | |
| 2727 | </fiddle-embed></div> |
| 2728 | |
| 2729 | ### See Also |
| 2730 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2731 | <a href='#Stroke_Join'>Stroke Join</a> <a href='#SkPaint_getStrokeJoin'>getStrokeJoin</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2732 | |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2733 | ### See Also |
| 2734 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2735 | <a href='#Miter_Limit'>Miter Limit</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2736 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2737 | <a name='Fill_Path'></a> |
| 2738 | |
| 2739 | --- |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 2740 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2741 | <a href='#Fill_Path'>Fill Path</a> creates a <a href='SkPath_Reference#Path'>Path</a> by applying the <a href='undocumented#Path_Effect'>Path Effect</a>, followed by the <a href='#Style_Stroke'>Style Stroke</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2742 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2743 | If <a href='#Paint'>Paint</a> contains <a href='undocumented#Path_Effect'>Path Effect</a>, <a href='undocumented#Path_Effect'>Path Effect</a> operates on the source <a href='SkPath_Reference#Path'>Path</a>; the result |
| 2744 | replaces the destination <a href='SkPath_Reference#Path'>Path</a>. Otherwise, the source <a href='SkPath_Reference#Path'>Path</a> is replaces the |
| 2745 | destination <a href='SkPath_Reference#Path'>Path</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2746 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2747 | Fill <a href='SkPath_Reference#Path'>Path</a> can request the <a href='undocumented#Path_Effect'>Path Effect</a> to restrict to a culling rectangle, but |
| 2748 | the <a href='undocumented#Path_Effect'>Path Effect</a> is not required to do so. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2749 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2750 | 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>, |
| 2751 | and <a href='#Stroke_Width'>Stroke Width</a> is greater than zero, the <a href='#Stroke_Width'>Stroke Width</a>, <a href='#Stroke_Cap'>Stroke Cap</a>, <a href='#Stroke_Join'>Stroke Join</a>, |
| 2752 | and <a href='#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] | 2753 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2754 | Fill <a href='SkPath_Reference#Path'>Path</a> can specify the precision used by <a href='#Stroke_Width'>Stroke Width</a> to approximate the stroke geometry. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2755 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2756 | If the <a href='#SkPaint_Style'>Style</a> is <a href='#SkPaint_kStroke_Style'>kStroke Style</a> and the <a href='#Stroke_Width'>Stroke Width</a> is zero, <a href='#SkPaint_getFillPath'>getFillPath</a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2757 | returns false since <a href='#Hairline'>Hairline</a> has no filled equivalent. |
| 2758 | |
| 2759 | ### See Also |
| 2760 | |
| 2761 | <a href='#Style_Stroke'>Style Stroke</a> <a href='#Stroke_Width'>Stroke Width</a> <a href='undocumented#Path_Effect'>Path Effect</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2762 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2763 | <a name='SkPaint_getFillPath'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2764 | |
| 2765 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2766 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2767 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 2768 | 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] | 2769 | </pre> |
| 2770 | |
Cary Clark | 80247e5 | 2018-07-11 16:18:41 -0400 | [diff] [blame] | 2771 | Returns the filled equivalent of the stroked path. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2772 | |
| 2773 | ### Parameters |
| 2774 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2775 | <table> <tr> <td><a name='SkPaint_getFillPath_src'><code><strong>src</strong></code></a></td> |
| 2776 | <td><a href='SkPath_Reference#Path'>Path</a> read to create a filled version</td> |
| 2777 | </tr> |
| 2778 | <tr> <td><a name='SkPaint_getFillPath_dst'><code><strong>dst</strong></code></a></td> |
| 2779 | <td>resulting <a href='SkPath_Reference#Path'>Path</a>; may be the same as <a href='#SkPaint_getFillPath_src'>src</a>, but may not be nullptr</td> |
| 2780 | </tr> |
| 2781 | <tr> <td><a name='SkPaint_getFillPath_cullRect'><code><strong>cullRect</strong></code></a></td> |
| 2782 | <td>optional limit passed to <a href='undocumented#Path_Effect'>Path Effect</a></td> |
| 2783 | </tr> |
| 2784 | <tr> <td><a name='SkPaint_getFillPath_resScale'><code><strong>resScale</strong></code></a></td> |
| 2785 | <td>if > 1, increase precision, else if (0 < res < 1) reduce precision |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2786 | to favor speed and size</td> |
| 2787 | </tr> |
| 2788 | </table> |
| 2789 | |
| 2790 | ### Return Value |
| 2791 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2792 | true if the path represents <a href='#Style_Fill'>Style Fill</a>, or false if it represents <a href='#Hairline'>Hairline</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2793 | |
| 2794 | ### Example |
| 2795 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2796 | <div><fiddle-embed name="cedd6233848198e1fca4d1e14816baaf"><div>A very small <a href='SkPath_Reference#Quad'>Quad</a> stroke is turned into a filled path with increasing levels of precision. |
| 2797 | At the lowest precision, the <a href='SkPath_Reference#Quad'>Quad</a> stroke is approximated by a rectangle. |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 2798 | At the highest precision, the filled path has high fidelity compared to the original stroke. |
| 2799 | </div></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2800 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2801 | <a name='SkPaint_getFillPath_2'></a> |
Cary Clark | 2dc84ad | 2018-01-26 12:56:22 -0500 | [diff] [blame] | 2802 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2803 | --- |
| 2804 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2805 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 2806 | 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] | 2807 | </pre> |
| 2808 | |
Cary Clark | 80247e5 | 2018-07-11 16:18:41 -0400 | [diff] [blame] | 2809 | Returns the filled equivalent of the stroked path. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2810 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2811 | Replaces <a href='#SkPaint_getFillPath_2_dst'>dst</a> with the <a href='#SkPaint_getFillPath_2_src'>src</a> path modified by <a href='undocumented#Path_Effect'>Path Effect</a> and <a href='#Style_Stroke'>Style Stroke</a>. |
| 2812 | <a href='undocumented#Path_Effect'>Path Effect</a>, if any, is not culled. <a href='#Stroke_Width'>Stroke Width</a> is created with default precision. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2813 | |
| 2814 | ### Parameters |
| 2815 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2816 | <table> <tr> <td><a name='SkPaint_getFillPath_2_src'><code><strong>src</strong></code></a></td> |
| 2817 | <td><a href='SkPath_Reference#Path'>Path</a> read to create a filled version</td> |
| 2818 | </tr> |
| 2819 | <tr> <td><a name='SkPaint_getFillPath_2_dst'><code><strong>dst</strong></code></a></td> |
| 2820 | <td>resulting <a href='SkPath_Reference#Path'>Path</a> <a href='#SkPaint_getFillPath_2_dst'>dst</a> may be the same as <a href='#SkPaint_getFillPath_2_src'>src</a>, but may not be nullptr</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2821 | </tr> |
| 2822 | </table> |
| 2823 | |
| 2824 | ### Return Value |
| 2825 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2826 | true if the path represents <a href='#Style_Fill'>Style Fill</a>, or false if it represents <a href='#Hairline'>Hairline</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2827 | |
| 2828 | ### Example |
| 2829 | |
| 2830 | <div><fiddle-embed name="e6d8ca0cc17e0b475bd54dd995825468"></fiddle-embed></div> |
| 2831 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2832 | <a name='Shader_Methods'></a> |
| 2833 | |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2834 | --- |
| 2835 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2836 | <a href='undocumented#Shader'>Shader</a> defines the colors used when drawing a shape. |
| 2837 | <a href='undocumented#Shader'>Shader</a> may be an image, a gradient, or a computed fill. |
| 2838 | If <a href='#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] | 2839 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2840 | <a href='undocumented#Shader'>Shader</a> is modulated by <a href='SkColor_Reference#Alpha'>Color Alpha</a> component of <a href='SkColor_Reference#Color'>Color</a>. |
| 2841 | If <a href='undocumented#Shader'>Shader</a> object defines only <a href='SkColor_Reference#Alpha'>Color Alpha</a>, then <a href='SkColor_Reference#Color'>Color</a> modulated by <a href='SkColor_Reference#Alpha'>Color Alpha</a> describes |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2842 | the fill. |
| 2843 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2844 | The drawn transparency can be modified without altering <a href='undocumented#Shader'>Shader</a>, by changing <a href='SkColor_Reference#Alpha'>Color Alpha</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2845 | |
| 2846 | ### Example |
| 2847 | |
| 2848 | <div><fiddle-embed name="c015dc2010c15e1c00b4f7330232b0f7"></fiddle-embed></div> |
| 2849 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2850 | If <a href='undocumented#Shader'>Shader</a> generates only <a href='SkColor_Reference#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] | 2851 | |
| 2852 | ### Example |
| 2853 | |
skia-bookmaker | 525f9a9 | 2018-05-03 06:27:39 +0000 | [diff] [blame] | 2854 | <div><fiddle-embed name="fe80fd80b98a20823db7fb9a077243c7"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2855 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2856 | <a name='SkPaint_getShader'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2857 | |
| 2858 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2859 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2860 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 2861 | <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] | 2862 | </pre> |
| 2863 | |
Cary Clark | 80247e5 | 2018-07-11 16:18:41 -0400 | [diff] [blame] | 2864 | Returns optional colors used when filling a path, such as a gradient. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2865 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2866 | Does not alter <a href='undocumented#Shader'>Shader</a> <a href='undocumented#Reference_Count'>Reference Count</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2867 | |
| 2868 | ### Return Value |
| 2869 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2870 | <a href='undocumented#Shader'>Shader</a> if previously set, nullptr otherwise |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2871 | |
| 2872 | ### Example |
| 2873 | |
| 2874 | <div><fiddle-embed name="09f15b9fd88882850da2d235eb86292f"> |
| 2875 | |
| 2876 | #### Example Output |
| 2877 | |
| 2878 | ~~~~ |
| 2879 | nullptr == shader |
| 2880 | nullptr != shader |
| 2881 | ~~~~ |
| 2882 | |
| 2883 | </fiddle-embed></div> |
| 2884 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2885 | <a name='SkPaint_refShader'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2886 | |
| 2887 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2888 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2889 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 2890 | <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] | 2891 | </pre> |
| 2892 | |
Cary Clark | 80247e5 | 2018-07-11 16:18:41 -0400 | [diff] [blame] | 2893 | Returns optional colors used when filling a path, such as a gradient. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2894 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2895 | Increases <a href='undocumented#Shader'>Shader</a> <a href='undocumented#Reference_Count'>Reference Count</a> by one. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2896 | |
| 2897 | ### Return Value |
| 2898 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2899 | <a href='undocumented#Shader'>Shader</a> if previously set, nullptr otherwise |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2900 | |
| 2901 | ### Example |
| 2902 | |
| 2903 | <div><fiddle-embed name="53da0295972a418cbc9607bbb17feaa8"> |
| 2904 | |
| 2905 | #### Example Output |
| 2906 | |
| 2907 | ~~~~ |
| 2908 | shader unique: true |
| 2909 | shader unique: false |
| 2910 | ~~~~ |
| 2911 | |
| 2912 | </fiddle-embed></div> |
| 2913 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2914 | <a name='SkPaint_setShader'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2915 | |
| 2916 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2917 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2918 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 2919 | void <a href='#SkPaint_setShader'>setShader</a>(<a href='undocumented#sk_sp'>sk sp</a><<a href='undocumented#SkShader'>SkShader</a>> shader) |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2920 | </pre> |
| 2921 | |
Cary Clark | 80247e5 | 2018-07-11 16:18:41 -0400 | [diff] [blame] | 2922 | Sets optional colors used when filling a path, such as a gradient. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2923 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2924 | Sets <a href='undocumented#Shader'>Shader</a> to <a href='#SkPaint_setShader_shader'>shader</a>, decreasing <a href='undocumented#Reference_Count'>Reference Count</a> of the previous <a href='undocumented#Shader'>Shader</a>. |
| 2925 | Increments <a href='#SkPaint_setShader_shader'>shader</a> <a href='undocumented#Reference_Count'>Reference Count</a> by one. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2926 | |
| 2927 | ### Parameters |
| 2928 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2929 | <table> <tr> <td><a name='SkPaint_setShader_shader'><code><strong>shader</strong></code></a></td> |
| 2930 | <td>how geometry is filled with color; 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] | 2931 | </tr> |
| 2932 | </table> |
| 2933 | |
| 2934 | ### Example |
| 2935 | |
skia-bookmaker | e0a458f | 2018-07-16 05:29:00 +0000 | [diff] [blame] | 2936 | <div><fiddle-embed name="77e64d5bae9b1ba037fd99252bb4aa58"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2937 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2938 | <a name='Color_Filter_Methods'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2939 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2940 | --- |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 2941 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2942 | <a href='undocumented#Color_Filter'>Color Filter</a> alters the color used when drawing a shape. |
Cary Clark | 224c700 | 2018-06-27 11:00:21 -0400 | [diff] [blame] | 2943 | <a href='undocumented#Color_Filter'>Color Filter</a> may apply <a href='SkBlendMode_Reference#Blend_Mode'>Blend Mode</a>, transform the color through a matrix, or composite multiple filters. |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2944 | If <a href='#Paint'>Paint</a> has no <a href='undocumented#Color_Filter'>Color Filter</a>, the color is unaltered. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2945 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2946 | The drawn transparency can be modified without altering <a href='undocumented#Color_Filter'>Color Filter</a>, by changing <a href='SkColor_Reference#Alpha'>Color Alpha</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2947 | |
| 2948 | ### Example |
| 2949 | |
| 2950 | <div><fiddle-embed name="5abde56ca2f89a18b8e231abd1b57c56"></fiddle-embed></div> |
| 2951 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2952 | <a name='SkPaint_getColorFilter'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2953 | |
| 2954 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2955 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2956 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 2957 | <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] | 2958 | </pre> |
| 2959 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2960 | Returns <a href='undocumented#Color_Filter'>Color Filter</a> if set, or nullptr. |
| 2961 | Does not alter <a href='undocumented#Color_Filter'>Color Filter</a> <a href='undocumented#Reference_Count'>Reference Count</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2962 | |
| 2963 | ### Return Value |
| 2964 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2965 | <a href='undocumented#Color_Filter'>Color Filter</a> if previously set, nullptr otherwise |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2966 | |
| 2967 | ### Example |
| 2968 | |
| 2969 | <div><fiddle-embed name="093bdc627d6b59002670fd290931f6c9"> |
| 2970 | |
| 2971 | #### Example Output |
| 2972 | |
| 2973 | ~~~~ |
| 2974 | nullptr == color filter |
| 2975 | nullptr != color filter |
| 2976 | ~~~~ |
| 2977 | |
| 2978 | </fiddle-embed></div> |
| 2979 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2980 | <a name='SkPaint_refColorFilter'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 2981 | |
| 2982 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2983 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2984 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 2985 | <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] | 2986 | </pre> |
| 2987 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2988 | Returns <a href='undocumented#Color_Filter'>Color Filter</a> if set, or nullptr. |
| 2989 | Increases <a href='undocumented#Color_Filter'>Color Filter</a> <a href='undocumented#Reference_Count'>Reference Count</a> by one. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2990 | |
| 2991 | ### Return Value |
| 2992 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2993 | <a href='undocumented#Color_Filter'>Color Filter</a> if set, or nullptr |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2994 | |
| 2995 | ### Example |
| 2996 | |
| 2997 | <div><fiddle-embed name="b588c95fa4c86ddbc4b0546762f08297"> |
| 2998 | |
| 2999 | #### Example Output |
| 3000 | |
| 3001 | ~~~~ |
| 3002 | color filter unique: true |
| 3003 | color filter unique: false |
| 3004 | ~~~~ |
| 3005 | |
| 3006 | </fiddle-embed></div> |
| 3007 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3008 | <a name='SkPaint_setColorFilter'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3009 | |
| 3010 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3011 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3012 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 3013 | 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] | 3014 | </pre> |
| 3015 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3016 | Sets <a href='undocumented#Color_Filter'>Color Filter</a> to filter, decreasing <a href='undocumented#Reference_Count'>Reference Count</a> of the previous |
| 3017 | <a href='undocumented#Color_Filter'>Color Filter</a>. Pass nullptr to clear <a href='undocumented#Color_Filter'>Color Filter</a>. |
Cary Clark | 6fc5041 | 2017-09-21 12:31:06 -0400 | [diff] [blame] | 3018 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3019 | Increments filter <a href='undocumented#Reference_Count'>Reference Count</a> by one. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3020 | |
| 3021 | ### Parameters |
| 3022 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3023 | <table> <tr> <td><a name='SkPaint_setColorFilter_colorFilter'><code><strong>colorFilter</strong></code></a></td> |
| 3024 | <td><a href='undocumented#Color_Filter'>Color Filter</a> to apply to subsequent draw</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3025 | </tr> |
| 3026 | </table> |
| 3027 | |
| 3028 | ### Example |
| 3029 | |
skia-bookmaker | 61cc9fa | 2018-07-11 05:28:17 +0000 | [diff] [blame] | 3030 | <div><fiddle-embed name="c7b786dc9b3501cd0eaba47494b6fa31"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3031 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3032 | <a name='Blend_Mode_Methods'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3033 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3034 | --- |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 3035 | |
Cary Clark | 224c700 | 2018-06-27 11:00:21 -0400 | [diff] [blame] | 3036 | <a href='SkBlendMode_Reference#Blend_Mode'>Blend Mode</a> describes how <a href='SkColor_Reference#Color'>Color</a> combines with the destination color. |
| 3037 | The default setting, <a href='SkBlendMode_Reference#SkBlendMode_kSrcOver'>SkBlendMode::kSrcOver</a>, draws the source color |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3038 | over the destination color. |
| 3039 | |
| 3040 | ### Example |
| 3041 | |
Cary Clark | 8364706 | 2018-07-18 16:21:51 -0400 | [diff] [blame] | 3042 | <div><fiddle-embed name="73092d4d06faecea3c204d852a4dd8a8"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3043 | |
| 3044 | ### See Also |
| 3045 | |
Cary Clark | 224c700 | 2018-06-27 11:00:21 -0400 | [diff] [blame] | 3046 | <a href='SkBlendMode_Reference#Blend_Mode'>Blend Mode</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3047 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3048 | <a name='SkPaint_getBlendMode'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3049 | |
| 3050 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3051 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3052 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | 224c700 | 2018-06-27 11:00:21 -0400 | [diff] [blame] | 3053 | <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] | 3054 | </pre> |
| 3055 | |
Cary Clark | 224c700 | 2018-06-27 11:00:21 -0400 | [diff] [blame] | 3056 | Returns <a href='SkBlendMode_Reference#Blend_Mode'>Blend Mode</a>. |
| 3057 | By default, returns <a href='SkBlendMode_Reference#SkBlendMode_kSrcOver'>SkBlendMode::kSrcOver</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3058 | |
| 3059 | ### Return Value |
| 3060 | |
| 3061 | mode used to combine source color with destination color |
| 3062 | |
| 3063 | ### Example |
| 3064 | |
skia-bookmaker | 525f9a9 | 2018-05-03 06:27:39 +0000 | [diff] [blame] | 3065 | <div><fiddle-embed name="a1e059c8f6740fa2044cc64152b39dda"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3066 | |
| 3067 | #### Example Output |
| 3068 | |
| 3069 | ~~~~ |
| 3070 | kSrcOver == getBlendMode |
| 3071 | kSrcOver != getBlendMode |
| 3072 | ~~~~ |
| 3073 | |
| 3074 | </fiddle-embed></div> |
| 3075 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3076 | <a name='SkPaint_isSrcOver'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3077 | |
| 3078 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3079 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3080 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 3081 | bool <a href='#SkPaint_isSrcOver'>isSrcOver</a>() const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3082 | </pre> |
| 3083 | |
Cary Clark | 224c700 | 2018-06-27 11:00:21 -0400 | [diff] [blame] | 3084 | Returns true if <a href='SkBlendMode_Reference#Blend_Mode'>Blend Mode</a> is <a href='SkBlendMode_Reference#SkBlendMode_kSrcOver'>SkBlendMode::kSrcOver</a>, the default. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3085 | |
| 3086 | ### Return Value |
| 3087 | |
Cary Clark | 224c700 | 2018-06-27 11:00:21 -0400 | [diff] [blame] | 3088 | true if <a href='SkBlendMode_Reference#Blend_Mode'>Blend Mode</a> is <a href='SkBlendMode_Reference#SkBlendMode_kSrcOver'>SkBlendMode::kSrcOver</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3089 | |
| 3090 | ### Example |
| 3091 | |
| 3092 | <div><fiddle-embed name="257c9473db7a2b3a0fb2b9e2431e59a6"> |
| 3093 | |
| 3094 | #### Example Output |
| 3095 | |
| 3096 | ~~~~ |
| 3097 | isSrcOver == true |
| 3098 | isSrcOver != true |
| 3099 | ~~~~ |
| 3100 | |
| 3101 | </fiddle-embed></div> |
| 3102 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3103 | <a name='SkPaint_setBlendMode'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3104 | |
| 3105 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3106 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3107 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | 224c700 | 2018-06-27 11:00:21 -0400 | [diff] [blame] | 3108 | 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] | 3109 | </pre> |
| 3110 | |
Cary Clark | 224c700 | 2018-06-27 11:00:21 -0400 | [diff] [blame] | 3111 | Sets <a href='SkBlendMode_Reference#Blend_Mode'>Blend Mode</a> to <a href='#SkPaint_setBlendMode_mode'>mode</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3112 | Does not check for valid input. |
| 3113 | |
| 3114 | ### Parameters |
| 3115 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3116 | <table> <tr> <td><a name='SkPaint_setBlendMode_mode'><code><strong>mode</strong></code></a></td> |
Cary Clark | 224c700 | 2018-06-27 11:00:21 -0400 | [diff] [blame] | 3117 | <td><a href='SkBlendMode_Reference#SkBlendMode'>SkBlendMode</a> used to combine source color and destination</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3118 | </tr> |
| 3119 | </table> |
| 3120 | |
| 3121 | ### Example |
| 3122 | |
| 3123 | <div><fiddle-embed name="257c9473db7a2b3a0fb2b9e2431e59a6"> |
| 3124 | |
| 3125 | #### Example Output |
| 3126 | |
| 3127 | ~~~~ |
| 3128 | isSrcOver == true |
| 3129 | isSrcOver != true |
| 3130 | ~~~~ |
| 3131 | |
| 3132 | </fiddle-embed></div> |
| 3133 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3134 | <a name='Path_Effect_Methods'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3135 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3136 | --- |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 3137 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3138 | <a href='undocumented#Path_Effect'>Path Effect</a> modifies the path geometry before drawing it. |
| 3139 | <a href='undocumented#Path_Effect'>Path Effect</a> may implement dashing, custom fill effects and custom stroke effects. |
| 3140 | If <a href='#Paint'>Paint</a> has no <a href='undocumented#Path_Effect'>Path Effect</a>, the path geometry is unaltered when filled or stroked. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3141 | |
| 3142 | ### Example |
| 3143 | |
| 3144 | <div><fiddle-embed name="8cf5684b187d60f09e11c4a48993ea39"></fiddle-embed></div> |
| 3145 | |
| 3146 | ### See Also |
| 3147 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3148 | <a href='undocumented#Path_Effect'>Path Effect</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3149 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3150 | <a name='SkPaint_getPathEffect'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3151 | |
| 3152 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3153 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3154 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 3155 | <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] | 3156 | </pre> |
| 3157 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3158 | Returns <a href='undocumented#Path_Effect'>Path Effect</a> if set, or nullptr. |
| 3159 | Does not alter <a href='undocumented#Path_Effect'>Path Effect</a> <a href='undocumented#Reference_Count'>Reference Count</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3160 | |
| 3161 | ### Return Value |
| 3162 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3163 | <a href='undocumented#Path_Effect'>Path Effect</a> if previously set, nullptr otherwise |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3164 | |
| 3165 | ### Example |
| 3166 | |
skia-bookmaker | b95bbba | 2018-07-06 05:23:23 +0000 | [diff] [blame] | 3167 | <div><fiddle-embed name="211a1b14bfa6c4332082c8eab4fbc5fd"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3168 | |
| 3169 | #### Example Output |
| 3170 | |
| 3171 | ~~~~ |
| 3172 | nullptr == path effect |
| 3173 | nullptr != path effect |
| 3174 | ~~~~ |
| 3175 | |
| 3176 | </fiddle-embed></div> |
| 3177 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3178 | <a name='SkPaint_refPathEffect'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3179 | |
| 3180 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3181 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3182 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 3183 | <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] | 3184 | </pre> |
| 3185 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3186 | Returns <a href='undocumented#Path_Effect'>Path Effect</a> if set, or nullptr. |
| 3187 | Increases <a href='undocumented#Path_Effect'>Path Effect</a> <a href='undocumented#Reference_Count'>Reference Count</a> by one. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3188 | |
| 3189 | ### Return Value |
| 3190 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3191 | <a href='undocumented#Path_Effect'>Path Effect</a> if previously set, nullptr otherwise |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3192 | |
| 3193 | ### Example |
| 3194 | |
Cary Clark | 8364706 | 2018-07-18 16:21:51 -0400 | [diff] [blame] | 3195 | <div><fiddle-embed name="f56039b94c702c2704c8c5100e623aca"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3196 | |
| 3197 | #### Example Output |
| 3198 | |
| 3199 | ~~~~ |
| 3200 | path effect unique: true |
| 3201 | path effect unique: false |
| 3202 | ~~~~ |
| 3203 | |
| 3204 | </fiddle-embed></div> |
| 3205 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3206 | <a name='SkPaint_setPathEffect'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3207 | |
| 3208 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3209 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3210 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 3211 | 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] | 3212 | </pre> |
| 3213 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3214 | Sets <a href='undocumented#Path_Effect'>Path Effect</a> to <a href='#SkPaint_setPathEffect_pathEffect'>pathEffect</a>, decreasing <a href='undocumented#Reference_Count'>Reference Count</a> of the previous |
| 3215 | <a href='undocumented#Path_Effect'>Path Effect</a>. Pass nullptr to leave the path geometry unaltered. |
Cary Clark | 6fc5041 | 2017-09-21 12:31:06 -0400 | [diff] [blame] | 3216 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3217 | Increments <a href='#SkPaint_setPathEffect_pathEffect'>pathEffect</a> <a href='undocumented#Reference_Count'>Reference Count</a> by one. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3218 | |
| 3219 | ### Parameters |
| 3220 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3221 | <table> <tr> <td><a name='SkPaint_setPathEffect_pathEffect'><code><strong>pathEffect</strong></code></a></td> |
| 3222 | <td>replace <a href='SkPath_Reference#Path'>Path</a> with a modification when drawn</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3223 | </tr> |
| 3224 | </table> |
| 3225 | |
| 3226 | ### Example |
| 3227 | |
| 3228 | <div><fiddle-embed name="52dd55074ca0b7d520d04e750ca2a0d7"></fiddle-embed></div> |
| 3229 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3230 | <a name='Mask_Filter_Methods'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3231 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3232 | --- |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 3233 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3234 | <a href='undocumented#Mask_Filter'>Mask Filter</a> uses coverage of the shape drawn to create <a href='undocumented#Mask_Alpha'>Mask Alpha</a>. |
| 3235 | <a href='undocumented#Mask_Filter'>Mask Filter</a> takes a Mask, and returns a Mask. |
Cary Clark | 6fc5041 | 2017-09-21 12:31:06 -0400 | [diff] [blame] | 3236 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3237 | <a href='undocumented#Mask_Filter'>Mask Filter</a> may change the geometry and transparency of the shape, such as |
| 3238 | creating a blur effect. Set <a href='undocumented#Mask_Filter'>Mask Filter</a> to nullptr to prevent <a href='undocumented#Mask_Filter'>Mask Filter</a> from |
Cary Clark | 6fc5041 | 2017-09-21 12:31:06 -0400 | [diff] [blame] | 3239 | modifying the draw. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3240 | |
| 3241 | ### Example |
| 3242 | |
Cary Clark | 681287e | 2018-03-16 11:34:15 -0400 | [diff] [blame] | 3243 | <div><fiddle-embed name="55d7b9d482ac8e17a6153f555a8adb8d"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3244 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3245 | <a name='SkPaint_getMaskFilter'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3246 | |
| 3247 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3248 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3249 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 3250 | <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] | 3251 | </pre> |
| 3252 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3253 | Returns <a href='undocumented#Mask_Filter'>Mask Filter</a> if set, or nullptr. |
| 3254 | Does not alter <a href='undocumented#Mask_Filter'>Mask Filter</a> <a href='undocumented#Reference_Count'>Reference Count</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3255 | |
| 3256 | ### Return Value |
| 3257 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3258 | <a href='undocumented#Mask_Filter'>Mask Filter</a> if previously set, nullptr otherwise |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3259 | |
| 3260 | ### Example |
| 3261 | |
Cary Clark | 681287e | 2018-03-16 11:34:15 -0400 | [diff] [blame] | 3262 | <div><fiddle-embed name="5ac4b31371726da87bb7390b385e9fee"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3263 | |
| 3264 | #### Example Output |
| 3265 | |
| 3266 | ~~~~ |
| 3267 | nullptr == mask filter |
| 3268 | nullptr != mask filter |
| 3269 | ~~~~ |
| 3270 | |
| 3271 | </fiddle-embed></div> |
| 3272 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3273 | <a name='SkPaint_refMaskFilter'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3274 | |
| 3275 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3276 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3277 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 3278 | <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] | 3279 | </pre> |
| 3280 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3281 | Returns <a href='undocumented#Mask_Filter'>Mask Filter</a> if set, or nullptr. |
Cary Clark | 6fc5041 | 2017-09-21 12:31:06 -0400 | [diff] [blame] | 3282 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3283 | Increases <a href='undocumented#Mask_Filter'>Mask Filter</a> <a href='undocumented#Reference_Count'>Reference Count</a> by one. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3284 | |
| 3285 | ### Return Value |
| 3286 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3287 | <a href='undocumented#Mask_Filter'>Mask Filter</a> if previously set, nullptr otherwise |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3288 | |
| 3289 | ### Example |
| 3290 | |
Cary Clark | 8364706 | 2018-07-18 16:21:51 -0400 | [diff] [blame] | 3291 | <div><fiddle-embed name="084b0dc3cebd78718c651d58f257f799"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3292 | |
| 3293 | #### Example Output |
| 3294 | |
| 3295 | ~~~~ |
| 3296 | mask filter unique: true |
| 3297 | mask filter unique: false |
| 3298 | ~~~~ |
| 3299 | |
| 3300 | </fiddle-embed></div> |
| 3301 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3302 | <a name='SkPaint_setMaskFilter'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3303 | |
| 3304 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3305 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3306 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 3307 | 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] | 3308 | </pre> |
| 3309 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3310 | Sets <a href='undocumented#Mask_Filter'>Mask Filter</a> to <a href='#SkPaint_setMaskFilter_maskFilter'>maskFilter</a>, decreasing <a href='undocumented#Reference_Count'>Reference Count</a> of the previous |
| 3311 | <a href='undocumented#Mask_Filter'>Mask Filter</a>. Pass nullptr to clear <a href='undocumented#Mask_Filter'>Mask Filter</a> and leave <a href='undocumented#Mask_Filter'>Mask Filter</a> effect on |
| 3312 | <a href='undocumented#Mask_Alpha'>Mask Alpha</a> unaltered. |
Cary Clark | 6fc5041 | 2017-09-21 12:31:06 -0400 | [diff] [blame] | 3313 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3314 | Increments <a href='#SkPaint_setMaskFilter_maskFilter'>maskFilter</a> <a href='undocumented#Reference_Count'>Reference Count</a> by one. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3315 | |
| 3316 | ### Parameters |
| 3317 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3318 | <table> <tr> <td><a name='SkPaint_setMaskFilter_maskFilter'><code><strong>maskFilter</strong></code></a></td> |
| 3319 | <td>modifies clipping mask generated from drawn geometry</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3320 | </tr> |
| 3321 | </table> |
| 3322 | |
| 3323 | ### Example |
| 3324 | |
Cary Clark | 681287e | 2018-03-16 11:34:15 -0400 | [diff] [blame] | 3325 | <div><fiddle-embed name="a993831c40f3e134f809134e3b74e4a6"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3326 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3327 | <a name='Typeface_Methods'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3328 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3329 | --- |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 3330 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3331 | <a href='undocumented#Typeface'>Typeface</a> identifies the font used when drawing and measuring text. |
| 3332 | <a href='undocumented#Typeface'>Typeface</a> may be specified by name, from a file, or from a data stream. |
| 3333 | The default <a href='undocumented#Typeface'>Typeface</a> defers to the platform-specific default font |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3334 | implementation. |
| 3335 | |
| 3336 | ### Example |
| 3337 | |
skia-bookmaker | 61cc9fa | 2018-07-11 05:28:17 +0000 | [diff] [blame] | 3338 | <div><fiddle-embed name="1a7a5062725139760962582f599f1b97"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3339 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3340 | <a name='SkPaint_getTypeface'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3341 | |
| 3342 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3343 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3344 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 3345 | <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] | 3346 | </pre> |
| 3347 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3348 | Returns <a href='undocumented#Typeface'>Typeface</a> if set, or nullptr. |
Cary Clark | 81abc43 | 2018-06-25 16:30:08 -0400 | [diff] [blame] | 3349 | Does not alter <a href='undocumented#Typeface'>Typeface</a> <a href='undocumented#Reference_Count'>Reference Count</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3350 | |
| 3351 | ### Return Value |
| 3352 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3353 | <a href='undocumented#Typeface'>Typeface</a> if previously set, nullptr otherwise |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3354 | |
| 3355 | ### Example |
| 3356 | |
Cary Clark | f960398 | 2018-07-17 08:20:27 -0400 | [diff] [blame] | 3357 | <div><fiddle-embed name="5ce718e5a184baaac80e7098d7dad67b"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3358 | |
| 3359 | #### Example Output |
| 3360 | |
| 3361 | ~~~~ |
| 3362 | nullptr == typeface |
| 3363 | nullptr != typeface |
| 3364 | ~~~~ |
| 3365 | |
| 3366 | </fiddle-embed></div> |
| 3367 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3368 | <a name='SkPaint_refTypeface'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3369 | |
| 3370 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3371 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3372 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 3373 | <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] | 3374 | </pre> |
| 3375 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3376 | Increases <a href='undocumented#Typeface'>Typeface</a> <a href='undocumented#Reference_Count'>Reference Count</a> by one. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3377 | |
| 3378 | ### Return Value |
| 3379 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3380 | <a href='undocumented#Typeface'>Typeface</a> if previously set, nullptr otherwise |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3381 | |
| 3382 | ### Example |
| 3383 | |
Cary Clark | 8364706 | 2018-07-18 16:21:51 -0400 | [diff] [blame] | 3384 | <div><fiddle-embed name="8b5aa7e555a0dc31be69db7cadf471a1"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3385 | |
| 3386 | #### Example Output |
| 3387 | |
| 3388 | ~~~~ |
| 3389 | typeface1 != typeface2 |
| 3390 | typeface1 == typeface2 |
| 3391 | ~~~~ |
| 3392 | |
| 3393 | </fiddle-embed></div> |
| 3394 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3395 | <a name='SkPaint_setTypeface'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3396 | |
| 3397 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3398 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3399 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 3400 | void <a href='#SkPaint_setTypeface'>setTypeface</a>(<a href='undocumented#sk_sp'>sk sp</a><<a href='undocumented#SkTypeface'>SkTypeface</a>> typeface) |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3401 | </pre> |
| 3402 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3403 | Sets <a href='undocumented#Typeface'>Typeface</a> to <a href='#SkPaint_setTypeface_typeface'>typeface</a>, decreasing <a href='undocumented#Reference_Count'>Reference Count</a> of the previous <a href='undocumented#Typeface'>Typeface</a>. |
| 3404 | Pass nullptr to clear <a href='undocumented#Typeface'>Typeface</a> and use the default <a href='#SkPaint_setTypeface_typeface'>typeface</a>. Increments |
| 3405 | <a href='#SkPaint_setTypeface_typeface'>typeface</a> <a href='undocumented#Reference_Count'>Reference Count</a> by one. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3406 | |
| 3407 | ### Parameters |
| 3408 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3409 | <table> <tr> <td><a name='SkPaint_setTypeface_typeface'><code><strong>typeface</strong></code></a></td> |
| 3410 | <td>font and style used to draw text</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3411 | </tr> |
| 3412 | </table> |
| 3413 | |
| 3414 | ### Example |
| 3415 | |
Cary Clark | 71961fb | 2018-01-05 14:21:59 -0500 | [diff] [blame] | 3416 | <div><fiddle-embed name="0e6fbb7773cd925b274552f4cd1abef2"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3417 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3418 | <a name='Image_Filter_Methods'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3419 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3420 | --- |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 3421 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3422 | <a href='undocumented#Image_Filter'>Image Filter</a> operates on the pixel representation of the shape, as modified by <a href='#Paint'>Paint</a> |
Cary Clark | 224c700 | 2018-06-27 11:00:21 -0400 | [diff] [blame] | 3423 | with <a href='SkBlendMode_Reference#Blend_Mode'>Blend Mode</a> set to <a href='SkBlendMode_Reference#SkBlendMode_kSrcOver'>SkBlendMode::kSrcOver</a>. <a href='undocumented#Image_Filter'>Image Filter</a> creates a new bitmap, |
| 3424 | which is drawn to the device using the set <a href='SkBlendMode_Reference#Blend_Mode'>Blend Mode</a>. |
Cary Clark | 6fc5041 | 2017-09-21 12:31:06 -0400 | [diff] [blame] | 3425 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3426 | <a href='undocumented#Image_Filter'>Image Filter</a> is higher level than <a href='undocumented#Mask_Filter'>Mask Filter</a>; for instance, an <a href='undocumented#Image_Filter'>Image Filter</a> |
| 3427 | can operate on all channels of <a href='SkColor_Reference#Color'>Color</a>, while <a href='undocumented#Mask_Filter'>Mask Filter</a> generates <a href='SkColor_Reference#Alpha'>Alpha</a> only. |
| 3428 | <a href='undocumented#Image_Filter'>Image Filter</a> operates independently of and can be used in combination with |
| 3429 | <a href='undocumented#Mask_Filter'>Mask Filter</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3430 | |
| 3431 | ### Example |
| 3432 | |
skia-bookmaker | 44bad2e | 2018-07-05 05:35:27 +0000 | [diff] [blame] | 3433 | <div><fiddle-embed name="ece04ee3d3761e3425f37c8f06f054c1"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3434 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3435 | <a name='SkPaint_getImageFilter'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3436 | |
| 3437 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3438 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3439 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 3440 | <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] | 3441 | </pre> |
| 3442 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3443 | Returns <a href='undocumented#Image_Filter'>Image Filter</a> if set, or nullptr. |
| 3444 | Does not alter <a href='undocumented#Image_Filter'>Image Filter</a> <a href='undocumented#Reference_Count'>Reference Count</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3445 | |
| 3446 | ### Return Value |
| 3447 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3448 | <a href='undocumented#Image_Filter'>Image Filter</a> if previously set, nullptr otherwise |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3449 | |
| 3450 | ### Example |
| 3451 | |
skia-bookmaker | b95bbba | 2018-07-06 05:23:23 +0000 | [diff] [blame] | 3452 | <div><fiddle-embed name="c11f8eaa1dd149bc18db21e23ce26904"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3453 | |
| 3454 | #### Example Output |
| 3455 | |
| 3456 | ~~~~ |
| 3457 | nullptr == image filter |
| 3458 | nullptr != image filter |
| 3459 | ~~~~ |
| 3460 | |
| 3461 | </fiddle-embed></div> |
| 3462 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3463 | <a name='SkPaint_refImageFilter'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3464 | |
| 3465 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3466 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3467 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 3468 | <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] | 3469 | </pre> |
| 3470 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3471 | Returns <a href='undocumented#Image_Filter'>Image Filter</a> if set, or nullptr. |
| 3472 | Increases <a href='undocumented#Image_Filter'>Image Filter</a> <a href='undocumented#Reference_Count'>Reference Count</a> by one. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3473 | |
| 3474 | ### Return Value |
| 3475 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3476 | <a href='undocumented#Image_Filter'>Image Filter</a> if previously set, nullptr otherwise |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3477 | |
| 3478 | ### Example |
| 3479 | |
| 3480 | <div><fiddle-embed name="13f09088b569251547107d14ae989dc1"> |
| 3481 | |
| 3482 | #### Example Output |
| 3483 | |
| 3484 | ~~~~ |
| 3485 | image filter unique: true |
| 3486 | image filter unique: false |
| 3487 | ~~~~ |
| 3488 | |
| 3489 | </fiddle-embed></div> |
| 3490 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3491 | <a name='SkPaint_setImageFilter'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3492 | |
| 3493 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3494 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3495 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 3496 | 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] | 3497 | </pre> |
| 3498 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3499 | Sets <a href='undocumented#Image_Filter'>Image Filter</a> to <a href='#SkPaint_setImageFilter_imageFilter'>imageFilter</a>, decreasing <a href='undocumented#Reference_Count'>Reference Count</a> of the previous |
| 3500 | <a href='undocumented#Image_Filter'>Image Filter</a>. Pass nullptr to clear <a href='undocumented#Image_Filter'>Image Filter</a>, and remove <a href='undocumented#Image_Filter'>Image Filter</a> effect |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3501 | on drawing. |
Cary Clark | 6fc5041 | 2017-09-21 12:31:06 -0400 | [diff] [blame] | 3502 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3503 | Increments <a href='#SkPaint_setImageFilter_imageFilter'>imageFilter</a> <a href='undocumented#Reference_Count'>Reference Count</a> by one. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3504 | |
| 3505 | ### Parameters |
| 3506 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3507 | <table> <tr> <td><a name='SkPaint_setImageFilter_imageFilter'><code><strong>imageFilter</strong></code></a></td> |
| 3508 | <td>how <a href='SkImage_Reference#Image'>Image</a> is sampled when transformed</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3509 | </tr> |
| 3510 | </table> |
| 3511 | |
| 3512 | ### Example |
| 3513 | |
| 3514 | <div><fiddle-embed name="6679d6e4ec632715ee03e68391bd7f9a"></fiddle-embed></div> |
| 3515 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3516 | <a name='Draw_Looper_Methods'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3517 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3518 | --- |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 3519 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3520 | <a href='undocumented#Draw_Looper'>Draw Looper</a> sets a modifier that communicates state from one <a href='undocumented#Draw_Layer'>Draw Layer</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3521 | to another to construct the draw. |
Cary Clark | 6fc5041 | 2017-09-21 12:31:06 -0400 | [diff] [blame] | 3522 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3523 | <a href='undocumented#Draw_Looper'>Draw Looper</a> draws one or more times, modifying the canvas and paint each time. |
| 3524 | <a href='undocumented#Draw_Looper'>Draw Looper</a> may be used to draw multiple colors or create a colored shadow. |
| 3525 | Set <a href='undocumented#Draw_Looper'>Draw Looper</a> to nullptr to prevent <a href='undocumented#Draw_Looper'>Draw Looper</a> from modifying the draw. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3526 | |
| 3527 | ### Example |
| 3528 | |
| 3529 | <div><fiddle-embed name="84ec12a36e50df5ac565cc7a75ffbe9f"></fiddle-embed></div> |
| 3530 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3531 | <a name='SkPaint_getDrawLooper'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3532 | |
| 3533 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3534 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3535 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 3536 | <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] | 3537 | </pre> |
| 3538 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3539 | Returns <a href='undocumented#Draw_Looper'>Draw Looper</a> if set, or nullptr. |
| 3540 | Does not alter <a href='undocumented#Draw_Looper'>Draw Looper</a> <a href='undocumented#Reference_Count'>Reference Count</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3541 | |
| 3542 | ### Return Value |
| 3543 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3544 | <a href='undocumented#Draw_Looper'>Draw Looper</a> if previously set, nullptr otherwise |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3545 | |
| 3546 | ### Example |
| 3547 | |
| 3548 | <div><fiddle-embed name="af4c5acc7a91e7f23c2af48018903ad4"> |
| 3549 | |
| 3550 | #### Example Output |
| 3551 | |
| 3552 | ~~~~ |
| 3553 | nullptr == draw looper |
| 3554 | nullptr != draw looper |
| 3555 | ~~~~ |
| 3556 | |
| 3557 | </fiddle-embed></div> |
| 3558 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3559 | <a name='SkPaint_refDrawLooper'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3560 | |
| 3561 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3562 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3563 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 3564 | <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] | 3565 | </pre> |
| 3566 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3567 | Returns <a href='undocumented#Draw_Looper'>Draw Looper</a> if set, or nullptr. |
| 3568 | Increases <a href='undocumented#Draw_Looper'>Draw Looper</a> <a href='undocumented#Reference_Count'>Reference Count</a> by one. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3569 | |
| 3570 | ### Return Value |
| 3571 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3572 | <a href='undocumented#Draw_Looper'>Draw Looper</a> if previously set, nullptr otherwise |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3573 | |
| 3574 | ### Example |
| 3575 | |
| 3576 | <div><fiddle-embed name="2a3782c33f04ed17a725d0e449c6f7c3"> |
| 3577 | |
| 3578 | #### Example Output |
| 3579 | |
| 3580 | ~~~~ |
| 3581 | draw looper unique: true |
| 3582 | draw looper unique: false |
| 3583 | ~~~~ |
| 3584 | |
| 3585 | </fiddle-embed></div> |
| 3586 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3587 | <a name='SkPaint_getLooper'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3588 | |
| 3589 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3590 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3591 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 3592 | <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] | 3593 | </pre> |
| 3594 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3595 | Deprecated. |
| 3596 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3597 | <a name='SkPaint_setDrawLooper'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3598 | |
| 3599 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3600 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3601 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 3602 | void <a href='#SkPaint_setDrawLooper'>setDrawLooper</a>(<a href='undocumented#sk_sp'>sk sp</a><<a href='undocumented#SkDrawLooper'>SkDrawLooper</a>> drawLooper) |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3603 | </pre> |
| 3604 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3605 | Sets <a href='undocumented#Draw_Looper'>Draw Looper</a> to <a href='#SkPaint_setDrawLooper_drawLooper'>drawLooper</a>, decreasing <a href='undocumented#Reference_Count'>Reference Count</a> of the previous |
| 3606 | <a href='#SkPaint_setDrawLooper_drawLooper'>drawLooper</a>. Pass nullptr to clear <a href='undocumented#Draw_Looper'>Draw Looper</a> and leave <a href='undocumented#Draw_Looper'>Draw Looper</a> effect on |
Cary Clark | 6fc5041 | 2017-09-21 12:31:06 -0400 | [diff] [blame] | 3607 | drawing unaltered. |
| 3608 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3609 | Increments <a href='#SkPaint_setDrawLooper_drawLooper'>drawLooper</a> <a href='undocumented#Reference_Count'>Reference Count</a> by one. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3610 | |
| 3611 | ### Parameters |
| 3612 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3613 | <table> <tr> <td><a name='SkPaint_setDrawLooper_drawLooper'><code><strong>drawLooper</strong></code></a></td> |
| 3614 | <td>iterates through drawing one or more time, altering <a href='#Paint'>Paint</a></td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3615 | </tr> |
| 3616 | </table> |
| 3617 | |
| 3618 | ### Example |
| 3619 | |
| 3620 | <div><fiddle-embed name="bf10f838b330f0a3a3266d42ea68a638"></fiddle-embed></div> |
| 3621 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3622 | <a name='SkPaint_setLooper'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3623 | |
| 3624 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3625 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3626 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 3627 | 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] | 3628 | </pre> |
| 3629 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3630 | Deprecated. |
| 3631 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3632 | <a name='Text_Align'></a> |
| 3633 | |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3634 | --- |
| 3635 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3636 | <a name='SkPaint_Align'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3637 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3638 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3639 | |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 3640 | <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] | 3641 | enum <a href='#SkPaint_Align'>Align</a> { |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 3642 | <a href='#SkPaint_kLeft_Align'>kLeft_Align</a>, |
| 3643 | <a href='#SkPaint_kCenter_Align'>kCenter_Align</a>, |
| 3644 | <a href='#SkPaint_kRight_Align'>kRight_Align</a>, |
Cary Clark | 186d08f | 2018-04-03 08:43:27 -0400 | [diff] [blame] | 3645 | }; |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3646 | </pre> |
Cary Clark | d98f78c | 2018-04-26 08:32:37 -0400 | [diff] [blame] | 3647 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3648 | <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] | 3649 | static constexpr int <a href='#SkPaint_kAlignCount'>kAlignCount</a> = 3; |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 3650 | </pre> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3651 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3652 | <a href='#SkPaint_Align'>Align</a> adjusts the text relative to the text position. |
| 3653 | <a href='#SkPaint_Align'>Align</a> affects <a href='undocumented#Glyph'>Glyphs</a> drawn with: <a href='SkCanvas_Reference#SkCanvas_drawText'>SkCanvas::drawText</a>, <a href='SkCanvas_Reference#SkCanvas_drawPosText'>SkCanvas::drawPosText</a>, |
Cary Clark | 153e76d | 2018-08-28 11:48:28 -0400 | [diff] [blame] | 3654 | <a href='SkCanvas_Reference#SkCanvas_drawPosTextH'>SkCanvas::drawPosTextH</a>, <a href='SkCanvas_Reference#SkCanvas_drawTextRSXform'>SkCanvas::drawTextRSXform</a>, <a href='SkCanvas_Reference#SkCanvas_drawTextBlob'>SkCanvas::drawTextBlob</a>, |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3655 | and <a href='SkCanvas_Reference#SkCanvas_drawString'>SkCanvas::drawString</a>; |
| 3656 | as well as calls that place text <a href='undocumented#Glyph'>Glyphs</a> like <a href='#SkPaint_getTextWidths'>getTextWidths</a> and <a href='#SkPaint_getTextPath'>getTextPath</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3657 | |
| 3658 | The text position is set by the font for both horizontal and vertical text. |
| 3659 | Typically, for horizontal text, the position is to the left side of the glyph on the |
| 3660 | base line; and for vertical text, the position is the horizontal center of the glyph |
| 3661 | at the caps height. |
| 3662 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3663 | <a href='#SkPaint_Align'>Align</a> adjusts the glyph position to center it or move it to abut the position |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3664 | using the metrics returned by the font. |
| 3665 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3666 | <a href='#SkPaint_Align'>Align</a> defaults to <a href='#SkPaint_kLeft_Align'>kLeft Align</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3667 | |
| 3668 | ### Constants |
| 3669 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3670 | <table style='border-collapse: collapse; width: 62.5em'> |
| 3671 | <tr><th style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>Const</th> |
| 3672 | <th style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>Value</th> |
| 3673 | <th style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>Description</th></tr> |
| 3674 | <tr style='background-color: #f0f0f0; '> |
| 3675 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kLeft_Align'><code>SkPaint::kLeft_Align</code></a></td> |
| 3676 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>0</td> |
| 3677 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 3678 | Leaves the glyph at the position computed by the font offset by the text position. |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 3679 | </td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3680 | </tr> |
| 3681 | <tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3682 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kCenter_Align'><code>SkPaint::kCenter_Align</code></a></td> |
| 3683 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>1</td> |
| 3684 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
Cary Clark | 3aca39d | 2018-10-23 14:44:05 -0400 | [diff] [blame] | 3685 | Moves the glyph half its width. |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3686 | </td> |
| 3687 | </tr> |
| 3688 | <tr style='background-color: #f0f0f0; '> |
| 3689 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kRight_Align'><code>SkPaint::kRight_Align</code></a></td> |
| 3690 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>2</td> |
| 3691 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
Cary Clark | 3aca39d | 2018-10-23 14:44:05 -0400 | [diff] [blame] | 3692 | Moves the glyph by its width. |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 3693 | </td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3694 | </tr> |
| 3695 | <tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3696 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kAlignCount'><code>SkPaint::kAlignCount</code></a></td> |
| 3697 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>3</td> |
| 3698 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
Cary Clark | 137b874 | 2018-05-30 09:21:49 -0400 | [diff] [blame] | 3699 | May be used to verify that <a href='#SkPaint_Align'>Align</a> is a legal value. |
| 3700 | </td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3701 | </tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3702 | </table> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3703 | |
| 3704 | ### Example |
| 3705 | |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 3706 | <div><fiddle-embed name="702617fd9ebc3f12e30081b5db93e8a8"><div>Each position separately moves the glyph in drawPosText. |
| 3707 | </div></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3708 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3709 | <a name='SkPaint_getTextAlign'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3710 | |
| 3711 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3712 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3713 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 3714 | <a href='#SkPaint_Align'>Align</a> <a href='#SkPaint_getTextAlign'>getTextAlign</a>() const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3715 | </pre> |
| 3716 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3717 | Returns <a href='#Text_Align'>Text Align</a>. |
| 3718 | Returns <a href='#SkPaint_kLeft_Align'>kLeft Align</a> if <a href='#Text_Align'>Text Align</a> has not been set. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3719 | |
| 3720 | ### Return Value |
| 3721 | |
| 3722 | text placement relative to position |
| 3723 | |
| 3724 | ### Example |
| 3725 | |
| 3726 | <div><fiddle-embed name="2df932f526e810f74c89d30ec3f4c947"> |
| 3727 | |
| 3728 | #### Example Output |
| 3729 | |
| 3730 | ~~~~ |
| 3731 | kLeft_Align == default |
| 3732 | ~~~~ |
| 3733 | |
| 3734 | </fiddle-embed></div> |
| 3735 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3736 | <a name='SkPaint_setTextAlign'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3737 | |
| 3738 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3739 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3740 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 3741 | void <a href='#SkPaint_setTextAlign'>setTextAlign</a>(<a href='#SkPaint_Align'>Align</a> align) |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3742 | </pre> |
| 3743 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3744 | Sets <a href='#Text_Align'>Text Align</a> to <a href='#SkPaint_setTextAlign_align'>align</a>. |
| 3745 | Has no effect if <a href='#SkPaint_setTextAlign_align'>align</a> is an invalid value. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3746 | |
| 3747 | ### Parameters |
| 3748 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3749 | <table> <tr> <td><a name='SkPaint_setTextAlign_align'><code><strong>align</strong></code></a></td> |
| 3750 | <td>text placement relative to position</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3751 | </tr> |
| 3752 | </table> |
| 3753 | |
| 3754 | ### Example |
| 3755 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3756 | <div><fiddle-embed name="d37540afd918506ac2594665ca63979b"><div><a href='undocumented#Text'>Text</a> is left-aligned by default, and then set to center. Setting the |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 3757 | alignment out of range has no effect. |
| 3758 | </div></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3759 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3760 | <a name='Text_Size'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3761 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3762 | --- |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 3763 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3764 | <a href='#Text_Size'>Text Size</a> adjusts the overall text size in points. |
| 3765 | <a href='#Text_Size'>Text Size</a> can be set to any positive value or zero. |
| 3766 | <a href='#Text_Size'>Text Size</a> defaults to 12. |
| 3767 | 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] | 3768 | |
| 3769 | ### Example |
| 3770 | |
| 3771 | <div><fiddle-embed name="91c9a3e498bb9412e4522a95d076ed5f"></fiddle-embed></div> |
| 3772 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3773 | <a name='SkPaint_getTextSize'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3774 | |
| 3775 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3776 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3777 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 3778 | <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] | 3779 | </pre> |
| 3780 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3781 | Returns <a href='#Text_Size'>Text Size</a> in points. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3782 | |
| 3783 | ### Return Value |
| 3784 | |
| 3785 | typographic height of text |
| 3786 | |
| 3787 | ### Example |
| 3788 | |
skia-bookmaker | 233c652 | 2018-07-04 05:33:26 +0000 | [diff] [blame] | 3789 | <div><fiddle-embed name="983e2a71ba72d4ba8c945420040b8f1c"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3790 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3791 | <a name='SkPaint_setTextSize'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3792 | |
| 3793 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3794 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3795 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 3796 | 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] | 3797 | </pre> |
| 3798 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3799 | Sets <a href='#Text_Size'>Text Size</a> in points. |
| 3800 | 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] | 3801 | |
| 3802 | ### Parameters |
| 3803 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3804 | <table> <tr> <td><a name='SkPaint_setTextSize_textSize'><code><strong>textSize</strong></code></a></td> |
| 3805 | <td>typographic height of text</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3806 | </tr> |
| 3807 | </table> |
| 3808 | |
| 3809 | ### Example |
| 3810 | |
skia-bookmaker | 44bad2e | 2018-07-05 05:35:27 +0000 | [diff] [blame] | 3811 | <div><fiddle-embed name="6510c9e2f57b83c47e67829e7a68d493"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3812 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3813 | <a name='Text_Scale_X'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3814 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3815 | --- |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 3816 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3817 | <a href='#Text_Scale_X'>Text Scale X</a> adjusts the text horizontal scale. |
| 3818 | <a href='undocumented#Text'>Text</a> scaling approximates condensed and expanded type faces when the actual face |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3819 | is not available. |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3820 | <a href='#Text_Scale_X'>Text Scale X</a> can be set to any value. |
| 3821 | <a href='#Text_Scale_X'>Text Scale X</a> defaults to 1. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3822 | |
| 3823 | ### Example |
| 3824 | |
skia-bookmaker | 44bad2e | 2018-07-05 05:35:27 +0000 | [diff] [blame] | 3825 | <div><fiddle-embed name="d13d787c1e36f515319fc998411c1d91"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3826 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3827 | <a name='SkPaint_getTextScaleX'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3828 | |
| 3829 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3830 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3831 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 3832 | <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] | 3833 | </pre> |
| 3834 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3835 | Returns <a href='#Text_Scale_X'>Text Scale X</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3836 | Default value is 1. |
| 3837 | |
| 3838 | ### Return Value |
| 3839 | |
| 3840 | text horizontal scale |
| 3841 | |
| 3842 | ### Example |
| 3843 | |
| 3844 | <div><fiddle-embed name="5dc8e58f6910cb8e4de9ed60f888188b"></fiddle-embed></div> |
| 3845 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3846 | <a name='SkPaint_setTextScaleX'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3847 | |
| 3848 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3849 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3850 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 3851 | 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] | 3852 | </pre> |
| 3853 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3854 | Sets <a href='#Text_Scale_X'>Text Scale X</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3855 | Default value is 1. |
| 3856 | |
| 3857 | ### Parameters |
| 3858 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3859 | <table> <tr> <td><a name='SkPaint_setTextScaleX_scaleX'><code><strong>scaleX</strong></code></a></td> |
| 3860 | <td>text horizontal scale</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3861 | </tr> |
| 3862 | </table> |
| 3863 | |
| 3864 | ### Example |
| 3865 | |
| 3866 | <div><fiddle-embed name="a75bbdb8bb866b125c4c1dd5e967d470"></fiddle-embed></div> |
| 3867 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3868 | <a name='Text_Skew_X'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3869 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3870 | --- |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 3871 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3872 | <a href='#Text_Skew_X'>Text Skew X</a> adjusts the text horizontal slant. |
| 3873 | <a href='undocumented#Text'>Text</a> skewing approximates italic and oblique type faces when the actual face |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3874 | is not available. |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3875 | <a href='#Text_Skew_X'>Text Skew X</a> can be set to any value. |
| 3876 | <a href='#Text_Skew_X'>Text Skew X</a> defaults to 0. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3877 | |
| 3878 | ### Example |
| 3879 | |
| 3880 | <div><fiddle-embed name="aff208b0aab265f273045b27e683c17c"></fiddle-embed></div> |
| 3881 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3882 | <a name='SkPaint_getTextSkewX'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3883 | |
| 3884 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3885 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3886 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 3887 | <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] | 3888 | </pre> |
| 3889 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3890 | Returns <a href='#Text_Skew_X'>Text Skew X</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3891 | Default value is zero. |
| 3892 | |
| 3893 | ### Return Value |
| 3894 | |
| 3895 | additional shear in x-axis relative to y-axis |
| 3896 | |
| 3897 | ### Example |
| 3898 | |
Cary Clark | 7f644ec | 2018-07-19 10:50:44 -0400 | [diff] [blame] | 3899 | <div><fiddle-embed name="11c10f466dae0d1639dbb9f6a0040218"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3900 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3901 | <a name='SkPaint_setTextSkewX'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3902 | |
| 3903 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3904 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3905 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 3906 | 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] | 3907 | </pre> |
| 3908 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3909 | Sets <a href='#Text_Skew_X'>Text Skew X</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3910 | Default value is zero. |
| 3911 | |
| 3912 | ### Parameters |
| 3913 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3914 | <table> <tr> <td><a name='SkPaint_setTextSkewX_skewX'><code><strong>skewX</strong></code></a></td> |
| 3915 | <td>additional shear in x-axis relative to y-axis</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3916 | </tr> |
| 3917 | </table> |
| 3918 | |
| 3919 | ### Example |
| 3920 | |
skia-bookmaker | 61cc9fa | 2018-07-11 05:28:17 +0000 | [diff] [blame] | 3921 | <div><fiddle-embed name="6bd705a6e0c5f8ee24f302fe531bfabc"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3922 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3923 | <a name='Text_Encoding'></a> |
| 3924 | |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3925 | --- |
| 3926 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3927 | <a name='SkPaint_TextEncoding'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3928 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3929 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3930 | |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 3931 | <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] | 3932 | enum <a href='#SkPaint_TextEncoding'>TextEncoding</a> { |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 3933 | <a href='#SkPaint_kUTF8_TextEncoding'>kUTF8_TextEncoding</a>, |
| 3934 | <a href='#SkPaint_kUTF16_TextEncoding'>kUTF16_TextEncoding</a>, |
| 3935 | <a href='#SkPaint_kUTF32_TextEncoding'>kUTF32_TextEncoding</a>, |
| 3936 | <a href='#SkPaint_kGlyphID_TextEncoding'>kGlyphID_TextEncoding</a>, |
Cary Clark | 186d08f | 2018-04-03 08:43:27 -0400 | [diff] [blame] | 3937 | }; |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 3938 | </pre> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3939 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3940 | <a href='#SkPaint_TextEncoding'>TextEncoding</a> determines whether text specifies character codes and their encoded |
| 3941 | size, or glyph indices. Characters are encoded as specified by the <a href='https://unicode.org/standard/standard.html'>Unicode standard</a></a> . |
Cary Clark | 6fc5041 | 2017-09-21 12:31:06 -0400 | [diff] [blame] | 3942 | |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 3943 | Character codes encoded size are specified by UTF-8, UTF-16, or UTF-32. |
Cary Clark | 7cfcbca | 2018-01-04 16:11:51 -0500 | [diff] [blame] | 3944 | All character code formats are able to represent all of Unicode, differing only |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3945 | in the total storage required. |
| 3946 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3947 | <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] | 3948 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3949 | <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] | 3950 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3951 | <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] | 3952 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3953 | <a href='undocumented#Font_Manager'>Font Manager</a> uses font data to convert character code points into glyph indices. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3954 | A glyph index is a 16-bit word. |
| 3955 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3956 | <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] | 3957 | |
| 3958 | ### Constants |
| 3959 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3960 | <table style='border-collapse: collapse; width: 62.5em'> |
| 3961 | <tr><th style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>Const</th> |
| 3962 | <th style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>Value</th> |
| 3963 | <th style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>Description</th></tr> |
| 3964 | <tr style='background-color: #f0f0f0; '> |
| 3965 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kUTF8_TextEncoding'><code>SkPaint::kUTF8_TextEncoding</code></a></td> |
| 3966 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>0</td> |
| 3967 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 3968 | uses bytes to represent UTF-8 or ASCII</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3969 | </tr> |
| 3970 | <tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3971 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kUTF16_TextEncoding'><code>SkPaint::kUTF16_TextEncoding</code></a></td> |
| 3972 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>1</td> |
| 3973 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 3974 | uses two byte words to represent most of Unicode</td> |
| 3975 | </tr> |
| 3976 | <tr style='background-color: #f0f0f0; '> |
| 3977 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kUTF32_TextEncoding'><code>SkPaint::kUTF32_TextEncoding</code></a></td> |
| 3978 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>2</td> |
| 3979 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 3980 | uses four byte words to represent all of Unicode</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3981 | </tr> |
| 3982 | <tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3983 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kGlyphID_TextEncoding'><code>SkPaint::kGlyphID_TextEncoding</code></a></td> |
| 3984 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>3</td> |
| 3985 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 3986 | uses two byte words to represent glyph indices</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3987 | </tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3988 | </table> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3989 | |
| 3990 | ### Example |
| 3991 | |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 3992 | <div><fiddle-embed name="b29294e7f29d160a1b46abf2dcec9d2a"><div>First line is encoded in UTF-8. |
| 3993 | Second line is encoded in UTF-16. |
| 3994 | Third line is encoded in UTF-32. |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3995 | Fourth line has 16-bit glyph indices. |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 3996 | </div></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3997 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3998 | <a name='SkPaint_getTextEncoding'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 3999 | |
| 4000 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4001 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4002 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 4003 | <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] | 4004 | </pre> |
| 4005 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4006 | Returns <a href='#Text_Encoding'>Text Encoding</a>. |
| 4007 | <a href='#Text_Encoding'>Text Encoding</a> determines how character code points are mapped to font glyph indices. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4008 | |
| 4009 | ### Return Value |
| 4010 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4011 | 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 |
| 4012 | <a href='#SkPaint_kGlyphID_TextEncoding'>kGlyphID TextEncoding</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4013 | |
| 4014 | ### Example |
| 4015 | |
skia-bookmaker | 525f9a9 | 2018-05-03 06:27:39 +0000 | [diff] [blame] | 4016 | <div><fiddle-embed name="c6cc2780a9828b3af8c4621c12b29a1b"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4017 | |
| 4018 | #### Example Output |
| 4019 | |
| 4020 | ~~~~ |
| 4021 | kUTF8_TextEncoding == text encoding |
| 4022 | kGlyphID_TextEncoding == text encoding |
| 4023 | ~~~~ |
| 4024 | |
| 4025 | </fiddle-embed></div> |
| 4026 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4027 | <a name='SkPaint_setTextEncoding'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 4028 | |
| 4029 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4030 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4031 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 4032 | 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] | 4033 | </pre> |
| 4034 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4035 | Sets <a href='#Text_Encoding'>Text Encoding</a> to <a href='#SkPaint_setTextEncoding_encoding'>encoding</a>. |
| 4036 | <a href='#Text_Encoding'>Text Encoding</a> determines how character code points are mapped to font glyph indices. |
| 4037 | Invalid values for <a href='#SkPaint_setTextEncoding_encoding'>encoding</a> are ignored. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4038 | |
| 4039 | ### Parameters |
| 4040 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4041 | <table> <tr> <td><a name='SkPaint_setTextEncoding_encoding'><code><strong>encoding</strong></code></a></td> |
| 4042 | <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 |
| 4043 | <a href='#SkPaint_kGlyphID_TextEncoding'>kGlyphID TextEncoding</a></td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4044 | </tr> |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 4045 | # |
| 4046 | |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4047 | </table> |
| 4048 | |
| 4049 | ### Example |
| 4050 | |
Cary Clark | 75fd449 | 2018-06-20 12:45:16 -0400 | [diff] [blame] | 4051 | <div><fiddle-embed name="6d9ffdd3c5543e9f12972a06dd4a0ce5"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4052 | |
| 4053 | #### Example Output |
| 4054 | |
| 4055 | ~~~~ |
| 4056 | 4 != text encoding |
| 4057 | ~~~~ |
| 4058 | |
| 4059 | </fiddle-embed></div> |
| 4060 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 4061 | <a name='Font_Metrics'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4062 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 4063 | --- |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 4064 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4065 | <a href='#Font_Metrics'>Font Metrics</a> describe dimensions common to the <a href='undocumented#Glyph'>Glyphs</a> in <a href='undocumented#Typeface'>Typeface</a>. |
| 4066 | The dimensions are computed by <a href='undocumented#Font_Manager'>Font Manager</a> from font data and do not take |
| 4067 | <a href='#Paint'>Paint</a> settings other than <a href='#Text_Size'>Text Size</a> into account. |
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 href='undocumented#Font'>Font</a> dimensions specify the anchor to the left of the glyph at baseline as the origin. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4070 | X-axis values to the left of the glyph are negative, and to the right of the left glyph edge |
| 4071 | are positive. |
| 4072 | Y-axis values above the baseline are negative, and below the baseline are positive. |
| 4073 | |
| 4074 | ### Example |
| 4075 | |
Ben Wagner | e580649 | 2017-11-09 12:08:31 -0500 | [diff] [blame] | 4076 | <div><fiddle-embed name="2bfa3783719fcd769af177a1b244e171"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4077 | |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 4078 | <a name='SkPaint_FontMetrics'></a> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4079 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 4080 | --- |
| 4081 | |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 4082 | <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] | 4083 | struct <a href='#SkPaint_FontMetrics'>FontMetrics</a> { |
| 4084 | enum <a href='#SkPaint_FontMetrics_FontMetricsFlags'>FontMetricsFlags</a> { |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 4085 | <a href='#SkPaint_FontMetrics_kUnderlineThicknessIsValid_Flag'>kUnderlineThicknessIsValid_Flag</a> = 1 << 0, |
| 4086 | <a href='#SkPaint_FontMetrics_kUnderlinePositionIsValid_Flag'>kUnderlinePositionIsValid_Flag</a> = 1 << 1, |
| 4087 | <a href='#SkPaint_FontMetrics_kStrikeoutThicknessIsValid_Flag'>kStrikeoutThicknessIsValid_Flag</a> = 1 << 2, |
| 4088 | <a href='#SkPaint_FontMetrics_kStrikeoutPositionIsValid_Flag'>kStrikeoutPositionIsValid_Flag</a> = 1 << 3, |
Cary Clark | 186d08f | 2018-04-03 08:43:27 -0400 | [diff] [blame] | 4089 | }; |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4090 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 4091 | uint32_t <a href='#SkPaint_FontMetrics_fFlags'>fFlags</a>; |
| 4092 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_FontMetrics_fTop'>fTop</a>; |
| 4093 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_FontMetrics_fAscent'>fAscent</a>; |
| 4094 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_FontMetrics_fDescent'>fDescent</a>; |
| 4095 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_FontMetrics_fBottom'>fBottom</a>; |
| 4096 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_FontMetrics_fLeading'>fLeading</a>; |
| 4097 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_FontMetrics_fAvgCharWidth'>fAvgCharWidth</a>; |
| 4098 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_FontMetrics_fMaxCharWidth'>fMaxCharWidth</a>; |
| 4099 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_FontMetrics_fXMin'>fXMin</a>; |
| 4100 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_FontMetrics_fXMax'>fXMax</a>; |
| 4101 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_FontMetrics_fXHeight'>fXHeight</a>; |
| 4102 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_FontMetrics_fCapHeight'>fCapHeight</a>; |
| 4103 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_FontMetrics_fUnderlineThickness'>fUnderlineThickness</a>; |
| 4104 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_FontMetrics_fUnderlinePosition'>fUnderlinePosition</a>; |
| 4105 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_FontMetrics_fStrikeoutThickness'>fStrikeoutThickness</a>; |
| 4106 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_FontMetrics_fStrikeoutPosition'>fStrikeoutPosition</a>; |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4107 | |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 4108 | bool <a href='#SkPaint_FontMetrics_hasUnderlineThickness'>hasUnderlineThickness</a>(<a href='undocumented#SkScalar'>SkScalar</a>* thickness) const; |
| 4109 | bool <a href='#SkPaint_FontMetrics_hasUnderlinePosition'>hasUnderlinePosition</a>(<a href='undocumented#SkScalar'>SkScalar</a>* position) const; |
| 4110 | bool <a href='#SkPaint_FontMetrics_hasStrikeoutThickness'>hasStrikeoutThickness</a>(<a href='undocumented#SkScalar'>SkScalar</a>* thickness) const; |
| 4111 | bool <a href='#SkPaint_FontMetrics_hasStrikeoutPosition'>hasStrikeoutPosition</a>(<a href='undocumented#SkScalar'>SkScalar</a>* position) const; |
Cary Clark | 186d08f | 2018-04-03 08:43:27 -0400 | [diff] [blame] | 4112 | }; |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 4113 | </pre> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4114 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4115 | <a href='#SkPaint_FontMetrics'>FontMetrics</a> is filled out by <a href='#SkPaint_getFontMetrics'>getFontMetrics</a>. <a href='#SkPaint_FontMetrics'>FontMetrics</a> contents reflect the values |
| 4116 | computed by <a href='undocumented#Font_Manager'>Font Manager</a> using <a href='undocumented#Typeface'>Typeface</a>. Values are set to zero if they are |
Cary Clark | 154beea | 2017-10-26 07:58:48 -0400 | [diff] [blame] | 4117 | not available. |
| 4118 | |
Cary Clark | 5538c13 | 2018-06-14 12:28:14 -0400 | [diff] [blame] | 4119 | All vertical values are relative to the baseline, on a y-axis pointing down. |
| 4120 | Zero is on the baseline, negative values are above the baseline, and positive |
| 4121 | values are below the baseline. |
Ben Wagner | e580649 | 2017-11-09 12:08:31 -0500 | [diff] [blame] | 4122 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4123 | <a href='#SkPaint_FontMetrics_fUnderlineThickness'>fUnderlineThickness</a> and <a href='#SkPaint_FontMetrics_fUnderlinePosition'>fUnderlinePosition</a> have a bit set in <a href='#SkPaint_FontMetrics_fFlags'>fFlags</a> if their values |
Cary Clark | 154beea | 2017-10-26 07:58:48 -0400 | [diff] [blame] | 4124 | are valid, since their value may be zero. |
Ben Wagner | e580649 | 2017-11-09 12:08:31 -0500 | [diff] [blame] | 4125 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4126 | <a href='#SkPaint_FontMetrics_fStrikeoutThickness'>fStrikeoutThickness</a> and <a href='#SkPaint_FontMetrics_fStrikeoutPosition'>fStrikeoutPosition</a> have a bit set in <a href='#SkPaint_FontMetrics_fFlags'>fFlags</a> if their values |
Cary Clark | 154beea | 2017-10-26 07:58:48 -0400 | [diff] [blame] | 4127 | are valid, since their value may be zero. |
| 4128 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 4129 | <a name='SkPaint_FontMetrics_FontMetricsFlags'></a> |
| 4130 | |
| 4131 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4132 | |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 4133 | <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] | 4134 | enum <a href='#SkPaint_FontMetrics_FontMetricsFlags'>FontMetricsFlags</a> { |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 4135 | <a href='#SkPaint_FontMetrics_kUnderlineThicknessIsValid_Flag'>kUnderlineThicknessIsValid_Flag</a> = 1 << 0, |
| 4136 | <a href='#SkPaint_FontMetrics_kUnderlinePositionIsValid_Flag'>kUnderlinePositionIsValid_Flag</a> = 1 << 1, |
| 4137 | <a href='#SkPaint_FontMetrics_kStrikeoutThicknessIsValid_Flag'>kStrikeoutThicknessIsValid_Flag</a> = 1 << 2, |
| 4138 | <a href='#SkPaint_FontMetrics_kStrikeoutPositionIsValid_Flag'>kStrikeoutPositionIsValid_Flag</a> = 1 << 3, |
Cary Clark | 186d08f | 2018-04-03 08:43:27 -0400 | [diff] [blame] | 4139 | }; |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 4140 | </pre> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4141 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4142 | <a href='#SkPaint_FontMetrics_FontMetricsFlags'>FontMetricsFlags</a> are set in <a href='#SkPaint_FontMetrics_fFlags'>fFlags</a> when underline and strikeout metrics are valid; |
Cary Clark | 154beea | 2017-10-26 07:58:48 -0400 | [diff] [blame] | 4143 | the underline or strikeout metric may be valid and zero. |
| 4144 | Fonts with embedded bitmaps may not have valid underline or strikeout metrics. |
| 4145 | |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4146 | ### Constants |
| 4147 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4148 | <table style='border-collapse: collapse; width: 62.5em'> |
| 4149 | <tr><th style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>Const</th> |
| 4150 | <th style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>Value</th> |
| 4151 | <th style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>Description</th></tr> |
| 4152 | <tr style='background-color: #f0f0f0; '> |
| 4153 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_FontMetrics_kUnderlineThicknessIsValid_Flag'><code>SkPaint::FontMetrics::kUnderlineThicknessIsValid_Flag</code></a></td> |
| 4154 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>0x0001</td> |
| 4155 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 4156 | set if fUnderlineThickness is valid</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4157 | </tr> |
| 4158 | <tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4159 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_FontMetrics_kUnderlinePositionIsValid_Flag'><code>SkPaint::FontMetrics::kUnderlinePositionIsValid_Flag</code></a></td> |
| 4160 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>0x0002</td> |
| 4161 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 4162 | set if fUnderlinePosition is valid</td> |
| 4163 | </tr> |
| 4164 | <tr style='background-color: #f0f0f0; '> |
| 4165 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_FontMetrics_kStrikeoutThicknessIsValid_Flag'><code>SkPaint::FontMetrics::kStrikeoutThicknessIsValid_Flag</code></a></td> |
| 4166 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>0x0004</td> |
| 4167 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 4168 | set if fStrikeoutThickness is valid</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4169 | </tr> |
| 4170 | <tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4171 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_FontMetrics_kStrikeoutPositionIsValid_Flag'><code>SkPaint::FontMetrics::kStrikeoutPositionIsValid_Flag</code></a></td> |
| 4172 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>0x0008</td> |
| 4173 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 4174 | set if fStrikeoutPosition is valid</td> |
| 4175 | </tr> |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 4176 | </table><table style='border-collapse: collapse; width: 62.5em'> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4177 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4178 | <tr><th style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>Type</th> |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 4179 | <th style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>Member</th> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4180 | <th style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>Description</th></tr> |
| 4181 | <tr style='background-color: #f0f0f0; '> |
| 4182 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>uint32_t</td> |
| 4183 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_FontMetrics_fFlags'><code>fFlags</code></a></td> |
| 4184 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 4185 | is set to FontMetricsFlags when metrics are valid</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4186 | </tr> |
| 4187 | <tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4188 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>SkScalar</td> |
| 4189 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_FontMetrics_fTop'><code>fTop</code></a></td> |
| 4190 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
Ben Wagner | e580649 | 2017-11-09 12:08:31 -0500 | [diff] [blame] | 4191 | Greatest extent above the baseline for any glyph. |
| 4192 | Typically less than zero. |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4193 | </td> |
| 4194 | </tr> |
| 4195 | <tr style='background-color: #f0f0f0; '> |
| 4196 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>SkScalar</td> |
| 4197 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_FontMetrics_fAscent'><code>fAscent</code></a></td> |
| 4198 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4199 | Recommended distance above the baseline to reserve for a line of text. |
Ben Wagner | e580649 | 2017-11-09 12:08:31 -0500 | [diff] [blame] | 4200 | Typically less than zero. |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4201 | </td> |
| 4202 | </tr> |
| 4203 | <tr> |
| 4204 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>SkScalar</td> |
| 4205 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_FontMetrics_fDescent'><code>fDescent</code></a></td> |
| 4206 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4207 | Recommended distance below the baseline to reserve for a line of text. |
Ben Wagner | e580649 | 2017-11-09 12:08:31 -0500 | [diff] [blame] | 4208 | Typically greater than zero. |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4209 | </td> |
| 4210 | </tr> |
| 4211 | <tr style='background-color: #f0f0f0; '> |
| 4212 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>SkScalar</td> |
| 4213 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_FontMetrics_fBottom'><code>fBottom</code></a></td> |
| 4214 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
Ben Wagner | e580649 | 2017-11-09 12:08:31 -0500 | [diff] [blame] | 4215 | Greatest extent below the baseline for any glyph. |
| 4216 | Typically greater than zero. |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4217 | </td> |
| 4218 | </tr> |
| 4219 | <tr> |
| 4220 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>SkScalar</td> |
| 4221 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_FontMetrics_fLeading'><code>fLeading</code></a></td> |
| 4222 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4223 | Recommended distance to add between lines of text. |
Ben Wagner | e580649 | 2017-11-09 12:08:31 -0500 | [diff] [blame] | 4224 | Typically greater than or equal to zero. |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4225 | </td> |
| 4226 | </tr> |
| 4227 | <tr style='background-color: #f0f0f0; '> |
| 4228 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>SkScalar</td> |
| 4229 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_FontMetrics_fAvgCharWidth'><code>fAvgCharWidth</code></a></td> |
| 4230 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4231 | Average character width, if it is available. |
| 4232 | Zero if no average width is stored in the font. |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4233 | </td> |
| 4234 | </tr> |
| 4235 | <tr> |
| 4236 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>SkScalar</td> |
| 4237 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_FontMetrics_fMaxCharWidth'><code>fMaxCharWidth</code></a></td> |
| 4238 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 4239 | maximum character width</td> |
| 4240 | </tr> |
| 4241 | <tr style='background-color: #f0f0f0; '> |
| 4242 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>SkScalar</td> |
| 4243 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_FontMetrics_fXMin'><code>fXMin</code></a></td> |
| 4244 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
Cary Clark | 5538c13 | 2018-06-14 12:28:14 -0400 | [diff] [blame] | 4245 | Minimum bounding box x-axis value for all <a href='undocumented#Glyph'>Glyphs</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4246 | Typically less than zero. |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4247 | </td> |
| 4248 | </tr> |
| 4249 | <tr> |
| 4250 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>SkScalar</td> |
| 4251 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_FontMetrics_fXMax'><code>fXMax</code></a></td> |
| 4252 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
Cary Clark | 5538c13 | 2018-06-14 12:28:14 -0400 | [diff] [blame] | 4253 | Maximum bounding box x-axis value for all <a href='undocumented#Glyph'>Glyphs</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4254 | Typically greater than zero. |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4255 | </td> |
| 4256 | </tr> |
| 4257 | <tr style='background-color: #f0f0f0; '> |
| 4258 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>SkScalar</td> |
| 4259 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_FontMetrics_fXHeight'><code>fXHeight</code></a></td> |
| 4260 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4261 | May be zero if no lower-case height is stored in the font. |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4262 | </td> |
| 4263 | </tr> |
| 4264 | <tr> |
| 4265 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>SkScalar</td> |
| 4266 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_FontMetrics_fCapHeight'><code>fCapHeight</code></a></td> |
| 4267 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4268 | May be zero if no upper-case height is stored in the font. |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4269 | </td> |
| 4270 | </tr> |
| 4271 | <tr style='background-color: #f0f0f0; '> |
| 4272 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>SkScalar</td> |
| 4273 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_FontMetrics_fUnderlineThickness'><code>fUnderlineThickness</code></a></td> |
| 4274 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 4275 | If the metric is valid, the <a href='#SkPaint_FontMetrics_kUnderlineThicknessIsValid_Flag'>kUnderlineThicknessIsValid Flag</a> is set in <a href='#SkPaint_FontMetrics_fFlags'>fFlags</a>. |
| 4276 | If <a href='#SkPaint_FontMetrics_kUnderlineThicknessIsValid_Flag'>kUnderlineThicknessIsValid Flag</a> is clear, <a href='#SkPaint_FontMetrics_fUnderlineThickness'>fUnderlineThickness</a> is zero. |
| 4277 | </td> |
| 4278 | </tr> |
| 4279 | <tr> |
| 4280 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>SkScalar</td> |
| 4281 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_FontMetrics_fUnderlinePosition'><code>fUnderlinePosition</code></a></td> |
| 4282 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
Ben Wagner | e580649 | 2017-11-09 12:08:31 -0500 | [diff] [blame] | 4283 | Position of the top of the underline stroke relative to the baseline. |
| 4284 | Typically positive when valid. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4285 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4286 | If the metric is valid, the <a href='#SkPaint_FontMetrics_kUnderlinePositionIsValid_Flag'>kUnderlinePositionIsValid Flag</a> is set in <a href='#SkPaint_FontMetrics_fFlags'>fFlags</a>. |
| 4287 | If <a href='#SkPaint_FontMetrics_kUnderlinePositionIsValid_Flag'>kUnderlinePositionIsValid Flag</a> is clear, <a href='#SkPaint_FontMetrics_fUnderlinePosition'>fUnderlinePosition</a> is zero. |
| 4288 | </td> |
| 4289 | </tr> |
| 4290 | <tr style='background-color: #f0f0f0; '> |
| 4291 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>SkScalar</td> |
| 4292 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_FontMetrics_fStrikeoutThickness'><code>fStrikeoutThickness</code></a></td> |
| 4293 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 4294 | If the metric is valid, the <a href='#SkPaint_FontMetrics_kStrikeoutThicknessIsValid_Flag'>kStrikeoutThicknessIsValid Flag</a> is set in <a href='#SkPaint_FontMetrics_fFlags'>fFlags</a>. |
| 4295 | If <a href='#SkPaint_FontMetrics_kStrikeoutThicknessIsValid_Flag'>kStrikeoutThicknessIsValid Flag</a> is clear, <a href='#SkPaint_FontMetrics_fStrikeoutThickness'>fStrikeoutThickness</a> is zero. |
| 4296 | </td> |
| 4297 | </tr> |
| 4298 | <tr> |
| 4299 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>SkScalar</td> |
| 4300 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_FontMetrics_fStrikeoutPosition'><code>fStrikeoutPosition</code></a></td> |
| 4301 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
Ben Wagner | e580649 | 2017-11-09 12:08:31 -0500 | [diff] [blame] | 4302 | Position of the bottom of the strikeout stroke relative to the baseline. |
| 4303 | Typically negative when valid. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4304 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4305 | If the metric is valid, the <a href='#SkPaint_FontMetrics_kStrikeoutPositionIsValid_Flag'>kStrikeoutPositionIsValid Flag</a> is set in <a href='#SkPaint_FontMetrics_fFlags'>fFlags</a>. |
| 4306 | If <a href='#SkPaint_FontMetrics_kStrikeoutPositionIsValid_Flag'>kStrikeoutPositionIsValid Flag</a> is clear, <a href='#SkPaint_FontMetrics_fStrikeoutPosition'>fStrikeoutPosition</a> is zero. |
| 4307 | </td> |
| 4308 | </tr> |
| 4309 | </table> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4310 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4311 | <a name='SkPaint_FontMetrics_hasUnderlineThickness'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 4312 | |
| 4313 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4314 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4315 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 4316 | bool <a href='#SkPaint_FontMetrics_hasUnderlineThickness'>hasUnderlineThickness</a>(<a href='undocumented#SkScalar'>SkScalar</a>* thickness) const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4317 | </pre> |
| 4318 | |
Cary Clark | 80247e5 | 2018-07-11 16:18:41 -0400 | [diff] [blame] | 4319 | Returns true if <a href='#Font_Metrics'>Font Metrics</a> has a valid underline <a href='#SkPaint_FontMetrics_hasUnderlineThickness_thickness'>thickness</a>, and sets |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4320 | <a href='#SkPaint_FontMetrics_hasUnderlineThickness_thickness'>thickness</a> to that value. If the underline <a href='#SkPaint_FontMetrics_hasUnderlineThickness_thickness'>thickness</a> is not valid, |
| 4321 | return false, and ignore <a href='#SkPaint_FontMetrics_hasUnderlineThickness_thickness'>thickness</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4322 | |
| 4323 | ### Parameters |
| 4324 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4325 | <table> <tr> <td><a name='SkPaint_FontMetrics_hasUnderlineThickness_thickness'><code><strong>thickness</strong></code></a></td> |
| 4326 | <td>storage for underline width</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4327 | </tr> |
| 4328 | </table> |
| 4329 | |
| 4330 | ### Return Value |
| 4331 | |
| 4332 | true if font specifies underline width |
| 4333 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4334 | <a name='SkPaint_FontMetrics_hasUnderlinePosition'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 4335 | |
| 4336 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4337 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4338 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 4339 | bool <a href='#SkPaint_FontMetrics_hasUnderlinePosition'>hasUnderlinePosition</a>(<a href='undocumented#SkScalar'>SkScalar</a>* position) const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4340 | </pre> |
| 4341 | |
Cary Clark | 80247e5 | 2018-07-11 16:18:41 -0400 | [diff] [blame] | 4342 | Returns true if <a href='#Font_Metrics'>Font Metrics</a> has a valid underline <a href='#SkPaint_FontMetrics_hasUnderlinePosition_position'>position</a>, and sets |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4343 | <a href='#SkPaint_FontMetrics_hasUnderlinePosition_position'>position</a> to that value. If the underline <a href='#SkPaint_FontMetrics_hasUnderlinePosition_position'>position</a> is not valid, |
| 4344 | return false, and ignore <a href='#SkPaint_FontMetrics_hasUnderlinePosition_position'>position</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4345 | |
| 4346 | ### Parameters |
| 4347 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4348 | <table> <tr> <td><a name='SkPaint_FontMetrics_hasUnderlinePosition_position'><code><strong>position</strong></code></a></td> |
| 4349 | <td>storage for underline <a href='#SkPaint_FontMetrics_hasUnderlinePosition_position'>position</a></td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4350 | </tr> |
| 4351 | </table> |
| 4352 | |
| 4353 | ### Return Value |
| 4354 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4355 | true if font specifies underline <a href='#SkPaint_FontMetrics_hasUnderlinePosition_position'>position</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4356 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4357 | <a name='SkPaint_FontMetrics_hasStrikeoutThickness'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 4358 | |
| 4359 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4360 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4361 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 4362 | bool <a href='#SkPaint_FontMetrics_hasStrikeoutThickness'>hasStrikeoutThickness</a>(<a href='undocumented#SkScalar'>SkScalar</a>* thickness) const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4363 | </pre> |
| 4364 | |
Cary Clark | 80247e5 | 2018-07-11 16:18:41 -0400 | [diff] [blame] | 4365 | Returns true if <a href='#Font_Metrics'>Font Metrics</a> has a valid strikeout <a href='#SkPaint_FontMetrics_hasStrikeoutThickness_thickness'>thickness</a>, and sets |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4366 | <a href='#SkPaint_FontMetrics_hasStrikeoutThickness_thickness'>thickness</a> to that value. If the underline <a href='#SkPaint_FontMetrics_hasStrikeoutThickness_thickness'>thickness</a> is not valid, |
| 4367 | return false, and ignore <a href='#SkPaint_FontMetrics_hasStrikeoutThickness_thickness'>thickness</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4368 | |
| 4369 | ### Parameters |
| 4370 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4371 | <table> <tr> <td><a name='SkPaint_FontMetrics_hasStrikeoutThickness_thickness'><code><strong>thickness</strong></code></a></td> |
| 4372 | <td>storage for strikeout width</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4373 | </tr> |
| 4374 | </table> |
| 4375 | |
| 4376 | ### Return Value |
| 4377 | |
| 4378 | true if font specifies strikeout width |
| 4379 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4380 | <a name='SkPaint_FontMetrics_hasStrikeoutPosition'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 4381 | |
| 4382 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4383 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4384 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 4385 | bool <a href='#SkPaint_FontMetrics_hasStrikeoutPosition'>hasStrikeoutPosition</a>(<a href='undocumented#SkScalar'>SkScalar</a>* position) const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4386 | </pre> |
| 4387 | |
Cary Clark | 80247e5 | 2018-07-11 16:18:41 -0400 | [diff] [blame] | 4388 | Returns true if <a href='#Font_Metrics'>Font Metrics</a> has a valid strikeout <a href='#SkPaint_FontMetrics_hasStrikeoutPosition_position'>position</a>, and sets |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4389 | <a href='#SkPaint_FontMetrics_hasStrikeoutPosition_position'>position</a> to that value. If the underline <a href='#SkPaint_FontMetrics_hasStrikeoutPosition_position'>position</a> is not valid, |
| 4390 | return false, and ignore <a href='#SkPaint_FontMetrics_hasStrikeoutPosition_position'>position</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4391 | |
| 4392 | ### Parameters |
| 4393 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4394 | <table> <tr> <td><a name='SkPaint_FontMetrics_hasStrikeoutPosition_position'><code><strong>position</strong></code></a></td> |
| 4395 | <td>storage for strikeout <a href='#SkPaint_FontMetrics_hasStrikeoutPosition_position'>position</a></td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4396 | </tr> |
| 4397 | </table> |
| 4398 | |
| 4399 | ### Return Value |
| 4400 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4401 | true if font specifies strikeout <a href='#SkPaint_FontMetrics_hasStrikeoutPosition_position'>position</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4402 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4403 | <a name='SkPaint_getFontMetrics'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 4404 | |
| 4405 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4406 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4407 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 4408 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_getFontMetrics'>getFontMetrics</a>(<a href='#SkPaint_FontMetrics'>FontMetrics</a>* metrics, <a href='undocumented#SkScalar'>SkScalar</a> scale = 0) const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4409 | </pre> |
| 4410 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4411 | Returns <a href='#Font_Metrics'>Font Metrics</a> associated with <a href='undocumented#Typeface'>Typeface</a>. |
| 4412 | The return value is the recommended spacing between lines: the sum of <a href='#SkPaint_getFontMetrics_metrics'>metrics</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4413 | descent, ascent, and leading. |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4414 | If <a href='#SkPaint_getFontMetrics_metrics'>metrics</a> is not nullptr, <a href='#Font_Metrics'>Font Metrics</a> is copied to <a href='#SkPaint_getFontMetrics_metrics'>metrics</a>. |
| 4415 | Results are scaled by <a href='#Text_Size'>Text Size</a> but does not take into account |
| 4416 | 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>, |
| 4417 | <a href='#Style_Stroke'>Style Stroke</a>, and <a href='undocumented#Path_Effect'>Path Effect</a>. |
| 4418 | Results can be additionally scaled by <a href='#SkPaint_getFontMetrics_scale'>scale</a>; a <a href='#SkPaint_getFontMetrics_scale'>scale</a> of zero |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4419 | is ignored. |
| 4420 | |
| 4421 | ### Parameters |
| 4422 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4423 | <table> <tr> <td><a name='SkPaint_getFontMetrics_metrics'><code><strong>metrics</strong></code></a></td> |
| 4424 | <td>storage for <a href='#Font_Metrics'>Font Metrics</a> from <a href='undocumented#Typeface'>Typeface</a>; may be nullptr</td> |
| 4425 | </tr> |
| 4426 | <tr> <td><a name='SkPaint_getFontMetrics_scale'><code><strong>scale</strong></code></a></td> |
| 4427 | <td>additional multiplier for returned values</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4428 | </tr> |
| 4429 | </table> |
| 4430 | |
| 4431 | ### Return Value |
| 4432 | |
| 4433 | recommended spacing between lines |
| 4434 | |
| 4435 | ### Example |
| 4436 | |
| 4437 | <div><fiddle-embed name="b899d84caba6607340322d317992d070"></fiddle-embed></div> |
| 4438 | |
| 4439 | ### See Also |
| 4440 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4441 | <a href='#Text_Size'>Text Size</a> <a href='undocumented#Typeface'>Typeface</a> <a href='#Typeface_Methods'>Typeface Methods</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4442 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4443 | <a name='SkPaint_getFontSpacing'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 4444 | |
| 4445 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4446 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4447 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 4448 | <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] | 4449 | </pre> |
| 4450 | |
| 4451 | Returns the recommended spacing between lines: the sum of metrics |
| 4452 | descent, ascent, and leading. |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4453 | Result is scaled by <a href='#Text_Size'>Text Size</a> but does not take into account |
| 4454 | dimensions required by stroking and <a href='undocumented#Path_Effect'>Path Effect</a>. |
| 4455 | Returns the same result as <a href='#SkPaint_getFontMetrics'>getFontMetrics</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4456 | |
| 4457 | ### Return Value |
| 4458 | |
| 4459 | recommended spacing between lines |
| 4460 | |
| 4461 | ### Example |
| 4462 | |
| 4463 | <div><fiddle-embed name="424741e26e1b174e43087d67422ce14f"> |
| 4464 | |
| 4465 | #### Example Output |
| 4466 | |
| 4467 | ~~~~ |
| 4468 | textSize: 12 fontSpacing: 13.9688 |
| 4469 | textSize: 18 fontSpacing: 20.9531 |
| 4470 | textSize: 24 fontSpacing: 27.9375 |
| 4471 | textSize: 32 fontSpacing: 37.25 |
| 4472 | ~~~~ |
| 4473 | |
| 4474 | </fiddle-embed></div> |
| 4475 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4476 | <a name='SkPaint_getFontBounds'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 4477 | |
| 4478 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4479 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4480 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 4481 | <a href='SkRect_Reference#SkRect'>SkRect</a> <a href='#SkPaint_getFontBounds'>getFontBounds</a>() const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4482 | </pre> |
| 4483 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4484 | Returns the union of bounds of all <a href='undocumented#Glyph'>Glyphs</a>. |
| 4485 | Returned dimensions are computed by <a href='undocumented#Font_Manager'>Font Manager</a> from font data, |
| 4486 | ignoring <a href='#SkPaint_Hinting'>Hinting</a>. Includes <a href='#Text_Size'>Text Size</a>, <a href='#Text_Scale_X'>Text Scale X</a>, |
| 4487 | and <a href='#Text_Skew_X'>Text Skew X</a>, but not <a href='#Fake_Bold'>Fake Bold</a> or <a href='undocumented#Path_Effect'>Path Effect</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4488 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4489 | If <a href='#Text_Size'>Text Size</a> is large, <a href='#Text_Scale_X'>Text Scale X</a> is one, and <a href='#Text_Skew_X'>Text Skew X</a> is zero, |
| 4490 | returns the same bounds as <a href='#Font_Metrics'>Font Metrics</a> { <a href='#SkPaint_FontMetrics_fXMin'>FontMetrics::fXMin</a>, |
| 4491 | <a href='#SkPaint_FontMetrics_fTop'>FontMetrics::fTop</a>, <a href='#SkPaint_FontMetrics_fXMax'>FontMetrics::fXMax</a>, <a href='#SkPaint_FontMetrics_fBottom'>FontMetrics::fBottom</a> }. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4492 | |
| 4493 | ### Return Value |
| 4494 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4495 | union of bounds of all <a href='undocumented#Glyph'>Glyphs</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4496 | |
| 4497 | ### Example |
| 4498 | |
skia-bookmaker | 44bad2e | 2018-07-05 05:35:27 +0000 | [diff] [blame] | 4499 | <div><fiddle-embed name="facaddeec7943bc491988e345e27e65f"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4500 | |
| 4501 | #### Example Output |
| 4502 | |
| 4503 | ~~~~ |
| 4504 | metrics bounds = { -12.2461, -14.7891, 21.5215, 5.55469 } |
| 4505 | font bounds = { -12.2461, -14.7891, 21.5215, 5.55469 } |
| 4506 | ~~~~ |
| 4507 | |
| 4508 | </fiddle-embed></div> |
| 4509 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4510 | <a name='SkPaint_textToGlyphs'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 4511 | |
| 4512 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4513 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4514 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 4515 | int <a href='#SkPaint_textToGlyphs'>textToGlyphs</a>(const void* text, size_t byteLength, <a href='undocumented#SkGlyphID'>SkGlyphID</a> glyphs[]) const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4516 | </pre> |
| 4517 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4518 | Converts <a href='#SkPaint_textToGlyphs_text'>text</a> into glyph indices. |
| 4519 | Returns the number of glyph indices represented by <a href='#SkPaint_textToGlyphs_text'>text</a>. |
| 4520 | <a href='#Text_Encoding'>Text Encoding</a> specifies how <a href='#SkPaint_textToGlyphs_text'>text</a> represents characters or <a href='#SkPaint_textToGlyphs_glyphs'>glyphs</a>. |
| 4521 | <a href='#SkPaint_textToGlyphs_glyphs'>glyphs</a> may be nullptr, to compute the glyph count. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4522 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4523 | Does not check <a href='#SkPaint_textToGlyphs_text'>text</a> for valid character codes or valid glyph indices. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4524 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4525 | If <a href='#SkPaint_textToGlyphs_byteLength'>byteLength</a> equals zero, returns zero. |
| 4526 | 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] | 4527 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4528 | If <a href='#Text_Encoding'>Text Encoding</a> is <a href='#SkPaint_kUTF8_TextEncoding'>kUTF8 TextEncoding</a> and |
| 4529 | <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] | 4530 | |
| 4531 | ### Parameters |
| 4532 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4533 | <table> <tr> <td><a name='SkPaint_textToGlyphs_text'><code><strong>text</strong></code></a></td> |
| 4534 | <td>character storage encoded with <a href='#Text_Encoding'>Text Encoding</a></td> |
| 4535 | </tr> |
| 4536 | <tr> <td><a name='SkPaint_textToGlyphs_byteLength'><code><strong>byteLength</strong></code></a></td> |
| 4537 | <td>length of character storage in bytes</td> |
| 4538 | </tr> |
| 4539 | <tr> <td><a name='SkPaint_textToGlyphs_glyphs'><code><strong>glyphs</strong></code></a></td> |
| 4540 | <td>storage for glyph indices; may be nullptr</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4541 | </tr> |
| 4542 | </table> |
| 4543 | |
| 4544 | ### Return Value |
| 4545 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4546 | 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] | 4547 | |
| 4548 | ### Example |
| 4549 | |
| 4550 | <div><fiddle-embed name="343e9471a7f7b5f09abdc3b44983433b"></fiddle-embed></div> |
| 4551 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4552 | <a name='SkPaint_countText'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 4553 | |
| 4554 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4555 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4556 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 4557 | int <a href='#SkPaint_countText'>countText</a>(const void* text, size_t byteLength) const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4558 | </pre> |
| 4559 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4560 | Returns the number of <a href='undocumented#Glyph'>Glyphs</a> in <a href='#SkPaint_countText_text'>text</a>. |
| 4561 | Uses <a href='#Text_Encoding'>Text Encoding</a> to count the <a href='undocumented#Glyph'>Glyphs</a>. |
| 4562 | Returns the same result as <a href='#SkPaint_textToGlyphs'>textToGlyphs</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4563 | |
| 4564 | ### Parameters |
| 4565 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4566 | <table> <tr> <td><a name='SkPaint_countText_text'><code><strong>text</strong></code></a></td> |
| 4567 | <td>character storage encoded with <a href='#Text_Encoding'>Text Encoding</a></td> |
| 4568 | </tr> |
| 4569 | <tr> <td><a name='SkPaint_countText_byteLength'><code><strong>byteLength</strong></code></a></td> |
| 4570 | <td>length of character storage in bytes</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4571 | </tr> |
| 4572 | </table> |
| 4573 | |
| 4574 | ### Return Value |
| 4575 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4576 | 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] | 4577 | |
| 4578 | ### Example |
| 4579 | |
Cary Clark | f960398 | 2018-07-17 08:20:27 -0400 | [diff] [blame] | 4580 | <div><fiddle-embed name="85436c71aab5410767fc688ab0573e09"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4581 | |
| 4582 | #### Example Output |
| 4583 | |
| 4584 | ~~~~ |
| 4585 | count = 5 |
| 4586 | ~~~~ |
| 4587 | |
| 4588 | </fiddle-embed></div> |
| 4589 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4590 | <a name='SkPaint_containsText'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 4591 | |
| 4592 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4593 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4594 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 4595 | bool <a href='#SkPaint_containsText'>containsText</a>(const void* text, size_t byteLength) const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4596 | </pre> |
| 4597 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4598 | Returns true if all <a href='#SkPaint_containsText_text'>text</a> corresponds to a non-zero glyph index. |
| 4599 | Returns false if any characters in <a href='#SkPaint_containsText_text'>text</a> are not supported in |
| 4600 | <a href='undocumented#Typeface'>Typeface</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4601 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4602 | If <a href='#Text_Encoding'>Text Encoding</a> is <a href='#SkPaint_kGlyphID_TextEncoding'>kGlyphID TextEncoding</a>, |
| 4603 | returns true if all glyph indices in <a href='#SkPaint_containsText_text'>text</a> are non-zero; |
| 4604 | does not check to see if <a href='#SkPaint_containsText_text'>text</a> contains valid glyph indices for <a href='undocumented#Typeface'>Typeface</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4605 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4606 | Returns true if <a href='#SkPaint_containsText_byteLength'>byteLength</a> is zero. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4607 | |
| 4608 | ### Parameters |
| 4609 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4610 | <table> <tr> <td><a name='SkPaint_containsText_text'><code><strong>text</strong></code></a></td> |
| 4611 | <td>array of characters or <a href='undocumented#Glyph'>Glyphs</a></td> |
| 4612 | </tr> |
| 4613 | <tr> <td><a name='SkPaint_containsText_byteLength'><code><strong>byteLength</strong></code></a></td> |
| 4614 | <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] | 4615 | </tr> |
| 4616 | </table> |
| 4617 | |
| 4618 | ### Return Value |
| 4619 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4620 | true if all <a href='#SkPaint_containsText_text'>text</a> corresponds to a non-zero glyph index |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4621 | |
Ruiqi Mao | 94d57c4 | 2018-07-02 15:20:10 -0400 | [diff] [blame] | 4622 | <div><a href='#SkPaint_containsText'>containsText</a> succeeds for degree symbol, but cannot find a glyph index |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 4623 | corresponding to the Unicode surrogate code point. |
| 4624 | </div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4625 | |
| 4626 | #### Example Output |
| 4627 | |
| 4628 | ~~~~ |
| 4629 | 0x00b0 == has char |
| 4630 | 0xd800 != has char |
| 4631 | ~~~~ |
| 4632 | |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4633 | ### Example |
| 4634 | |
skia-bookmaker | 61cc9fa | 2018-07-11 05:28:17 +0000 | [diff] [blame] | 4635 | <div><fiddle-embed name="083557b6f653d6fc00a34e01f87b74ff"><div><a href='#SkPaint_containsText'>containsText</a> returns true that glyph index is greater than zero, not |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4636 | 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] | 4637 | </div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4638 | |
| 4639 | #### Example Output |
| 4640 | |
| 4641 | ~~~~ |
| 4642 | 0x01ff == has glyph |
| 4643 | 0x0000 != has glyph |
| 4644 | 0xffff == has glyph |
| 4645 | ~~~~ |
| 4646 | |
| 4647 | </fiddle-embed></div> |
| 4648 | |
| 4649 | ### See Also |
| 4650 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4651 | <a href='#SkPaint_setTextEncoding'>setTextEncoding</a> <a href='undocumented#Typeface'>Typeface</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4652 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4653 | <a name='SkPaint_glyphsToUnichars'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 4654 | |
| 4655 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4656 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4657 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 4658 | void <a href='#SkPaint_glyphsToUnichars'>glyphsToUnichars</a>(const <a href='undocumented#SkGlyphID'>SkGlyphID</a> glyphs[], int count, <a href='undocumented#SkUnichar'>SkUnichar</a> text[]) const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4659 | </pre> |
| 4660 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4661 | Converts <a href='#SkPaint_glyphsToUnichars_glyphs'>glyphs</a> into <a href='#SkPaint_glyphsToUnichars_text'>text</a> if possible. |
| 4662 | <a href='undocumented#Glyph'>Glyph</a> values without direct Unicode equivalents are mapped to zero. |
| 4663 | Uses the <a href='undocumented#Typeface'>Typeface</a>, but is unaffected |
| 4664 | by <a href='#Text_Encoding'>Text Encoding</a>; the <a href='#SkPaint_glyphsToUnichars_text'>text</a> values returned are equivalent to <a href='#SkPaint_kUTF32_TextEncoding'>kUTF32 TextEncoding</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4665 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4666 | Only supported on platforms that use FreeType as the <a href='undocumented#Engine'>Font Engine</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4667 | |
| 4668 | ### Parameters |
| 4669 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4670 | <table> <tr> <td><a name='SkPaint_glyphsToUnichars_glyphs'><code><strong>glyphs</strong></code></a></td> |
| 4671 | <td>array of indices into font</td> |
| 4672 | </tr> |
| 4673 | <tr> <td><a name='SkPaint_glyphsToUnichars_count'><code><strong>count</strong></code></a></td> |
| 4674 | <td>length of glyph array</td> |
| 4675 | </tr> |
| 4676 | <tr> <td><a name='SkPaint_glyphsToUnichars_text'><code><strong>text</strong></code></a></td> |
| 4677 | <td>storage for character codes, one per glyph</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4678 | </tr> |
| 4679 | </table> |
| 4680 | |
| 4681 | ### Example |
| 4682 | |
skia-bookmaker | b95bbba | 2018-07-06 05:23:23 +0000 | [diff] [blame] | 4683 | <div><fiddle-embed name="c12686b0b3e0a87d0a248bbfc57e9492"><div>Convert UTF-8 <a href='#SkPaint_glyphsToUnichars_text'>text</a> to <a href='#SkPaint_glyphsToUnichars_glyphs'>glyphs</a>; then convert <a href='#SkPaint_glyphsToUnichars_glyphs'>glyphs</a> to Unichar code points. |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 4684 | </div></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4685 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 4686 | <a name='Measure_Text'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4687 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4688 | <a name='SkPaint_measureText'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 4689 | |
| 4690 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4691 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4692 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 4693 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_measureText'>measureText</a>(const void* text, size_t length, <a href='SkRect_Reference#SkRect'>SkRect</a>* bounds) const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4694 | </pre> |
| 4695 | |
Cary Clark | 3aca39d | 2018-10-23 14:44:05 -0400 | [diff] [blame] | 4696 | Returns the advance width of <a href='#SkPaint_measureText_text'>text</a>. |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4697 | The advance is the normal distance to move before drawing additional <a href='#SkPaint_measureText_text'>text</a>. |
| 4698 | Uses <a href='#Text_Encoding'>Text Encoding</a> to decode <a href='#SkPaint_measureText_text'>text</a>, <a href='undocumented#Typeface'>Typeface</a> to get the font metrics, |
| 4699 | 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 |
| 4700 | <a href='undocumented#Path_Effect'>Path Effect</a> to scale the metrics and <a href='#SkPaint_measureText_bounds'>bounds</a>. |
| 4701 | Returns the bounding box of <a href='#SkPaint_measureText_text'>text</a> if <a href='#SkPaint_measureText_bounds'>bounds</a> is not nullptr. |
| 4702 | 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] | 4703 | |
| 4704 | ### Parameters |
| 4705 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4706 | <table> <tr> <td><a name='SkPaint_measureText_text'><code><strong>text</strong></code></a></td> |
| 4707 | <td>character codes or glyph indices to be measured</td> |
| 4708 | </tr> |
| 4709 | <tr> <td><a name='SkPaint_measureText_length'><code><strong>length</strong></code></a></td> |
| 4710 | <td>number of bytes of <a href='#SkPaint_measureText_text'>text</a> to measure</td> |
| 4711 | </tr> |
| 4712 | <tr> <td><a name='SkPaint_measureText_bounds'><code><strong>bounds</strong></code></a></td> |
| 4713 | <td>returns bounding box relative to (0, 0) if not nullptr</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4714 | </tr> |
| 4715 | </table> |
| 4716 | |
| 4717 | ### Return Value |
| 4718 | |
| 4719 | advance width or height |
| 4720 | |
| 4721 | ### Example |
| 4722 | |
Cary Clark | 8364706 | 2018-07-18 16:21:51 -0400 | [diff] [blame] | 4723 | <div><fiddle-embed name="06084f609184470135a9cd9ebc5af149"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4724 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4725 | <a name='SkPaint_measureText_2'></a> |
Cary Clark | 2dc84ad | 2018-01-26 12:56:22 -0500 | [diff] [blame] | 4726 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 4727 | --- |
| 4728 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4729 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 4730 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_measureText'>measureText</a>(const void* text, size_t length) const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4731 | </pre> |
| 4732 | |
Cary Clark | 3aca39d | 2018-10-23 14:44:05 -0400 | [diff] [blame] | 4733 | 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] | 4734 | The advance is the normal distance to move before drawing additional <a href='#SkPaint_measureText_2_text'>text</a>. |
| 4735 | Uses <a href='#Text_Encoding'>Text Encoding</a> to decode <a href='#SkPaint_measureText_2_text'>text</a>, <a href='undocumented#Typeface'>Typeface</a> to get the font metrics, |
| 4736 | and <a href='#Text_Size'>Text Size</a> to scale the metrics. |
| 4737 | Does not scale the advance or bounds by <a href='#Fake_Bold'>Fake Bold</a> or <a href='undocumented#Path_Effect'>Path Effect</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4738 | |
| 4739 | ### Parameters |
| 4740 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4741 | <table> <tr> <td><a name='SkPaint_measureText_2_text'><code><strong>text</strong></code></a></td> |
| 4742 | <td>character codes or glyph indices to be measured</td> |
| 4743 | </tr> |
| 4744 | <tr> <td><a name='SkPaint_measureText_2_length'><code><strong>length</strong></code></a></td> |
| 4745 | <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] | 4746 | </tr> |
| 4747 | </table> |
| 4748 | |
| 4749 | ### Return Value |
| 4750 | |
| 4751 | advance width or height |
| 4752 | |
| 4753 | ### Example |
| 4754 | |
| 4755 | <div><fiddle-embed name="f1139a5ddd17fd47c2f45f6e642cac76"> |
| 4756 | |
| 4757 | #### Example Output |
| 4758 | |
| 4759 | ~~~~ |
| 4760 | default width = 5 |
| 4761 | double width = 10 |
| 4762 | ~~~~ |
| 4763 | |
| 4764 | </fiddle-embed></div> |
| 4765 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4766 | <a name='SkPaint_breakText'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 4767 | |
| 4768 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4769 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4770 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 4771 | size_t <a href='#SkPaint_breakText'>breakText</a>(const void* text, size_t length, <a href='undocumented#SkScalar'>SkScalar</a> maxWidth, |
| 4772 | <a href='undocumented#SkScalar'>SkScalar</a>* measuredWidth = nullptr) const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4773 | </pre> |
| 4774 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4775 | Returns the bytes of <a href='#SkPaint_breakText_text'>text</a> that fit within <a href='#SkPaint_breakText_maxWidth'>maxWidth</a>. |
Cary Clark | 3aca39d | 2018-10-23 14:44:05 -0400 | [diff] [blame] | 4776 | 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] | 4777 | Measures only while the advance is less than or equal to <a href='#SkPaint_breakText_maxWidth'>maxWidth</a>. |
| 4778 | 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. |
| 4779 | Uses <a href='#Text_Encoding'>Text Encoding</a> to decode <a href='#SkPaint_breakText_text'>text</a>, <a href='undocumented#Typeface'>Typeface</a> to get the font metrics, |
| 4780 | and <a href='#Text_Size'>Text Size</a> to scale the metrics. |
| 4781 | Does not scale the advance or bounds by <a href='#Fake_Bold'>Fake Bold</a> or <a href='undocumented#Path_Effect'>Path Effect</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4782 | |
| 4783 | ### Parameters |
| 4784 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4785 | <table> <tr> <td><a name='SkPaint_breakText_text'><code><strong>text</strong></code></a></td> |
| 4786 | <td>character codes or glyph indices to be measured</td> |
| 4787 | </tr> |
| 4788 | <tr> <td><a name='SkPaint_breakText_length'><code><strong>length</strong></code></a></td> |
| 4789 | <td>number of bytes of <a href='#SkPaint_breakText_text'>text</a> to measure</td> |
| 4790 | </tr> |
| 4791 | <tr> <td><a name='SkPaint_breakText_maxWidth'><code><strong>maxWidth</strong></code></a></td> |
| 4792 | <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> |
| 4793 | </tr> |
| 4794 | <tr> <td><a name='SkPaint_breakText_measuredWidth'><code><strong>measuredWidth</strong></code></a></td> |
| 4795 | <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] | 4796 | </tr> |
| 4797 | </table> |
| 4798 | |
| 4799 | ### Return Value |
| 4800 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4801 | 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] | 4802 | |
| 4803 | ### Example |
| 4804 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4805 | <div><fiddle-embed name="fd0033470ccbd5c7059670fdbf96cffc"><div><a href='undocumented#Line'>Line</a> under "" shows desired width, shorter than available characters. |
| 4806 | <a href='undocumented#Line'>Line</a> under "" shows measured width after breaking <a href='#SkPaint_breakText_text'>text</a>. |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 4807 | </div></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4808 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4809 | <a name='SkPaint_getTextWidths'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 4810 | |
| 4811 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4812 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4813 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 4814 | int <a href='#SkPaint_getTextWidths'>getTextWidths</a>(const void* text, 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] | 4815 | </pre> |
| 4816 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4817 | Retrieves the advance and <a href='#SkPaint_getTextWidths_bounds'>bounds</a> for each glyph in <a href='#SkPaint_getTextWidths_text'>text</a>, and returns |
| 4818 | the glyph count in <a href='#SkPaint_getTextWidths_text'>text</a>. |
| 4819 | Both <a href='#SkPaint_getTextWidths_widths'>widths</a> and <a href='#SkPaint_getTextWidths_bounds'>bounds</a> may be nullptr. |
| 4820 | If <a href='#SkPaint_getTextWidths_widths'>widths</a> is not nullptr, <a href='#SkPaint_getTextWidths_widths'>widths</a> must be an array of glyph count entries. |
| 4821 | if <a href='#SkPaint_getTextWidths_bounds'>bounds</a> is not nullptr, <a href='#SkPaint_getTextWidths_bounds'>bounds</a> must be an array of glyph count entries. |
Cary Clark | 3aca39d | 2018-10-23 14:44:05 -0400 | [diff] [blame] | 4822 | Widths returns the horizontal advance. |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4823 | Uses <a href='#Text_Encoding'>Text Encoding</a> to decode <a href='#SkPaint_getTextWidths_text'>text</a>, <a href='undocumented#Typeface'>Typeface</a> to get the font metrics, |
| 4824 | 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>. |
| 4825 | Does not scale the advance by <a href='#Fake_Bold'>Fake Bold</a> or <a href='undocumented#Path_Effect'>Path Effect</a>. |
| 4826 | Does include <a href='#Fake_Bold'>Fake Bold</a> and <a href='undocumented#Path_Effect'>Path Effect</a> in the <a href='#SkPaint_getTextWidths_bounds'>bounds</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4827 | |
| 4828 | ### Parameters |
| 4829 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4830 | <table> <tr> <td><a name='SkPaint_getTextWidths_text'><code><strong>text</strong></code></a></td> |
| 4831 | <td>character codes or glyph indices to be measured</td> |
| 4832 | </tr> |
| 4833 | <tr> <td><a name='SkPaint_getTextWidths_byteLength'><code><strong>byteLength</strong></code></a></td> |
| 4834 | <td>number of bytes of <a href='#SkPaint_getTextWidths_text'>text</a> to measure</td> |
| 4835 | </tr> |
| 4836 | <tr> <td><a name='SkPaint_getTextWidths_widths'><code><strong>widths</strong></code></a></td> |
| 4837 | <td>returns <a href='#SkPaint_getTextWidths_text'>text</a> advances for each glyph; may be nullptr</td> |
| 4838 | </tr> |
| 4839 | <tr> <td><a name='SkPaint_getTextWidths_bounds'><code><strong>bounds</strong></code></a></td> |
| 4840 | <td>returns <a href='#SkPaint_getTextWidths_bounds'>bounds</a> for each glyph relative to (0, 0); may be nullptr</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4841 | </tr> |
| 4842 | </table> |
| 4843 | |
| 4844 | ### Return Value |
| 4845 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4846 | glyph count in <a href='#SkPaint_getTextWidths_text'>text</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4847 | |
| 4848 | ### Example |
| 4849 | |
Cary Clark | f960398 | 2018-07-17 08:20:27 -0400 | [diff] [blame] | 4850 | <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. |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4851 | 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] | 4852 | </div></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4853 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 4854 | <a name='Text_Path'></a> |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 4855 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4856 | <a href='#Text_Path'>Text Path</a> describes the geometry of <a href='undocumented#Glyph'>Glyphs</a> used to draw text. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4857 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4858 | <a name='SkPaint_getTextPath'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 4859 | |
| 4860 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4861 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4862 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 4863 | void <a href='#SkPaint_getTextPath'>getTextPath</a>(const void* text, size_t length, <a href='undocumented#SkScalar'>SkScalar</a> x, <a href='undocumented#SkScalar'>SkScalar</a> y, <a href='SkPath_Reference#SkPath'>SkPath</a>* path) const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4864 | </pre> |
| 4865 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4866 | Returns the geometry as <a href='SkPath_Reference#Path'>Path</a> equivalent to the drawn <a href='#SkPaint_getTextPath_text'>text</a>. |
| 4867 | Uses <a href='#Text_Encoding'>Text Encoding</a> to decode <a href='#SkPaint_getTextPath_text'>text</a>, <a href='undocumented#Typeface'>Typeface</a> to get the glyph paths, |
| 4868 | and <a href='#Text_Size'>Text Size</a>, <a href='#Fake_Bold'>Fake Bold</a>, and <a href='undocumented#Path_Effect'>Path Effect</a> to scale and modify the glyph paths. |
| 4869 | All of the glyph paths are stored in <a href='#SkPaint_getTextPath_path'>path</a>. |
| 4870 | Uses <a href='#SkPaint_getTextPath_x'>x</a>, <a href='#SkPaint_getTextPath_y'>y</a>, and <a href='#Text_Align'>Text Align</a> to position <a href='#SkPaint_getTextPath_path'>path</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4871 | |
| 4872 | ### Parameters |
| 4873 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4874 | <table> <tr> <td><a name='SkPaint_getTextPath_text'><code><strong>text</strong></code></a></td> |
| 4875 | <td>character codes or glyph indices</td> |
| 4876 | </tr> |
| 4877 | <tr> <td><a name='SkPaint_getTextPath_length'><code><strong>length</strong></code></a></td> |
| 4878 | <td>number of bytes of <a href='#SkPaint_getTextPath_text'>text</a></td> |
| 4879 | </tr> |
| 4880 | <tr> <td><a name='SkPaint_getTextPath_x'><code><strong>x</strong></code></a></td> |
Cary Clark | 5538c13 | 2018-06-14 12:28:14 -0400 | [diff] [blame] | 4881 | <td><a href='#SkPaint_getTextPath_x'>x</a>-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] | 4882 | </tr> |
| 4883 | <tr> <td><a name='SkPaint_getTextPath_y'><code><strong>y</strong></code></a></td> |
Cary Clark | 5538c13 | 2018-06-14 12:28:14 -0400 | [diff] [blame] | 4884 | <td><a href='#SkPaint_getTextPath_y'>y</a>-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] | 4885 | </tr> |
| 4886 | <tr> <td><a name='SkPaint_getTextPath_path'><code><strong>path</strong></code></a></td> |
| 4887 | <td>geometry of the <a href='undocumented#Glyph'>Glyphs</a></td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4888 | </tr> |
| 4889 | </table> |
| 4890 | |
| 4891 | ### Example |
| 4892 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4893 | <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 |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 4894 | the offset location. The result is rendered with one draw call. |
| 4895 | </div></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4896 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4897 | <a name='SkPaint_getPosTextPath'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 4898 | |
| 4899 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4900 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4901 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 4902 | void <a href='#SkPaint_getPosTextPath'>getPosTextPath</a>(const void* text, size_t length, const <a href='SkPoint_Reference#SkPoint'>SkPoint</a> pos[], <a href='SkPath_Reference#SkPath'>SkPath</a>* path) const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4903 | </pre> |
| 4904 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4905 | Returns the geometry as <a href='SkPath_Reference#Path'>Path</a> equivalent to the drawn <a href='#SkPaint_getPosTextPath_text'>text</a>. |
| 4906 | Uses <a href='#Text_Encoding'>Text Encoding</a> to decode <a href='#SkPaint_getPosTextPath_text'>text</a>, <a href='undocumented#Typeface'>Typeface</a> to get the glyph paths, |
| 4907 | and <a href='#Text_Size'>Text Size</a>, <a href='#Fake_Bold'>Fake Bold</a>, and <a href='undocumented#Path_Effect'>Path Effect</a> to scale and modify the glyph paths. |
| 4908 | All of the glyph paths are stored in <a href='#SkPaint_getPosTextPath_path'>path</a>. |
| 4909 | Uses <a href='#SkPaint_getPosTextPath_pos'>pos</a> array and <a href='#Text_Align'>Text Align</a> to position <a href='#SkPaint_getPosTextPath_path'>path</a>. |
| 4910 | <a href='#SkPaint_getPosTextPath_pos'>pos</a> contains a position for each glyph. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4911 | |
| 4912 | ### Parameters |
| 4913 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4914 | <table> <tr> <td><a name='SkPaint_getPosTextPath_text'><code><strong>text</strong></code></a></td> |
| 4915 | <td>character codes or glyph indices</td> |
| 4916 | </tr> |
| 4917 | <tr> <td><a name='SkPaint_getPosTextPath_length'><code><strong>length</strong></code></a></td> |
| 4918 | <td>number of bytes of <a href='#SkPaint_getPosTextPath_text'>text</a></td> |
| 4919 | </tr> |
| 4920 | <tr> <td><a name='SkPaint_getPosTextPath_pos'><code><strong>pos</strong></code></a></td> |
| 4921 | <td>positions of each glyph</td> |
| 4922 | </tr> |
| 4923 | <tr> <td><a name='SkPaint_getPosTextPath_path'><code><strong>path</strong></code></a></td> |
| 4924 | <td>geometry of the <a href='undocumented#Glyph'>Glyphs</a></td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4925 | </tr> |
| 4926 | </table> |
| 4927 | |
| 4928 | ### Example |
| 4929 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4930 | <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] | 4931 | </div></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4932 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 4933 | <a name='Text_Intercepts'></a> |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 4934 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4935 | <a href='#Text_Intercepts'>Text Intercepts</a> describe the intersection of drawn text <a href='undocumented#Glyph'>Glyphs</a> with a pair |
| 4936 | of lines parallel to the text advance. <a href='#Text_Intercepts'>Text Intercepts</a> permits creating a |
Cary Clark | 137b874 | 2018-05-30 09:21:49 -0400 | [diff] [blame] | 4937 | underline that skips <a href='undocumented#Descenders'>Descenders</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4938 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4939 | <a name='SkPaint_getTextIntercepts'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 4940 | |
| 4941 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4942 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4943 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 4944 | int <a href='#SkPaint_getTextIntercepts'>getTextIntercepts</a>(const void* text, size_t length, <a href='undocumented#SkScalar'>SkScalar</a> x, <a href='undocumented#SkScalar'>SkScalar</a> y, |
| 4945 | 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] | 4946 | </pre> |
| 4947 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4948 | Returns the number of <a href='#SkPaint_getTextIntercepts_intervals'>intervals</a> that intersect <a href='#SkPaint_getTextIntercepts_bounds'>bounds</a>. |
| 4949 | <a href='#SkPaint_getTextIntercepts_bounds'>bounds</a> describes a pair of lines parallel to the <a href='#SkPaint_getTextIntercepts_text'>text</a> advance. |
| 4950 | 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 | 7cfcbca | 2018-01-04 16:11:51 -0500 | [diff] [blame] | 4951 | the string. |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4952 | Uses <a href='#Text_Encoding'>Text Encoding</a> to decode <a href='#SkPaint_getTextIntercepts_text'>text</a>, <a href='undocumented#Typeface'>Typeface</a> to get the glyph paths, |
| 4953 | and <a href='#Text_Size'>Text Size</a>, <a href='#Fake_Bold'>Fake Bold</a>, and <a href='undocumented#Path_Effect'>Path Effect</a> to scale and modify the glyph paths. |
| 4954 | Uses <a href='#SkPaint_getTextIntercepts_x'>x</a>, <a href='#SkPaint_getTextIntercepts_y'>y</a>, and <a href='#Text_Align'>Text Align</a> to position <a href='#SkPaint_getTextIntercepts_intervals'>intervals</a>. |
skia-bookmaker | 525f9a9 | 2018-05-03 06:27:39 +0000 | [diff] [blame] | 4955 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4956 | Pass nullptr for <a href='#SkPaint_getTextIntercepts_intervals'>intervals</a> to determine the size of the interval array. |
skia-bookmaker | 525f9a9 | 2018-05-03 06:27:39 +0000 | [diff] [blame] | 4957 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4958 | <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] | 4959 | |
| 4960 | ### Parameters |
| 4961 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4962 | <table> <tr> <td><a name='SkPaint_getTextIntercepts_text'><code><strong>text</strong></code></a></td> |
| 4963 | <td>character codes or glyph indices</td> |
| 4964 | </tr> |
| 4965 | <tr> <td><a name='SkPaint_getTextIntercepts_length'><code><strong>length</strong></code></a></td> |
| 4966 | <td>number of bytes of <a href='#SkPaint_getTextIntercepts_text'>text</a></td> |
| 4967 | </tr> |
| 4968 | <tr> <td><a name='SkPaint_getTextIntercepts_x'><code><strong>x</strong></code></a></td> |
Cary Clark | 5538c13 | 2018-06-14 12:28:14 -0400 | [diff] [blame] | 4969 | <td><a href='#SkPaint_getTextIntercepts_x'>x</a>-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] | 4970 | </tr> |
| 4971 | <tr> <td><a name='SkPaint_getTextIntercepts_y'><code><strong>y</strong></code></a></td> |
Cary Clark | 5538c13 | 2018-06-14 12:28:14 -0400 | [diff] [blame] | 4972 | <td><a href='#SkPaint_getTextIntercepts_y'>y</a>-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] | 4973 | </tr> |
| 4974 | <tr> <td><a name='SkPaint_getTextIntercepts_bounds'><code><strong>bounds</strong></code></a></td> |
| 4975 | <td>lower and upper line parallel to the advance</td> |
| 4976 | </tr> |
| 4977 | <tr> <td><a name='SkPaint_getTextIntercepts_intervals'><code><strong>intervals</strong></code></a></td> |
| 4978 | <td>returned intersections; may be nullptr</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4979 | </tr> |
| 4980 | </table> |
| 4981 | |
| 4982 | ### Return Value |
| 4983 | |
| 4984 | number of intersections; may be zero |
| 4985 | |
| 4986 | ### Example |
| 4987 | |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 4988 | <div><fiddle-embed name="2a0b80ed20d193c688085b79deb5bdc9"><div>Underline uses intercepts to draw on either side of the glyph Descender. |
| 4989 | </div></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4990 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4991 | <a name='SkPaint_getPosTextIntercepts'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 4992 | |
| 4993 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4994 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4995 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 4996 | int <a href='#SkPaint_getPosTextIntercepts'>getPosTextIntercepts</a>(const void* text, size_t length, const <a href='SkPoint_Reference#SkPoint'>SkPoint</a> pos[], |
| 4997 | 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] | 4998 | </pre> |
| 4999 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5000 | Returns the number of <a href='#SkPaint_getPosTextIntercepts_intervals'>intervals</a> that intersect <a href='#SkPaint_getPosTextIntercepts_bounds'>bounds</a>. |
| 5001 | <a href='#SkPaint_getPosTextIntercepts_bounds'>bounds</a> describes a pair of lines parallel to the <a href='#SkPaint_getPosTextIntercepts_text'>text</a> advance. |
| 5002 | 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 | 7cfcbca | 2018-01-04 16:11:51 -0500 | [diff] [blame] | 5003 | the string. |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5004 | Uses <a href='#Text_Encoding'>Text Encoding</a> to decode <a href='#SkPaint_getPosTextIntercepts_text'>text</a>, <a href='undocumented#Typeface'>Typeface</a> to get the glyph paths, |
| 5005 | and <a href='#Text_Size'>Text Size</a>, <a href='#Fake_Bold'>Fake Bold</a>, and <a href='undocumented#Path_Effect'>Path Effect</a> to scale and modify the glyph paths. |
| 5006 | Uses <a href='#SkPaint_getPosTextIntercepts_pos'>pos</a> array and <a href='#Text_Align'>Text Align</a> to position <a href='#SkPaint_getPosTextIntercepts_intervals'>intervals</a>. |
skia-bookmaker | 525f9a9 | 2018-05-03 06:27:39 +0000 | [diff] [blame] | 5007 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5008 | Pass nullptr for <a href='#SkPaint_getPosTextIntercepts_intervals'>intervals</a> to determine the size of the interval array. |
skia-bookmaker | 525f9a9 | 2018-05-03 06:27:39 +0000 | [diff] [blame] | 5009 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5010 | <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] | 5011 | |
| 5012 | ### Parameters |
| 5013 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5014 | <table> <tr> <td><a name='SkPaint_getPosTextIntercepts_text'><code><strong>text</strong></code></a></td> |
| 5015 | <td>character codes or glyph indices</td> |
| 5016 | </tr> |
| 5017 | <tr> <td><a name='SkPaint_getPosTextIntercepts_length'><code><strong>length</strong></code></a></td> |
| 5018 | <td>number of bytes of <a href='#SkPaint_getPosTextIntercepts_text'>text</a></td> |
| 5019 | </tr> |
| 5020 | <tr> <td><a name='SkPaint_getPosTextIntercepts_pos'><code><strong>pos</strong></code></a></td> |
| 5021 | <td>positions of each glyph</td> |
| 5022 | </tr> |
| 5023 | <tr> <td><a name='SkPaint_getPosTextIntercepts_bounds'><code><strong>bounds</strong></code></a></td> |
| 5024 | <td>lower and upper line parallel to the advance</td> |
| 5025 | </tr> |
| 5026 | <tr> <td><a name='SkPaint_getPosTextIntercepts_intervals'><code><strong>intervals</strong></code></a></td> |
| 5027 | <td>returned intersections; may be nullptr</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 5028 | </tr> |
| 5029 | </table> |
| 5030 | |
| 5031 | ### Return Value |
| 5032 | |
Cary Clark | a523d2d | 2017-08-30 08:58:10 -0400 | [diff] [blame] | 5033 | number of intersections; may be zero |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 5034 | |
| 5035 | ### Example |
| 5036 | |
Cary Clark | 92694be | 2018-10-25 08:15:36 -0400 | [diff] [blame^] | 5037 | <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] | 5038 | </div></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 5039 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5040 | <a name='SkPaint_getPosTextHIntercepts'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 5041 | |
| 5042 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 5043 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5044 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 5045 | int <a href='#SkPaint_getPosTextHIntercepts'>getPosTextHIntercepts</a>(const void* text, size_t length, const <a href='undocumented#SkScalar'>SkScalar</a> xpos[], <a href='undocumented#SkScalar'>SkScalar</a> constY, |
| 5046 | 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] | 5047 | </pre> |
| 5048 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5049 | Returns the number of <a href='#SkPaint_getPosTextHIntercepts_intervals'>intervals</a> that intersect <a href='#SkPaint_getPosTextHIntercepts_bounds'>bounds</a>. |
| 5050 | <a href='#SkPaint_getPosTextHIntercepts_bounds'>bounds</a> describes a pair of lines parallel to the <a href='#SkPaint_getPosTextHIntercepts_text'>text</a> advance. |
| 5051 | 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 | 7cfcbca | 2018-01-04 16:11:51 -0500 | [diff] [blame] | 5052 | the string. |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5053 | Uses <a href='#Text_Encoding'>Text Encoding</a> to decode <a href='#SkPaint_getPosTextHIntercepts_text'>text</a>, <a href='undocumented#Typeface'>Typeface</a> to get the glyph paths, |
| 5054 | and <a href='#Text_Size'>Text Size</a>, <a href='#Fake_Bold'>Fake Bold</a>, and <a href='undocumented#Path_Effect'>Path Effect</a> to scale and modify the glyph paths. |
| 5055 | Uses <a href='#SkPaint_getPosTextHIntercepts_xpos'>xpos</a> array, <a href='#SkPaint_getPosTextHIntercepts_constY'>constY</a>, and <a href='#Text_Align'>Text Align</a> to position <a href='#SkPaint_getPosTextHIntercepts_intervals'>intervals</a>. |
skia-bookmaker | 525f9a9 | 2018-05-03 06:27:39 +0000 | [diff] [blame] | 5056 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5057 | Pass nullptr for <a href='#SkPaint_getPosTextHIntercepts_intervals'>intervals</a> to determine the size of the interval array. |
skia-bookmaker | 525f9a9 | 2018-05-03 06:27:39 +0000 | [diff] [blame] | 5058 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5059 | <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] | 5060 | |
| 5061 | ### Parameters |
| 5062 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5063 | <table> <tr> <td><a name='SkPaint_getPosTextHIntercepts_text'><code><strong>text</strong></code></a></td> |
| 5064 | <td>character codes or glyph indices</td> |
| 5065 | </tr> |
| 5066 | <tr> <td><a name='SkPaint_getPosTextHIntercepts_length'><code><strong>length</strong></code></a></td> |
| 5067 | <td>number of bytes of <a href='#SkPaint_getPosTextHIntercepts_text'>text</a></td> |
| 5068 | </tr> |
| 5069 | <tr> <td><a name='SkPaint_getPosTextHIntercepts_xpos'><code><strong>xpos</strong></code></a></td> |
| 5070 | <td>positions of each glyph in x</td> |
| 5071 | </tr> |
| 5072 | <tr> <td><a name='SkPaint_getPosTextHIntercepts_constY'><code><strong>constY</strong></code></a></td> |
| 5073 | <td>position of each glyph in y</td> |
| 5074 | </tr> |
| 5075 | <tr> <td><a name='SkPaint_getPosTextHIntercepts_bounds'><code><strong>bounds</strong></code></a></td> |
| 5076 | <td>lower and upper line parallel to the advance</td> |
| 5077 | </tr> |
| 5078 | <tr> <td><a name='SkPaint_getPosTextHIntercepts_intervals'><code><strong>intervals</strong></code></a></td> |
| 5079 | <td>returned intersections; may be nullptr</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 5080 | </tr> |
| 5081 | </table> |
| 5082 | |
| 5083 | ### Return Value |
| 5084 | |
| 5085 | number of intersections; may be zero |
| 5086 | |
| 5087 | ### Example |
| 5088 | |
Cary Clark | 80247e5 | 2018-07-11 16:18:41 -0400 | [diff] [blame] | 5089 | <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] | 5090 | </div></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 5091 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5092 | <a name='SkPaint_getTextBlobIntercepts'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 5093 | |
| 5094 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 5095 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5096 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
Cary Clark | d2ca79c | 2018-08-10 13:09:13 -0400 | [diff] [blame] | 5097 | 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] | 5098 | </pre> |
| 5099 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5100 | Returns the number of <a href='#SkPaint_getTextBlobIntercepts_intervals'>intervals</a> that intersect <a href='#SkPaint_getTextBlobIntercepts_bounds'>bounds</a>. |
| 5101 | <a href='#SkPaint_getTextBlobIntercepts_bounds'>bounds</a> describes a pair of lines parallel to the text advance. |
| 5102 | 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 | 7cfcbca | 2018-01-04 16:11:51 -0500 | [diff] [blame] | 5103 | the string. |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5104 | Uses <a href='undocumented#Typeface'>Typeface</a> to get the glyph paths, |
| 5105 | and <a href='#Text_Size'>Text Size</a>, <a href='#Fake_Bold'>Fake Bold</a>, and <a href='undocumented#Path_Effect'>Path Effect</a> to scale and modify the glyph paths. |
| 5106 | Uses run array and <a href='#Text_Align'>Text Align</a> to position <a href='#SkPaint_getTextBlobIntercepts_intervals'>intervals</a>. |
skia-bookmaker | 525f9a9 | 2018-05-03 06:27:39 +0000 | [diff] [blame] | 5107 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5108 | <a href='#Text_Encoding'>Text Encoding</a> must be set to <a href='#SkPaint_kGlyphID_TextEncoding'>SkPaint::kGlyphID TextEncoding</a>. |
Cary Clark | 3cd22cc | 2017-12-01 11:49:58 -0500 | [diff] [blame] | 5109 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5110 | Pass nullptr for <a href='#SkPaint_getTextBlobIntercepts_intervals'>intervals</a> to determine the size of the interval array. |
skia-bookmaker | 525f9a9 | 2018-05-03 06:27:39 +0000 | [diff] [blame] | 5111 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5112 | <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] | 5113 | |
| 5114 | ### Parameters |
| 5115 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5116 | <table> <tr> <td><a name='SkPaint_getTextBlobIntercepts_blob'><code><strong>blob</strong></code></a></td> |
| 5117 | <td><a href='undocumented#Glyph'>Glyphs</a>, positions, and text paint attributes</td> |
| 5118 | </tr> |
| 5119 | <tr> <td><a name='SkPaint_getTextBlobIntercepts_bounds'><code><strong>bounds</strong></code></a></td> |
| 5120 | <td>lower and upper line parallel to the advance</td> |
| 5121 | </tr> |
| 5122 | <tr> <td><a name='SkPaint_getTextBlobIntercepts_intervals'><code><strong>intervals</strong></code></a></td> |
| 5123 | <td>returned intersections; may be nullptr</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 5124 | </tr> |
| 5125 | </table> |
| 5126 | |
| 5127 | ### Return Value |
| 5128 | |
| 5129 | number of intersections; may be zero |
| 5130 | |
| 5131 | ### Example |
| 5132 | |
skia-bookmaker | 44bad2e | 2018-07-05 05:35:27 +0000 | [diff] [blame] | 5133 | <div><fiddle-embed name="f2229dd5c8e76f9e12fafe59b61353c8"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 5134 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5135 | <a name='SkPaint_nothingToDraw'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 5136 | |
| 5137 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 5138 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5139 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 5140 | bool <a href='#SkPaint_nothingToDraw'>nothingToDraw</a>() const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 5141 | </pre> |
| 5142 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5143 | Returns true if <a href='#Paint'>Paint</a> prevents all drawing; |
| 5144 | otherwise, the <a href='#Paint'>Paint</a> may or may not allow drawing. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 5145 | |
Cary Clark | 224c700 | 2018-06-27 11:00:21 -0400 | [diff] [blame] | 5146 | Returns true if, for example, <a href='SkBlendMode_Reference#Blend_Mode'>Blend Mode</a> combined with <a href='SkColor_Reference#Alpha'>Color Alpha</a> computes a |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5147 | new <a href='SkColor_Reference#Alpha'>Alpha</a> of zero. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 5148 | |
| 5149 | ### Return Value |
| 5150 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5151 | true if <a href='#Paint'>Paint</a> prevents all drawing |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 5152 | |
| 5153 | ### Example |
| 5154 | |
Cary Clark | 8364706 | 2018-07-18 16:21:51 -0400 | [diff] [blame] | 5155 | <div><fiddle-embed name="2973b05bfbb6b4c29332c8ac4fcf3995"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 5156 | |
| 5157 | #### Example Output |
| 5158 | |
| 5159 | ~~~~ |
| 5160 | initial nothing to draw: false |
| 5161 | blend dst nothing to draw: true |
| 5162 | blend src over nothing to draw: false |
| 5163 | alpha 0 nothing to draw: true |
| 5164 | ~~~~ |
| 5165 | |
| 5166 | </fiddle-embed></div> |
| 5167 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 5168 | <a name='Fast_Bounds'></a> |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 5169 | |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 5170 | Private: To be made private. |
| 5171 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5172 | <a href='#Fast_Bounds'>Fast Bounds</a> functions conservatively outset a drawing bounds by additional area |
| 5173 | <a href='#Paint'>Paint</a> may draw to. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 5174 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5175 | <a name='SkPaint_canComputeFastBounds'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 5176 | |
| 5177 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 5178 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5179 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 5180 | bool <a href='#SkPaint_canComputeFastBounds'>canComputeFastBounds</a>() const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 5181 | </pre> |
| 5182 | |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 5183 | Private: (to be made private) |
| 5184 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5185 | Returns true if <a href='#Paint'>Paint</a> does not include elements requiring extensive computation |
| 5186 | to compute <a href='undocumented#Device'>Device</a> bounds of drawn geometry. For instance, <a href='#Paint'>Paint</a> with <a href='undocumented#Path_Effect'>Path Effect</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 5187 | always returns false. |
| 5188 | |
| 5189 | ### Return Value |
| 5190 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5191 | true if <a href='#Paint'>Paint</a> allows for fast computation of bounds |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 5192 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5193 | <a name='SkPaint_computeFastBounds'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 5194 | |
| 5195 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 5196 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5197 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 5198 | 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] | 5199 | </pre> |
| 5200 | |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 5201 | Private: (to be made private) |
| 5202 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5203 | Only call this if <a href='#SkPaint_canComputeFastBounds'>canComputeFastBounds</a> returned true. This takes a |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 5204 | raw rectangle (the raw bounds of a shape), and adjusts it for stylistic |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5205 | effects in the paint (e.g. stroking). If needed, it uses the <a href='#SkPaint_computeFastBounds_storage'>storage</a> |
Cary Clark | ce10124 | 2017-09-01 15:51:02 -0400 | [diff] [blame] | 5206 | parameter. It returns the adjusted bounds that can then be used |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5207 | for <a href='SkCanvas_Reference#SkCanvas_quickReject'>SkCanvas::quickReject</a> tests. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 5208 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5209 | 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 |
| 5210 | should not rely on <a href='#SkPaint_computeFastBounds_storage'>storage</a> being set to the result, but should always |
| 5211 | 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 |
| 5212 | <a href='SkRect_Reference#Rect'>Rect</a>. |
| 5213 | |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 5214 | Private: For example: |
| 5215 | if (!path.isInverseFillType() && paint.canComputeFastBounds()) { |
| 5216 | SkRect storage; |
| 5217 | if (canvas->quickReject(paint.computeFastBounds(path.getBounds(), &storage))) { |
| 5218 | return; // do not draw the path |
| 5219 | } |
| 5220 | } |
| 5221 | // draw the path |
| 5222 | |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 5223 | ### Parameters |
| 5224 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5225 | <table> <tr> <td><a name='SkPaint_computeFastBounds_orig'><code><strong>orig</strong></code></a></td> |
| 5226 | <td>geometry modified by <a href='#Paint'>Paint</a> when drawn</td> |
| 5227 | </tr> |
| 5228 | <tr> <td><a name='SkPaint_computeFastBounds_storage'><code><strong>storage</strong></code></a></td> |
| 5229 | <td>computed bounds of geometry; may not be nullptr</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 5230 | </tr> |
| 5231 | </table> |
| 5232 | |
| 5233 | ### Return Value |
| 5234 | |
| 5235 | fast computed bounds |
| 5236 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5237 | <a name='SkPaint_computeFastStrokeBounds'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 5238 | |
| 5239 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 5240 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5241 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 5242 | 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] | 5243 | </pre> |
| 5244 | |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 5245 | Private: (to be made private) |
| 5246 | |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 5247 | ### Parameters |
| 5248 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5249 | <table> <tr> <td><a name='SkPaint_computeFastStrokeBounds_orig'><code><strong>orig</strong></code></a></td> |
| 5250 | <td>geometry modified by <a href='#Paint'>Paint</a> when drawn</td> |
| 5251 | </tr> |
| 5252 | <tr> <td><a name='SkPaint_computeFastStrokeBounds_storage'><code><strong>storage</strong></code></a></td> |
| 5253 | <td>computed bounds of geometry</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 5254 | </tr> |
| 5255 | </table> |
| 5256 | |
| 5257 | ### Return Value |
| 5258 | |
| 5259 | fast computed bounds |
| 5260 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5261 | <a name='SkPaint_doComputeFastBounds'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 5262 | |
| 5263 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 5264 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5265 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 5266 | 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] | 5267 | </pre> |
| 5268 | |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 5269 | Private: (to be made private) |
| 5270 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5271 | Computes the bounds, overriding the <a href='#Paint'>Paint</a> <a href='#SkPaint_Style'>Style</a>. This can be used to |
| 5272 | account for additional width required by stroking <a href='#SkPaint_doComputeFastBounds_orig'>orig</a>, without |
| 5273 | altering <a href='#SkPaint_Style'>Style</a> set to fill. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 5274 | |
| 5275 | ### Parameters |
| 5276 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5277 | <table> <tr> <td><a name='SkPaint_doComputeFastBounds_orig'><code><strong>orig</strong></code></a></td> |
| 5278 | <td>geometry modified by <a href='#Paint'>Paint</a> when drawn</td> |
| 5279 | </tr> |
| 5280 | <tr> <td><a name='SkPaint_doComputeFastBounds_storage'><code><strong>storage</strong></code></a></td> |
| 5281 | <td>computed bounds of geometry</td> |
| 5282 | </tr> |
| 5283 | <tr> <td><a name='SkPaint_doComputeFastBounds_style'><code><strong>style</strong></code></a></td> |
| 5284 | <td>overrides <a href='#SkPaint_Style'>Style</a></td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 5285 | </tr> |
| 5286 | </table> |
| 5287 | |
| 5288 | ### Return Value |
| 5289 | |
| 5290 | fast computed bounds |
| 5291 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 5292 | <a name='Utility'></a> |
Cary Clark | 78de751 | 2018-02-07 07:27:09 -0500 | [diff] [blame] | 5293 | |